Skip to content

Commit

Permalink
docs: Update installation guide
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Collins <[email protected]>
  • Loading branch information
alexec committed Aug 6, 2021
1 parent a105b13 commit 745c1cf
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Check out our [Java, Golang and Python SDKs](https://github.com/argoproj-labs/ar

```bash
kubectl create namespace argo
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/stable/manifests/install.yaml
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/master/manifests/install.yaml
```

## Who uses Argo Workflows?
Expand Down
17 changes: 7 additions & 10 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@

You can choose one of three common installations:

* **cluster install** Execute workflows in any namespace?
* **cluster install** Execute workflows in any namespace?
* **namespace install** Only execute workflows in the same namespace we install in (typically `argo`).
* **managed namespace install**: Only execute workflows in a specific namespace ([learn more](managed-namespace.md)).

Choose [a manifests from the list](https://github.com/argoproj/argo-workflows/tree/stable/manifests).

E.g.

```sh
kubectl create ns argo
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/stable/manifests/namespace-install.yaml
```

## Recommendations

* Make sure you're using the manifests attached to the release.
* Read the [upgrading guide](upgrading.md) before any major upgrade to be aware of breaking changes.
* If you are using GitOps, copy the manifests into your repository, rather use `base` to reference them. Fewer issues
regarding network loss, and you'll be able to check what has changed each time you upgrade.
* Double-check you have the right version of your executor configured, it's easy to miss.



Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To get started quickly, you can use the quick start manifest which will install

```sh
kubectl create ns argo
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/stable/manifests/quick-start-postgres.yaml
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo-workflows/master/manifests/quick-start-postgres.yaml
```

!!! note
Expand Down

0 comments on commit 745c1cf

Please sign in to comment.