-
Notifications
You must be signed in to change notification settings - Fork 7k
docs: add terminal documentation #9948
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
crenshaw-dev
merged 1 commit into
argoproj:master
from
notfromstatefarm:docs/terminal-docs
Jul 12, 2022
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Web-based Terminal | ||
|
|
||
|  | ||
|
|
||
| Since v2.4, Argo CD has a web-based terminal that allows you to get a shell inside a running pod just like you would with | ||
| `kubectl exec`. It's basically SSH from your browser, full ANSI color support and all! However, for security this feature | ||
| is disabled by default. | ||
|
|
||
| This is a powerful privilege. It allows the user to run arbitrary code on any Pod managed by an Application for which | ||
| they have the `exec/create` privilege. If the Pod mounts a ServiceAccount token (which is the default behavior of | ||
| Kubernetes), then the user effectively has the same privileges as that ServiceAccount. | ||
|
|
||
| ## Enabling the terminal | ||
|
|
||
| 1. Set the `exec.enabled` key to `true` on the `argocd-cm` ConfigMap. | ||
|
|
||
| 2. Patch the `argocd-server` Role (if using namespaced Argo) or ClusterRole (if using clustered Argo) to allow `argocd-server` | ||
| to exec into pods | ||
| ```yaml | ||
| - apiGroups: | ||
| - "" | ||
| resources: | ||
| - pods/exec | ||
| verbs: | ||
| - create | ||
| ``` | ||
|
|
||
| 3. Add RBAC rules to allow your users to `create` the `exec` resource, i.e. | ||
| ``` | ||
| p, role:myrole, exec, create, */*, allow | ||
| ``` | ||
|
|
||
| See [RBAC Configuration](rbac.md#exec-resource) for more info. | ||
|
|
||
| ## Changing allowed shells | ||
|
|
||
| By default, Argo CD attempts to execute shells in this order: | ||
|
|
||
| 1. bash | ||
| 2. sh | ||
| 3. powershell | ||
| 4. cmd | ||
|
|
||
| If none of the shells are found, the terminal session will fail. To add to or change the allowed shells, change the | ||
| `exec.shells` key in the `argocd-cm` ConfigMap, separating them with commas. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.