Skip to content

Commit

Permalink
docs(quick-start): consolidate UI & port-forward sections (#12560)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
(cherry picked from commit 37827b7)
  • Loading branch information
agilgur5 committed May 4, 2024
1 parent df2eb7f commit f208cf9
Showing 1 changed file with 12 additions and 24 deletions.
36 changes: 12 additions & 24 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,25 +43,13 @@ kubectl patch deployment \

```

### Port-forward the UI

Open a port-forward so you can access the UI:

```bash
kubectl -n argo port-forward deployment/argo-server 2746:2746
```

This will serve the UI on <https://localhost:2746>. Due to the self-signed certificate, you will receive a TLS error which you will need to manually approve.

> Pay close attention to the URI. It uses `https` and not `http`. Navigating to `http://localhost:2746` results in a server-side error that breaks the port forwarding.
## Install the Argo Workflows CLI

You can more easily interact with Argo Workflows with the [Argo CLI](walk-through/argo-cli.md).

## Submitting an example workflow
## Submit an example workflow

### Submit an example workflow (CLI)
### Submit via the CLI

```bash
argo submit -n argo --watch https://github.com/raw/argoproj/argo-workflows/main/examples/hello-world.yaml
Expand Down Expand Up @@ -95,16 +83,16 @@ You can also observe the logs of the Workflow run by running the following:
argo logs -n argo @latest
```

### Submit an example workflow (GUI)

* Open a port-forward so you can access the UI:

```bash
kubectl -n argo port-forward service/argo-server 2746:2746
```
### Submit via the UI

* Navigate your browser to <https://localhost:2746>.
1. Forward the Server's port to access the UI:

* Click `+ Submit New Workflow` and then `Edit using full workflow options`
```bash
kubectl -n argo port-forward service/argo-server 2746:2746
```

* You can find an example workflow already in the text field. Press `+ Create` to start the workflow.
1. Navigate your browser to <https://localhost:2746>.
* **Note**: The URL uses `https` and not `http`. Navigating to `http` will result in a server-side error.
* Due to the self-signed certificate, you will receive a TLS error which you will need to manually approve.
1. Click `+ Submit New Workflow` and then `Edit using full workflow options`
1. You can find an example workflow already in the text field. Press `+ Create` to start the workflow.

0 comments on commit f208cf9

Please sign in to comment.