Skip to content

Commit

Permalink
docs: improve grammar + wording on Managed NS install (#11817)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
  • Loading branch information
agilgur5 authored Oct 19, 2023
1 parent 247448c commit 7b2c4aa
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
1 change: 1 addition & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ BlackRock
Breitgand
Codespaces
Couler
ClusterRoles
ClusterRoleBinding
CRD
CRDs
Expand Down
13 changes: 6 additions & 7 deletions docs/managed-namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

> v2.5 and after
You can install Argo in either cluster scoped or namespace scope configurations.
This dictates if you must set-up cluster roles or normal roles.
You can install Argo in either namespace scoped or cluster scoped configurations.
The main difference is whether you install Roles or ClusterRoles, respectively.

In namespace scope configuration, you must run both the Workflow Controller and
Argo Server using `--namespaced`. If you would like to have the workflows running in a separate
namespace, add `--managed-namespace` as well. (In cluster scope installation, don't include `--namespaced`
or `--managed-namespace`.)
In namespace scoped configuration, you must run both the Workflow Controller and Argo Server using `--namespaced`.
If you want to run workflows in a separate namespace, add `--managed-namespace` as well.
(In cluster scoped configuration, _don't_ include `--namespaced` or `--managed-namespace`.)

For example:

Expand All @@ -23,7 +22,7 @@ For example:
- default
```
Please mind that both cluster scoped and namespace scoped configurations require "admin" role because some custom resource (CRD) must be created (and CRD is always a cluster level object)
Please note that both cluster scoped and namespace scoped configurations require "admin" roles to install because Argo's Custom Resource Definitions (CRDs) must be created (CRDs are cluster scoped objects).
!!! Info "Example Use Case"
You can use a managed namespace install if you want some users or services to run Workflows without granting them privileges in the namespace where Argo Workflows is installed.
Expand Down

0 comments on commit 7b2c4aa

Please sign in to comment.