Skip to content

Commit

Permalink
docs: Change http to https for argo-server. Fixes #5866 (#5904)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Collins <[email protected]>
  • Loading branch information
alexec committed May 14, 2021
1 parent f8bff12 commit 948c284
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 13 deletions.
8 changes: 6 additions & 2 deletions docs/argo-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

> v2.5 and after
!!! Warning "HTTP vs HTTPS"
Since v3.0 the Argo Server listens for HTTPS requests, rather than HTTP.

The Argo Server is a server that exposes an API and UI for workflows. You'll need to use this if you want to [offload large workflows](offloading-large-workflows.md) or the [workflow archive](workflow-archive.md).

You can run this in either "hosted" or "local" mode.
Expand Down Expand Up @@ -32,7 +35,8 @@ To run locally:
argo server
```

This will start a server on port 2746 which you can view at [https://localhost:2746](https://localhost:2746).
This will start a server on port 2746 which you can view at [https://localhost:2746](https://localhost:2746).


## Options

Expand Down Expand Up @@ -71,7 +75,7 @@ following:
kubectl -n argo port-forward svc/argo-server 2746:2746
```

Then visit: http:https://127.0.0.1:2746
Then visit: https:https://127.0.0.1:2746


### Expose a `LoadBalancer`
Expand Down
4 changes: 2 additions & 2 deletions docs/async-pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You may need an [access token](access-token.md).

```
curl --request PUT \
--url http:https://localhost:2746/api/v1/workflows/<NAMESPACE>/<WORKFLOWNAME>/resume
--url https:https://localhost:2746/api/v1/workflows/<NAMESPACE>/<WORKFLOWNAME>/resume
--header 'content-type: application/json' \
--header "Authorization: Bearer $ARGO_TOKEN" \
--data '{
Expand All @@ -78,7 +78,7 @@ or stop if unsuccessful:

```
curl --request PUT \
--url http:https://localhost:2746/api/v1/workflows/<NAMESPACE>/<WORKFLOWNAME>/stop
--url https:https://localhost:2746/api/v1/workflows/<NAMESPACE>/<WORKFLOWNAME>/stop
--header 'content-type: application/json' \
--header "Authorization: Bearer $ARGO_TOKEN" \
--data '{
Expand Down
4 changes: 2 additions & 2 deletions docs/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ The server can be configured with or without client auth (`server --auth-mode cl

```
ARGO_TOKEN=$(argo auth token)
curl -H "Authorization: $ARGO_TOKEN" http:https://localhost:2746/api/v1/workflows/argo
curl -H "Authorization: $ARGO_TOKEN" https:https://localhost:2746/api/v1/workflows/argo
```

* Learn more on [how to generate an access token](access-token.md).

API reference docs :

* [Latest docs](swagger.md) (maybe incorrect)
* Interactively in the [Argo Server UI](http:https://localhost:2746/apidocs). (>= v2.10)
* Interactively in the [Argo Server UI](https:https://localhost:2746/apidocs). (>= v2.10)

8 changes: 4 additions & 4 deletions docs/rest-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Assuming

```
curl --request POST \
--url http:https://localhost:2746/api/v1/workflows/argo \
--url https:https://localhost:2746/api/v1/workflows/argo \
--header 'content-type: application/json' \
--data '{
"namespace": "argo",
Expand Down Expand Up @@ -59,19 +59,19 @@ curl --request POST \

```
curl --request GET \
--url http:https://localhost:2746/api/v1/workflows/argo
--url https:https://localhost:2746/api/v1/workflows/argo
```

## Getting single workflow for namespace argo

```
curl --request GET \
--url http:https://localhost:2746/api/v1/workflows/argo/abc-dthgt
--url https:https://localhost:2746/api/v1/workflows/argo/abc-dthgt
```

## Deleting single workflow for namespace argo

```
curl --request DELETE \
--url http:https://localhost:2746/api/v1/workflows/argo/abc-dthgt
--url https:https://localhost:2746/api/v1/workflows/argo/abc-dthgt
```
2 changes: 1 addition & 1 deletion docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Argo Workflows requires various levels of network access depending on configurat

### Argo Server

The argo server is commonly exposed to end-users to provide users with a user interface for visualizing and managing their workflows. It must also be exposed if leveraging [webhooks](webhooks.md) to trigger workflows. Both of these use cases require that the argo-server Service to be exposed for ingress traffic (e.g. with an Ingress object or load balancer). Note that the Argo UI is also available to be accessed by running the server locally (i.e. `argo server`) using local kubeconfig credentials, and visiting the UI over http:https://localhost:2746.
The argo server is commonly exposed to end-users to provide users with a user interface for visualizing and managing their workflows. It must also be exposed if leveraging [webhooks](webhooks.md) to trigger workflows. Both of these use cases require that the argo-server Service to be exposed for ingress traffic (e.g. with an Ingress object or load balancer). Note that the Argo UI is also available to be accessed by running the server locally (i.e. `argo server`) using local kubeconfig credentials, and visiting the UI over https:https://localhost:2746.

The argo server additionally has a feature to allow downloading of artifacts through the user interface. This feature requires that the argo-server be given egress access to the underlying artifact provider (e.g. S3, GCS, MinIO, Arfactory) in order to download and stream the artifact.

Expand Down
2 changes: 1 addition & 1 deletion docs/stress-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Run `make start PROFILE=stress IMAGE_NAMESPACE=alexcollinsintuit DOCKER_PUSH=tru

If this fails, just try running it again.

Open http:https://localhost:2746 and check you can run a workflow.
Open https:https://localhost:2746 and check you can run a workflow.

Open `test/stress/main.go` and run it with a small number (e.g. 10) workflows and make sure they complete.

Expand Down
2 changes: 1 addition & 1 deletion docs/workflow-submitting-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
command:
- sh
source: >
curl http:https://argo-server:2746/api/v1/workflows/argo/submit \
curl https:https://argo-server:2746/api/v1/workflows/argo/submit \
-fs \
-H "Authorization: Bearer eyJhbGci..." \
-d '{"resourceKind": "WorkflowTemplate", "resourceName": "wait", "submitOptions": {"labels": "workflows.argoproj.io/workflow-template=wait"}}'
Expand Down

0 comments on commit 948c284

Please sign in to comment.