-
Notifications
You must be signed in to change notification settings - Fork 330
doc: OpenShift argocd CLI client command reference documentation #650
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
Open
anandf
wants to merge
23
commits into
redhat-developer:master
Choose a base branch
from
anandf:add_cli_documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
12f89b9
Initial commit for CLI command reference documentation
anandf f36bae9
Added note about core mode of execution for MicroShift installations
anandf 120c9a3
Updated the version output for verification
anandf 95d31ff
Converted args to table entries
anandf b96e4b0
Added configuration section and changed global commands to utility co…
anandf 2569942
Formatted basic syntax commands
anandf 18665b2
Added the parent argocd command reference
anandf 8527333
Updated the app creation and app sync commands
anandf 2994db7
Added a short description for Global options
anandf e69581c
Added tips warning and notes for commands and description for user guide
anandf ed2086f
Removed accidental commit of unresolved conflicts
anandf b1f376e
Addressed review comments related to core mode and options with kubec…
anandf 965062a
Corrected some formatting errors and typos
anandf 370df4e
Made some minor corrections
anandf 6cde0d4
Added RHEL8 or later and corrected the repo name
anandf 7dd2cbf
Updated repos for RHEL 8 and RHEL 9 separately
anandf a400287
Corrected command for getting the secret and fixed the build info output
anandf edf7cc7
Corrected the server url option
anandf 0e288ea
Added note about passwords containing shell variables
anandf 70713d3
Removed hardcoded password
anandf 30f5f08
Corrected core mode commands after testing
anandf 0cc95da
Removed sync section when automated sync policy is used
anandf 75cf183
Fixed review comments from Kevin and Varsha
anandf 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
Large diffs are not rendered by default.
Oops, something went wrong.
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,55 @@ | ||
# `argocd` Command Reference | ||
|
||
## argocd | ||
|
||
argocd controls a Argo CD server | ||
|
||
``` | ||
argocd [flags] | ||
``` | ||
|
||
### Options | ||
|
||
| Option| Argument Type | Description| | ||
| ----- | ------------- |----------- | | ||
| --auth-token | string | Authentication token | | ||
| --client-crt | string | Client certificate file | ||
| --client-crt-key | string | Client certificate key file | | ||
| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | | ||
| --controller-name | string | Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller") | | ||
| --core | | If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server | | ||
| --grpc-web | | Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. | | ||
| --grpc-web-root-path | string | Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root.| | ||
| -H, --header | strings | Sets additional header to all requests made by Argo CD CLI. (Can be repeated multiple times to add multiple headers, also supports comma separated headers) | | ||
| -h, --help | | help for argocd | | ||
| --http-retry-max | int | Maximum number of retries to establish http connection to Argo CD server | | ||
| --insecure | | Skip server certificate and domain verification | | ||
| --kube-context | string | Directs the command to the given kube-context | | ||
| --logformat | string | Set the logging format. One of: text|json (default "text") | | ||
| --loglevel | string | Set the logging level. One of: debug|info|warn|error (default "info") | | ||
| --plaintext | | Disable TLS | | ||
| --port-forward | | Connect to a random argocd-server port using port forwarding | | ||
| --port-forward-namespace | string | Namespace name which should be used for port forwarding | | ||
| --redis-haproxy-name | string | Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy") | | ||
| --redis-name | string | Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis") | | ||
|
||
|
||
### SEE ALSO | ||
|
||
* [argocd account](argocd_account.md) - Manage account settings | ||
* [argocd admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access | ||
* [argocd app](argocd_app.md) - Manage applications | ||
* [argocd appset](argocd_appset.md) - Manage ApplicationSets | ||
* [argocd cert](argocd_cert.md) - Manage repository certificates and SSH known hosts entries | ||
* [argocd cluster](argocd_cluster.md) - Manage cluster credentials | ||
* [argocd completion](argocd_completion.md) - output shell completion code for the specified shell (bash or zsh) | ||
* [argocd context](argocd_context.md) - Switch between contexts | ||
* [argocd gpg](argocd_gpg.md) - Manage GPG keys used for signature verification | ||
* [argocd login](argocd_login.md) - Log in to Argo CD | ||
* [argocd logout](argocd_logout.md) - Log out from Argo CD | ||
* [argocd proj](argocd_proj.md) - Manage projects | ||
* [argocd relogin](argocd_relogin.md) - Refresh an expired authenticate token | ||
* [argocd repo](argocd_repo.md) - Manage repository connection parameters | ||
* [argocd repocreds](argocd_repocreds.md) - Manage repository connection parameters | ||
* [argocd version](argocd_version.md) - Print version information | ||
|
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,85 @@ | ||
# `argocd account` Command Reference | ||
|
||
## argocd account | ||
|
||
Manage account settings | ||
|
||
``` | ||
argocd account [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# List accounts | ||
argocd account list | ||
|
||
# Update the current user's password | ||
argocd account update-password | ||
|
||
# Can I sync any app? | ||
argocd account can-i sync applications '*' | ||
|
||
# Get User information | ||
argocd account get-user-info | ||
``` | ||
|
||
### Options | ||
|
||
| Option | Argument type | Description | | ||
| ---------------- | ------ | ---- | | ||
| --as | string | Username to impersonate for the operation | | ||
| --as-group | string Array| Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | | ||
| --as-uid | string | UID to impersonate for the operation | | ||
| --certificate-authority | string | Path to a cert file for the certificate authority | | ||
| --client-certificate | string | Path to a client certificate file for TLS | | ||
| --client-key | string | Path to a client key file for TLS | | ||
| --cluster | string | The name of the kubeconfig cluster to use | | ||
| --context | string | The name of the kubeconfig context to use | | ||
| --disable-compression | | If true, opt-out of response compression for all requests to the server | | ||
| --insecure-skip-tls-verify | | If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | | ||
| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | | ||
| --password | string | Password for basic authentication to the API server | | ||
| --proxy-url | string | If provided, this URL will be used to connect via proxy | | ||
| --request-timeout | string | The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") | | ||
| --tls-server-name | string | If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used. | | ||
| --token | string | Bearer token for authentication to the API server | | ||
| --user | string | The name of the kubeconfig user to use | | ||
| --username | string | Username for basic authentication to the API server | | ||
|
||
### Options inherited from parent commands | ||
| Option | Argument type | Description | | ||
| ---------------- | ------ | ---- | | ||
| --auth-token | string | Authentication token | | ||
| --client-crt | string | Client certificate file | | ||
| --client-crt-key | string | Client certificate key file | | ||
| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | | ||
| --controller-name | string | Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller") | | ||
| --core | |If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server | | ||
| --grpc-web | |Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. | | ||
| --grpc-web-root-path | string | Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root. | | ||
| --http-retry-max | int | Maximum number of retries to establish http connection to Argo CD server | | ||
| --insecure | |Skip server certificate and domain verification | | ||
| --kube-context | string | Directs the command to the given kube-context | | ||
| --logformat | string | Set the logging format. One of: text|json (default "text") | | ||
| --loglevel | string | Set the logging level. One of: debug|info|warn|error (default "info") | | ||
| --plaintext | |Disable TLS | | ||
| --port-forward | |Connect to a random argocd-server port using port forwarding | | ||
| --port-forward-namespace | string | Namespace name which should be used for port forwarding | | ||
| --redis-haproxy-name | string | Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy") | | ||
| --redis-name | string | Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis") | | ||
| --repo-server-name | string | Name of the Argo CD Repo server; set this or the ARGOCD_REPO_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-repo-server") | | ||
| --server | string | Argo CD server address | | ||
| --server-crt | string | Server certificate file | | ||
| --server-name | string | Name of the Argo CD API server; set this or the ARGOCD_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-server") | | ||
|
||
### SEE ALSO | ||
|
||
* [argocd account bcrypt](argocd_account_bcrypt.md) - Generate bcrypt hash for any password | ||
* [argocd account can-i](argocd_account_can-i.md) - Can I | ||
* [argocd account delete-token](argocd_account_delete-token.md) - Deletes account token | ||
* [argocd account generate-token](argocd_account_generate-token.md) - Generate account token | ||
* [argocd account get](argocd_account_get.md) - Get account details | ||
* [argocd account get-user-info](argocd_account_get-user-info.md) - Get user info | ||
* [argocd account list](argocd_account_list.md) - List accounts | ||
* [argocd account update-password](argocd_account_update-password.md) - Update an account's password |
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,62 @@ | ||
# `argocd account bcrypt` Command Reference | ||
|
||
## argocd account bcrypt | ||
|
||
Generate bcrypt hash for any password | ||
|
||
``` | ||
argocd account bcrypt [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Generate bcrypt hash for any password | ||
argocd account bcrypt --password YOUR_PASSWORD | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for bcrypt | ||
--password string Password for which bcrypt hash is generated | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
| Option | Argument type | Description | | ||
| ---------------- | ------ | ---- | | ||
| --password | string | Password for which bcrypt hash is generated | | ||
| --auth-token | string | Authentication token | | ||
| --client-crt | string | Client certificate file | | ||
| --client-crt-key | string | Client certificate key file | | ||
| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | | ||
| --controller-name | string | Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller") | | ||
| --core | |If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server | | ||
| --grpc-web | |Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. | | ||
| --grpc-web-root-path | string | Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root. | | ||
| --http-retry-max | int | Maximum number of retries to establish http connection to Argo CD server | | ||
| --insecure | |Skip server certificate and domain verification | | ||
| --kube-context | string | Directs the command to the given kube-context | | ||
| --logformat | string | Set the logging format. One of: text|json (default "text") | | ||
| --loglevel | string | Set the logging level. One of: debug|info|warn|error (default "info") | | ||
| --plaintext | |Disable TLS | | ||
| --port-forward | |Connect to a random argocd-server port using port forwarding | | ||
| --port-forward-namespace | string | Namespace name which should be used for port forwarding | | ||
| --redis-haproxy-name | string | Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy") | | ||
| --redis-name | string | Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis") | | ||
| --repo-server-name | string | Name of the Argo CD Repo server; set this or the ARGOCD_REPO_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-repo-server") | | ||
| --server | string | Argo CD server address | | ||
| --server-crt | string | Server certificate file | | ||
| --server-name | string | Name of the Argo CD API server; set this or the ARGOCD_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-server") | | ||
|
||
### SEE ALSO | ||
|
||
* [argocd account](argocd_account.md) - Manage account settings | ||
* [argocd account can-i](argocd_account_can-i.md) - Can I | ||
* [argocd account delete-token](argocd_account_delete-token.md) - Deletes account token | ||
* [argocd account generate-token](argocd_account_generate-token.md) - Generate account token | ||
* [argocd account get](argocd_account_get.md) - Get account details | ||
* [argocd account get-user-info](argocd_account_get-user-info.md) - Get user info | ||
* [argocd account list](argocd_account_list.md) - List accounts | ||
* [argocd account update-password](argocd_account_update-password.md) - Update an account's password |
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,72 @@ | ||
# `argocd account can-i` Command Reference | ||
|
||
## argocd account can-i | ||
|
||
Can I | ||
|
||
``` | ||
argocd account can-i ACTION RESOURCE SUBRESOURCE [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
|
||
# Can I sync any app? | ||
argocd account can-i sync applications '*' | ||
|
||
# Can I update a project? | ||
argocd account can-i update projects 'default' | ||
|
||
# Can I create a cluster? | ||
argocd account can-i create clusters '*' | ||
|
||
Actions: [get create update delete sync override] | ||
Resources: [clusters projects applications applicationsets repositories certificates logs exec] | ||
|
||
``` | ||
|
||
### Options | ||
|
||
| Option | Argument type | Description | | ||
| ---------------- | ------ | ---- | | ||
| -h, --help | | help for can-i| | ||
|
||
|
||
### Options inherited from parent commands | ||
|
||
| Option | Argument type | Description | | ||
| ---------------- | ------ | ---- | | ||
| --auth-token | string | Authentication token | | ||
| --client-crt | string | Client certificate file | | ||
| --client-crt-key | string | Client certificate key file | | ||
| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | | ||
| --controller-name | string | Name of the Argo CD Application controller; set this or the ARGOCD_APPLICATION_CONTROLLER_NAME environment variable when the controller's name label differs from the default, for example when installing via the Helm chart (default "argocd-application-controller") | | ||
| --core | |If set to true then CLI talks directly to Kubernetes instead of talking to Argo CD API server | | ||
| --grpc-web | |Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. | | ||
| --grpc-web-root-path | string | Enables gRPC-web protocol. Useful if Argo CD server is behind proxy which does not support HTTP2. Set web root. | | ||
| --http-retry-max | int | Maximum number of retries to establish http connection to Argo CD server | | ||
| --insecure | |Skip server certificate and domain verification | | ||
| --kube-context | string | Directs the command to the given kube-context | | ||
| --logformat | string | Set the logging format. One of: text|json (default "text") | | ||
| --loglevel | string | Set the logging level. One of: debug|info|warn|error (default "info") | | ||
| --plaintext | |Disable TLS | | ||
| --port-forward | |Connect to a random argocd-server port using port forwarding | | ||
| --port-forward-namespace | string | Namespace name which should be used for port forwarding | | ||
| --redis-haproxy-name | string | Name of the Redis HA Proxy; set this or the ARGOCD_REDIS_HAPROXY_NAME environment variable when the HA Proxy's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis-ha-haproxy") | | ||
| --redis-name | string | Name of the Redis deployment; set this or the ARGOCD_REDIS_NAME environment variable when the Redis's name label differs from the default, for example when installing via the Helm chart (default "argocd-redis") | | ||
| --repo-server-name | string | Name of the Argo CD Repo server; set this or the ARGOCD_REPO_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-repo-server") | | ||
| --server | string | Argo CD server address | | ||
| --server-crt | string | Server certificate file | | ||
| --server-name | string | Name of the Argo CD API server; set this or the ARGOCD_SERVER_NAME environment variable when the server's name label differs from the default, for example when installing via the Helm chart (default "argocd-server") | | ||
|
||
### SEE ALSO | ||
|
||
* [argocd account](argocd_account.md) - Manage account settings | ||
* [argocd account bcrypt](argocd_account_bcrypt.md) - Generate bcrypt hash for any password | ||
* [argocd account delete-token](argocd_account_delete-token.md) - Deletes account token | ||
* [argocd account generate-token](argocd_account_generate-token.md) - Generate account token | ||
* [argocd account get](argocd_account_get.md) - Get account details | ||
* [argocd account get-user-info](argocd_account_get-user-info.md) - Get user info | ||
* [argocd account list](argocd_account_list.md) - List accounts | ||
* [argocd account update-password](argocd_account_update-password.md) - Update an account's password |
Oops, something went wrong.
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.