diff --git a/docs/OpenShift GitOps CLI User Guide.md b/docs/OpenShift GitOps CLI User Guide.md new file mode 100644 index 000000000..b9c300c21 --- /dev/null +++ b/docs/OpenShift GitOps CLI User Guide.md @@ -0,0 +1,806 @@ +# OpenShift GitOps CLI User Guide +OpenShift GitOps `argocd` CLI enables users to manage OpenShift GitOps from a terminal. Using the CLI tool, users can manage ArgoCD resources (Application, ApplicationSets, AppProjects, User accounts, GPG keys etc) from a client terminal. + +**Note:** Both the archives and the RPMs contain the `argocd` executable binary file. + +**WARNING** +Red Hat OpenShift GitOps with the `argocd` CLI tool is a Technology Preview feature only. + +**Tip:** This guide assumes you have a grounding in the tools that OpenShift GitOps is based on. Please read [about Red Hat OpenShift GitOps](https://docs.openshift.com/gitops/1.11/understanding_openshift_gitops/about-redhat-openshift-gitops.html) to learn about these tools. + +## Installing OpenShift GitOps CLI (argocd) +Use the CLI tool to manage Red Hat OpenShift GitOps from a terminal. You can install the CLI tool on different platforms. + +### Installing the Red Hat OpenShift GitOps CLI on Linux using an RPM +For Red Hat Enterprise Linux (RHEL) version 8 or version 9, you can install the Red Hat OpenShift GitOps CLI as an RPM. +#### Prerequisites +You have an active OpenShift Container Platform subscription on your Red Hat account. +You have root or sudo privileges on your local system. +#### Procedure +- Register with Red Hat Subscription Manager: +``` +# subscription-manager register +``` +- Pull the latest subscription data: +``` +# subscription-manager refresh +``` +- List the available subscriptions: +``` +# subscription-manager list --available --matches '*gitops*' +``` +- In the output for the previous command, find the pool ID for your OpenShift Container Platform subscription and attach the subscription to the registered system: +``` +# subscription-manager attach --pool= +``` +- Enable the repositories required by Red Hat OpenShift GitOps: + - RHEL 8 + - Linux (x86_64, amd64) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-8-x86_64-rpms" + ``` + - Linux on IBM zSystems and IBM® LinuxONE (s390x) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-8-s390x-rpms" + ``` + - Linux on IBM Power (ppc64le) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-8-ppc64le-rpms" + ``` + - Linux on ARM (aarch64, arm64) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-8-aarch64-rpms" + ``` + - RHEL 9 + - Linux (x86_64, amd64) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-9-x86_64-rpms" + ``` + - Linux on IBM zSystems and IBM® LinuxONE (s390x) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-9-s390x-rpms" + ``` + - Linux on IBM Power (ppc64le) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-9-ppc64le-rpms" + ``` + - Linux on ARM (aarch64, arm64) + ``` + # subscription-manager repos --enable="gitops-1.12-for-rhel-9-aarch64-rpms" + ``` +- Install the `openshift-gitops-argocd-cli` package: +``` +# yum install openshift-gitops-argocd-cli +``` +#### Verification +Run the following command to validate that the installation has succeeded. +``` +# argocd version --client +``` +Sample output: +``` +argocd: v2.9.5+f943664 + BuildDate: 2024-02-15T05:19:27Z + GitCommit: f9436641a616d277ab1f98694e5ce4c986d4ea05 + GitTreeState: clean + GoVersion: go1.20.10 + Compiler: gc + Platform: linux/amd64 + ExtraBuildInfo: openshift-gitops-version: 1.12.0, release: 0015022024 +``` +**Note:** The above output is just for reference. The actual details might be different based on the version of OpenShift GitOps argocd CLI client installed. + +### Installing the Red Hat OpenShift GitOps CLI on Windows +#### Prerequisites +- ZIP file tools like winrar, 7zip etc +#### Procedure +- Download the [CLI tool](https://mirror.openshift.com/pub/openshift-v4/clients/argocd-cli/1.12.0/argocd-cli-windows-amd64.zip). +- Extract the archive with a ZIP program. +- Add the location of your `argocd` files to your `PATH` environment variable. +#### Verification +Run the following command to validate that the installation has succeeded. +``` +# argocd version --client +``` +Sample output: +``` +argocd: v2.9.5+f943664 + BuildDate: 2024-02-15T05:19:27Z + GitCommit: f9436641a616d277ab1f98694e5ce4c986d4ea05 + GitTreeState: clean + GoVersion: go1.20.10 + Compiler: gc + Platform: linux/amd64 + ExtraBuildInfo: openshift-gitops-version: 1.12.0, release: 0015022024 +``` +**Note:** The above output is just for reference. The actual details might be different based on the version of OpenShift GitOps argocd CLI client installed. + +### Installing the Red Hat OpenShift GitOps CLI on macOS +#### Prerequisites +- tar +#### Procedure +- Download the CLI tool for the appropriate processor architecture + - [macOS on Intel](https://mirror.openshift.com/pub/openshift-v4/clients/argocd-cli/1.12.0/argocd-cli-darwin-amd64.tar.gz) + - [macOS on ARM](https://mirror.openshift.com/pub/openshift-v4/clients/argocd-cli/1.12.0/argocd-cli-darwin-arm64.tar.gz) + +- Extract the archive with a ZIP program. +- Add the location of your `argocd` files to your `PATH` environment variable. +#### Verification +Run the following command to validate that the installation has succeeded. +``` +# argocd version --client +``` +Sample output: +``` +argocd: v2.9.5+f943664 + BuildDate: 2024-02-15T05:19:27Z + GitCommit: f9436641a616d277ab1f98694e5ce4c986d4ea05 + GitTreeState: clean + GoVersion: go1.20.10 + Compiler: gc + Platform: linux/amd64 + ExtraBuildInfo: openshift-gitops-version: 1.12.0, release: 0015022024 +``` +**Note:** The above output is just for reference. The actual details might be different based on the version of OpenShift GitOps argocd CLI client installed. + +## Configuring OpenShift GitOps CLI (argocd) + +Configure the Red Hat OpenShift GitOps `argocd` CLI to enable tab completion. + +### Enabling tab completion + +After you install the `argocd` CLI, you can enable tab completion to automatically complete `argocd` commands or suggest options when you press Tab. + +#### Prerequisites +- You must have the `argocd` CLI tool installed. +- You must have bash-completion installed on your local system. + +#### Procedure +The following procedure enables tab completion for Bash. + +1. Save the Bash completion code to a file: + ``` + $ argocd completion bash > argocd_bash_completion + ``` +2. Copy the file to `/etc/bash_completion.d/`: + ``` + $ sudo cp argocd_bash_completion /etc/bash_completion.d/ + ``` + Alternatively, you can save the file to a local directory and source it from your `.bashrc` file instead. + +Tab completion is enabled when you open a new terminal. + +## OpenShift GitOps argocd reference + +This section lists the basic `argocd` CLI commands. +**Note** MicroShift based installation do not host an ArgoCD server and supports only the `core` mode of execution. +In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server set as per the `KUBECONFIG` environment variable or the default file `$HOME/.kube/config`. There is no need for users to login into the ArgoCD server for executing commands. + +### Basic syntax + +#### Normal mode + +In the normal mode (default mode), the `argocd` CLI client makes API requests to the ArgoCD server component. This requires users to explicitly login to the ArgoCD server component using the ArgoCD credentials before executing further commands. Users should remain logged in to the ArgoCD server when running the commands. If the login times out in between, users can re-login using the `relogin` command. After running all commands, users can logout using the `logout` command. + +##### Steps to login to the ArgoCD server and execute a command. + + 1. Get the admin password for the ArgoCD server + ``` + # ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d) + ``` + 2. Get the ArgoCD server url using the following command + ``` + # SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}') + ``` + 3. Login to the ArgoCD server using the login command + ``` + # argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL} + ``` + eg: + ``` + # get the admin password and use it by enclosing in single quotes. + # argocd login --username admin --password '' openshift-gitops.openshift-gitops.apps-crc.testing + ``` + **IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors. + + Upon successful login, the context that would be used for the session would be displayed as below. + ``` + 'admin:login' logged in successfully + Context '' updated + ``` + +#### Core mode + +In the `core` mode (`--core` argument specified), the CLI talks directly to the Kubernetes API server (unlike in normal mode, where the CLI talks to the ArgoCD Server) using the credentials set in the kubeconfig file. The default kubeconfig file is available at location `$HOME/.kube/config` can be customized using the `KUBECONFIG` environment variable. Unlike the normal mode, there is no explicit login step required for user authentication. The command would be executed using the credentials provided in the `kubeconfig` file. + +##### Steps to execute command in the core mode + +1. ArgoCD commands can be executed in the core mode using one of the following options. + +###### Option 1: With default kubeconfig file (using the default context) + ``` + # argocd --core [command or options] [arguments…​] + ``` + eg: + ``` + # ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core app list + (or) + # argocd --core app list --repo-server-name openshift-gitops-repo-server + ``` +###### Option 2: With default kubeconfig file (using a custom context) + ``` + # argocd --core --kube-context [context] [command or options] [arguments…​] + ``` + eg: + ``` + # ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core --kube-context kubeadmin-local app list + (or) + # argocd --core --kube-context kubeadmin-local app list --repo-server-name openshift-gitops-repo-server + ``` + +###### Option 3: With a custom kubeconfig file (using the default context) + ``` + # KUBECONFIG=~/.kube/custom_config argocd --core [command or options] [arguments…​] + ``` + eg: + ``` + # KUBECONFIG=~/.kube/custom_config argocd --core app list --repo-server-name openshift-gitops-repo-server + ``` + +###### Option 4: With a custom kubeconfig file (using a custom context) + ``` + # KUBECONFIG=~/.kube/custom_config argocd --core --kube-context [context] [command or options] [arguments…​] + ``` + eg: + ``` + # KUBECONFIG=~/.kube/custom_config argocd --kube-context kubeadmin-local --core app list --repo-server-name openshift-gitops-repo-server + ``` + +**NOTE** If there are multiple ArgoCD instances, then set the default namespace of the current context to the namespace of the ArgoCD instance that you want to interact with. Also set the environment variable `ARGOCD_REPO_SERVER_NAME` or use the command line option `--repo-server-name` to specify the repo server component name in the format `-repo-server`. + +### Global options +Global options are options applicable to all sub-commands of `argocd`. + +| 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") | + + +### Utility Commands + +#### version +Print version information + +##### Usage: +``` +# argocd version [flags] +``` +##### Examples +- Print the full version of client and server to stdout +``` +# argocd version +``` +- Print only full version of the client - no connection to server will be made +``` +# argocd version --client +``` +- Print only full version of the server +``` +# argocd version --server +``` +- Print the full version of client and server in JSON format +``` +# argocd version -o json +``` +- Print only client and server core version strings in YAML format +``` +# argocd version --short -o yaml +``` + +#### help +Prints the help message about any command + +##### Usage: +``` +# argocd version [sub-command] +``` + +##### Examples: +- To get the help text for all the available commands, run the following command +``` +# argocd help admin +``` + +- To get the help text for `admin` sub command run the following command +``` +# argocd help admin +``` + +#### completion +Write bash or zsh shell completion code to standard output. + +For bash, ensure you have bash completions installed and enabled. +To access completions in your current shell, run the following command +``` +# source <(argocd completion bash) +``` +Alternatively, write it to a file and source in `.bash_profile` + +For zsh, add the following to your `~/.zshrc` file: +``` +source <(argocd completion zsh) +compdef _argocd argocd +``` + +##### Usage: +``` +# argocd completion SHELL [flags] +``` +##### Flags: + -h, --help help for completion + +### Login related Commands +* [argocd login](./cli/argocd_login.md) - Log in to an Argo CD server +* [argocd logout](./cli/argocd_logout.md) - Log out from Argo CD +* [argocd relogin](./cli/argocd_relogin.md) - Refresh an expired authenticate token + +### Administrative Commands +* [argocd admin](./cli/argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin export](./cli/argocd_admin_export.md) - Export all Argo CD data to stdout (default) or a file +* [argocd admin import](./cli/argocd_admin_import.md) - Import Argo CD data from stdin (specify `-') or a file +* [argocd admin app](./cli/argocd_admin_app.md) - Manage applications configuration +* [argocd admin cluster](./cli/argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin dashboard](./cli/argocd_admin_dashboard.md) - Starts Argo CD Web UI locally +* [argocd admin export](./cli/argocd_admin_export.md) - Export all Argo CD data to stdout (default) or a file +* [argocd admin import](./cli/argocd_admin_import.md) - Import Argo CD data from stdin (specify `-') or a file +* [argocd admin initial-password](./cli/argocd_admin_initial-password.md) - Prints initial password to log in to Argo CD for the first time +* [argocd admin notifications](./cli/argocd_admin_notifications.md) - Set of CLI commands that helps manage notifications settings +* [argocd admin proj](./cli/argocd_admin_proj.md) - Manage projects configuration +* [argocd admin repo](./cli/argocd_admin_repo.md) - Manage repositories configuration +* [argocd admin settings](./cli/argocd_admin_settings.md) - Provides set of commands for settings validation and troubleshooting +* [argocd admin app diff-reconcile-results](./cli/argocd_admin_app_diff-reconcile-results.md) - Compare results of two reconciliations and print diff. +* [argocd admin app generate-spec](./cli/argocd_admin_app_generate-spec.md) - Generate declarative config for an application +* [argocd admin app get-reconcile-results](./cli/argocd_admin_app_get-reconcile-results.md) - Reconcile all applications and stores reconciliation summary in the specified file. +* [argocd admin cluster generate-spec](./cli/argocd_admin_cluster_generate-spec.md) - Generate declarative config for a cluster +* [argocd admin cluster kubeconfig](./cli/argocd_admin_cluster_kubeconfig.md) - Generates kubeconfig for the specified cluster +* [argocd admin cluster namespaces](./cli/argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster shards](./cli/argocd_admin_cluster_shards.md) - Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. +* [argocd admin cluster stats](./cli/argocd_admin_cluster_stats.md) - Prints information cluster statistics and inferred shard number +* [argocd admin notifications template](./cli/argocd_admin_notifications_template.md) - Notification templates related commands +* [argocd admin notifications trigger](./cli/argocd_admin_notifications_trigger.md) - Notification triggers related commands +* [argocd admin proj generate-allow-list](./cli/argocd_admin_proj_generate-allow-list.md) - Generates project allow list from the specified clusterRole file +* [argocd admin proj generate-spec](./cli/argocd_admin_proj_generate-spec.md) - Generate declarative config for a project +* [argocd admin proj update-role-policy](./cli/argocd_admin_proj_update-role-policy.md) - Implement bulk project role update. Useful to back-fill existing project policies or remove obsolete actions. +* [argocd admin repo generate-spec](./cli/argocd_admin_repo_generate-spec.md) - Generate declarative config for a repo +* [argocd admin settings rbac](./cli/argocd_admin_settings_rbac.md) - Validate and test RBAC configuration +* [argocd admin settings resource-overrides](./cli/argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides +* [argocd admin settings validate](./cli/argocd_admin_settings_validate.md) - Validate settings + +### Account management commands +* [argocd account](./cli/argocd_account.md) - Manage argo accounts +* [argocd account bcrypt](./cli/argocd_account_bcrypt.md) - Generate bcrypt hash for any password +* [argocd account can-i](./cli/argocd_account_can-i.md) - Can I +* [argocd account delete-token](./cli/argocd_account_delete-token.md) - Deletes account token +* [argocd account generate-token](./cli/argocd_account_generate-token.md) - Generate account token +* [argocd account get](./cli/argocd_account_get.md) - Get account details +* [argocd account get-user-info](./cli/argocd_account_get-user-info.md) - Get user info +* [argocd account list](./cli/argocd_account_list.md) - List accounts +* [argocd account update-password](./cli/argocd_account_update-password.md) - Update an account's password + +### GPG key management Commands +* [argocd gpg add](./cli/argocd_gpg_add.md) - Adds a GPG public key to the server's keyring +* [argocd gpg get](./cli/argocd_gpg_get.md) - Get the GPG public key with ID from the server +* [argocd gpg list](./cli/argocd_gpg_list.md) - List configured GPG public keys +* [argocd gpg rm](./cli/argocd_gpg_rm.md) - Removes a GPG public key from the server's keyring + +### Project management commands +* [argocd proj](./cli/argocd_proj.md) - Manage projects +* [argocd proj add-destination](./cli/argocd_proj_add-destination.md) - Add project destination +* [argocd proj add-orphaned-ignore](./cli/argocd_proj_add-orphaned-ignore.md) - Add a resource to orphaned ignore list +* [argocd proj add-signature-key](./cli/argocd_proj_add-signature-key.md) - Add GnuPG signature key to project +* [argocd proj add-source](./cli/argocd_proj_add-source.md) - Add project source repository +* [argocd proj allow-cluster-resource](./cli/argocd_proj_allow-cluster-resource.md) - Adds a cluster-scoped API resource to the allow list and removes it from deny list +* [argocd proj allow-namespace-resource](./cli/argocd_proj_allow-namespace-resource.md) - Removes a namespaced API resource from the deny list or add a namespaced API resource to the allow list +* [argocd proj create](./cli/argocd_proj_create.md) - Create a project +* [argocd proj delete](./cli/argocd_proj_delete.md) - Delete project +* [argocd proj deny-cluster-resource](./cli/argocd_proj_deny-cluster-resource.md) - Removes a cluster-scoped API resource from the allow list and adds it to deny list +* [argocd proj deny-namespace-resource](./cli/argocd_proj_deny-namespace-resource.md) - Adds a namespaced API resource to the deny list or removes a namespaced API resource from the allow list +* [argocd proj edit](./cli/argocd_proj_edit.md) - Edit project +* [argocd proj get](./cli/argocd_proj_get.md) - Get project details +* [argocd proj list](./cli/argocd_proj_list.md) - List projects +* [argocd proj remove-destination](./cli/argocd_proj_remove-destination.md) - Remove project destination +* [argocd proj remove-orphaned-ignore](./cli/argocd_proj_remove-orphaned-ignore.md) - Remove a resource from orphaned ignore list +* [argocd proj remove-signature-key](./cli/argocd_proj_remove-signature-key.md) - Remove GnuPG signature key from project +* [argocd proj remove-source](./cli/argocd_proj_remove-source.md) - Remove project source repository +* [argocd proj role](./cli/argocd_proj_role.md) - Manage a project's roles +* [argocd proj set](./cli/argocd_proj_set.md) - Set project parameters +* [argocd proj windows](./cli/argocd_proj_windows.md) - Manage a project's sync windows + +### Application management commands +* [argocd app](./cli/argocd_app.md) - Manage argo Applications +* [argocd app actions](./cli/argocd_app_actions.md) - Manage Resource actions +* [argocd app create](./cli/argocd_app_create.md) - Create an application +* [argocd app delete](./cli/argocd_app_delete.md) - Delete an application +* [argocd app delete-resource](./cli/argocd_app_delete-resource.md) - Delete resource in an application +* [argocd app diff](./cli/argocd_app_diff.md) - Perform a diff against the target and live state. +* [argocd app edit](./cli/argocd_app_edit.md) - Edit application +* [argocd app get](./cli/argocd_app_get.md) - Get application details +* [argocd app history](./cli/argocd_app_history.md) - Show application deployment history +* [argocd app list](./cli/argocd_app_list.md) - List applications +* [argocd app logs](./cli/argocd_app_logs.md) - Get logs of application pods +* [argocd app manifests](./cli/argocd_app_manifests.md) - Print manifests of an application +* [argocd app patch](./cli/argocd_app_patch.md) - Patch application +* [argocd app patch-resource](./cli/argocd_app_patch-resource.md) - Patch resource in an application +* [argocd app resources](./cli/argocd_app_resources.md) - List resource of application +* [argocd app rollback](./cli/argocd_app_rollback.md) - Rollback application to a previous deployed version by History ID, omitted will Rollback to the previous version +* [argocd app set](./cli/argocd_app_set.md) - Set application parameters +* [argocd app sync](./cli/argocd_app_sync.md) - Sync an application to its target state +* [argocd app terminate-op](./cli/argocd_app_terminate-op.md) - Terminate running operation of an application +* [argocd app unset](./cli/argocd_app_unset.md) - Unset application parameters +* [argocd app wait](./cli/argocd_app_wait.md) - Wait for an application to reach a synced and healthy state +* [argocd app actions](./cli/argocd_app_actions.md) - Manage Resource actions +* [argocd app create](./cli/argocd_app_create.md) - Create an application +* [argocd app delete](./cli/argocd_app_delete.md) - Delete an application +* [argocd app delete-resource](./cli/argocd_app_delete-resource.md) - Delete resource in an application +* [argocd app diff](./cli/argocd_app_diff.md) - Perform a diff against the target and live state. +* [argocd app edit](./cli/argocd_app_edit.md) - Edit application +* [argocd app get](./cli/argocd_app_get.md) - Get application details +* [argocd app history](./cli/argocd_app_history.md) - Show application deployment history +* [argocd app list](./cli/argocd_app_list.md) - List applications +* [argocd app logs](./cli/argocd_app_logs.md) - Get logs of application pods +* [argocd app manifests](./cli/argocd_app_manifests.md) - Print manifests of an application +* [argocd app patch](./cli/argocd_app_patch.md) - Patch application +* [argocd app patch-resource](./cli/argocd_app_patch-resource.md) - Patch resource in an application +* [argocd app resources](./cli/argocd_app_resources.md) - List resource of application +* [argocd app rollback](./cli/argocd_app_rollback.md) - Rollback application to a previous deployed version by History ID, omitted will Rollback to the previous version +* [argocd app set](./cli/argocd_app_set.md) - Set application parameters +* [argocd app sync](./cli/argocd_app_sync.md) - Sync an application to its target state +* [argocd app terminate-op](./cli/argocd_app_terminate-op.md) - Terminate running operation of an application +* [argocd app unset](./cli/argocd_app_unset.md) - Unset application parameters +* [argocd app wait](./cli/argocd_app_wait.md) - Wait for an application to reach a synced and healthy state + +### Application Set management commands +* [argocd appset](./cli/argocd_appset.md) - argocd controls a Argo CD server +* [argocd appset create](./cli/argocd_appset_create.md) - Create one or more ApplicationSets +* [argocd appset delete](./cli/argocd_appset_delete.md) - Delete one or more ApplicationSets +* [argocd appset get](./cli/argocd_appset_get.md) - Get ApplicationSet details +* [argocd appset list](./cli/argocd_appset_list.md) - List ApplicationSets +* [argocd appset update](./cli/argocd_appset_update.md) - Updates the given ApplicationSet(s) + +### Repository management commands +* [argocd repo add](./cli/argocd_repo_add.md) - Add git repository connection parameters +* [argocd repo get](./cli/argocd_repo_get.md) - Get a configured repository by URL +* [argocd repo list](./cli/argocd_repo_list.md) - List configured repositories +* [argocd repo rm](./cli/argocd_repo_rm.md) - Remove repository credentials +* [argocd repocreds](./cli/argocd_repocreds.md) - Repository credentials command +* [argocd repocreds add](./cli/argocd_repocreds_add.md) - Add git repository connection parameters +* [argocd repocreds list](./cli/argocd_repocreds_list.md) - List configured repository credentials +* [argocd repocreds rm](./cli/argocd_repocreds_rm.md) - Remove repository credentials + + +## Creating an application by using OpenShift GitOps argocd CLI + +### Create an application in Normal mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) + +#### Procedure + 1. Get the admin password for the ArgoCD server + ``` + # ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d) + ``` + 2. Get the ArgoCD server url using the following command + ``` + # SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}') + ``` + 3. Login to the ArgoCD server using the login command + ``` + # argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL} + ``` + eg: + ``` + # get the admin password and use it by enclosing in single quotes. + # argocd login --username admin --password '' openshift-gitops.openshift-gitops.apps-crc.testing + ``` + **IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors. + 3. Validate that you are able to run `argocd` commands in normal mode by executing the following command to list all Applications. + ``` + # argocd app list + ``` + If the configuration is correct, then existing Applications will be listed with header as below + ``` + NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET + ``` + 4. Let's create an application in normal mode + ``` + # argocd app create app-spring-petclinic \ + --repo https://github.com/redhat-developer/openshift-gitops-getting-started.git \ + --path app \ + --revision main \ + --dest-server https://kubernetes.default.svc \ + --dest-namespace spring-petclinic \ + --directory-recurse \ + --sync-policy automated \ + --self-heal \ + --sync-option Prune=true \ + --sync-option CreateNamespace=true + ``` + 5. Label the destination namespace `spring-petclinic` to be managed by `openshif-gitops` argocd instance as below + ``` + # oc label ns spring-petclinic "argocd.argoproj.io/managed-by=openshift-gitops" + ``` + 6. List the application to confirm that the application is created successfully and repeat the command till the application reaches the state `Synced` and the health of the application is `Healthy`. + ``` + # argocd app list + ``` + +### Create an application in Core mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) + +#### Procedure + + 1. Login to the OpenShift Cluster using the `oc` CLI tool + ``` + # oc login -u [username] -p [password] [server_url] + ``` + eg: + ``` + # oc login -u kubeadmin -p ${ADMIN_PASSWD} https://api.crc.testing:6443 + ``` + 2. Check if the context is set correctly in the kubeconfig file + ``` + # oc config current-context + ``` + 3. Set the default namespace of the current context to `openshift-gitops` + ``` + # oc config set-context --current --namespace openshift-gitops + ``` + 4. Set the following environment variables to override the argocd component names + ``` + # export ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server + ``` + 5. Validate that you are able to run `argocd` commands in core mode by executing the following command to list all Applications. + ``` + # argocd app list --core + ``` + If the configuration is correct, then existing Applications will be listed with header as below + ``` + NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET + ``` + 6. Let's create an application in core mode + ``` + # argocd app create app-spring-petclinic --core \ + --repo https://github.com/redhat-developer/openshift-gitops-getting-started.git \ + --path app \ + --revision main \ + --dest-server https://kubernetes.default.svc \ + --dest-namespace spring-petclinic \ + --directory-recurse \ + --sync-policy automated \ + --self-heal \ + --sync-option Prune=true \ + --sync-option CreateNamespace=true + ``` + 7. Label the destination namespace `spring-petclinic` to be managed by `openshif-gitops` argocd instance as below + ``` + # oc label ns spring-petclinic "argocd.argoproj.io/managed-by=openshift-gitops" + ``` + 8. List the application to confirm that the application is created successfully and repeat the command till the application reaches the state `Synced` and the health of the application is `Healthy`. + ``` + # argocd app list --core + ``` + +## Declarative cluster configuration using OpenShift GitOps argocd CLI + +### Create cluster config application in Normal mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) + +#### Procedure + 1. Get the admin password for the ArgoCD server + ``` + # ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d) + ``` + 2. Get the ArgoCD server url using the following command + ``` + # SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}') + ``` + 3. Login to the ArgoCD server using the login command + ``` + # argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL} + ``` + eg: + ``` + # get the admin password and use it by enclosing in single quotes. + # argocd login --username admin --password '' openshift-gitops.openshift-gitops.apps-crc.testing + ``` + **IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors. + 3. Validate that you are able to run `argocd` commands in normal mode by executing the following command to list all Applications. + ``` + # argocd app list + ``` + If the configuration is correct, then existing Applications will be listed with header as below + ``` + NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET + ``` + 4. Let's create an application in normal mode + ``` + # argocd app create cluster-configs \ + --repo https://github.com/redhat-developer/openshift-gitops-getting-started.git \ + --path cluster \ + --revision main \ + --dest-server https://kubernetes.default.svc \ + --dest-namespace spring-petclinic \ + --directory-recurse \ + --sync-policy none \ + --sync-option Prune=true \ + --sync-option CreateNamespace=true + ``` + 5. Label the destination namespace `spring-petclinic` to be managed by `openshif-gitops` argocd instance as below + ``` + # oc label ns spring-petclinic "argocd.argoproj.io/managed-by=openshift-gitops" + ``` + 6. List the application to confirm that the application is created successfully. The application will stay in the state `OutOfSync` as the sync policy was set to `none` and the health of the application is `Healthy`. + ``` + # argocd app list + ``` + +### Create cluster config application in Core mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) + +#### Procedure + + 1. Login to the OpenShift Cluster using the `oc` CLI tool + ``` + # oc login -u [username] -p [password] [server_url] + ``` + eg: + ``` + # oc login -u kubeadmin -p ${ADMIN_PASSWD} https://api.crc.testing:6443 + ``` + 2. Check if the context is set correctly in the kubeconfig file + ``` + # oc config current-context + ``` + 3. Set the default namespace of the current context to `openshift-gitops` + ``` + # oc config set-context --current --namespace openshift-gitops + ``` + 4. Set the following environment variables to override the argocd component names + ``` + # export ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server + ``` + 5. Validate that you are able to run `argocd` commands in core mode by executing the following command to list all Applications. + ``` + # argocd app list --core + ``` + If the configuration is correct, then existing Applications will be listed with header as below + ``` + NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET + ``` + 6. Let's create an application in core mode + ``` + # argocd app create cluster-configs --core \ + --repo https://github.com/redhat-developer/openshift-gitops-getting-started.git \ + --path cluster \ + --revision main \ + --dest-server https://kubernetes.default.svc \ + --dest-namespace spring-petclinic \ + --directory-recurse \ + --sync-policy none \ + --sync-option Prune=true \ + --sync-option CreateNamespace=true + ``` + 7. List the application to confirm that the application is created successfully. The application will stay in the state `OutOfSync` as the sync policy was set to `none` and the health of the application is `Healthy`. + ``` + # argocd app list --core + ``` + +### Syncing cluster configuration application in normal mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) +#### Procedure + + 1. Get the admin password for the ArgoCD server + ``` + # ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d) + ``` + 2. Get the ArgoCD server url using the following command + ``` + # SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}') + ``` + 3. Login to the ArgoCD server using the login command + ``` + # argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL} + ``` + eg: + ``` + # get the admin password and use it by enclosing in single quotes. + # argocd login --username admin --password '' openshift-gitops.openshift-gitops.apps-crc.testing + ``` + **IMPORTANT** passwords can contain special characters like `$` which would be interpreted as shell variables. This can cause the command to fail as a wrong value (shell interpreted) of password would be sent to the server. Always use single quotes '' to enclose the actual value of the password to avoid such errors. + 4. As the argo application is created with sync policy `none`, user has to trigger the sync operation manually. This can be done by using the `argocd` CLI in core mode as below + ``` + # argocd app sync openshift-gitops/cluster-configs + ``` + 5. List the application to confirm that the application has reached the state `Synced` and the health of the application is `Healthy`. + ``` + # argocd app list + ``` +### Syncing cluster configuration application in core mode + +#### Prerequisites + +- OpenShift CLI (oc) +- OpenShift GitOps CLI (argocd) + +#### Procedure + + 1. Login to the OpenShift Cluster using the `oc` CLI tool + ``` + # oc login -u [username] -p [password] [server_url] + ``` + eg: + ``` + # oc login -u kubeadmin -p ${ADMIN_PASSWD} https://api.crc.testing:6443 + ``` + 2. Check if the context is set correctly in the kubeconfig file + ``` + # oc config current-context + ``` + 3. Set the default namespace of the current context to `openshift-gitops` + ``` + # oc config set-context --current --namespace openshift-gitops + ``` + 4. Set the following environment variables to override the argocd component names + ``` + # export ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server + ``` + 5. As the argo application is created with sync policy `none`, user has to trigger the sync operation manually. This can be done by using the `argocd` CLI in core mode as below + ``` + # argocd app sync --core openshift-gitops/cluster-configs + ``` + 6. List the application to confirm that the application has reached the state `Synced` and the health of the application is `Healthy`. + ``` + # argocd app list --core + ``` + + +## References +https://argo-cd.readthedocs.io/en/stable/user-guide/commands/argocd/ diff --git a/docs/cli/argocd.md b/docs/cli/argocd.md new file mode 100644 index 000000000..9e7f4682d --- /dev/null +++ b/docs/cli/argocd.md @@ -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 + diff --git a/docs/cli/argocd_account.md b/docs/cli/argocd_account.md new file mode 100644 index 000000000..ae14265cf --- /dev/null +++ b/docs/cli/argocd_account.md @@ -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 diff --git a/docs/cli/argocd_account_bcrypt.md b/docs/cli/argocd_account_bcrypt.md new file mode 100644 index 000000000..f0764c85b --- /dev/null +++ b/docs/cli/argocd_account_bcrypt.md @@ -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 \ No newline at end of file diff --git a/docs/cli/argocd_account_can-i.md b/docs/cli/argocd_account_can-i.md new file mode 100644 index 000000000..bc4cc06c0 --- /dev/null +++ b/docs/cli/argocd_account_can-i.md @@ -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 \ No newline at end of file diff --git a/docs/cli/argocd_account_delete-token.md b/docs/cli/argocd_account_delete-token.md new file mode 100644 index 000000000..8445bad38 --- /dev/null +++ b/docs/cli/argocd_account_delete-token.md @@ -0,0 +1,64 @@ +# `argocd account delete-token` Command Reference + +## argocd account delete-token + +Deletes account token + +``` +argocd account delete-token [flags] +``` + +### Examples + +``` +# Delete token of the currently logged in account +argocd account delete-token ID + +# Delete token of the account with the specified name +argocd account delete-token --account ID +``` + +### Options + +``` + -a, --account string Account name. Defaults to the current account. + -h, --help help for delete-token +``` + +### 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 can-i](argocd_account_can-i.md) - Can I +* [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 diff --git a/docs/cli/argocd_account_generate-token.md b/docs/cli/argocd_account_generate-token.md new file mode 100644 index 000000000..399db3aaf --- /dev/null +++ b/docs/cli/argocd_account_generate-token.md @@ -0,0 +1,68 @@ +# `argocd account generate-token` Command Reference + +## argocd account generate-token + +Generate account token + +``` +argocd account generate-token [flags] +``` + +### Examples + +``` +# Generate token for the currently logged in account +argocd account generate-token + +# Generate token for the account with the specified name +argocd account generate-token --account +``` + +### Options + +``` + -a, --account string Account name. Defaults to the current account. + -e, --expires-in string Duration before the token will expire. (Default: No expiration) (default "0s") + -h, --help help for generate-token + --id string Optional token id. Fall back to uuid if not value specified. +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --id | string | Optional token id. Fall back to uuid if not value specified. | +| --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 can-i](argocd_account_can-i.md) - Can I +* [argocd account delete-token](argocd_account_delete-token.md) - Deletes 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 diff --git a/docs/cli/argocd_account_get-user-info.md b/docs/cli/argocd_account_get-user-info.md new file mode 100644 index 000000000..bbcf9ec51 --- /dev/null +++ b/docs/cli/argocd_account_get-user-info.md @@ -0,0 +1,65 @@ +# `argocd account get-user-info` Command Reference + +## argocd account get-user-info + +Get user info + +``` +argocd account get-user-info [flags] +``` + +### Examples + +``` + # Get User information for the currently logged-in user (see 'argocd login') + argocd account get-user-info + + # Get User information in yaml format + argocd account get-user-info -o yaml +``` + +### Options + +``` + -h, --help help for get-user-info + -o, --output string Output format. One of: yaml, json +``` + +### 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 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 list](argocd_account_list.md) - List accounts +* [argocd account update-password](argocd_account_update-password.md) - Update an account's password + diff --git a/docs/cli/argocd_account_get.md b/docs/cli/argocd_account_get.md new file mode 100644 index 000000000..1d5150a26 --- /dev/null +++ b/docs/cli/argocd_account_get.md @@ -0,0 +1,66 @@ +# `argocd account get` Command Reference + +## argocd account get + +Get account details + +``` +argocd account get [flags] +``` + +### Examples + +``` +# Get the currently logged in account details +argocd account get + +# Get details for an account by name +argocd account get --account +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -a, --account | string | Account name. Defaults to the current account. | +| -h, --help | | help for get | +| -o, --output | string | Output format. One of: json|yaml|wide|name (default "wide") | + + +### 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 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-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 \ No newline at end of file diff --git a/docs/cli/argocd_account_list.md b/docs/cli/argocd_account_list.md new file mode 100644 index 000000000..3a975b2d0 --- /dev/null +++ b/docs/cli/argocd_account_list.md @@ -0,0 +1,61 @@ +# `argocd account list` Command Reference + +## argocd account list + +List accounts + +``` +argocd account list [flags] +``` + +### Examples + +``` +argocd account list +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for list| +| -o, --output | string | Output format. One of: json|yaml|wide|name (default "wide")| + + +### 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 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 update-password](argocd_account_update-password.md) - Update an account's password diff --git a/docs/cli/argocd_account_update-password.md b/docs/cli/argocd_account_update-password.md new file mode 100644 index 000000000..2df6b483f --- /dev/null +++ b/docs/cli/argocd_account_update-password.md @@ -0,0 +1,80 @@ +# `argocd account update-password` Command Reference + +## argocd account update-password + +Update an account's password + +### Synopsis + + +This command can be used to update the password of the currently logged on +user, or an arbitrary local user account when the currently logged on user +has appropriate RBAC permissions to change other accounts. + + +``` +argocd account update-password [flags] +``` + +### Examples + +``` + + # Update the current user's password + argocd account update-password + + # Update the password for user foobar + argocd account update-password --account foobar + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --account | string An account name that should be updated. Defaults to current user account | +| --current-password | string | Password of the currently logged on user | +| -h, --help | | help for update-password | +| --new-password | string | New password you want to update to | + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --account | string | An account name that should be updated. Defaults to current user account | +| --current-password | string | Password of the currently logged on user | +| --new-password | string | New password you want to update to | +| --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 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 \ No newline at end of file diff --git a/docs/cli/argocd_admin.md b/docs/cli/argocd_admin.md new file mode 100644 index 000000000..dec5f5d4d --- /dev/null +++ b/docs/cli/argocd_admin.md @@ -0,0 +1,143 @@ +# `argocd admin` Command Reference + +## argocd admin + +Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access + +``` +argocd admin [flags] +``` + +### Examples + +``` +# List all clusters +$ argocd admin cluster list + +# Add a new cluster +$ argocd admin cluster add my-cluster --name my-cluster --in-cluster-context + +# Remove a cluster +argocd admin cluster remove my-cluster + +# List all projects +$ argocd admin project list + +# Create a new project +$argocd admin project create my-project --src-namespace my-source-namespace --dest-namespace my-dest-namespace + +# Update a project +$ argocd admin project update my-project --src-namespace my-updated-source-namespace --dest-namespace my-updated-dest-namespace + +# Delete a project +$ argocd admin project delete my-project + +# List all settings +$ argocd admin settings list + +# Get the current settings +$ argocd admin settings get + +# Update settings +$ argocd admin settings update --repository.resync --value 15 + +# List all applications +$ argocd admin app list + +# Get application details +$ argocd admin app get my-app + +# Sync an application +$ argocd admin app sync my-app + +# Pause an application +$ argocd admin app pause my-app + +# Resume an application +$ argocd admin app resume my-app + +# List all repositories +$ argocd admin repo list + +# Add a repository +$ argocd admin repo add https://github.com/argoproj/my-repo.git + +# Remove a repository +$ argocd admin repo remove https://github.com/argoproj/my-repo.git + +# Import an application from a YAML file +$ argocd admin app import -f my-app.yaml + +# Export an application to a YAML file +$ argocd admin app export my-app -o my-exported-app.yaml + +# Access the Argo CD web UI +$ argocd admin dashboard + +# List notifications +$ argocd admin notification list + +# Get notification details +$ argocd admin notification get my-notification + +# Create a new notification +$ argocd admin notification create my-notification -f notification-config.yaml + +# Update a notification +$ argocd admin notification update my-notification -f updated-notification-config.yaml + +# Delete a notification +$ argocd admin notification delete my-notification + +# Reset the initial admin password +$ argocd admin initial-password reset + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for admin| +| --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") | + +### 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 | +| --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](argocd.md) - argocd controls a Argo CD server +* [argocd admin app](argocd_admin_app.md) - Manage applications configuration +* [argocd admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin dashboard](argocd_admin_dashboard.md) - Starts Argo CD Web UI locally +* [argocd admin export](argocd_admin_export.md) - Export all Argo CD data to stdout (default) or a file +* [argocd admin import](argocd_admin_import.md) - Import Argo CD data from stdin (specify `-') or a file +* [argocd admin initial-password](argocd_admin_initial-password.md) - Prints initial password to log in to Argo CD for the first time +* [argocd admin notifications](argocd_admin_notifications.md) - Set of CLI commands that helps manage notifications settings +* [argocd admin proj](argocd_admin_proj.md) - Manage projects configuration +* [argocd admin repo](argocd_admin_repo.md) - Manage repositories configuration +* [argocd admin settings](argocd_admin_settings.md) - Provides set of commands for settings validation and troubleshooting diff --git a/docs/cli/argocd_admin_app.md b/docs/cli/argocd_admin_app.md new file mode 100644 index 000000000..47b7e0056 --- /dev/null +++ b/docs/cli/argocd_admin_app.md @@ -0,0 +1,67 @@ +# `argocd admin app` Command Reference + +## argocd admin app + +Manage applications configuration + +``` +argocd admin app [flags] +``` + +### Examples + +``` + +# Compare results of two reconciliations and print diff +argocd admin app diff-reconcile-results APPNAME [flags] + +# Generate declarative config for an application +argocd admin app generate-spec APPNAME + +# Reconcile all applications and store reconciliation summary in the specified file +argocd admin app get-reconcile-results APPNAME + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for app | + + +### 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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin app diff-reconcile-results](argocd_admin_app_diff-reconcile-results.md) - Compare results of two reconciliations and print diff. +* [argocd admin app generate-spec](argocd_admin_app_generate-spec.md) - Generate declarative config for an application +* [argocd admin app get-reconcile-results](argocd_admin_app_get-reconcile-results.md) - Reconcile all applications and stores reconciliation summary in the specified file. + diff --git a/docs/cli/argocd_admin_app_diff-reconcile-results.md b/docs/cli/argocd_admin_app_diff-reconcile-results.md new file mode 100644 index 000000000..152f2f424 --- /dev/null +++ b/docs/cli/argocd_admin_app_diff-reconcile-results.md @@ -0,0 +1,48 @@ +# `argocd admin app diff-reconcile-results` Command Reference + +## argocd admin app diff-reconcile-results + +Compare results of two reconciliations and print diff. + +``` +argocd admin app diff-reconcile-results PATH1 PATH2 [flags] +``` + +### Options + +``` + -h, --help help for diff-reconcile-results +``` + +### 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 admin app](argocd_admin_app.md) - Manage applications configuration +* [argocd admin app generate-spec](argocd_admin_app_generate-spec.md) - Generate declarative config for an application +* [argocd admin app get-reconcile-results](argocd_admin_app_get-reconcile-results.md) - Reconcile all applications and stores reconciliation summary in the specified file. \ No newline at end of file diff --git a/docs/cli/argocd_admin_app_generate-spec.md b/docs/cli/argocd_admin_app_generate-spec.md new file mode 100644 index 000000000..7477ad1cf --- /dev/null +++ b/docs/cli/argocd_admin_app_generate-spec.md @@ -0,0 +1,123 @@ +# `argocd admin app generate-spec` Command Reference + +## argocd admin app generate-spec + +Generate declarative config for an application + +``` +argocd admin app generate-spec APPNAME [flags] +``` + +### Examples + +``` + + # Generate declarative config for a directory app + argocd admin app generate-spec guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --directory-recurse + + # Generate declarative config for a Jsonnet app + argocd admin app generate-spec jsonnet-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path jsonnet-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --jsonnet-ext-str replicas=2 + + # Generate declarative config for a Helm app + argocd admin app generate-spec helm-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path helm-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --helm-set replicaCount=2 + + # Generate declarative config for a Helm app from a Helm repo + argocd admin app generate-spec nginx-ingress --repo https://charts.helm.sh/stable --helm-chart nginx-ingress --revision 1.24.3 --dest-namespace default --dest-server https://kubernetes.default.svc + + # Generate declarative config for a Kustomize app + argocd admin app generate-spec kustomize-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path kustomize-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --kustomize-image gcr.io/heptio-images/ks-guestbook-demo:0.1 + + # Generate declarative config for a app using a custom tool: + argocd admin app generate-spec kasane --repo https://github.com/argoproj/argocd-example-apps.git --path plugins/kasane --dest-namespace default --dest-server https://kubernetes.default.svc --config-management-plugin kasane + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-empty| Set allow zero live resources when sync is automated | +| --annotations | string Array| Set metadata annotations (e.g. example=value) | +| --auto-prune| Set automatic pruning when sync is automated | +| --config-management-plugin | string | Config management plugin name | +| --dest-name | string | K8s cluster Name (e.g. minikube) | +| --dest-namespace | string | K8s target namespace | +| --dest-server | string | K8s cluster URL (e.g. https://kubernetes.default.svc) | +| --directory-exclude | string | Set glob expression used to exclude files from application source path | +| --directory-include | string | Set glob expression used to include files from application source path | +| --directory-recurse| Recurse directory | +| --env | string | Application environment to monitor | +| --helm-chart | string | Helm Chart name | +| --helm-pass-credentials| Pass credentials to all domain | +| --helm-set | string Array| Helm set values on the command line (can be repeated to set several values: --helm-set key1=val1 --helm-set key2=val2) | +| --helm-set-file | string Array| Helm set values from respective files specified via the command line (can be repeated to set several values: --helm-set-file key1=path1 --helm-set-file key2=path2) | +| --helm-set-string | string Array| Helm set STRING values on the command line (can be repeated to set several values: --helm-set-string key1=val1 --helm-set-string key2=val2) | +| --helm-skip-crds| Skip helm crd installation step | +| --helm-version | string | Helm version | +| --ignore-missing-value-files| Ignore locally missing valueFiles when setting helm template --values | +| --jsonnet-ext-var-code | string Array| Jsonnet ext var | +| --jsonnet-ext-var-str | string Array| Jsonnet | string ext var | +| --jsonnet-libs | string Array| Additional jsonnet libs (prefixed by repoRoot) | +| --jsonnet-tla-code | string Array| Jsonnet top level code arguments | +| --jsonnet-tla-str | string Array| Jsonnet top level | string arguments | +| --kustomize-common-annotation | string Array| Set common labels in Kustomize | +| --kustomize-common-label | string Array| Set common labels in Kustomize | +| --kustomize-force-common-annotation| Force common annotations in Kustomize | +| --kustomize-force-common-label| Force common labels in Kustomize | +| --kustomize-image | string Array| Kustomize images (e.g. --kustomize-image node:8.15.0 --kustomize-image mysql=mariadb,alpine@sha256:24a0c4b4a4c0eb97a1aabb8e29f18e917d05abfe1b7a7c07857230879ce7d3d) | +| --kustomize-namespace | string | Kustomize namespace | +| --kustomize-replica | string Array| Kustomize replicas (e.g. --kustomize-replica my-development=2 --kustomize-replica my-statefulset=4) | +| --kustomize-version | string | Kustomize version | +| --name | string | A name for the app, ignored if a file is set (DEPRECATED) | +| --nameprefix | string | Kustomize nameprefix | +| --namesuffix | string | Kustomize namesuffix | +| --path | string | Path in repository to the app directory, ignored if a file is set | +| --plugin-env | string Array| Additional plugin envs | +| --project | string | Application project name | +| --release-name | string | Helm release-name | +| --repo | string | Repository URL, ignored if a file is set | +| --revision | string | The tracking source branch, tag, commit or Helm chart version the application will sync to | +| --revision-history-limit | int | How many items to keep in revision history (default 10) | +| --self-heal| Set self healing when sync is automated | +| --sync-option Prune=false| Add or remove a sync option, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false` | +| --sync-policy | string | Set the sync policy (one of: none, automated (aliases of automated: auto, automatic)) | +| --sync-retry-backoff-duration duration| Sync retry backoff base duration. Input needs to be a duration (e.g. 2m, 1h) (default 5s) | +| --sync-retry-backoff-factor | int | Factor multiplies the base duration after each failed sync retry (default 2) | +| --sync-retry-backoff-max-duration duration| Max sync retry backoff duration. Input needs to be a duration (e.g. 2m, 1h) (default 3m0s) | +| --sync-retry-limit | int | Max number of allowed sync retries | +| --validate| Validation of repo and cluster (default true) | +| --values | string Array| Helm values file(s) to use | +| --values-literal-file | string | Filename or URL to import as a literal Helm values block | + +### 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 admin app](argocd_admin_app.md) - Manage applications configuration +* [argocd admin app diff-reconcile-results](argocd_admin_app_diff-reconcile-results.md) - Compare results of two reconciliations and print diff. +* [argocd admin app get-reconcile-results](argocd_admin_app_get-reconcile-results.md) - Reconcile all applications and stores reconciliation summary in the specified file. \ No newline at end of file diff --git a/docs/cli/argocd_admin_app_get-reconcile-results.md b/docs/cli/argocd_admin_app_get-reconcile-results.md new file mode 100644 index 000000000..7d57a40c7 --- /dev/null +++ b/docs/cli/argocd_admin_app_get-reconcile-results.md @@ -0,0 +1,70 @@ +# `argocd admin app get-reconcile-results` Command Reference + +## argocd admin app get-reconcile-results + +Reconcile all applications and stores reconciliation summary in the specified file. + +``` +argocd admin app get-reconcile-results PATH [flags] +``` + +### 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 | +| --l | string | Label selector | +| --o | string | Output format (yaml|json) (default "yaml") | +| --password | string | Password for basic authentication to the API server | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --refresh| If set to true then recalculates apps reconciliation | +| --repo-server | string | Repo server address. | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --server-side-diff| If set to "true" will use server-side diff while comparing resources. Default ("false") | +| --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-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 admin app](argocd_admin_app.md) - Manage applications configuration +* [argocd admin app diff-reconcile-results](argocd_admin_app_diff-reconcile-results.md) - Compare results of two reconciliations and print diff. +* [argocd admin app generate-spec](argocd_admin_app_generate-spec.md) - Generate declarative config for an application \ No newline at end of file diff --git a/docs/cli/argocd_admin_cluster.md b/docs/cli/argocd_admin_cluster.md new file mode 100644 index 000000000..389775770 --- /dev/null +++ b/docs/cli/argocd_admin_cluster.md @@ -0,0 +1,65 @@ +# `argocd admin cluster` Command Reference + +## argocd admin cluster + +Manage clusters configuration + +``` +argocd admin cluster [flags] +``` + +### Examples + +``` + +#Generate declarative config for a cluster +argocd admin cluster generate-spec my-cluster -o yaml + +#Generate a kubeconfig for a cluster named "my-cluster" and display it in the console +argocd admin cluster kubeconfig my-cluster + +#Print information namespaces which Argo CD manages in each cluster +argocd admin cluster namespaces my-cluster +``` + +### Options + +``` + -h, --help help for cluster +``` + +### 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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin cluster generate-spec](argocd_admin_cluster_generate-spec.md) - Generate declarative config for a cluster +* [argocd admin cluster kubeconfig](argocd_admin_cluster_kubeconfig.md) - Generates kubeconfig for the specified cluster +* [argocd admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster shards](argocd_admin_cluster_shards.md) - Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. +* [argocd admin cluster stats](argocd_admin_cluster_stats.md) - Prints information cluster statistics and inferred shard number diff --git a/docs/cli/argocd_admin_cluster_generate-spec.md b/docs/cli/argocd_admin_cluster_generate-spec.md new file mode 100644 index 000000000..6c2c02d13 --- /dev/null +++ b/docs/cli/argocd_admin_cluster_generate-spec.md @@ -0,0 +1,70 @@ +# `argocd admin cluster generate-spec` Command Reference + +## argocd admin cluster generate-spec + +Generate declarative config for a cluster + +``` +argocd admin cluster generate-spec CONTEXT [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --annotation | string Array| Set metadata annotations (e.g. --annotation key=value) | +| --aws-cluster-name | string | AWS Cluster name if set then aws cli eks token command will be used to access cluster | +| --aws-profile | string | Optional AWS profile. If set then AWS IAM Authenticator uses this profile to perform cluster operations instead of the default AWS credential provider chain. | +| --aws-role-arn | string | Optional AWS role arn. If set then AWS IAM Authenticator assumes a role to perform cluster operations instead of the default AWS credential provider chain. | +| --bearer-token | string | Authentication token that should be used to access K8S API server | +| --cluster-endpoint | string | Cluster endpoint to use. Can be one of the following: 'kubeconfig', 'kube-public', or 'internal'. | +| --cluster-resources| Indicates if cluster level resources should be managed. The setting is used only if list of managed namespaces is not empty. | +| --exec-command | string | Command to run to provide client credentials to the cluster. You may need to build a custom ArgoCD image to ensure the command is available at runtime. | +| --exec-command-api-version | string | Preferred input version of the ExecInfo for the --exec-command executable | +| --exec-command-args | string Array| Arguments to supply to the --exec-command executable | +| --exec-command-env | string ToString| Environment vars to set when running the --exec-command executable (default []) | +| --exec-command-install-hint | string | Text shown to the user when the --exec-command executable doesn't seem to be present | +| --generate-bearer-token| Generate authentication token that should be used to access K8S API server | +| --in-cluster| Indicates Argo CD resides inside this cluster and should connect using the | int ernal k8s hostname (kubernetes.default.svc) | +| --kubeconfig | string | use a particular kubeconfig file | +| --label | string Array| Set metadata labels (e.g. --label key=value) | +| --name | string | Overwrite the cluster name | +| --namespace | string Array| List of namespaces which are allowed to manage | +| --project | string | project of the cluster | +| --service-account | string | System namespace service account to use for kubernetes resource management. If not set then default "argocd-manager" SA will be used (default "argocd-manager") | +| --shard | int | Cluster shard number; inferred from hostname if not set (default -1) | +| --system-namespace | string | Use different system namespace (default "kube-system") | + +### 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 admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin cluster kubeconfig](argocd_admin_cluster_kubeconfig.md) - Generates kubeconfig for the specified cluster +* [argocd admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster shards](argocd_admin_cluster_shards.md) - Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. +* [argocd admin cluster stats](argocd_admin_cluster_stats.md) - Prints information cluster statistics and inferred shard number \ No newline at end of file diff --git a/docs/cli/argocd_admin_cluster_kubeconfig.md b/docs/cli/argocd_admin_cluster_kubeconfig.md new file mode 100644 index 000000000..78684f7e4 --- /dev/null +++ b/docs/cli/argocd_admin_cluster_kubeconfig.md @@ -0,0 +1,83 @@ +# `argocd admin cluster kubeconfig` Command Reference + +## argocd admin cluster kubeconfig + +Generates kubeconfig for the specified cluster + +``` +argocd admin cluster kubeconfig CLUSTER_URL OUTPUT_PATH [flags] +``` + +### Examples + +``` + +#Generate a kubeconfig for a cluster named "my-cluster" on console +argocd admin cluster kubeconfig my-cluster + +#Listing available kubeconfigs for clusters managed by argocd +argocd admin cluster kubeconfig + +#Removing a specific kubeconfig file +argocd admin cluster kubeconfig my-cluster --delete + +#Generate a Kubeconfig for a Cluster with TLS Verification Disabled +argocd admin cluster kubeconfig https://cluster-api-url:6443 /path/to/output/kubeconfig.yaml --insecure-skip-tls-verify +``` + +### 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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin cluster generate-spec](argocd_admin_cluster_generate-spec.md) - Generate declarative config for a cluster +* [argocd admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster shards](argocd_admin_cluster_shards.md) - Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. +* [argocd admin cluster stats](argocd_admin_cluster_stats.md) - Prints information cluster statistics and inferred shard number \ No newline at end of file diff --git a/docs/cli/argocd_admin_cluster_namespaces.md b/docs/cli/argocd_admin_cluster_namespaces.md new file mode 100644 index 000000000..9ef28eced --- /dev/null +++ b/docs/cli/argocd_admin_cluster_namespaces.md @@ -0,0 +1,63 @@ +# `argocd admin cluster namespaces` Command Reference + +## argocd admin cluster namespaces + +Print information namespaces which Argo CD manages in each cluster. + +``` +argocd admin cluster namespaces [flags] +``` + +### 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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin cluster namespaces disable-namespaced-mode](argocd_admin_cluster_namespaces_disable-namespaced-mode.md) - Disable namespaced mode for clusters which name matches to the specified pattern. +* [argocd admin cluster namespaces enable-namespaced-mode](argocd_admin_cluster_namespaces_enable-namespaced-mode.md) - Enable namespaced mode for clusters which name matches to the specified pattern. diff --git a/docs/cli/argocd_admin_cluster_namespaces_disable-namespaced-mode.md b/docs/cli/argocd_admin_cluster_namespaces_disable-namespaced-mode.md new file mode 100644 index 000000000..6f431d67b --- /dev/null +++ b/docs/cli/argocd_admin_cluster_namespaces_disable-namespaced-mode.md @@ -0,0 +1,64 @@ +# `argocd admin cluster namespaces disable-namespaced-mode` Command Reference + +## argocd admin cluster namespaces disable-namespaced-mode + +Disable namespaced mode for clusters which name matches to the specified pattern. + +``` +argocd admin cluster namespaces disable-namespaced-mode PATTERN [flags] +``` + +### 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 | +| --dry-run| Print what will be performed (default true) | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster namespaces enable-namespaced-mode](argocd_admin_cluster_namespaces_enable-namespaced-mode.md) - Enable namespaced mode for clusters which name matches to the specified pattern. \ No newline at end of file diff --git a/docs/cli/argocd_admin_cluster_namespaces_enable-namespaced-mode.md b/docs/cli/argocd_admin_cluster_namespaces_enable-namespaced-mode.md new file mode 100644 index 000000000..28c5f32c4 --- /dev/null +++ b/docs/cli/argocd_admin_cluster_namespaces_enable-namespaced-mode.md @@ -0,0 +1,66 @@ +# `argocd admin cluster namespaces enable-namespaced-mode` Command Reference + +## argocd admin cluster namespaces enable-namespaced-mode + +Enable namespaced mode for clusters which name matches to the specified pattern. + +``` +argocd admin cluster namespaces enable-namespaced-mode PATTERN [flags] +``` + +### 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 | +| --cluster-resources| Indicates if cluster level resources should be managed. | +| --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 | +| --dry-run| Print what will be performed (default true) | +| --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 | +| --max-namespace-count | int | Max number of namespaces that cluster should managed managed namespaces is less or equal to specified count | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster namespaces disable-namespaced-mode](argocd_admin_cluster_namespaces_disable-namespaced-mode.md) - Disable namespaced mode for clusters which name matches to the specified pattern. + diff --git a/docs/cli/argocd_admin_cluster_shards.md b/docs/cli/argocd_admin_cluster_shards.md new file mode 100644 index 000000000..8c74c97bc --- /dev/null +++ b/docs/cli/argocd_admin_cluster_shards.md @@ -0,0 +1,81 @@ +# `argocd admin cluster shards` Command Reference + +## argocd admin cluster shards + +Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. + +``` +argocd admin cluster shards [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --app-state-cache-expiration duration| Cache expiration for app state (default 1h0m0s) | +| --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 | +| --default-cache-expiration duration| Cache expiration default (default 24h0m0s) | +| --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 | +| --port-forward-redis| Automatically port-forward ha proxy redis from current namespace? (default true) | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --redis | string | Redis server hostname and port (e.g. argocd-redis:6379). | +| --redis-ca-certificate | string | Path to Redis server CA certificate (e.g. /etc/certs/redis/ca.crt). If not specified, system trusted CAs will be used for server certificate validation. | +| --redis-client-certificate | string | Path to Redis client certificate (e.g. /etc/certs/redis/client.crt). | +| --redis-client-key | string | Path to Redis client key (e.g. /etc/certs/redis/client.crt). | +| --redis-compress | string | Enable compression for data sent to Redis with the required compression algorithm. (possible values: gzip, none) (default "gzip") | +| --redis-insecure-skip-tls-verify| Skip Redis server certificate validation. | +| --redis-use-tls| Use TLS when connecting to Redis. | +| --redisdb | int | Redis database. | +| --replicas | int | Application controller replicas count. Inferred from number of running controller pods if not specified | +| --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") | +| --sentinel | string Array| Redis sentinel hostname and port (e.g. argocd-redis-ha-announce-0:6379). | +| --sentinelmaster | string | Redis sentinel master group name. (default "master") | +| --server | string | The address and port of the Kubernetes API server | +| --shard | int | Cluster shard filter (default -1) | +| --sharding-method | string | Sharding method. Defaults: legacy. Supported sharding methods are : [legacy, round-robin]| (default "legacy") | +| --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 + +| --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-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 admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin cluster generate-spec](argocd_admin_cluster_generate-spec.md) - Generate declarative config for a cluster +* [argocd admin cluster kubeconfig](argocd_admin_cluster_kubeconfig.md) - Generates kubeconfig for the specified cluster +* [argocd admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster stats](argocd_admin_cluster_stats.md) - Prints information cluster statistics and inferred shard number \ No newline at end of file diff --git a/docs/cli/argocd_admin_cluster_stats.md b/docs/cli/argocd_admin_cluster_stats.md new file mode 100644 index 000000000..e43a2797d --- /dev/null +++ b/docs/cli/argocd_admin_cluster_stats.md @@ -0,0 +1,96 @@ +# `argocd admin cluster stats` Command Reference + +## argocd admin cluster stats + +Prints information cluster statistics and inferred shard number + +``` +argocd admin cluster stats [flags] +``` + +### Examples + +``` + +#Display stats and shards for clusters +argocd admin cluster stats + +#Display Cluster Statistics for a Specific Shard +argocd admin cluster stats --shard=1 + +#In a multi-cluster environment to print stats for a specific cluster say(target-cluster) +argocd admin cluster stats target-cluster +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --app-state-cache-expiration duration| Cache expiration for app state (default 1h0m0s) | +| --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 | +| --default-cache-expiration duration| Cache expiration default (default 24h0m0s) | +| --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 | +| --port-forward-redis| Automatically port-forward ha proxy redis from current namespace? (default true) | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --redis | string | Redis server hostname and port (e.g. argocd-redis:6379). | +| --redis-ca-certificate | string | Path to Redis server CA certificate (e.g. /etc/certs/redis/ca.crt). If not specified, system trusted CAs will be used for server certificate validation. | +| --redis-client-certificate | string | Path to Redis client certificate (e.g. /etc/certs/redis/client.crt). | +| --redis-client-key | string | Path to Redis client key (e.g. /etc/certs/redis/client.crt). | +| --redis-compress | string | Enable compression for data sent to Redis with the required compression algorithm. (possible values: gzip, none) (default "gzip") | +| --redis-insecure-skip-tls-verify| Skip Redis server certificate validation. | +| --redis-use-tls| Use TLS when connecting to Redis. | +| --redisdb | int | Redis database. | +| --replicas | int | Application controller replicas count. Inferred from number of running controller pods if not specified | +| --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") | +| --sentinel | string Array| Redis sentinel hostname and port (e.g. argocd-redis-ha-announce-0:6379). | +| --sentinelmaster | string | Redis sentinel master group name. (default "master") | +| --server | string | The address and port of the Kubernetes API server | +| --shard | int | Cluster shard filter (default -1) | +| --sharding-method | string | Sharding method. Defaults: legacy. Supported sharding methods are : [legacy, round-robin]| (default "legacy") | +| --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-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 admin cluster](argocd_admin_cluster.md) - Manage clusters configuration +* [argocd admin cluster generate-spec](argocd_admin_cluster_generate-spec.md) - Generate declarative config for a cluster +* [argocd admin cluster kubeconfig](argocd_admin_cluster_kubeconfig.md) - Generates kubeconfig for the specified cluster +* [argocd admin cluster namespaces](argocd_admin_cluster_namespaces.md) - Print information namespaces which Argo CD manages in each cluster. +* [argocd admin cluster shards](argocd_admin_cluster_shards.md) - Print information about each controller shard and the estimated portion of Kubernetes resources it is responsible for. \ No newline at end of file diff --git a/docs/cli/argocd_admin_dashboard.md b/docs/cli/argocd_admin_dashboard.md new file mode 100644 index 000000000..8e7f47031 --- /dev/null +++ b/docs/cli/argocd_admin_dashboard.md @@ -0,0 +1,79 @@ +# `argocd admin dashboard` Command Reference + +## argocd admin dashboard + +Starts Argo CD Web UI locally + +``` +argocd admin dashboard [flags] +``` + +### Examples + +``` +# Start the Argo CD Web UI locally on the default port and address +$ argocd admin dashboard + +# Start the Argo CD Web UI locally on a custom port and address +$ argocd admin dashboard --port 8080 --address 127.0.0.1 + +# Start the Argo CD Web UI with GZip compression +$ argocd admin dashboard --redis-compress gzip + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --address | string | Listen on given address (default "localhost") | +| --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 | +| --port | int | Listen on given port (default 8080) | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --redis-compress | string | Enable this if the application controller is configured with redis compression enabled. (possible values: gzip, none) (default "gzip") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access diff --git a/docs/cli/argocd_admin_export.md b/docs/cli/argocd_admin_export.md new file mode 100644 index 000000000..9f7e53a5e --- /dev/null +++ b/docs/cli/argocd_admin_export.md @@ -0,0 +1,62 @@ +# `argocd admin export` Command Reference + +## argocd admin export + +Export all Argo CD data to stdout (default) or a file + +``` +argocd admin export [flags] +``` + +### 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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access \ No newline at end of file diff --git a/docs/cli/argocd_admin_import.md b/docs/cli/argocd_admin_import.md new file mode 100644 index 000000000..2b1407823 --- /dev/null +++ b/docs/cli/argocd_admin_import.md @@ -0,0 +1,67 @@ +# `argocd admin import` Command Reference + +## argocd admin import + +Import Argo CD data from stdin (specify `-') or a file + +``` +argocd admin import SOURCE [flags] +``` + +### 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 | +| --dry-run| Print what will be performed | +| --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 | +| --prune| Prune secrets, applications and projects which do not appear in the backup | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --stop-operation| Stop any existing operations | +| --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 | +| --verbose| Verbose output (versus only changed output) | + +### 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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access \ No newline at end of file diff --git a/docs/cli/argocd_admin_initial-password.md b/docs/cli/argocd_admin_initial-password.md new file mode 100644 index 000000000..b4108b127 --- /dev/null +++ b/docs/cli/argocd_admin_initial-password.md @@ -0,0 +1,62 @@ +# `argocd admin initial-password` Command Reference + +## argocd admin initial-password + +Prints initial password to log in to Argo CD for the first time + +``` +argocd admin initial-password [flags] +``` + +### 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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access \ No newline at end of file diff --git a/docs/cli/argocd_admin_notifications.md b/docs/cli/argocd_admin_notifications.md new file mode 100644 index 000000000..4196b26dd --- /dev/null +++ b/docs/cli/argocd_admin_notifications.md @@ -0,0 +1,70 @@ +# `argocd admin notifications` Command Reference + +## argocd admin notifications + +Set of CLI commands that helps manage notifications settings + +``` +argocd admin notifications [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin notifications template](argocd_admin_notifications_template.md) - Notification templates related commands +* [argocd admin notifications trigger](argocd_admin_notifications_trigger.md) - Notification triggers related commands \ No newline at end of file diff --git a/docs/cli/argocd_admin_notifications_template.md b/docs/cli/argocd_admin_notifications_template.md new file mode 100644 index 000000000..f63b1f720 --- /dev/null +++ b/docs/cli/argocd_admin_notifications_template.md @@ -0,0 +1,74 @@ +# `argocd admin notifications template` Command Reference + +## argocd admin notifications template + +Notification templates related commands + +``` +argocd admin notifications template [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for template| + + +### Options inherited from parent commands + + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin notifications](argocd_admin_notifications.md) - Set of CLI commands that helps manage notifications settings +* [argocd admin notifications template get](argocd_admin_notifications_template_get.md) - Prints information about configured templates +* [argocd admin notifications template notify](argocd_admin_notifications_template_notify.md) - Generates notification using the specified template and send it to specified recipients + diff --git a/docs/cli/argocd_admin_notifications_template_get.md b/docs/cli/argocd_admin_notifications_template_get.md new file mode 100644 index 000000000..e37662f5c --- /dev/null +++ b/docs/cli/argocd_admin_notifications_template_get.md @@ -0,0 +1,82 @@ +# `argocd admin notifications template get` Command Reference + +## argocd admin notifications template get + +Prints information about configured templates + +``` +argocd admin notifications template get [flags] +``` + +### Examples + +``` + +# prints all templates +argocd admin notifications template get +# print YAML formatted app-sync-succeeded template definition +argocd admin notifications template get app-sync-succeeded -o=yaml + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for get | +| -o, --output | string | Output format. One of:json|yaml|wide|name (default "wide")| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin notifications template](argocd_admin_notifications_template.md) - Notification templates related commands \ No newline at end of file diff --git a/docs/cli/argocd_admin_notifications_template_notify.md b/docs/cli/argocd_admin_notifications_template_notify.md new file mode 100644 index 000000000..a8cf5ef3c --- /dev/null +++ b/docs/cli/argocd_admin_notifications_template_notify.md @@ -0,0 +1,84 @@ +# `argocd admin notifications template notify` Command Reference + +## argocd admin notifications template notify + +Generates notification using the specified template and send it to specified recipients + +``` +argocd admin notifications template notify NAME RESOURCE_NAME [flags] +``` + +### Examples + +``` + +# Trigger notification using in-cluster config map and secret +argocd admin notifications template notify app-sync-succeeded guestbook --recipient slack:my-slack-channel + +# Render notification render generated notification in console +argocd admin notifications template notify app-sync-succeeded guestbook + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for notify| +| --recipient | stringArray | List of recipients (default [console:stdout])| + + +### Options inherited from parent commands +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --recipient | string Array| List of recipients (default [console:stdout]) | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin notifications template](argocd_admin_notifications_template.md) - Notification templates related commands + diff --git a/docs/cli/argocd_admin_notifications_trigger.md b/docs/cli/argocd_admin_notifications_trigger.md new file mode 100644 index 000000000..0eddf99bb --- /dev/null +++ b/docs/cli/argocd_admin_notifications_trigger.md @@ -0,0 +1,71 @@ +# `argocd admin notifications trigger` Command Reference + +## argocd admin notifications trigger + +Notification triggers related commands + +``` +argocd admin notifications trigger [flags] +``` + +### Options + +``` + -h, --help help for trigger +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin notifications](argocd_admin_notifications.md) - Set of CLI commands that helps manage notifications settings +* [argocd admin notifications trigger get](argocd_admin_notifications_trigger_get.md) - Prints information about configured triggers +* [argocd admin notifications trigger run](argocd_admin_notifications_trigger_run.md) - Evaluates specified trigger condition and prints the result diff --git a/docs/cli/argocd_admin_notifications_trigger_get.md b/docs/cli/argocd_admin_notifications_trigger_get.md new file mode 100644 index 000000000..c9141fa0e --- /dev/null +++ b/docs/cli/argocd_admin_notifications_trigger_get.md @@ -0,0 +1,84 @@ +# `argocd admin notifications trigger get` Command Reference + +## argocd admin notifications trigger get + +Prints information about configured triggers + +``` +argocd admin notifications trigger get [flags] +``` + +### Examples + +``` + +# prints all triggers +argocd admin notifications trigger get +# print YAML formatted on-sync-failed trigger definition +argocd admin notifications trigger get on-sync-failed -o=yaml + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | |help for get| +| -o, --output | string | Output format. One of:json|yaml|wide|name (default "wide")| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + + +### SEE ALSO + +* [argocd admin notifications trigger](argocd_admin_notifications_trigger.md) - Notification triggers related commands + diff --git a/docs/cli/argocd_admin_notifications_trigger_run.md b/docs/cli/argocd_admin_notifications_trigger_run.md new file mode 100644 index 000000000..1fa2c91a9 --- /dev/null +++ b/docs/cli/argocd_admin_notifications_trigger_run.md @@ -0,0 +1,82 @@ +# `argocd admin notifications trigger run` Command Reference + +## argocd admin notifications trigger run + +Evaluates specified trigger condition and prints the result + +``` +argocd admin notifications trigger run NAME RESOURCE_NAME [flags] +``` + +### Examples + +``` + +# Execute trigger configured in 'argocd-notification-cm' ConfigMap +argocd admin notifications trigger run on-sync-status-unknown ./sample-app.yaml + +# Execute trigger using my-config-map.yaml instead of 'argocd-notifications-cm' ConfigMap +argocd admin notifications trigger run on-sync-status-unknown ./sample-app.yaml \ + --config-map ./my-config-map.yaml +``` + +### Options + +``` + -h, --help help for run +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --config-map ./my-config-map.yaml | +| --argocd-repo-server | string | Argo CD repo server address (default "argocd-repo-server:8081") | +| --argocd-repo-server-plaintext| Use a plaintext client (non-TLS) to connect to repository server | +| --argocd-repo-server-strict-tls| Perform strict validation of TLS certificates when connecting to repo server | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --config-map | string | argocd-notifications-cm.yaml file path | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --secret | string | argocd-notifications-secret.yaml file path. Use empty secret if provided value is ':empty' | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin notifications trigger](argocd_admin_notifications_trigger.md) - Notification triggers related commands diff --git a/docs/cli/argocd_admin_proj.md b/docs/cli/argocd_admin_proj.md new file mode 100644 index 000000000..2c11771ec --- /dev/null +++ b/docs/cli/argocd_admin_proj.md @@ -0,0 +1,52 @@ +# `argocd admin proj` Command Reference + +## argocd admin proj + +Manage projects configuration + +``` +argocd admin proj [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for proj| + + +### 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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin proj generate-allow-list](argocd_admin_proj_generate-allow-list.md) - Generates project allow list from the specified clusterRole file +* [argocd admin proj generate-spec](argocd_admin_proj_generate-spec.md) - Generate declarative config for a project +* [argocd admin proj update-role-policy](argocd_admin_proj_update-role-policy.md) - Implement bulk project role update. Useful to back-fill existing project policies or remove obsolete actions. + + diff --git a/docs/cli/argocd_admin_proj_generate-allow-list.md b/docs/cli/argocd_admin_proj_generate-allow-list.md new file mode 100644 index 000000000..ff6e8442c --- /dev/null +++ b/docs/cli/argocd_admin_proj_generate-allow-list.md @@ -0,0 +1,73 @@ +# `argocd admin proj generate-allow-list` Command Reference + +## argocd admin proj generate-allow-list + +Generates project allow list from the specified clusterRole file + +``` +argocd admin proj generate-allow-list CLUSTERROLE_PATH PROJ_NAME [flags] +``` + +### Examples + +``` +# Generates project allow list from the specified clusterRole file +argocd admin proj generate-allow-list /path/to/clusterrole.yaml my-project +``` + +### 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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin proj](argocd_admin_proj.md) - Manage projects configuration + + diff --git a/docs/cli/argocd_admin_proj_generate-spec.md b/docs/cli/argocd_admin_proj_generate-spec.md new file mode 100644 index 000000000..dd8608845 --- /dev/null +++ b/docs/cli/argocd_admin_proj_generate-spec.md @@ -0,0 +1,67 @@ +# `argocd admin proj generate-spec` Command Reference + +## argocd admin proj generate-spec + +Generate declarative config for a project + +``` +argocd admin proj generate-spec PROJECT [flags] +``` + +### Examples + +``` + # Generate a YAML configuration for a project named "myproject" + argocd admin projects generate-spec myproject + + # Generate a JSON configuration for a project named "anotherproject" and specify an output file + argocd admin projects generate-spec anotherproject --output json --file config.json + + # Generate a YAML configuration for a project named "someproject" and write it back to the input file + argocd admin projects generate-spec someproject --inline +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-cluster-resource | string Array| List of allowed cluster level resources | +| --allow-namespaced-resource | string Array| List of allowed namespaced resources | +| --deny-cluster-resource | string Array| List of denied cluster level resources | +| --deny-namespaced-resource | string Array| List of denied namespaced resources | +| --description | string | Project description | +| --orphaned-resources| Enables orphaned resources monitoring | +| --orphaned-resources-warn| Specifies if applications should have a warning condition when orphaned resources detected | +| --signature-keys | string s| GnuPG public key IDs for commit signature verification | +| --source-namespaces | string s| List of source namespaces for applications | + +### 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 admin proj](argocd_admin_proj.md) - Manage projects configuration diff --git a/docs/cli/argocd_admin_proj_update-role-policy.md b/docs/cli/argocd_admin_proj_update-role-policy.md new file mode 100644 index 000000000..f85a46a36 --- /dev/null +++ b/docs/cli/argocd_admin_proj_update-role-policy.md @@ -0,0 +1,82 @@ +# `argocd admin proj update-role-policy` Command Reference + +## argocd admin proj update-role-policy + +Implement bulk project role update. Useful to back-fill existing project policies or remove obsolete actions. + +``` +argocd admin proj update-role-policy PROJECT_GLOB MODIFICATION ACTION [flags] +``` + +### Examples + +``` + # Add policy that allows executing any action (action/*) to roles which name matches to *deployer* in all projects + argocd admin projects update-role-policy '*' set 'action/*' --role '*deployer*' --resource applications --scope '*' --permission allow + + # Remove policy that which manages running (action/*) from all roles which name matches *deployer* in all projects + argocd admin projects update-role-policy '*' remove override --role '*deployer*' + +``` + +### 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 | +| --dry-run| Dry run (default true) | +| -h, --help | | help for update-role-policy| +| --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 | +| -n, --namespace | string | If present, the namespace scope for this CLI request| +| --password | string | Password for basic authentication to the API server | +| --permission | string | Action permission | +| --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") | +| --resource | string | Resource e.g. 'applications' | +| --role | string | Role name pattern e.g. '*deployer*' (default "*") | +| --scope | string | Resource scope e.g. '*' | +| --server | string | The address and port of the Kubernetes API server | +| --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 + + +| --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-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 admin proj](argocd_admin_proj.md) - Manage projects configuration + + diff --git a/docs/cli/argocd_admin_repo.md b/docs/cli/argocd_admin_repo.md new file mode 100644 index 000000000..1e4ff32f0 --- /dev/null +++ b/docs/cli/argocd_admin_repo.md @@ -0,0 +1,49 @@ +# `argocd admin repo` Command Reference + +## argocd admin repo + +Manage repositories configuration + +``` +argocd admin repo [flags] +``` + +### Options + +| Option | Argument type | Description | +| -h, --help | | help for repo | + + +### 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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin repo generate-spec](argocd_admin_repo_generate-spec.md) - Generate declarative config for a repo + + diff --git a/docs/cli/argocd_admin_repo_generate-spec.md b/docs/cli/argocd_admin_repo_generate-spec.md new file mode 100644 index 000000000..62bcc0541 --- /dev/null +++ b/docs/cli/argocd_admin_repo_generate-spec.md @@ -0,0 +1,94 @@ +# `argocd admin repo generate-spec` Command Reference + +## argocd admin repo generate-spec + +Generate declarative config for a repo + +``` +argocd admin repo generate-spec REPOURL [flags] +``` + +### Examples + +``` + + # Add a Git repository via SSH using a private key for authentication, ignoring the server's host key: + argocd admin repo generate-spec git@git.example.com:repos/repo --insecure-ignore-host-key --ssh-private-key-path ~/id_rsa + + # Add a Git repository via SSH on a non-default port - need to use ssh:// style URLs here + argocd admin repo generate-spec ssh://git@git.example.com:2222/repos/repo --ssh-private-key-path ~/id_rsa + + # Add a private Git repository via HTTPS using username/password and TLS client certificates: + argocd admin repo generate-spec https://git.example.com/repos/repo --username git --password secret --tls-client-cert-path ~/mycert.crt --tls-client-cert-key-path ~/mycert.key + + # Add a private Git repository via HTTPS using username/password without verifying the server's TLS certificate + argocd admin repo generate-spec https://git.example.com/repos/repo --username git --password secret --insecure-skip-server-verification + + # Add a public Helm repository named 'stable' via HTTPS + argocd admin repo generate-spec https://charts.helm.sh/stable --type helm --name stable + + # Add a private Helm repository named 'stable' via HTTPS + argocd admin repo generate-spec https://charts.helm.sh/stable --type helm --name stable --username test --password test + + # Add a private Helm OCI-based repository named 'stable' via HTTPS + argocd admin repo generate-spec helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type helm --name stable --enable-oci --username test --password test + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --enable-lfs| enable git-lfs (Large File Support) on this repository | +| --enable-oci| enable helm-oci (Helm OCI-Based Repository) | +| --force-http-basic-auth| whether to force use of basic auth when connecting repository via HTTP | +| --gcp-service-account-key-path | string | service account key for the Google Cloud Platform | +| --github-app-enterprise-base-url | string | base url to use when using GitHub Enterprise (e.g. https://ghe.example.com/api/v3 | +| --github-app-id | int | id of the GitHub Application | +| --github-app-installation-id | int | installation id of the GitHub Application | +| --github-app-private-key-path | string | private key of the GitHub Application | +| -h, --help | | help for generate-spec | +| --insecure-ignore-host-key| disables SSH strict host key checking (deprecated, use --insecure-skip-server-verification instead) | +| --insecure-skip-server-verification| disables server certificate and host key checks | +| --name | string | name of the repository, mandatory for repositories of type helm | +| -o, --output | string | Output format. One of: json|yaml (default "yaml")| +| --password | string | password to the repository | +| --project | string | project of the repository | +| --proxy | string | use proxy to access repository | +| --ssh-private-key-path | string | path to the private ssh key (e.g. ~/.ssh/id_rsa) | +| --tls-client-cert-key-path | string | path to the TLS client cert's key path (must be PEM format) | +| --tls-client-cert-path | string | path to the TLS client cert (must be PEM format) | +| --type | string | type of the repository, "git" or "helm" (default "git") | +| --username | string | username to the repository | + +### Options inherited from parent commands + + +| --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 admin repo](argocd_admin_repo.md) - Manage repositories configuration + + diff --git a/docs/cli/argocd_admin_settings.md b/docs/cli/argocd_admin_settings.md new file mode 100644 index 000000000..470feab53 --- /dev/null +++ b/docs/cli/argocd_admin_settings.md @@ -0,0 +1,72 @@ +# `argocd admin settings` Command Reference + +## argocd admin settings + +Provides set of commands for settings validation and troubleshooting + +``` +argocd admin settings [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| -h, --help | |help for settings| +| --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 | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| -n, --namespace string | |If present, the namespace scope for this CLI request| +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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-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 admin](argocd_admin.md) - Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access +* [argocd admin settings rbac](argocd_admin_settings_rbac.md) - Validate and test RBAC configuration +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides +* [argocd admin settings validate](argocd_admin_settings_validate.md) - Validate settings diff --git a/docs/cli/argocd_admin_settings_rbac.md b/docs/cli/argocd_admin_settings_rbac.md new file mode 100644 index 000000000..125467e45 --- /dev/null +++ b/docs/cli/argocd_admin_settings_rbac.md @@ -0,0 +1,117 @@ +# `argocd admin settings rbac` Command Reference + +## argocd admin settings rbac + +Validate and test RBAC configuration + +``` +argocd admin settings rbac [flags] +``` + +### Options + +``` + -h, --help help for rbac +``` + +### Options inherited from parent commands + +``` + --argocd-cm-path string Path to local argocd-cm.yaml file + --argocd-secret-path string Path to local argocd-secret.yaml file + --as string Username to impersonate for the operation + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --as-uid string UID to impersonate for the operation + --auth-token string Authentication token + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-crt string Client certificate file + --client-crt-key string Client certificate key file + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --config string Path to Argo CD config (default "/home/user/.config/argocd/config") + --context string The name of the kubeconfig context to use + --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 + --disable-compression If true, opt-out of response compression for all requests to the 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) + --http-retry-max int Maximum number of retries to establish http connection to Argo CD server + --insecure Skip server certificate and domain verification + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kube-context string Directs the command to the given kube-context + --kubeconfig string Path to a kube config. Only required if out-of-cluster + --load-cluster-settings Indicates that config map and secret should be loaded from cluster unless local file path is provided + --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") + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + --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 + --proxy-url string If provided, this URL will be used to connect via proxy + --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") + --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") + --server string The address and port of the Kubernetes API server + --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") + --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 +``` + +### SEE ALSO + +* [argocd admin settings](argocd_admin_settings.md) - Provides set of commands for settings validation and troubleshooting +* [argocd admin settings rbac can](argocd_admin_settings_rbac_can.md) - Check RBAC permissions for a role or subject +* [argocd admin settings rbac validate](argocd_admin_settings_rbac_validate.md) - Validate RBAC policy + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | diff --git a/docs/cli/argocd_admin_settings_rbac_can.md b/docs/cli/argocd_admin_settings_rbac_can.md new file mode 100644 index 000000000..e87dc8a81 --- /dev/null +++ b/docs/cli/argocd_admin_settings_rbac_can.md @@ -0,0 +1,154 @@ +# `argocd admin settings rbac can` Command Reference + +## argocd admin settings rbac can + +Check RBAC permissions for a role or subject + +### Synopsis + + +Check whether a given role or subject has appropriate RBAC permissions to do +something. + + +``` +argocd admin settings rbac can ROLE/SUBJECT ACTION RESOURCE [SUB-RESOURCE] [flags] +``` + +### Examples + +``` + +# Check whether role some:role has permissions to create an application in the +# 'default' project, using a local policy.csv file +argocd admin settings rbac can some:role create application 'default/app' --policy-file policy.csv + +# Policy file can also be K8s config map with data keys like argocd-rbac-cm, +# i.e. 'policy.csv' and (optionally) 'policy.default' +argocd admin settings rbac can some:role create application 'default/app' --policy-file argocd-rbac-cm.yaml + +# If --policy-file is not given, the ConfigMap 'argocd-rbac-cm' from K8s is +# used. You need to specify the argocd namespace, and make sure that your +# current Kubernetes context is pointing to the cluster Argo CD is running in +argocd admin settings rbac can some:role create application 'default/app' --namespace argocd + +# You can override a possibly configured default role +argocd admin settings rbac can someuser create application 'default/app' --default-role role:readonly + + +``` + +### Options + +``` + --as string Username to impersonate for the operation + --as-group stringArray 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 + --default-role string name of the default role to use + --disable-compression If true, opt-out of response compression for all requests to the server + -h, --help help for can + --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 + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + --policy-file string path to the policy file to use + --proxy-url string If provided, this URL will be used to connect via proxy + -q, --quiet quiet mode - do not print results to stdout + --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") + --server string The address and port of the Kubernetes API server + --strict whether to perform strict check on action and resource names (default true) + --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 + --use-builtin-policy whether to also use builtin-policy (default true) + --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 + +``` + --argocd-cm-path string Path to local argocd-cm.yaml file + --argocd-secret-path string Path to local argocd-secret.yaml file + --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) + --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 + --load-cluster-settings Indicates that config map and secret should be loaded from cluster unless local file path is provided + --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-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 admin settings rbac](argocd_admin_settings_rbac.md) - Validate and test RBAC configuration + +| 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 | +| --default-role | string | name of the default role 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 | +| --policy-file | string | path to the policy file to use | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --strict| whether to perform strict check on action and resource names (default true) | +| --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 | +| --use-builtin-policy| whether to also use builtin-policy (default true) | +| --user | string | The name of the kubeconfig user to use | +| --username | string | Username for basic authentication to the API server | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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-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") | diff --git a/docs/cli/argocd_admin_settings_rbac_validate.md b/docs/cli/argocd_admin_settings_rbac_validate.md new file mode 100644 index 000000000..2ea9efb72 --- /dev/null +++ b/docs/cli/argocd_admin_settings_rbac_validate.md @@ -0,0 +1,144 @@ +# `argocd admin settings rbac validate` Command Reference + +## argocd admin settings rbac validate + +Validate RBAC policy + +### Synopsis + + +Validates an RBAC policy for being syntactically correct. The policy must be +a local file or a K8s ConfigMap in the provided namespace, and in either CSV or K8s ConfigMap format. + + +``` +argocd admin settings rbac validate [--policy-file POLICYFILE] [--namespace NAMESPACE] [flags] +``` + +### Examples + +``` + +# Check whether a given policy file is valid using a local policy.csv file. +argocd admin settings rbac validate --policy-file policy.csv + +# Policy file can also be K8s config map with data keys like argocd-rbac-cm, +# i.e. 'policy.csv' and (optionally) 'policy.default' +argocd admin settings rbac validate --policy-file argocd-rbac-cm.yaml + +# If --policy-file is not given, and instead --namespace is giventhe ConfigMap 'argocd-rbac-cm' +# from K8s is used. +argocd admin settings rbac validate --namespace argocd + +# Either --policy-file or --namespace must be given. + +``` + +### Options + +``` + --as string Username to impersonate for the operation + --as-group stringArray 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 + -h, --help help for validate + --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 + --namespace string namespace to get argo rbac configmap from + --password string Password for basic authentication to the API server + --policy-file string path to the policy file to use + --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") + --server string The address and port of the Kubernetes API server + --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 + +``` + --argocd-cm-path string Path to local argocd-cm.yaml file + --argocd-secret-path string Path to local argocd-secret.yaml file + --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) + --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 + --load-cluster-settings Indicates that config map and secret should be loaded from cluster unless local file path is provided + --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-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 admin settings rbac](argocd_admin_settings_rbac.md) - Validate and test RBAC configuration + +| 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 | +| --namespace | string | namespace to get argo rbac configmap from | +| --password | string | Password for basic authentication to the API server | +| --policy-file | string | path to the policy file to use | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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 | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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-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") | diff --git a/docs/cli/argocd_admin_settings_resource-overrides.md b/docs/cli/argocd_admin_settings_resource-overrides.md new file mode 100644 index 000000000..e963467ba --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides.md @@ -0,0 +1,75 @@ +# `argocd admin settings resource-overrides` Command Reference + +## argocd admin settings resource-overrides + +Troubleshoot resource overrides + +``` +argocd admin settings resource-overrides [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for resource-overrides| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings](argocd_admin_settings.md) - Provides set of commands for settings validation and troubleshooting +* [argocd admin settings resource-overrides health](argocd_admin_settings_resource-overrides_health.md) - Assess resource health +* [argocd admin settings resource-overrides ignore-differences](argocd_admin_settings_resource-overrides_ignore-differences.md) - Renders fields excluded from diffing +* [argocd admin settings resource-overrides ignore-resource-updates](argocd_admin_settings_resource-overrides_ignore-resource-updates.md) - Renders fields excluded from resource updates +* [argocd admin settings resource-overrides list-actions](argocd_admin_settings_resource-overrides_list-actions.md) - List available resource actions +* [argocd admin settings resource-overrides run-action](argocd_admin_settings_resource-overrides_run-action.md) - Executes resource action + + diff --git a/docs/cli/argocd_admin_settings_resource-overrides_health.md b/docs/cli/argocd_admin_settings_resource-overrides_health.md new file mode 100644 index 000000000..3e114e69d --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides_health.md @@ -0,0 +1,77 @@ +# `argocd admin settings resource-overrides health` Command Reference + +## argocd admin settings resource-overrides health + +Assess resource health + +### Synopsis + +Assess resource health using the lua script configured in the 'resource.customizations' field of 'argocd-cm' ConfigMap + +``` +argocd admin settings resource-overrides health RESOURCE_YAML_PATH [flags] +``` + +### Examples + +``` + +argocd admin settings resource-overrides health ./deploy.yaml --argocd-cm-path ./argocd-cm.yaml +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for health| + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | +### SEE ALSO + +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides diff --git a/docs/cli/argocd_admin_settings_resource-overrides_ignore-differences.md b/docs/cli/argocd_admin_settings_resource-overrides_ignore-differences.md new file mode 100644 index 000000000..b576a02c3 --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides_ignore-differences.md @@ -0,0 +1,82 @@ +# `argocd admin settings resource-overrides ignore-differences` Command Reference + +## argocd admin settings resource-overrides ignore-differences + +Renders fields excluded from diffing + +### Synopsis + +Renders ignored fields using the 'ignoreDifferences' setting specified in the 'resource.customizations' field of 'argocd-cm' ConfigMap + +``` +argocd admin settings resource-overrides ignore-differences RESOURCE_YAML_PATH [flags] +``` + +### Examples + +``` + +argocd admin settings resource-overrides ignore-differences ./deploy.yaml --argocd-cm-path ./argocd-cm.yaml +``` + +### Options + + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for ignore-differences| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides + + diff --git a/docs/cli/argocd_admin_settings_resource-overrides_ignore-resource-updates.md b/docs/cli/argocd_admin_settings_resource-overrides_ignore-resource-updates.md new file mode 100644 index 000000000..84f3865de --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides_ignore-resource-updates.md @@ -0,0 +1,81 @@ +# `argocd admin settings resource-overrides ignore-resource-updates` Command Reference + +## argocd admin settings resource-overrides ignore-resource-updates + +Renders fields excluded from resource updates + +### Synopsis + +Renders ignored fields using the 'ignoreResourceUpdates' setting specified in the 'resource.customizations' field of 'argocd-cm' ConfigMap + +``` +argocd admin settings resource-overrides ignore-resource-updates RESOURCE_YAML_PATH [flags] +``` + +### Examples + +``` + +argocd admin settings resource-overrides ignore-resource-updates ./deploy.yaml --argocd-cm-path ./argocd-cm.yaml +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for ignore-resource-updates| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides + + diff --git a/docs/cli/argocd_admin_settings_resource-overrides_list-actions.md b/docs/cli/argocd_admin_settings_resource-overrides_list-actions.md new file mode 100644 index 000000000..d783d1f10 --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides_list-actions.md @@ -0,0 +1,81 @@ +# `argocd admin settings resource-overrides list-actions` Command Reference + +## argocd admin settings resource-overrides list-actions + +List available resource actions + +### Synopsis + +List actions available for given resource action using the lua scripts configured in the 'resource.customizations' field of 'argocd-cm' ConfigMap and outputs updated fields + +``` +argocd admin settings resource-overrides list-actions RESOURCE_YAML_PATH [flags] +``` + +### Examples + +``` + +argocd admin settings resource-overrides action list /tmp/deploy.yaml --argocd-cm-path ./argocd-cm.yaml +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for list-actions| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides + + diff --git a/docs/cli/argocd_admin_settings_resource-overrides_run-action.md b/docs/cli/argocd_admin_settings_resource-overrides_run-action.md new file mode 100644 index 000000000..3517a1fa2 --- /dev/null +++ b/docs/cli/argocd_admin_settings_resource-overrides_run-action.md @@ -0,0 +1,81 @@ +# `argocd admin settings resource-overrides run-action` Command Reference + +## argocd admin settings resource-overrides run-action + +Executes resource action + +### Synopsis + +Executes resource action using the lua script configured in the 'resource.customizations' field of 'argocd-cm' ConfigMap and outputs updated fields + +``` +argocd admin settings resource-overrides run-action RESOURCE_YAML_PATH ACTION [flags] +``` + +### Examples + +``` + +argocd admin settings resource-overrides action run /tmp/deploy.yaml restart --argocd-cm-path ./argocd-cm.yaml +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for run-action| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings resource-overrides](argocd_admin_settings_resource-overrides.md) - Troubleshoot resource overrides + + diff --git a/docs/cli/argocd_admin_settings_validate.md b/docs/cli/argocd_admin_settings_validate.md new file mode 100644 index 000000000..6d1b68a2c --- /dev/null +++ b/docs/cli/argocd_admin_settings_validate.md @@ -0,0 +1,84 @@ +# `argocd admin settings validate` Command Reference + +## argocd admin settings validate + +Validate settings + +### Synopsis + +Validates settings specified in 'argocd-cm' ConfigMap and 'argocd-secret' Secret + +``` +argocd admin settings validate [flags] +``` + +### Examples + +``` + +#Validates all settings in the specified YAML file +argocd admin settings validate --argocd-cm-path ./argocd-cm.yaml + +#Validates accounts and plugins settings in Kubernetes cluster of current kubeconfig context +argocd admin settings validate --group accounts --group plugins --load-cluster-settings +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --group | string Array| Optional list of setting groups that have to be validated ( one of: accounts, general, kustomize, repositories, resource-overrides) | +| -h, --help | | help for validate| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --argocd-cm-path | string | Path to local argocd-cm.yaml file | +| --argocd-secret-path | string | Path to local argocd-secret.yaml file | +| --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 | +| --auth-token | string | Authentication token | +| --certificate-authority | string | Path to a cert file for the certificate authority | +| --client-certificate | string | Path to a client certificate file for TLS | +| --client-crt | string | Client certificate file | +| --client-crt-key | string | Client certificate key file | +| --client-key | string | Path to a client key file for TLS | +| --cluster | string | The name of the kubeconfig cluster to use | +| --config | string | Path to Argo CD config (default "/home/user/.config/argocd/config") | +| --context | string | The name of the kubeconfig context to use | +| --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 | +| --disable-compression| If true, opt-out of response compression for all requests to the 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 | +| --insecure-skip-tls-verify| If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | +| --kube-context | string | Directs the command to the given kube-context | +| --kubeconfig | string | Path to a kube config. Only required if out-of-cluster | +| --load-cluster-settings| Indicates that config map and secret should be loaded from cluster unless local file path is provided | +| --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") | +| --password | string | Password for basic authentication to the API server | +| --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 | +| --proxy-url | string | If provided, this URL will be used to connect via proxy | +| --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") | +| --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") | +| --server | string | The address and port of the Kubernetes API server | +| --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") | +| --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 | + +### SEE ALSO + +* [argocd admin settings](argocd_admin_settings.md) - Provides set of commands for settings validation and troubleshooting diff --git a/docs/cli/argocd_app.md b/docs/cli/argocd_app.md new file mode 100644 index 000000000..566fda9e7 --- /dev/null +++ b/docs/cli/argocd_app.md @@ -0,0 +1,98 @@ +# `argocd app` Command Reference + +## argocd app + +Manage applications + +``` +argocd app [flags] +``` + +### Examples + +``` + # List all the applications. + argocd app list + + # Get the details of a application + argocd app get my-app + + # Set an override parameter + argocd app set my-app -p image.tag=v1.0.1 +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd app actions](argocd_app_actions.md) - Manage Resource actions +* [argocd app create](argocd_app_create.md) - Create an application +* [argocd app delete](argocd_app_delete.md) - Delete an application +* [argocd app delete-resource](argocd_app_delete-resource.md) - Delete resource in an application +* [argocd app diff](argocd_app_diff.md) - Perform a diff against the target and live state. +* [argocd app edit](argocd_app_edit.md) - Edit application +* [argocd app get](argocd_app_get.md) - Get application details +* [argocd app history](argocd_app_history.md) - Show application deployment history +* [argocd app list](argocd_app_list.md) - List applications +* [argocd app logs](argocd_app_logs.md) - Get logs of application pods +* [argocd app manifests](argocd_app_manifests.md) - Print manifests of an application +* [argocd app patch](argocd_app_patch.md) - Patch application +* [argocd app patch-resource](argocd_app_patch-resource.md) - Patch resource in an application +* [argocd app resources](argocd_app_resources.md) - List resource of application +* [argocd app rollback](argocd_app_rollback.md) - Rollback application to a previous deployed version by History ID, omitted will Rollback to the previous version +* [argocd app set](argocd_app_set.md) - Set application parameters +* [argocd app sync](argocd_app_sync.md) - Sync an application to its target state +* [argocd app terminate-op](argocd_app_terminate-op.md) - Terminate running operation of an application +* [argocd app unset](argocd_app_unset.md) - Unset application parameters +* [argocd app wait](argocd_app_wait.md) - Wait for an application to reach a synced and healthy state + + diff --git a/docs/cli/argocd_app_actions.md b/docs/cli/argocd_app_actions.md new file mode 100644 index 000000000..4efdf4bcb --- /dev/null +++ b/docs/cli/argocd_app_actions.md @@ -0,0 +1,60 @@ +# `argocd app actions` Command Reference + +## argocd app actions + +Manage Resource actions + +``` +argocd app actions [flags] +``` + +### Examples + +``` + # List all the available actions for an application + argocd app actions list APPNAME + + # Run an available action for an application + argocd app actions run APPNAME ACTION --kind KIND [--resource-name RESOURCE] [--namespace NAMESPACE] [--group GROUP] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for actions| + + +### 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 app](argocd_app.md) - Manage applications +* [argocd app actions list](argocd_app_actions_list.md) - Lists available actions on a resource +* [argocd app actions run](argocd_app_actions_run.md) - Runs an available action on resource(s) + diff --git a/docs/cli/argocd_app_actions_list.md b/docs/cli/argocd_app_actions_list.md new file mode 100644 index 000000000..411ea1869 --- /dev/null +++ b/docs/cli/argocd_app_actions_list.md @@ -0,0 +1,63 @@ +# `argocd app actions list` Command Reference + +## argocd app actions list + +Lists available actions on a resource + +``` +argocd app actions list APPNAME [flags] +``` + +### Examples + +``` + # List all the available actions for an application + argocd app actions list APPNAME +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --group | string | Group | +| -h, --help | | | help for list | +| --kind | string | Kind | +| --namespace | string | Namespace | +| -o, --out | string | Output format. One of: yaml, json | +| --resource-name | string | Name of resource| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --group | string | Group | +| --kind | string | Kind | +| --namespace | string | Namespace | +| --resource-name | string | Name of resource | +| --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 app actions](argocd_app_actions.md) - Manage Resource actions diff --git a/docs/cli/argocd_app_actions_run.md b/docs/cli/argocd_app_actions_run.md new file mode 100644 index 000000000..475d76be9 --- /dev/null +++ b/docs/cli/argocd_app_actions_run.md @@ -0,0 +1,64 @@ +# `argocd app actions run` Command Reference + +## argocd app actions run + +Runs an available action on resource(s) + +``` +argocd app actions run APPNAME ACTION [flags] +``` + +### Examples + +``` + # Run an available action for an application + argocd app actions run APPNAME ACTION --kind KIND [--resource-name RESOURCE] [--namespace NAMESPACE] [--group GROUP] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --all | | Indicates whether to run the action on multiple matching resources | +| --group | string | Group | +| -h, --help | | help for run | +| --kind | string | Kind | +| --namespace | string | Namespace | +| --resource-name | string | Name of resource| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --all| Indicates whether to run the action on multiple matching resources | +| --group | string | Group | +| --kind | string | Kind | +| --namespace | string | Namespace | +| --resource-name | string | Name of resource | +| --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 app actions](argocd_app_actions.md) - Manage Resource actions diff --git a/docs/cli/argocd_app_create.md b/docs/cli/argocd_app_create.md new file mode 100644 index 000000000..9369ded0d --- /dev/null +++ b/docs/cli/argocd_app_create.md @@ -0,0 +1,127 @@ +# `argocd app create` Command Reference + +## argocd app create + +Create an application + +``` +argocd app create APPNAME [flags] +``` + +### Examples + +``` + # Create a directory app + argocd app create guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --directory-recurse + + # Create a Jsonnet app + argocd app create jsonnet-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path jsonnet-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --jsonnet-ext-str replicas=2 + + # Create a Helm app + argocd app create helm-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path helm-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --helm-set replicaCount=2 + + # Create a Helm app from a Helm repo + argocd app create nginx-ingress --repo https://charts.helm.sh/stable --helm-chart nginx-ingress --revision 1.24.3 --dest-namespace default --dest-server https://kubernetes.default.svc + + # Create a Kustomize app + argocd app create kustomize-guestbook --repo https://github.com/argoproj/argocd-example-apps.git --path kustomize-guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --kustomize-image gcr.io/heptio-images/ks-guestbook-demo:0.1 + + # Create a app using a custom tool: + argocd app create kasane --repo https://github.com/argoproj/argocd-example-apps.git --path plugins/kasane --dest-namespace default --dest-server https://kubernetes.default.svc --config-management-plugin kasane +``` + +### Options +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-empty| Set allow zero live resources when sync is automated | +| --annotations | string Array| Set metadata annotations (e.g. example=value) | +| -N, --app-namespace | string | Namespace where the application will be created in| +| --auto-prune| Set automatic pruning when sync is automated | +| --config-management-plugin | string | Config management plugin name | +| --dest-name | string | K8s cluster Name (e.g. minikube) | +| --dest-namespace | string | K8s target namespace | +| --dest-server | string | K8s cluster URL (e.g. https://kubernetes.default.svc) | +| --directory-exclude | string | Set glob expression used to exclude files from application source path | +| --directory-include | string | Set glob expression used to include files from application source path | +| --directory-recurse| Recurse directory | +| --env | string | Application environment to monitor | +| -f, --file | string | Filename or URL to Kubernetes manifests for the app| +| --helm-chart | string | Helm Chart name | +| --helm-pass-credentials| Pass credentials to all domain | +| --helm-set | string Array| Helm set values on the command line (can be repeated to set several values: --helm-set key1=val1 --helm-set key2=val2) | +| --helm-set-file | string Array| Helm set values from respective files specified via the command line (can be repeated to set several values: --helm-set-file key1=path1 --helm-set-file key2=path2) | +| --helm-set-string | string Array| Helm set STRING values on the command line (can be repeated to set several values: --helm-set-string key1=val1 --helm-set-string key2=val2) | +| --helm-skip-crds| Skip helm crd installation step | +| --helm-version | string | Helm version | +| -h, --help | | help for create| +| --ignore-missing-value-files| Ignore locally missing valueFiles when setting helm template --values | +| --jsonnet-ext-var-code | string Array| Jsonnet ext var | +| --jsonnet-ext-var-str | string Array| Jsonnet | string ext var | +| --jsonnet-libs | string Array| Additional jsonnet libs (prefixed by repoRoot) | +| --jsonnet-tla-code | string Array| Jsonnet top level code arguments | +| --jsonnet-tla-str | string Array| Jsonnet top level | string arguments | +| --kustomize-common-annotation | string Array| Set common labels in Kustomize | +| --kustomize-common-label | string Array| Set common labels in Kustomize | +| --kustomize-force-common-annotation| Force common annotations in Kustomize | +| --kustomize-force-common-label| Force common labels in Kustomize | +| --kustomize-image | string Array| Kustomize images (e.g. --kustomize-image node:8.15.0 --kustomize-image mysql=mariadb,alpine@sha256:24a0c4b4a4c0eb97a1aabb8e29f18e917d05abfe1b7a7c07857230879ce7d3d) | +| --kustomize-namespace | string | Kustomize namespace | +| --kustomize-replica | string Array| Kustomize replicas (e.g. --kustomize-replica my-development=2 --kustomize-replica my-statefulset=4) | +| --kustomize-version | string | Kustomize version | + -l, --label stringArray Labels to apply to the app +| --name | string | A name for the app, ignored if a file is set (DEPRECATED) | +| --nameprefix | string | Kustomize nameprefix | +| --namesuffix | string | Kustomize namesuffix | + -p, --parameter stringArray set a parameter override (e.g. -p guestbook=image=example/guestbook:latest) +| --path | string | Path in repository to the app directory, ignored if a file is set | +| --plugin-env | string Array| Additional plugin envs | +| --project | string | Application project name | +| --release-name | string | Helm release-name | +| --repo | string | Repository URL, ignored if a file is set | +| --revision | string | The tracking source branch, tag, commit or Helm chart version the application will sync to | +| --revision-history-limit | int | How many items to keep in revision history (default 10) | +| --self-heal| Set self healing when sync is automated | +| --set-finalizer| Sets deletion finalizer on the application, application resources will be cascaded on deletion | +| --sync-option Prune=false| Add or remove a sync option, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false` | +| --sync-policy | string | Set the sync policy (one of: none, automated (aliases of automated: auto, automatic)) | +| --sync-retry-backoff-duration duration| Sync retry backoff base duration. Input needs to be a duration (e.g. 2m, 1h) (default 5s) | +| --sync-retry-backoff-factor | int | Factor multiplies the base duration after each failed sync retry (default 2) | +| --sync-retry-backoff-max-duration duration| Max sync retry backoff duration. Input needs to be a duration (e.g. 2m, 1h) (default 3m0s) | +| --sync-retry-limit | int | Max number of allowed sync retries | +| --upsert| Allows to override application with the same name even if supplied application spec is different from existing spec | +| --validate| Validation of repo and cluster (default true) | +| --values | string Array| Helm values file(s) to use | +| --values-literal-file | string | Filename or URL to import as a literal Helm values block | + +### 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 app](argocd_app.md) - Manage applications + diff --git a/docs/cli/argocd_app_delete-resource.md b/docs/cli/argocd_app_delete-resource.md new file mode 100644 index 000000000..29443c3ec --- /dev/null +++ b/docs/cli/argocd_app_delete-resource.md @@ -0,0 +1,56 @@ +# `argocd app delete-resource` Command Reference + +## argocd app delete-resource + +Delete resource in an application + +``` +argocd app delete-resource APPNAME [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --all| Indicates whether to patch multiple matching of resources | +| --force| Indicates whether to orphan the dependents of the deleted resource | +| --group | string | Group | +| -h, --help | | help for delete-resource| +| --kind | string | Kind | +| --namespace | string | Namespace | +| --orphan| Indicates whether to force delete the resource | +| --project | string | The name of the application's project - specifying this allows the command to report "not found" instead of "permission denied" if the app does not exist | +| --resource-name | string | Name of resource | + +### 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 app](argocd_app.md) - Manage applications + diff --git a/docs/cli/argocd_app_delete.md b/docs/cli/argocd_app_delete.md new file mode 100644 index 000000000..aaf188a03 --- /dev/null +++ b/docs/cli/argocd_app_delete.md @@ -0,0 +1,69 @@ +# `argocd app delete` Command Reference + +## argocd app delete + +Delete an application + +``` +argocd app delete APPNAME [flags] +``` + +### Examples + +``` + # Delete an app + argocd app delete my-app + + # Delete multiple apps + argocd app delete my-app other-app + + # Delete apps by label + argocd app delete -l app.kubernetes.io/instance=my-app + argocd app delete -l app.kubernetes.io/instance!=my-app + argocd app delete -l app.kubernetes.io/instance + argocd app delete -l '!app.kubernetes.io/instance' + argocd app delete -l 'app.kubernetes.io/instance notin (my-app,other-app)' +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --cascade| Perform a cascaded deletion of all application resources (default true) | +| -h, --help | | help for delete | +| -p, --propagation-policy| string | Specify propagation policy for deletion of application's resources. One of: foreground|background (default "foreground") | +| -l, --selector| string | Delete all apps with matching label. Supports '=', '==', '!=', in, notin, exists & not exists. Matching apps must satisfy all of the specified label constraints.| +| -y, --yes | | Turn off prompting to confirm cascaded deletion of application resources| + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_diff.md b/docs/cli/argocd_app_diff.md new file mode 100644 index 000000000..8c109c7f9 --- /dev/null +++ b/docs/cli/argocd_app_diff.md @@ -0,0 +1,61 @@ +# `argocd app diff` Command Reference + +## argocd app diff + +Perform a diff against the target and live state. + +### Synopsis + +Perform a diff against the target and live state. +Uses 'diff' to render the difference. KUBECTL_EXTERNAL_DIFF environment variable can be used to select your own diff tool. +Returns the following exit codes: 2 on general errors, 1 when a diff is found, and 0 when no diff is found + +``` +argocd app diff APPNAME [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --exit-code| Return non-zero exit code when there is a diff (default true) | +| --hard-refresh| Refresh application data as well as target manifests cache | +| --local | string | Compare live app to a local manifests | +| --local-include | string Array| Used with --server-side-generate, specify patterns of filenames to send. Matching is based on filename and not path. (default [*.yaml,*.yml,*.json]) | +| --local-repo-root | string | Path to the repository root. Used together with --local allows setting the repository root (default "/") | +| --refresh| Refresh application data when retrieving | +| --revision | string | Compare live app to a particular revision | +| --server-side-generate| Used with --local, this will send your manifests to the server for diffing | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_edit.md b/docs/cli/argocd_app_edit.md new file mode 100644 index 000000000..1883966f3 --- /dev/null +++ b/docs/cli/argocd_app_edit.md @@ -0,0 +1,48 @@ +# `argocd app edit` Command Reference + +## argocd app edit + +Edit application + +``` +argocd app edit APPNAME [flags] +``` + +### Options + +``` + -h, --help help for edit +``` + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_get.md b/docs/cli/argocd_app_get.md new file mode 100644 index 000000000..f0bb9955f --- /dev/null +++ b/docs/cli/argocd_app_get.md @@ -0,0 +1,84 @@ +# `argocd app get` Command Reference + +## argocd app get + +Get application details + +``` +argocd app get APPNAME [flags] +``` + +### Examples + +``` + # Get basic details about the application "my-app" in wide format + argocd app get my-app -o wide + + # Get detailed information about the application "my-app" in YAML format + argocd app get my-app -o yaml + + # Get details of the application "my-app" in JSON format + argocd get my-app -o json + + # Get application details and include information about the current operation + argocd app get my-app --show-operation + + # Show application parameters and overrides + argocd app get my-app --show-params + + # Refresh application data when retrieving + argocd app get my-app --refresh + + # Perform a hard refresh, including refreshing application data and target manifests cache + argocd app get my-app --hard-refresh + + # Get application details and display them in a tree format + argocd app get my-app --output tree + + # Get application details and display them in a detailed tree format + argocd app get my-app --output tree=detailed +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --hard-refresh| Refresh application data as well as target manifests cache | +| -h, --help | | help for get| +| -o, --output | string |Output format. One of: json|yaml|wide|tree (default "wide")| +| --refresh| Refresh application data when retrieving | +| --show-operation| Show application operation | +| --show-params| Show application parameters and overrides | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_history.md b/docs/cli/argocd_app_history.md new file mode 100644 index 000000000..be021e322 --- /dev/null +++ b/docs/cli/argocd_app_history.md @@ -0,0 +1,49 @@ +# `argocd app history` Command Reference + +## argocd app history + +Show application deployment history + +``` +argocd app history APPNAME [flags] +``` + +### Options + +``` + -h, --help help for history + -o, --output string Output format. One of: wide|id (default "wide") +``` + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_list.md b/docs/cli/argocd_app_list.md new file mode 100644 index 000000000..00cd92538 --- /dev/null +++ b/docs/cli/argocd_app_list.md @@ -0,0 +1,68 @@ +# `argocd app list` Command Reference + +## argocd app list + +List applications + +``` +argocd app list [flags] +``` + +### Examples + +``` + # List all apps + argocd app list + + # List apps by label, in this example we listing apps that are children of another app (aka app-of-apps) + argocd app list -l app.kubernetes.io/instance=my-app + argocd app list -l app.kubernetes.io/instance!=my-app + argocd app list -l app.kubernetes.io/instance + argocd app list -l '!app.kubernetes.io/instance' + argocd app list -l 'app.kubernetes.io/instance notin (my-app,other-app)' +``` + +### Options + +``` + -N, --app-namespace string Only list applications in namespace + -c, --cluster string List apps by cluster name or url + -h, --help help for list + -o, --output string Output format. One of: wide|name|json|yaml (default "wide") + -p, --project stringArray Filter by project name + -r, --repo string List apps by source repo URL + -l, --selector string List apps by label. Supports '=', '==', '!=', in, notin, exists & not exists. Matching apps must satisfy all of the specified label constraints. +``` + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_logs.md b/docs/cli/argocd_app_logs.md new file mode 100644 index 000000000..4783e9349 --- /dev/null +++ b/docs/cli/argocd_app_logs.md @@ -0,0 +1,99 @@ +# `argocd app logs` Command Reference + +## argocd app logs + +Get logs of application pods + +``` +argocd app logs APPNAME [flags] +``` + +### Examples + +``` + # Get logs of pods associated with the application "my-app" + argocd app logs my-app + + # Get logs of pods associated with the application "my-app" in a specific resource group + argocd app logs my-app --group my-group + + # Get logs of pods associated with the application "my-app" in a specific resource kind + argocd app logs my-app --kind my-kind + + # Get logs of pods associated with the application "my-app" in a specific namespace + argocd app logs my-app --namespace my-namespace + + # Get logs of pods associated with the application "my-app" for a specific resource name + argocd app logs my-app --name my-resource + + # Stream logs in real-time for the application "my-app" + argocd app logs my-app -f + + # Get the last N lines of logs for the application "my-app" + argocd app logs my-app --tail 100 + + # Get logs since a specified number of seconds ago + argocd app logs my-app --since-seconds 3600 + + # Get logs until a specified time (format: "2023-10-10T15:30:00Z") + argocd app logs my-app --until-time "2023-10-10T15:30:00Z" + + # Filter logs to show only those containing a specific string + argocd app logs my-app --filter "error" + + # Get logs for a specific container within the pods + argocd app logs my-app -c my-container + + # Get previously terminated container logs + argocd app logs my-app -p +``` + +### Options + + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -c, --container | string | Optional container name | +| --filter | string | Show logs contain this | string | +| -f, --follow | | Specify if the logs should be streamed | +| --group | string | Resource group | +| -h, --help | | help for logs | +| --kind | string | Resource kind | +| --name | string | Resource name | +| --namespace | string | Resource namespace | + -p, --previous | | Specify if the previously terminated container logs should be returned +| --since-seconds | int | A relative time in seconds before the current time from which to show logs | +| --tail | int | The number of lines from the end of the logs to show | +| --until-time | string | Show logs until this time | + +### 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 app](argocd_app.md) - Manage applications + diff --git a/docs/cli/argocd_app_manifests.md b/docs/cli/argocd_app_manifests.md new file mode 100644 index 000000000..1501abfe7 --- /dev/null +++ b/docs/cli/argocd_app_manifests.md @@ -0,0 +1,51 @@ +# `argocd app manifests` Command Reference + +## argocd app manifests + +Print manifests of an application + +``` +argocd app manifests APPNAME [flags] +``` + +### Options + + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | help for manifests | +| --local | string | If set, show locally-generated manifests. Value is the absolute path to app manifests within the manifest repo. Example: '/home/username/apps/env/app-1'. | +| --local-repo-root | string | Path to the local repository root. Used together with --local allows setting the repository root. Example: '/home/username/apps'. (default ".") | +| --revision | string | Show manifests at a specific revision | +| --source | string | Source of manifests. One of: live|git (default "git") | + +### Options inherited from parent commands + + +| --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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_patch-resource.md b/docs/cli/argocd_app_patch-resource.md new file mode 100644 index 000000000..3bfe6896d --- /dev/null +++ b/docs/cli/argocd_app_patch-resource.md @@ -0,0 +1,54 @@ +# `argocd app patch-resource` Command Reference + +## argocd app patch-resource + +Patch resource in an application + +``` +argocd app patch-resource APPNAME [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --all| Indicates whether to patch multiple matching of resources | +| --group | string | Group | +| -h, --help | | help for patch-resource | +| --kind | string | Kind | +| --namespace | string | Namespace | +| --patch | string | Patch | +| --patch-type | string | Which Patching strategy to use: 'application/json-patch+json', 'application/merge-patch+json', or 'application/strategic-merge-patch+json'. Defaults to 'application/merge-patch+json' (default "application/merge-patch+json") | +| --project | string | The name of the application's project - specifying this allows the command to report "not found" instead of "permission denied" if the app does not exist | +| --resource-name | string | Name of resource | +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_patch.md b/docs/cli/argocd_app_patch.md new file mode 100644 index 000000000..93e3192f8 --- /dev/null +++ b/docs/cli/argocd_app_patch.md @@ -0,0 +1,60 @@ +# `argocd app patch` Command Reference + +## argocd app patch + +Patch application + +``` +argocd app patch APPNAME [flags] +``` + +### Examples + +``` + # Update an application's source path using json patch + argocd app patch myapplication --patch='[{"op": "replace", "path": "/spec/source/path", "value": "newPath"}]' --type json + + # Update an application's repository target revision using merge patch + argocd app patch myapplication --patch '{"spec": { "source": { "targetRevision": "master" } }}' --type merge +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | help for patch | +| --patch | string | Patch body | +| --type | string | The type of patch being provided; one of [json merge] (default "json") | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_resources.md b/docs/cli/argocd_app_resources.md new file mode 100644 index 000000000..f5145f799 --- /dev/null +++ b/docs/cli/argocd_app_resources.md @@ -0,0 +1,51 @@ +# `argocd app resources` Command Reference + +## argocd app resources + +List resource of application + +``` +argocd app resources APPNAME [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for resources| +| --orphaned| Lists only orphaned resources | +| --output | string | Provides the tree view of the resources | +| --project | string | The name of the application's project - specifying this allows the command to report "not found" instead of "permission denied" if the app does not exist | + +### 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 app](argocd_app.md) - Manage applications + diff --git a/docs/cli/argocd_app_rollback.md b/docs/cli/argocd_app_rollback.md new file mode 100644 index 000000000..04d9ef9c3 --- /dev/null +++ b/docs/cli/argocd_app_rollback.md @@ -0,0 +1,51 @@ +# `argocd app rollback` Command Reference + +## argocd app rollback + +Rollback application to a previous deployed version by History ID, omitted will Rollback to the previous version + +``` +argocd app rollback APPNAME [ID] [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for rollback | +|-o, --output | string | Output format. One of: json|yaml|wide|tree|tree=detailed (default "wide") | +| --prune| Allow deleting unexpected resources | +| --timeout uint| Time out after this many seconds | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_set.md b/docs/cli/argocd_app_set.md new file mode 100644 index 000000000..8bea66281 --- /dev/null +++ b/docs/cli/argocd_app_set.md @@ -0,0 +1,116 @@ +# `argocd app set` Command Reference + +## argocd app set + +Set application parameters + +``` +argocd app set APPNAME [flags] +``` + +### Examples + +``` + # Set application parameters for the application "my-app" + argocd app set my-app --parameter key1=value1 --parameter key2=value2 + + # Set and validate application parameters for "my-app" + argocd app set my-app --parameter key1=value1 --parameter key2=value2 --validate + + # Set and override application parameters with JSON or YAML file + argocd app set my-app --from-file path/to/parameters.json + + # Set and override application parameters with a parameter file + argocd app set my-app --parameter-file path/to/parameter-file.yaml + + # Set application parameters and specify the namespace + argocd app set my-app --parameter key1=value1 --parameter key2=value2 --namespace my-namespace +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-empty| Set allow zero live resources when sync is automated | +| --auto-prune| Set automatic pruning when sync is automated | +| --config-management-plugin | string | Config management plugin name | +| --dest-name | string | K8s cluster Name (e.g. minikube) | +| --dest-namespace | string | K8s target namespace | +| --dest-server | string | K8s cluster URL (e.g. https://kubernetes.default.svc) | +| --directory-exclude | string | Set glob expression used to exclude files from application source path | +| --directory-include | string | Set glob expression used to include files from application source path | +| --directory-recurse| Recurse directory | +| --env | string | Application environment to monitor | +| --helm-chart | string | Helm Chart name | +| --helm-pass-credentials| Pass credentials to all domain | +| --helm-set | string Array| Helm set values on the command line (can be repeated to set several values: --helm-set key1=val1 --helm-set key2=val2) | +| --helm-set-file | string Array| Helm set values from respective files specified via the command line (can be repeated to set several values: --helm-set-file key1=path1 --helm-set-file key2=path2) | +| --helm-set-string | string Array| Helm set STRING values on the command line (can be repeated to set several values: --helm-set-string key1=val1 --helm-set-string key2=val2) | +| --helm-skip-crds| Skip helm crd installation step | +| --helm-version | string | Helm version | +| --ignore-missing-value-files| Ignore locally missing valueFiles when setting helm template --values | +| --jsonnet-ext-var-code | string Array| Jsonnet ext var | +| --jsonnet-ext-var-str | string Array| Jsonnet | string ext var | +| --jsonnet-libs | string Array| Additional jsonnet libs (prefixed by repoRoot) | +| --jsonnet-tla-code | string Array| Jsonnet top level code arguments | +| --jsonnet-tla-str | string Array| Jsonnet top level | string arguments | +| --kustomize-common-annotation | string Array| Set common labels in Kustomize | +| --kustomize-common-label | string Array| Set common labels in Kustomize | +| --kustomize-force-common-annotation| Force common annotations in Kustomize | +| --kustomize-force-common-label| Force common labels in Kustomize | +| --kustomize-image | string Array| Kustomize images (e.g. --kustomize-image node:8.15.0 --kustomize-image mysql=mariadb,alpine@sha256:24a0c4b4a4c0eb97a1aabb8e29f18e917d05abfe1b7a7c07857230879ce7d3d) | +| --kustomize-namespace | string | Kustomize namespace | +| --kustomize-replica | string Array| Kustomize replicas (e.g. --kustomize-replica my-development=2 --kustomize-replica my-statefulset=4) | +| --kustomize-version | string | Kustomize version | +| --nameprefix | string | Kustomize nameprefix | +| --namesuffix | string | Kustomize namesuffix | +| --path | string | Path in repository to the app directory, ignored if a file is set | +| --plugin-env | string Array| Additional plugin envs | +| --project | string | Application project name | +| --release-name | string | Helm release-name | +| --repo | string | Repository URL, ignored if a file is set | +| --revision | string | The tracking source branch, tag, commit or Helm chart version the application will sync to | +| --revision-history-limit | int | How many items to keep in revision history (default 10) | +| --self-heal| Set self healing when sync is automated | +| --sync-option Prune=false| Add or remove a sync option, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false` | +| --sync-policy | string | Set the sync policy (one of: none, automated (aliases of automated: auto, automatic)) | +| --sync-retry-backoff-duration duration| Sync retry backoff base duration. Input needs to be a duration (e.g. 2m, 1h) (default 5s) | +| --sync-retry-backoff-factor | int | Factor multiplies the base duration after each failed sync retry (default 2) | +| --sync-retry-backoff-max-duration duration| Max sync retry backoff duration. Input needs to be a duration (e.g. 2m, 1h) (default 3m0s) | +| --sync-retry-limit | int | Max number of allowed sync retries | +| --validate| Validation of repo and cluster (default true) | +| --values | string Array| Helm values file(s) to use | +| --values-literal-file | string | Filename or URL to import as a literal Helm values block | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_sync.md b/docs/cli/argocd_app_sync.md new file mode 100644 index 000000000..916fd8695 --- /dev/null +++ b/docs/cli/argocd_app_sync.md @@ -0,0 +1,99 @@ +# `argocd app sync` Command Reference + +## argocd app sync + +Sync an application to its target state + +``` +argocd app sync [APPNAME... | -l selector | --project project-name] [flags] +``` + +### Examples + +``` + # Sync an app + argocd app sync my-app + + # Sync multiples apps + argocd app sync my-app other-app + + # Sync apps by label, in this example we sync apps that are children of another app (aka app-of-apps) + argocd app sync -l app.kubernetes.io/instance=my-app + argocd app sync -l app.kubernetes.io/instance!=my-app + argocd app sync -l app.kubernetes.io/instance + argocd app sync -l '!app.kubernetes.io/instance' + argocd app sync -l 'app.kubernetes.io/instance notin (my-app,other-app)' + + # Sync a specific resource + # Resource should be formatted as GROUP:KIND:NAME. If no GROUP is specified then :KIND:NAME + argocd app sync my-app --resource :Service:my-service + argocd app sync my-app --resource argoproj.io:Rollout:my-rollout + argocd app sync my-app --resource '!apps:Deployment:my-service' + argocd app sync my-app --resource apps:Deployment:my-service --resource :Service:my-service + argocd app sync my-app --resource '!*:Service:*' + # Specify namespace if the application has resources with the same name in different namespaces + argocd app sync my-app --resource argoproj.io:Rollout:my-namespace/my-rollout +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --apply-out-of-sync-only| Sync only out-of-sync resources | +| --assumeYes| Assume yes as answer for all user queries or prompts | +| --async| Do not wait for application to sync before continuing | +| --dry-run| Preview apply without affecting cluster | +| --force| Use a force apply | +| -h, --help | | help for sync | +| --info | string Array| A list of key-value pairs during sync process. These infos will be persisted in app. | +| --label | string Array| Sync only specific resources with a label. This option may be specified repeatedly. | +| --local | string | Path to a local directory. When this flag is present no git queries will be made | +| --local-repo-root | string | Path to the repository root. Used together with --local allows setting the repository root (default "/") | +| -o, --output | string | Output format. One of: json|yaml|wide|tree|tree=detailed (default "wide") | +| --preview-changes| Preview difference against the target and live state before syncing app and wait for user confirmation | +| --project | string Array| Sync apps that belong to the specified projects. This option may be specified repeatedly. | +| --prune| Allow deleting unexpected resources | +| --replace| Use a kubectl create/replace instead apply | +| --resource | string Array| Sync only specific resources as GROUP:KIND:NAME or !GROUP:KIND:NAME. Fields may be blank and '*' can be used. This option may be specified repeatedly | +| --retry-backoff-duration duration| Retry backoff base duration. Input needs to be a duration (e.g. 2m, 1h) (default 5s) | +| --retry-backoff-factor | int | Factor multiplies the base duration after each failed retry (default 2) | +| --retry-backoff-max-duration duration| Max retry backoff duration. Input needs to be a duration (e.g. 2m, 1h) (default 3m0s) | +| --retry-limit | int | Max number of allowed sync retries | +| --revision | string | Sync to a specific revision. Preserves parameter overrides | +| -l, --selector |string | Sync apps that match this label. Supports '=', '==', '!=', in, notin, exists & not exists. Matching apps must satisfy all of the specified label constraints.| +| --server-side| Use server-side apply while syncing the application | +| --strategy | string | Sync strategy (one of: apply|hook) | +| --timeout uint| Time out after this many seconds | + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_terminate-op.md b/docs/cli/argocd_app_terminate-op.md new file mode 100644 index 000000000..e1ad9e416 --- /dev/null +++ b/docs/cli/argocd_app_terminate-op.md @@ -0,0 +1,48 @@ +# `argocd app terminate-op` Command Reference + +## argocd app terminate-op + +Terminate running operation of an application + +``` +argocd app terminate-op APPNAME [flags] +``` + +### Options + +``` + -h, --help help for terminate-op +``` + +### 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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_unset.md b/docs/cli/argocd_app_unset.md new file mode 100644 index 000000000..6bcee39a0 --- /dev/null +++ b/docs/cli/argocd_app_unset.md @@ -0,0 +1,72 @@ +# `argocd app unset` Command Reference + +## argocd app unset + +Unset application parameters + +``` +argocd app unset APPNAME parameters [flags] +``` + +### Examples + +``` + # Unset kustomize override kustomize image + argocd app unset my-app --kustomize-image=alpine + + # Unset kustomize override prefix + argocd app unset my-app --namesuffix + + # Unset parameter override + argocd app unset my-app -p COMPONENT=PARAM +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for unset| +| --ignore-missing-value-files| Unset the helm ignore-missing-value-files option (revert to false) | +| --kustomize-image | string Array| Kustomize images name (e.g. --kustomize-image node --kustomize-image mysql) | +| --kustomize-namespace| Kustomize namespace | +| --kustomize-replica | string Array| Kustomize replicas name (e.g. --kustomize-replica my-deployment --kustomize-replica my-statefulset) | +| --kustomize-version| Kustomize version | +| --nameprefix| Kustomize nameprefix | +| --namesuffix| Kustomize namesuffix | +|-p, --parameter | stringArray | Unset a parameter override (e.g. -p guestbook=image) | +| --pass-credentials| Unset passCredentials | +| --plugin-env | string Array| Unset plugin env variables (e.g --plugin-env name) | +| --values | string Array| Unset one or more Helm values files | +| --values-literal| Unset literal Helm values block | + +### Options inherited from parent commands + + +| --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 app](argocd_app.md) - Manage applications + + diff --git a/docs/cli/argocd_app_wait.md b/docs/cli/argocd_app_wait.md new file mode 100644 index 000000000..8d9229d60 --- /dev/null +++ b/docs/cli/argocd_app_wait.md @@ -0,0 +1,84 @@ +# `argocd app wait` Command Reference + +## argocd app wait + +Wait for an application to reach a synced and healthy state + +``` +argocd app wait [APPNAME.. | -l selector] [flags] +``` + +### Examples + +``` + # Wait for an app + argocd app wait my-app + + # Wait for multiple apps + argocd app wait my-app other-app + + # Wait for apps by resource + # Resource should be formatted as GROUP:KIND:NAME. If no GROUP is specified then :KIND:NAME. + argocd app wait my-app --resource :Service:my-service + argocd app wait my-app --resource argoproj.io:Rollout:my-rollout + argocd app wait my-app --resource '!apps:Deployment:my-service' + argocd app wait my-app --resource apps:Deployment:my-service --resource :Service:my-service + argocd app wait my-app --resource '!*:Service:*' + # Specify namespace if the application has resources with the same name in different namespaces + argocd app wait my-app --resource argoproj.io:Rollout:my-namespace/my-rollout + + # Wait for apps by label, in this example we waiting for apps that are children of another app (aka app-of-apps) + argocd app wait -l app.kubernetes.io/instance=my-app + argocd app wait -l app.kubernetes.io/instance!=my-app + argocd app wait -l app.kubernetes.io/instance + argocd app wait -l '!app.kubernetes.io/instance' + argocd app wait -l 'app.kubernetes.io/instance notin (my-app,other-app)' +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --degraded| Wait for degraded | +| --health| Wait for health | +|-h, --help | help for wait | +| --operation| Wait for pending operations | +| --resource | string Array| Sync only specific resources as GROUP:KIND:NAME or !GROUP:KIND:NAME. Fields may be blank and '*' can be used. This option may be specified repeatedly | +| -l, --selector | string | Wait for apps by label. Supports '=', '==', '!=', in, notin, exists & not exists. Matching apps must satisfy all of the specified label constraints.| +| --suspended| Wait for suspended | +| --sync| Wait for sync | +| --timeout uint| Time out after this many seconds | + +### 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 app](argocd_app.md) - Manage applications + + + diff --git a/docs/cli/argocd_appset.md b/docs/cli/argocd_appset.md new file mode 100644 index 000000000..47045c8f0 --- /dev/null +++ b/docs/cli/argocd_appset.md @@ -0,0 +1,83 @@ +# `argocd appset` Command Reference + +## argocd appset + +Manage ApplicationSets + +``` +argocd appset [flags] +``` + +### Examples + +``` + # Get an ApplicationSet. + argocd appset get APPSETNAME + + # List all the ApplicationSets + argocd appset list + + # Create an ApplicationSet from a YAML stored in a file or at given URL + argocd appset create (...) + + # Delete an ApplicationSet + argocd appset delete APPSETNAME (APPSETNAME...) +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd appset create](argocd_appset_create.md) - Create one or more ApplicationSets +* [argocd appset delete](argocd_appset_delete.md) - Delete one or more ApplicationSets +* [argocd appset get](argocd_appset_get.md) - Get ApplicationSet details +* [argocd appset list](argocd_appset_list.md) - List ApplicationSets diff --git a/docs/cli/argocd_appset_create.md b/docs/cli/argocd_appset_create.md new file mode 100644 index 000000000..1441b44ae --- /dev/null +++ b/docs/cli/argocd_appset_create.md @@ -0,0 +1,54 @@ +# `argocd appset create` Command Reference + +## argocd appset create + +Create one or more ApplicationSets + +``` +argocd appset create [flags] +``` + +### Examples + +``` + # Create ApplicationSets + argocd appset create (...) +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | help for create | +| --upsert| Allows to override ApplicationSet with the same name even if supplied ApplicationSet spec is different from existing spec | + +### 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 appset](argocd_appset.md) - Manage ApplicationSets diff --git a/docs/cli/argocd_appset_delete.md b/docs/cli/argocd_appset_delete.md new file mode 100644 index 000000000..009b482fb --- /dev/null +++ b/docs/cli/argocd_appset_delete.md @@ -0,0 +1,55 @@ +# `argocd appset delete` Command Reference + +## argocd appset delete + +Delete one or more ApplicationSets + +``` +argocd appset delete [flags] +``` + +### Examples + +``` + # Delete an applicationset + argocd appset delete APPSETNAME (APPSETNAME...) +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for delete| +| -y, --yes | | Turn off prompting to confirm cascaded deletion of Application resources| + + +### 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 appset](argocd_appset.md) - Manage ApplicationSets diff --git a/docs/cli/argocd_appset_get.md b/docs/cli/argocd_appset_get.md new file mode 100644 index 000000000..a6939e8d0 --- /dev/null +++ b/docs/cli/argocd_appset_get.md @@ -0,0 +1,59 @@ +# `argocd appset get` Command Reference + +## argocd appset get + +Get ApplicationSet details + +``` +argocd appset get APPSETNAME [flags] +``` + +### Examples + +``` + # Get ApplicationSets + argocd appset get APPSETNAME +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for get| +| -o, --output | string | Output format. One of: json|yaml|wide (default "wide")| +| --show-params| |Show ApplicationSet parameters and overrides| + + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --show-params| Show ApplicationSet parameters and overrides | +| --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 appset](argocd_appset.md) - Manage ApplicationSets + + diff --git a/docs/cli/argocd_appset_list.md b/docs/cli/argocd_appset_list.md new file mode 100644 index 000000000..94dab5be3 --- /dev/null +++ b/docs/cli/argocd_appset_list.md @@ -0,0 +1,58 @@ +# `argocd appset list` Command Reference + +## argocd appset list + +List ApplicationSets + +``` +argocd appset list [flags] +``` + +### Examples + +``` + # List all ApplicationSets + argocd appset list +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -N, --appset-namespace | string | Only list applicationsets in namespace| +| -h, --help | | help for list| +| -o, --output | string | Output format. One of: wide|name|json|yaml (default "wide")| +| -p, --project |stringArray | Filter by project name| +| -l, --selector| string | List applicationsets by label| + + +### 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 appset](argocd_appset.md) - Manage ApplicationSets diff --git a/docs/cli/argocd_appset_update.md b/docs/cli/argocd_appset_update.md new file mode 100644 index 000000000..38516dbc8 --- /dev/null +++ b/docs/cli/argocd_appset_update.md @@ -0,0 +1,49 @@ +## argocd appset update + +Updates the given ApplicationSet(s) + +``` +argocd appset update [flags] +``` + +### Examples + +``` + + # Update ApplicationSet + argocd appset update (...) + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for update| + + +### 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") | +| --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 | +| --server | string | Argo CD server address | +| --server-crt | string | Server certificate file | + +### SEE ALSO + +* [argocd appset](argocd_appset.md) - Manage ApplicationSets diff --git a/docs/cli/argocd_cert.md b/docs/cli/argocd_cert.md new file mode 100644 index 000000000..a161d4005 --- /dev/null +++ b/docs/cli/argocd_cert.md @@ -0,0 +1,92 @@ +# `argocd cert` Command Reference + +## argocd cert + +Manage repository certificates and SSH known hosts entries + +``` +argocd cert [flags] +``` + +### Examples + +``` + # Add a TLS certificate for cd.example.com to ArgoCD cert store from a file + argocd cert add-tls --from ~/mycert.pem cd.example.com + + # Add a TLS certificate for cd.example.com to ArgoCD via stdin + cat ~/mycert.pem | argocd cert add-tls cd.example.com + + # Add SSH known host entries for cd.example.com to ArgoCD by scanning host + ssh-keyscan cd.example.com | argocd cert add-ssh --batch + + # List all known TLS certificates + argocd cert list --cert-type https + + # Remove all TLS certificates for cd.example.com + argocd cert rm --cert-type https cd.example.com + + # Remove all certificates and SSH known host entries for cd.example.com + argocd cert rm cd.example.com + +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd cert add-ssh](argocd_cert_add-ssh.md) - Add SSH known host entries for repository servers +* [argocd cert add-tls](argocd_cert_add-tls.md) - Add TLS certificate data for connecting to repository server SERVERNAME +* [argocd cert list](argocd_cert_list.md) - List configured certificates +* [argocd cert rm](argocd_cert_rm.md) - Remove certificate of TYPE for REPOSERVER + + diff --git a/docs/cli/argocd_cert_add-ssh.md b/docs/cli/argocd_cert_add-ssh.md new file mode 100644 index 000000000..0fc218250 --- /dev/null +++ b/docs/cli/argocd_cert_add-ssh.md @@ -0,0 +1,51 @@ +# `argocd cert add-ssh` Command Reference + +## argocd cert add-ssh + +Add SSH known host entries for repository servers + +``` +argocd cert add-ssh --batch [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --batch| Perform batch processing by reading in SSH known hosts data (mandatory flag) | +| --from | string | Read SSH known hosts data from file (default is to read from stdin) | +| -h, --help | | help for add-ssh| +| --upsert| Replace existing SSH server public host keys if key is different in input | + +### 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 cert](argocd_cert.md) - Manage repository certificates and SSH known hosts entries + + diff --git a/docs/cli/argocd_cert_add-tls.md b/docs/cli/argocd_cert_add-tls.md new file mode 100644 index 000000000..8ddde4bf3 --- /dev/null +++ b/docs/cli/argocd_cert_add-tls.md @@ -0,0 +1,50 @@ +# `argocd cert add-tls` Command Reference + +## argocd cert add-tls + +Add TLS certificate data for connecting to repository server SERVERNAME + +``` +argocd cert add-tls SERVERNAME [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --from | string | Read TLS certificate data from file (default is to read from stdin) | +|h, --help | help for add-tls| +| --upsert| Replace existing TLS certificate if certificate is different in input | + +### 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 cert](argocd_cert.md) - Manage repository certificates and SSH known hosts entries + + diff --git a/docs/cli/argocd_cert_list.md b/docs/cli/argocd_cert_list.md new file mode 100644 index 000000000..44e2a1065 --- /dev/null +++ b/docs/cli/argocd_cert_list.md @@ -0,0 +1,58 @@ +# `argocd cert list` Command Reference + +## argocd cert list + +List configured certificates + +``` +argocd cert list [flags] +``` + +### Options + +``` + --cert-type string Only list certificates of given type, valid: 'ssh','https' + -h, --help help for list + --hostname-pattern string Only list certificates for hosts matching given glob-pattern + -o, --output string Output format. One of: json|yaml|wide (default "wide") + --sort string Set display sort order for output format wide. One of: hostname|type +``` +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --cert-type | string | Only list certificates of given type, valid: 'ssh','https' | +|-h, --help | | help for list +| --hostname-pattern | string | Only list certificates for hosts matching given glob-pattern | +|-o, --output| string| Output format. One of: json|yaml|wide (default "wide")| +| --sort | string | Set display sort order for output format wide. One of: hostname|type | +### 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 cert](argocd_cert.md) - Manage repository certificates and SSH known hosts entries + + diff --git a/docs/cli/argocd_cert_rm.md b/docs/cli/argocd_cert_rm.md new file mode 100644 index 000000000..cd2afc34d --- /dev/null +++ b/docs/cli/argocd_cert_rm.md @@ -0,0 +1,49 @@ +# `argocd cert rm` Command Reference + +## argocd cert rm + +Remove certificate of TYPE for REPOSERVER + +``` +argocd cert rm REPOSERVER [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for rm| +| --cert-sub-type | string | Only remove certs of given sub-type (only for ssh) | +| --cert-type | string | Only remove certs of given type (ssh, https) | +### 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 cert](argocd_cert.md) - Manage repository certificates and SSH known hosts entries + + diff --git a/docs/cli/argocd_cluster.md b/docs/cli/argocd_cluster.md new file mode 100644 index 000000000..9755b5973 --- /dev/null +++ b/docs/cli/argocd_cluster.md @@ -0,0 +1,91 @@ +# `argocd cluster` Command Reference + +## argocd cluster + +Manage cluster credentials + +``` +argocd cluster [flags] +``` + +### Examples + +``` + # List all known clusters in JSON format: + argocd cluster list -o json + + # Add a target cluster configuration to ArgoCD. The context must exist in your kubectl config: + argocd cluster add example-cluster + + # Get specific details about a cluster in plain text (wide) format: + argocd cluster get example-cluster -o wide + + # Remove a target cluster context from ArgoCD + argocd cluster rm example-cluster + + # Set a target cluster context from ArgoCD + argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace '*' + argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace namespace-one --namespace namespace-two +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd cluster add](argocd_cluster_add.md) - argocd cluster add CONTEXT +* [argocd cluster get](argocd_cluster_get.md) - Get cluster information +* [argocd cluster list](argocd_cluster_list.md) - List configured clusters +* [argocd cluster rm](argocd_cluster_rm.md) - Remove cluster credentials +* [argocd cluster rotate-auth](argocd_cluster_rotate-auth.md) - argocd cluster rotate-auth SERVER/NAME +* [argocd cluster set](argocd_cluster_set.md) - Set cluster information + + diff --git a/docs/cli/argocd_cluster_add.md b/docs/cli/argocd_cluster_add.md new file mode 100644 index 000000000..e99c3da63 --- /dev/null +++ b/docs/cli/argocd_cluster_add.md @@ -0,0 +1,68 @@ +# `argocd cluster add` Command Reference + +## argocd cluster add + +argocd cluster add CONTEXT + +``` +argocd cluster add CONTEXT [flags] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --annotation | string Array| Set metadata annotations (e.g. --annotation key=value) | +| --aws-cluster-name | string | AWS Cluster name if set then aws cli eks token command will be used to access cluster | +| --aws-profile | string | Optional AWS profile. If set then AWS IAM Authenticator uses this profile to perform cluster operations instead of the default AWS credential provider chain. | +| --aws-role-arn | string | Optional AWS role arn. If set then AWS IAM Authenticator assumes a role to perform cluster operations instead of the default AWS credential provider chain. | +| --cluster-endpoint | string | Cluster endpoint to use. Can be one of the following: 'kubeconfig', 'kube-public', or 'internal'. | +| --cluster-resources| Indicates if cluster level resources should be managed. The setting is used only if list of managed namespaces is not empty. | +| --exec-command | string | Command to run to provide client credentials to the cluster. You may need to build a custom ArgoCD image to ensure the command is available at runtime. | +| --exec-command-api-version | string | Preferred input version of the ExecInfo for the --exec-command executable | +| --exec-command-args | string Array| Arguments to supply to the --exec-command executable | +| --exec-command-env | string ToString| Environment vars to set when running the --exec-command executable (default []) | +| --exec-command-install-hint | string | Text shown to the user when the --exec-command executable doesn't seem to be present | +| --in-cluster| Indicates Argo CD resides inside this cluster and should connect using the | int ernal k8s hostname (kubernetes.default.svc) | +| --kubeconfig | string | use a particular kubeconfig file | +| --label | string Array| Set metadata labels (e.g. --label key=value) | +| --name | string | Overwrite the cluster name | +| --namespace | string Array| List of namespaces which are allowed to manage | +| --project | string | project of the cluster | +| --service-account | string | System namespace service account to use for kubernetes resource management. If not set then default "argocd-manager" SA will be created | +| --shard | int | Cluster shard number; inferred from hostname if not set (default -1) | +| --system-namespace | string | Use different system namespace (default "kube-system") | +| --upsert| Override an existing cluster with the same name even if the spec differs | + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_cluster_get.md b/docs/cli/argocd_cluster_get.md new file mode 100644 index 000000000..dfba8739b --- /dev/null +++ b/docs/cli/argocd_cluster_get.md @@ -0,0 +1,56 @@ +# `argocd cluster get` Command Reference + +## argocd cluster get + +Get cluster information + +``` +argocd cluster get SERVER/NAME [flags] +``` + +### Examples + +``` +argocd cluster get https://12.34.567.89 +argocd cluster get in-cluster +``` + +### Options + +``` + -h, --help help for get + -o, --output string Output format. One of: json|yaml|wide|server (default "yaml") +``` + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_cluster_list.md b/docs/cli/argocd_cluster_list.md new file mode 100644 index 000000000..72ecaf32b --- /dev/null +++ b/docs/cli/argocd_cluster_list.md @@ -0,0 +1,71 @@ +# `argocd cluster list` Command Reference + +## argocd cluster list + +List configured clusters + +``` +argocd cluster list [flags] +``` + +### Examples + +``` + +# List Clusters in Default "Wide" Format +argocd cluster list + +# List Cluster via specifing the server +argocd cluster list --server + +# List Clusters in JSON Format +argocd cluster list -o json --server + +# List Clusters in YAML Format +argocd cluster list -o yaml --server + +# List Clusters that have been added to your Argo CD +argocd cluster list -o server + + +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide|server (default "wide") +``` + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_cluster_rm.md b/docs/cli/argocd_cluster_rm.md new file mode 100644 index 000000000..1320e811b --- /dev/null +++ b/docs/cli/argocd_cluster_rm.md @@ -0,0 +1,56 @@ +# `argocd cluster rm` Command Reference + +## argocd cluster rm + +Remove cluster credentials + +``` +argocd cluster rm SERVER/NAME [flags] +``` + +### Examples + +``` +argocd cluster rm https://12.34.567.89 +argocd cluster rm cluster-name +``` + +### Options + +``` + -h, --help help for rm + -y, --yes Turn off prompting to confirm remove of cluster resources +``` + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_cluster_rotate-auth.md b/docs/cli/argocd_cluster_rotate-auth.md new file mode 100644 index 000000000..0aae0b7c1 --- /dev/null +++ b/docs/cli/argocd_cluster_rotate-auth.md @@ -0,0 +1,56 @@ +# `argocd cluster rotate-auth` Command Reference + +## argocd cluster rotate-auth + +argocd cluster rotate-auth SERVER/NAME + +``` +argocd cluster rotate-auth SERVER/NAME [flags] +``` + +### Examples + +``` +argocd cluster rotate-auth https://12.34.567.89 +argocd cluster rotate-auth cluster-name +``` + +### Options + +``` + -h, --help help for rotate-auth +``` + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_cluster_set.md b/docs/cli/argocd_cluster_set.md new file mode 100644 index 000000000..42f42526f --- /dev/null +++ b/docs/cli/argocd_cluster_set.md @@ -0,0 +1,62 @@ +# `argocd cluster set` Command Reference + +## argocd cluster set + +Set cluster information + +``` +argocd cluster set NAME [flags] +``` + +### Examples + +``` + # Set cluster information + argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace '*' + argocd cluster set CLUSTER_NAME --name new-cluster-name --namespace namespace-one --namespace namespace-two +``` + +### Options + +``` + -h, --help help for set + --name string Overwrite the cluster name + --namespace stringArray List of namespaces which are allowed to manage. Specify '*' to manage all namespaces +``` +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for set | +| --name | string | Overwrite the cluster name | +| --namespace | string Array| List of namespaces which are allowed to manage. Specify '*' to manage all namespaces | + +### 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 cluster](argocd_cluster.md) - Manage cluster credentials + + diff --git a/docs/cli/argocd_completion.md b/docs/cli/argocd_completion.md new file mode 100644 index 000000000..7f355c253 --- /dev/null +++ b/docs/cli/argocd_completion.md @@ -0,0 +1,78 @@ +# `argocd completion` Command Reference + +## argocd completion + +output shell completion code for the specified shell (bash or zsh) + +### Synopsis + +Write bash or zsh shell completion code to standard output. + +For bash, ensure you have bash completions installed and enabled. +To access completions in your current shell, run +$ source <(argocd completion bash) +Alternatively, write it to a file and source in .bash_profile + +For zsh, add the following to your ~/.zshrc file: +$ source < (argocd completion zsh) +compdef _argocd argocd + +Optionally, also add the following, in case you are getting errors involving compdef & compinit such as command not found: compdef: +autoload -Uz compinit +compinit + + +``` +argocd completion SHELL [flags] +``` + +### Examples + +``` +# For bash +$ source <(argocd completion bash) + +# For zsh +$ argocd completion zsh > _argocd +$ source _argocd + +``` + +### Options + +``` + -h, --help help for completion +``` + +### 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](argocd.md) - argocd controls a Argo CD server + diff --git a/docs/cli/argocd_context.md b/docs/cli/argocd_context.md new file mode 100644 index 000000000..2d6896e5b --- /dev/null +++ b/docs/cli/argocd_context.md @@ -0,0 +1,63 @@ +# `argocd context` Command Reference + +## argocd context + +Switch between contexts + +``` +argocd context [CONTEXT] [flags] +``` + +### Examples + +``` +# List Argo CD Contexts +argocd context + +# Switch Argo CD context +argocd context cd.argoproj.io + +# Delete Argo CD context +argocd context cd.argoproj.io --delete +``` + +### Options + +``` + --delete Delete the context instead of switching to it + -h, --help help for context +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --delete| Delete the context instead of switching to it | +| --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](argocd.md) - argocd controls a Argo CD server + + diff --git a/docs/cli/argocd_gpg.md b/docs/cli/argocd_gpg.md new file mode 100644 index 000000000..df096e61d --- /dev/null +++ b/docs/cli/argocd_gpg.md @@ -0,0 +1,89 @@ +# `argocd gpg` Command Reference + +## argocd gpg + +Manage GPG keys used for signature verification + +``` +argocd gpg [flags] +``` + +### Options + +``` + --as string Username to impersonate for the operation + --as-group stringArray 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 + -h, --help help for gpg + --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 + -n, --namespace string If present, the namespace scope for this CLI request + --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 | +| ---------------- | ------ | ---- | +| --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 | +| --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](argocd.md) - argocd controls a Argo CD server +* [argocd gpg add](argocd_gpg_add.md) - Adds a GPG public key to the server's keyring +* [argocd gpg get](argocd_gpg_get.md) - Get the GPG public key with ID from the server +* [argocd gpg list](argocd_gpg_list.md) - List configured GPG public keys +* [argocd gpg rm](argocd_gpg_rm.md) - Removes a GPG public key from the server's keyring + + diff --git a/docs/cli/argocd_gpg_add.md b/docs/cli/argocd_gpg_add.md new file mode 100644 index 000000000..9d7e17bcc --- /dev/null +++ b/docs/cli/argocd_gpg_add.md @@ -0,0 +1,56 @@ +# `argocd gpg add` Command Reference + +## argocd gpg add + +Adds a GPG public key to the server's keyring + +``` +argocd gpg add [flags] +``` + +### Examples + +``` + # Add a GPG public key to the server's keyring from a file. + argocd gpg add --from /path/to/keyfile +``` + +### Options + +``` + -f, --from string Path to the file that contains the GPG public key to import + -h, --help help for add +``` + +### 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 gpg](argocd_gpg.md) - Manage GPG keys used for signature verification + + diff --git a/docs/cli/argocd_gpg_get.md b/docs/cli/argocd_gpg_get.md new file mode 100644 index 000000000..74313e4fd --- /dev/null +++ b/docs/cli/argocd_gpg_get.md @@ -0,0 +1,62 @@ +# `argocd gpg get` Command Reference + +## argocd gpg get + +Get the GPG public key with ID from the server + +``` +argocd gpg get KEYID [flags] +``` + +### Examples + +``` + # Get a GPG public key with the specified KEYID in wide format (default). + argocd gpg get KEYID + + # Get a GPG public key with the specified KEYID in JSON format. + argocd gpg get KEYID -o json + + # Get a GPG public key with the specified KEYID in YAML format. + argocd gpg get KEYID -o yaml +``` + +### Options + +``` + -h, --help help for get + -o, --output string Output format. One of: json|yaml|wide (default "wide") +``` + +### 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 gpg](argocd_gpg.md) - Manage GPG keys used for signature verification + + diff --git a/docs/cli/argocd_gpg_list.md b/docs/cli/argocd_gpg_list.md new file mode 100644 index 000000000..f0b6ffb0c --- /dev/null +++ b/docs/cli/argocd_gpg_list.md @@ -0,0 +1,62 @@ +# `argocd gpg list` Command Reference + +## argocd gpg list + +List configured GPG public keys + +``` +argocd gpg list [flags] +``` + +### Examples + +``` + # List all configured GPG public keys in wide format (default). + argocd gpg list + + # List all configured GPG public keys in JSON format. + argocd gpg list -o json + + # List all configured GPG public keys in YAML format. + argocd gpg list -o yaml +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide (default "wide") +``` + +### 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 gpg](argocd_gpg.md) - Manage GPG keys used for signature verification + + diff --git a/docs/cli/argocd_gpg_rm.md b/docs/cli/argocd_gpg_rm.md new file mode 100644 index 000000000..83da4a9a4 --- /dev/null +++ b/docs/cli/argocd_gpg_rm.md @@ -0,0 +1,48 @@ +# `argocd gpg rm` Command Reference + +## argocd gpg rm + +Removes a GPG public key from the server's keyring + +``` +argocd gpg rm KEYID [flags] +``` + +### Options + +``` + -h, --help help for rm +``` + +### 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 gpg](argocd_gpg.md) - Manage GPG keys used for signature verification + + diff --git a/docs/cli/argocd_login.md b/docs/cli/argocd_login.md new file mode 100644 index 000000000..824d4f343 --- /dev/null +++ b/docs/cli/argocd_login.md @@ -0,0 +1,71 @@ +# `argocd login` Command Reference + +## argocd login + +Log in to Argo CD + +### Synopsis + +Log in to Argo CD + +``` +argocd login SERVER [flags] +``` + +### Examples + +``` +# Login to Argo CD using a username and password +argocd login cd.argoproj.io + +# Login to Argo CD using SSO +argocd login cd.argoproj.io --sso + +# Configure direct access using Kubernetes API server +argocd login cd.argoproj.io --core +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help| | help for login | +| --name | string | Name to use for the context | +| --password | string | The password of an account to authenticate | +| --skip-test-tls| Skip testing whether the server is configured with TLS (this can help when the command hangs for no apparent reason) | +| --sso| Perform SSO login | +| --sso-port | int | Port to run local OAuth2 login application (default 8085) | +| --username | string | The username of an account to authenticate | + +### 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](argocd.md) - argocd controls a Argo CD server + + diff --git a/docs/cli/argocd_logout.md b/docs/cli/argocd_logout.md new file mode 100644 index 000000000..22a96b186 --- /dev/null +++ b/docs/cli/argocd_logout.md @@ -0,0 +1,61 @@ +# `argocd logout` Command Reference + +## argocd logout + +Log out from Argo CD + +### Synopsis + +Log out from Argo CD + +``` +argocd logout CONTEXT [flags] +``` + +### Examples + +``` +# To log out of argocd +$ argocd logout +# This can be helpful for security reasons or when you want to switch between different Argo CD contexts or accounts. + +``` + +### Options + +``` + -h, --help help for logout +``` + +### 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](argocd.md) - argocd controls a Argo CD server + + diff --git a/docs/cli/argocd_proj.md b/docs/cli/argocd_proj.md new file mode 100644 index 000000000..dd5afd24e --- /dev/null +++ b/docs/cli/argocd_proj.md @@ -0,0 +1,101 @@ +# `argocd proj` Command Reference + +## argocd proj + +Manage projects + +``` +argocd proj [flags] +``` + +### Examples + +``` + # List all available projects + argocd proj list + + # Create a new project with name PROJECT + argocd proj create PROJECT + + # Delete the project with name PROJECT + argocd proj delete PROJECT + + # Edit the information on project with name PROJECT + argocd proj edit PROJECT +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd proj add-destination](argocd_proj_add-destination.md) - Add project destination +* [argocd proj add-orphaned-ignore](argocd_proj_add-orphaned-ignore.md) - Add a resource to orphaned ignore list +* [argocd proj add-signature-key](argocd_proj_add-signature-key.md) - Add GnuPG signature key to project +* [argocd proj add-source](argocd_proj_add-source.md) - Add project source repository +* [argocd proj allow-cluster-resource](argocd_proj_allow-cluster-resource.md) - Adds a cluster-scoped API resource to the allow list and removes it from deny list +* [argocd proj allow-namespace-resource](argocd_proj_allow-namespace-resource.md) - Removes a namespaced API resource from the deny list or add a namespaced API resource to the allow list +* [argocd proj create](argocd_proj_create.md) - Create a project +* [argocd proj delete](argocd_proj_delete.md) - Delete project +* [argocd proj deny-cluster-resource](argocd_proj_deny-cluster-resource.md) - Removes a cluster-scoped API resource from the allow list and adds it to deny list +* [argocd proj deny-namespace-resource](argocd_proj_deny-namespace-resource.md) - Adds a namespaced API resource to the deny list or removes a namespaced API resource from the allow list +* [argocd proj edit](argocd_proj_edit.md) - Edit project +* [argocd proj get](argocd_proj_get.md) - Get project details +* [argocd proj list](argocd_proj_list.md) - List projects +* [argocd proj remove-destination](argocd_proj_remove-destination.md) - Remove project destination +* [argocd proj remove-orphaned-ignore](argocd_proj_remove-orphaned-ignore.md) - Remove a resource from orphaned ignore list +* [argocd proj remove-signature-key](argocd_proj_remove-signature-key.md) - Remove GnuPG signature key from project +* [argocd proj remove-source](argocd_proj_remove-source.md) - Remove project source repository +* [argocd proj role](argocd_proj_role.md) - Manage a project's roles +* [argocd proj set](argocd_proj_set.md) - Set project parameters +* [argocd proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_proj_add-destination.md b/docs/cli/argocd_proj_add-destination.md new file mode 100644 index 000000000..a2f796c5c --- /dev/null +++ b/docs/cli/argocd_proj_add-destination.md @@ -0,0 +1,59 @@ +# `argocd proj add-destination` Command Reference + +## argocd proj add-destination + +Add project destination + +``` +argocd proj add-destination PROJECT SERVER/NAME NAMESPACE [flags] +``` +**WARNING** When using glob patterns like `*` in the argument, ensure that it is properly quoted '*' to avoid the underlying shell interpreting it as a shell wildcard + +### Examples + +``` + # Add project destination using a server URL (SERVER) in the specified namespace (NAMESPACE) on the project with name PROJECT + argocd proj add-destination PROJECT SERVER NAMESPACE + + # Add project destination using a server name (NAME) in the specified namespace (NAMESPACE) on the project with name PROJECT + argocd proj add-destination PROJECT NAME NAMESPACE --name +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for add-destination| +| --name | string | Resource name pattern | +### 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 proj](argocd_proj.md) - Manage projects + diff --git a/docs/cli/argocd_proj_add-orphaned-ignore.md b/docs/cli/argocd_proj_add-orphaned-ignore.md new file mode 100644 index 000000000..9989c10d7 --- /dev/null +++ b/docs/cli/argocd_proj_add-orphaned-ignore.md @@ -0,0 +1,59 @@ +# `argocd proj add-orphaned-ignore` Command Reference + +## argocd proj add-orphaned-ignore + +Add a resource to orphaned ignore list + +``` +argocd proj add-orphaned-ignore PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Add a resource of the specified GROUP and KIND to orphaned ignore list on the project with name PROJECT + argocd proj add-orphaned-ignore PROJECT GROUP KIND + + # Add resources of the specified GROUP and KIND using a NAME pattern to orphaned ignore list on the project with name PROJECT + argocd proj add-orphaned-ignore PROJECT GROUP KIND --name NAME +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +|-h, --help | | help for add-orphaned-ignore| +| --name | string | Resource name pattern | + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_add-signature-key.md b/docs/cli/argocd_proj_add-signature-key.md new file mode 100644 index 000000000..ca0112c8d --- /dev/null +++ b/docs/cli/argocd_proj_add-signature-key.md @@ -0,0 +1,55 @@ +# `argocd proj add-signature-key` Command Reference + +## argocd proj add-signature-key + +Add GnuPG signature key to project + +``` +argocd proj add-signature-key PROJECT KEY-ID [flags] +``` + +### Examples + +``` + # Add GnuPG signature key KEY-ID to project PROJECT + argocd proj add-signature-key PROJECT KEY-ID +``` + +### Options + +``` + -h, --help help for add-signature-key +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_add-source.md b/docs/cli/argocd_proj_add-source.md new file mode 100644 index 000000000..66622104c --- /dev/null +++ b/docs/cli/argocd_proj_add-source.md @@ -0,0 +1,55 @@ +# `argocd proj add-source` Command Reference + +## argocd proj add-source + +Add project source repository + +``` +argocd proj add-source PROJECT URL [flags] +``` + +### Examples + +``` + # Add a source repository (URL) to the project with name PROJECT + argocd proj add-source PROJECT URL +``` + +### Options + +``` + -h, --help help for add-source +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_allow-cluster-resource.md b/docs/cli/argocd_proj_allow-cluster-resource.md new file mode 100644 index 000000000..483a9b7db --- /dev/null +++ b/docs/cli/argocd_proj_allow-cluster-resource.md @@ -0,0 +1,56 @@ +# `argocd proj allow-cluster-resource` Command Reference + +## argocd proj allow-cluster-resource + +Adds a cluster-scoped API resource to the allow list and removes it from deny list + +``` +argocd proj allow-cluster-resource PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Adds a cluster-scoped API resource with specified GROUP and KIND to the allow list and removes it from deny list for project PROJECT + argocd proj allow-cluster-resource PROJECT GROUP KIND +``` + +### Options + +``` + -h, --help help for allow-cluster-resource + -l, --list string Use deny list or allow list. This can only be 'allow' or 'deny' (default "allow") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_allow-namespace-resource.md b/docs/cli/argocd_proj_allow-namespace-resource.md new file mode 100644 index 000000000..5ce4e0114 --- /dev/null +++ b/docs/cli/argocd_proj_allow-namespace-resource.md @@ -0,0 +1,56 @@ +# `argocd proj allow-namespace-resource` Command Reference + +## argocd proj allow-namespace-resource + +Removes a namespaced API resource from the deny list or add a namespaced API resource to the allow list + +``` +argocd proj allow-namespace-resource PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Removes a namespaced API resource with specified GROUP and KIND from the deny list or add a namespaced API resource to the allow list for project PROJECT + argocd proj allow-namespace-resource PROJECT GROUP KIND +``` + +### Options + +``` + -h, --help help for allow-namespace-resource + -l, --list string Use deny list or allow list. This can only be 'allow' or 'deny' (default "deny") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_create.md b/docs/cli/argocd_proj_create.md new file mode 100644 index 000000000..16ceb64a9 --- /dev/null +++ b/docs/cli/argocd_proj_create.md @@ -0,0 +1,71 @@ +# `argocd proj create` Command Reference + +## argocd proj create + +Create a project + +``` +argocd proj create PROJECT [flags] +``` + +### Examples + +``` + # Create a new project with name PROJECT + argocd proj create PROJECT + + # Create a new project with name PROJECT from a file or URL to a Kubernetes manifest + argocd proj create PROJECT -f FILE|URL +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-cluster-resource | string Array| List of allowed cluster level resources | +| --allow-namespaced-resource | string Array| List of allowed namespaced resources | +| --deny-cluster-resource | string Array| List of denied cluster level resources | +| --deny-namespaced-resource | string Array| List of denied namespaced resources | +| --description | string | Project description | +| -d, --dest |stringArray | Permitted destination server and namespace (e.g. https://192.168.99.100:8443,default)| +| -f, --file |string | Filename or URL to Kubernetes manifests for the project| +| -h, --help | |help for create| +| --orphaned-resources| Enables orphaned resources monitoring | +| --orphaned-resources-warn| Specifies if applications should have a warning condition when orphaned resources detected | +| --signature-keys | string s| GnuPG public key IDs for commit signature verification | +| --source-namespaces | string s| List of source namespaces for applications | +| -s, --src | stringArray | Permitted source repository URL| +| --upsert| Allows to override a project with the same name even if supplied project spec is different from existing spec | + +### 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 proj](argocd_proj.md) - Manage projects + diff --git a/docs/cli/argocd_proj_delete.md b/docs/cli/argocd_proj_delete.md new file mode 100644 index 000000000..cde8e96c3 --- /dev/null +++ b/docs/cli/argocd_proj_delete.md @@ -0,0 +1,55 @@ +# `argocd proj delete` Command Reference + +## argocd proj delete + +Delete project + +``` +argocd proj delete PROJECT [flags] +``` + +### Examples + +``` + # Delete the project with name PROJECT + argocd proj delete PROJECT +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_deny-cluster-resource.md b/docs/cli/argocd_proj_deny-cluster-resource.md new file mode 100644 index 000000000..0da480d33 --- /dev/null +++ b/docs/cli/argocd_proj_deny-cluster-resource.md @@ -0,0 +1,56 @@ +# `argocd proj deny-cluster-resource` Command Reference + +## argocd proj deny-cluster-resource + +Removes a cluster-scoped API resource from the allow list and adds it to deny list + +``` +argocd proj deny-cluster-resource PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Removes a cluster-scoped API resource with specified GROUP and KIND from the allow list and adds it to deny list for project PROJECT + argocd proj deny-cluster-resource PROJECT GROUP KIND +``` + +### Options + +``` + -h, --help help for deny-cluster-resource + -l, --list string Use deny list or allow list. This can only be 'allow' or 'deny' (default "allow") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_deny-namespace-resource.md b/docs/cli/argocd_proj_deny-namespace-resource.md new file mode 100644 index 000000000..9a554465a --- /dev/null +++ b/docs/cli/argocd_proj_deny-namespace-resource.md @@ -0,0 +1,56 @@ +# `argocd proj deny-namespace-resource` Command Reference + +## argocd proj deny-namespace-resource + +Adds a namespaced API resource to the deny list or removes a namespaced API resource from the allow list + +``` +argocd proj deny-namespace-resource PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Adds a namespaced API resource with specified GROUP and KIND from the deny list or removes a namespaced API resource from the allow list for project PROJECT + argocd proj deny-namespace-resource PROJECT GROUP KIND +``` + +### Options + +``` + -h, --help help for deny-namespace-resource + -l, --list string Use deny list or allow list. This can only be 'allow' or 'deny' (default "deny") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_edit.md b/docs/cli/argocd_proj_edit.md new file mode 100644 index 000000000..ffc8c3491 --- /dev/null +++ b/docs/cli/argocd_proj_edit.md @@ -0,0 +1,55 @@ +# `argocd proj edit` Command Reference + +## argocd proj edit + +Edit project + +``` +argocd proj edit PROJECT [flags] +``` + +### Examples + +``` + # Edit the information on project with name PROJECT + argocd proj edit PROJECT +``` + +### Options + +``` + -h, --help help for edit +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_get.md b/docs/cli/argocd_proj_get.md new file mode 100644 index 000000000..c76ce6d8f --- /dev/null +++ b/docs/cli/argocd_proj_get.md @@ -0,0 +1,59 @@ +# `argocd proj get` Command Reference + +## argocd proj get + +Get project details + +``` +argocd proj get PROJECT [flags] +``` + +### Examples + +``` + # Get details from project PROJECT + argocd proj get PROJECT + + # Get details from project PROJECT in yaml format + argocd proj get PROJECT -o yaml +``` + +### Options + +``` + -h, --help help for get + -o, --output string Output format. One of: json|yaml|wide (default "wide") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_list.md b/docs/cli/argocd_proj_list.md new file mode 100644 index 000000000..4c89975a8 --- /dev/null +++ b/docs/cli/argocd_proj_list.md @@ -0,0 +1,59 @@ +# `argocd proj list` Command Reference + +## argocd proj list + +List projects + +``` +argocd proj list [flags] +``` + +### Examples + +``` + # List all available projects + argocd proj list + + # List all available projects in yaml format + argocd proj list -o yaml +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide|name (default "wide") +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_remove-destination.md b/docs/cli/argocd_proj_remove-destination.md new file mode 100644 index 000000000..c8e2e0667 --- /dev/null +++ b/docs/cli/argocd_proj_remove-destination.md @@ -0,0 +1,55 @@ +# `argocd proj remove-destination` Command Reference + +## argocd proj remove-destination + +Remove project destination + +``` +argocd proj remove-destination PROJECT SERVER NAMESPACE [flags] +``` + +### Examples + +``` + # Remove the destination (SERVER) from the specified namespace (NAMESPACE) on the project with name PROJECT + argocd proj remove-destination PROJECT SERVER NAMESPACE +``` + +### Options + +``` + -h, --help help for remove-destination +``` + +### 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 proj](argocd_proj.md) - Manage projects + diff --git a/docs/cli/argocd_proj_remove-orphaned-ignore.md b/docs/cli/argocd_proj_remove-orphaned-ignore.md new file mode 100644 index 000000000..dabcc2a65 --- /dev/null +++ b/docs/cli/argocd_proj_remove-orphaned-ignore.md @@ -0,0 +1,60 @@ +# `argocd proj remove-orphaned-ignore` Command Reference + +## argocd proj remove-orphaned-ignore + +Remove a resource from orphaned ignore list + +``` +argocd proj remove-orphaned-ignore PROJECT GROUP KIND [flags] +``` + +### Examples + +``` + # Remove a resource of the specified GROUP and KIND from orphaned ignore list on the project with name PROJECT + argocd proj remove-orphaned-ignore PROJECT GROUP KIND + + # Remove resources of the specified GROUP and KIND using a NAME pattern from orphaned ignore list on the project with name PROJECT + argocd proj remove-orphaned-ignore PROJECT GROUP KIND --name NAME +``` + +### Options + +``` + -h, --help help for remove-orphaned-ignore + --name string Resource name pattern +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --name | string | Resource name pattern | +| --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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_remove-signature-key.md b/docs/cli/argocd_proj_remove-signature-key.md new file mode 100644 index 000000000..bbf7aa56b --- /dev/null +++ b/docs/cli/argocd_proj_remove-signature-key.md @@ -0,0 +1,55 @@ +# `argocd proj remove-signature-key` Command Reference + +## argocd proj remove-signature-key + +Remove GnuPG signature key from project + +``` +argocd proj remove-signature-key PROJECT KEY-ID [flags] +``` + +### Examples + +``` + # Remove GnuPG signature key KEY-ID from project PROJECT + argocd proj remove-signature-key PROJECT KEY-ID +``` + +### Options + +``` + -h, --help help for remove-signature-key +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_remove-source.md b/docs/cli/argocd_proj_remove-source.md new file mode 100644 index 000000000..74483f001 --- /dev/null +++ b/docs/cli/argocd_proj_remove-source.md @@ -0,0 +1,55 @@ +# `argocd proj remove-source` Command Reference + +## argocd proj remove-source + +Remove project source repository + +``` +argocd proj remove-source PROJECT URL [flags] +``` + +### Examples + +``` + # Remove URL source repository to project PROJECT + argocd proj remove-source PROJECT URL +``` + +### Options + +``` + -h, --help help for remove-source +``` + +### 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 proj](argocd_proj.md) - Manage projects + + diff --git a/docs/cli/argocd_proj_role.md b/docs/cli/argocd_proj_role.md new file mode 100644 index 000000000..dc052b90b --- /dev/null +++ b/docs/cli/argocd_proj_role.md @@ -0,0 +1,59 @@ +# `argocd proj role` Command Reference + +## argocd proj role + +Manage a project's roles + +``` +argocd proj role [flags] +``` + +### Options + +``` + -h, --help help for role +``` + +### 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 proj](argocd_proj.md) - Manage projects +* [argocd proj role add-group](argocd_proj_role_add-group.md) - Add a group claim to a project role +* [argocd proj role add-policy](argocd_proj_role_add-policy.md) - Add a policy to a project role +* [argocd proj role create](argocd_proj_role_create.md) - Create a project role +* [argocd proj role create-token](argocd_proj_role_create-token.md) - Create a project token +* [argocd proj role delete](argocd_proj_role_delete.md) - Delete a project role +* [argocd proj role delete-token](argocd_proj_role_delete-token.md) - Delete a project token +* [argocd proj role get](argocd_proj_role_get.md) - Get the details of a specific role +* [argocd proj role list](argocd_proj_role_list.md) - List all the roles in a project +* [argocd proj role list-tokens](argocd_proj_role_list-tokens.md) - List tokens for a given role. +* [argocd proj role remove-group](argocd_proj_role_remove-group.md) - Remove a group claim from a role within a project +* [argocd proj role remove-policy](argocd_proj_role_remove-policy.md) - Remove a policy from a role within a project + + diff --git a/docs/cli/argocd_proj_role_add-group.md b/docs/cli/argocd_proj_role_add-group.md new file mode 100644 index 000000000..90270a9f5 --- /dev/null +++ b/docs/cli/argocd_proj_role_add-group.md @@ -0,0 +1,48 @@ +# `argocd proj role add-group` Command Reference + +## argocd proj role add-group + +Add a group claim to a project role + +``` +argocd proj role add-group PROJECT ROLE-NAME GROUP-CLAIM [flags] +``` + +### Options + +``` + -h, --help help for add-group +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + diff --git a/docs/cli/argocd_proj_role_add-policy.md b/docs/cli/argocd_proj_role_add-policy.md new file mode 100644 index 000000000..792564cdb --- /dev/null +++ b/docs/cli/argocd_proj_role_add-policy.md @@ -0,0 +1,80 @@ +# `argocd proj role add-policy` Command Reference + +## argocd proj role add-policy + +Add a policy to a project role + +``` +argocd proj role add-policy PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +# Before adding new policy +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696759698 2023-10-08T11:08:18+01:00 (3 hours ago) + +# Add a new policy to allow update to the project +$ argocd proj role add-policy test-project test-role -a update -p allow -o project + +# Policy should be updated +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +p, proj:test-project:test-role, applications, update, test-project/project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696759698 2023-10-08T11:08:18+01:00 (3 hours ago) + +``` + +### Options + +``` + -a, --action string Action to grant/deny permission on (e.g. get, create, list, update, delete) + -h, --help help for add-policy + -o, --object string Object within the project to grant/deny access. Use '*' for a wildcard. Will want access to '/' + -p, --permission string Whether to allow or deny access to object with the action. This can only be 'allow' or 'deny' (default "allow") +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_create-token.md b/docs/cli/argocd_proj_role_create-token.md new file mode 100644 index 000000000..d03861f89 --- /dev/null +++ b/docs/cli/argocd_proj_role_create-token.md @@ -0,0 +1,63 @@ +# `argocd proj role create-token` Command Reference + +## argocd proj role create-token + +Create a project token + +``` +argocd proj role create-token PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +$ argocd proj role create-token test-project test-role +Create token succeeded for proj:test-project:test-role. + ID: f316c466-40bd-4cfd-8a8c-1392e92255d4 + Issued At: 2023-10-08T15:21:40+01:00 + Expires At: Never + Token: xxx + +``` + +### Options + +``` + -e, --expires-in string Duration before the token will expire, e.g. "12h", "7d". (Default: No expiration) + -h, --help help for create-token + -i, --id string Token unique identifier. (Default: Random UUID) + -t, --token-only Output token only - for use in scripts. +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_create.md b/docs/cli/argocd_proj_role_create.md new file mode 100644 index 000000000..ce0db2af5 --- /dev/null +++ b/docs/cli/argocd_proj_role_create.md @@ -0,0 +1,57 @@ +# `argocd proj role create` Command Reference + +## argocd proj role create + +Create a project role + +``` +argocd proj role create PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` + # Create a project role in the "my-project" project with the name "my-role". + argocd proj role create my-project my-role --description "My project role description" +``` + +### Options + +``` + --description string Project description + -h, --help help for create +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --description | string | Project 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_delete-token.md b/docs/cli/argocd_proj_role_delete-token.md new file mode 100644 index 000000000..9b8bc820c --- /dev/null +++ b/docs/cli/argocd_proj_role_delete-token.md @@ -0,0 +1,80 @@ +# `argocd proj role delete-token` Command Reference + +## argocd proj role delete-token + +Delete a project token + +``` +argocd proj role delete-token PROJECT ROLE-NAME ISSUED-AT [flags] +``` + +### Examples + +``` +#Create project test-project +$ argocd proj create test-project + +# Create a role associated with test-project +$ argocd proj role create test-project test-role +Role 'test-role' created + +# Create test-role associated with test-project +$ argocd proj role create-token test-project test-role +Create token succeeded for proj:test-project:test-role. + ID: c312450e-12e1-4e0d-9f65-fac9cb027b32 + Issued At: 2023-10-08T13:58:57+01:00 + Expires At: Never + Token: xxx + +# Get test-role id to input into the delete-token command below +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696769937 2023-10-08T13:58:57+01:00 (6 minutes ago) + +$ argocd proj role delete-token test-project test-role 1696769937 + +``` + +### Options + +``` + -h, --help help for delete-token +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + diff --git a/docs/cli/argocd_proj_role_delete.md b/docs/cli/argocd_proj_role_delete.md new file mode 100644 index 000000000..40fc3a6c4 --- /dev/null +++ b/docs/cli/argocd_proj_role_delete.md @@ -0,0 +1,54 @@ +# `argocd proj role delete` Command Reference + +## argocd proj role delete + +Delete a project role + +``` +argocd proj role delete PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +$ argocd proj role delete test-project test-role +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_get.md b/docs/cli/argocd_proj_role_get.md new file mode 100644 index 000000000..aabb2f673 --- /dev/null +++ b/docs/cli/argocd_proj_role_get.md @@ -0,0 +1,63 @@ +# `argocd proj role get` Command Reference + +## argocd proj role get + +Get the details of a specific role + +``` +argocd proj role get PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696774900 2023-10-08T15:21:40+01:00 (4 minutes ago) +1696759698 2023-10-08T11:08:18+01:00 (4 hours ago) + +``` + +### Options + +``` + -h, --help help for get +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_list-tokens.md b/docs/cli/argocd_proj_role_list-tokens.md new file mode 100644 index 000000000..c11e5408e --- /dev/null +++ b/docs/cli/argocd_proj_role_list-tokens.md @@ -0,0 +1,59 @@ +# `argocd proj role list-tokens` Command Reference + +## argocd proj role list-tokens + +List tokens for a given role. + +``` +argocd proj role list-tokens PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +$ argocd proj role list-tokens test-project test-role +ID ISSUED AT EXPIRES AT +f316c466-40bd-4cfd-8a8c-1392e92255d4 2023-10-08T15:21:40+01:00 Never +fa9d3517-c52d-434c-9bff-215b38508842 2023-10-08T11:08:18+01:00 Never + +``` + +### Options + +``` + -h, --help help for list-tokens + -u, --unixtime Print timestamps as Unix time instead of converting. Useful for piping into delete-token. +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_list.md b/docs/cli/argocd_proj_role_list.md new file mode 100644 index 000000000..bb092dfa9 --- /dev/null +++ b/docs/cli/argocd_proj_role_list.md @@ -0,0 +1,59 @@ +# `argocd proj role list` Command Reference + +## argocd proj role list + +List all the roles in a project + +``` +argocd proj role list PROJECT [flags] +``` + +### Examples + +``` + # This command will list all the roles in argocd-project in a default table format. + argocd proj role list PROJECT + + # List the roles in the project in formats like json, yaml, wide, or name. + argocd proj role list PROJECT --output json +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide|name (default "wide") +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + diff --git a/docs/cli/argocd_proj_role_remove-group.md b/docs/cli/argocd_proj_role_remove-group.md new file mode 100644 index 000000000..a682cbd24 --- /dev/null +++ b/docs/cli/argocd_proj_role_remove-group.md @@ -0,0 +1,48 @@ +# `argocd proj role remove-group` Command Reference + +## argocd proj role remove-group + +Remove a group claim from a role within a project + +``` +argocd proj role remove-group PROJECT ROLE-NAME GROUP-CLAIM [flags] +``` + +### Options + +``` + -h, --help help for remove-group +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_role_remove-policy.md b/docs/cli/argocd_proj_role_remove-policy.md new file mode 100644 index 000000000..d05444456 --- /dev/null +++ b/docs/cli/argocd_proj_role_remove-policy.md @@ -0,0 +1,80 @@ +# `argocd proj role remove-policy` Command Reference + +## argocd proj role remove-policy + +Remove a policy from a role within a project + +``` +argocd proj role remove-policy PROJECT ROLE-NAME [flags] +``` + +### Examples + +``` +List the policy of the test-role before removing a policy +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +p, proj:test-project:test-role, applications, update, test-project/project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696759698 2023-10-08T11:08:18+01:00 (3 hours ago) + +# Remove the policy to allow update to objects +$ argocd proj role remove-policy test-project test-role -a update -p allow -o project + +# The role should be removed now. +$ argocd proj role get test-project test-role +Role Name: test-role +Description: +Policies: +p, proj:test-project:test-role, projects, get, test-project, allow +JWT Tokens: +ID ISSUED-AT EXPIRES-AT +1696759698 2023-10-08T11:08:18+01:00 (4 hours ago) + +``` + +### Options + +``` + -a, --action string Action to grant/deny permission on (e.g. get, create, list, update, delete) + -h, --help help for remove-policy + -o, --object string Object within the project to grant/deny access. Use '*' for a wildcard. Will want access to '/' + -p, --permission string Whether to allow or deny access to object with the action. This can only be 'allow' or 'deny' (default "allow") +``` + +### 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 proj role](argocd_proj_role.md) - Manage a project's roles + + diff --git a/docs/cli/argocd_proj_set.md b/docs/cli/argocd_proj_set.md new file mode 100644 index 000000000..a050b34a5 --- /dev/null +++ b/docs/cli/argocd_proj_set.md @@ -0,0 +1,66 @@ +# `argocd proj set` Command Reference + +## argocd proj set + +Set project parameters + +``` +argocd proj set PROJECT [flags] +``` + +### Examples + +``` + # Set project parameters with some allowed cluster resources [RES1,RES2,...] for project with name PROJECT + argocd proj set PROJECT --allow-cluster-resource [RES1,RES2,...] + + # Set project parameters with some denied namespaced resources [RES1,RES2,...] for project with name PROJECT + argocd proj set PROJECT ---deny-namespaced-resource [RES1,RES2,...] +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --allow-cluster-resource | string Array| List of allowed cluster level resources | +| --allow-namespaced-resource | string Array| List of allowed namespaced resources | +| --deny-cluster-resource | string Array| List of denied cluster level resources | +| --deny-namespaced-resource | string Array| List of denied namespaced resources | +| --description | string | Project description | +| --orphaned-resources| Enables orphaned resources monitoring | +| --orphaned-resources-warn| Specifies if applications should have a warning condition when orphaned resources detected | +| --signature-keys | string s| GnuPG public key IDs for commit signature verification | +| --source-namespaces | string s| List of source namespaces for applications | + +### 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 proj](argocd_proj.md) - Manage projects + diff --git a/docs/cli/argocd_proj_windows.md b/docs/cli/argocd_proj_windows.md new file mode 100644 index 000000000..7bea735a3 --- /dev/null +++ b/docs/cli/argocd_proj_windows.md @@ -0,0 +1,71 @@ +# `argocd proj windows` Command Reference + +## argocd proj windows + +Manage a project's sync windows + +``` +argocd proj windows [flags] +``` + +### Examples + +``` + +#Add a sync window to a project +argocd proj windows add my-project \ +--schedule "0 0 * * 1-5" \ +--duration 3600 \ +--prune + +#Delete a sync window from a project +argocd proj windows delete + +#List project sync windows +argocd proj windows list +``` + +### Options + +``` + -h, --help help for windows +``` + +### 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 proj](argocd_proj.md) - Manage projects +* [argocd proj windows add](argocd_proj_windows_add.md) - Add a sync window to a project +* [argocd proj windows delete](argocd_proj_windows_delete.md) - Delete a sync window from a project. Requires ID which can be found by running "argocd proj windows list PROJECT" +* [argocd proj windows disable-manual-sync](argocd_proj_windows_disable-manual-sync.md) - Disable manual sync for a sync window +* [argocd proj windows enable-manual-sync](argocd_proj_windows_enable-manual-sync.md) - Enable manual sync for a sync window +* [argocd proj windows list](argocd_proj_windows_list.md) - List project sync windows +* [argocd proj windows update](argocd_proj_windows_update.md) - Update a project sync window + + diff --git a/docs/cli/argocd_proj_windows_add.md b/docs/cli/argocd_proj_windows_add.md new file mode 100644 index 000000000..536eaaaa7 --- /dev/null +++ b/docs/cli/argocd_proj_windows_add.md @@ -0,0 +1,88 @@ +# `argocd proj windows add` Command Reference + +## argocd proj windows add + +Add a sync window to a project + +``` +argocd proj windows add PROJECT [flags] +``` + +### Examples + +``` + +#Add a 1 hour allow sync window +argocd proj windows add PROJECT \ + --kind allow \ + --schedule "0 22 * * *" \ + --duration 1h \ + --applications "*" + +#Add a deny sync window with the ability to manually sync. +argocd proj windows add PROJECT \ + --kind deny \ + --schedule "30 10 * * *" \ + --duration 30m \ + --applications "prod-\\*,website" \ + --namespaces "default,\\*-prod" \ + --clusters "prod,staging" \ + --manual-sync + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --kind allow \ | +| --schedule "0 22 * * *" \ | +| --duration 1h \ | +| --applications "*" | +| --kind deny \ | +| --schedule "30 10 * * *" \ | +| --duration 30m \ | +| --applications "prod-\\*,website" \ | +| --namespaces "default,\\*-prod" \ | +| --clusters "prod,staging" \ | +| --manual-sync | +| --applications | string s| Applications that the schedule will be applied to. Comma separated, wildcards supported (e.g. --applications prod-\*,website) | +| --clusters | string s| Clusters that the schedule will be applied to. Comma separated, wildcards supported (e.g. --clusters prod,staging) | +| --duration | string | Sync window duration. (e.g. --duration 1h) | +| --manual-sync| Allow manual syncs for both deny and allow windows | +| --namespaces | string s| Namespaces that the schedule will be applied to. Comma separated, wildcards supported (e.g. --namespaces default,\*-prod) | +| --schedule | string | Sync window schedule in cron format. (e.g. --schedule "0 22 * * *") | +| --time-zone | string | Time zone of the sync window (default "UTC") | + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_proj_windows_delete.md b/docs/cli/argocd_proj_windows_delete.md new file mode 100644 index 000000000..efe0edb08 --- /dev/null +++ b/docs/cli/argocd_proj_windows_delete.md @@ -0,0 +1,58 @@ +# `argocd proj windows delete` Command Reference + +## argocd proj windows delete + +Delete a sync window from a project. Requires ID which can be found by running "argocd proj windows list PROJECT" + +``` +argocd proj windows delete PROJECT ID [flags] +``` + +### Examples + +``` + +#Delete a sync window from a project (default) with ID 0 +argocd proj windows delete default 0 + +#Delete a sync window from a project (new-project) with ID 1 +argocd proj windows delete new-project 1 +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_proj_windows_disable-manual-sync.md b/docs/cli/argocd_proj_windows_disable-manual-sync.md new file mode 100644 index 000000000..c69f11803 --- /dev/null +++ b/docs/cli/argocd_proj_windows_disable-manual-sync.md @@ -0,0 +1,63 @@ +# `argocd proj windows disable-manual-sync` Command Reference + +## argocd proj windows disable-manual-sync + +Disable manual sync for a sync window + +### Synopsis + +Disable manual sync for a sync window. Requires ID which can be found by running "argocd proj windows list PROJECT" + +``` +argocd proj windows disable-manual-sync PROJECT ID [flags] +``` + +### Examples + +``` + +#Disable manual sync for a sync window for the Project +argocd proj windows disable-manual-sync PROJECT ID + +#Disbaling manual sync for a windows set on the default project with Id 0 +argocd proj windows disable-manual-sync default 0 +``` + +### Options + +``` + -h, --help help for disable-manual-sync +``` + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_proj_windows_enable-manual-sync.md b/docs/cli/argocd_proj_windows_enable-manual-sync.md new file mode 100644 index 000000000..6c6a6c961 --- /dev/null +++ b/docs/cli/argocd_proj_windows_enable-manual-sync.md @@ -0,0 +1,66 @@ +# `argocd proj windows enable-manual-sync` Command Reference + +## argocd proj windows enable-manual-sync + +Enable manual sync for a sync window + +### Synopsis + +Enable manual sync for a sync window. Requires ID which can be found by running "argocd proj windows list PROJECT" + +``` +argocd proj windows enable-manual-sync PROJECT ID [flags] +``` + +### Examples + +``` + +#Enabling manual sync for a general case +argocd proj windows enable-manual-sync PROJECT ID + +#Enabling manual sync for a windows set on the default project with Id 2 +argocd proj windows enable-manual-sync default 2 + +#Enabling manual sync with a custom message +argocd proj windows enable-manual-sync my-app-project --message "Manual sync initiated by admin +``` + +### Options + +``` + -h, --help help for enable-manual-sync +``` + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_proj_windows_list.md b/docs/cli/argocd_proj_windows_list.md new file mode 100644 index 000000000..a262ea749 --- /dev/null +++ b/docs/cli/argocd_proj_windows_list.md @@ -0,0 +1,63 @@ +# `argocd proj windows list` Command Reference + +## argocd proj windows list + +List project sync windows + +``` +argocd proj windows list PROJECT [flags] +``` + +### Examples + +``` + +#List project windows +argocd proj windows list PROJECT + +#List project windows in yaml format +argocd proj windows list PROJECT -o yaml + +#List project windows info for a project name (test-project) +argocd proj windows list test-project +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide (default "wide") +``` + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + diff --git a/docs/cli/argocd_proj_windows_update.md b/docs/cli/argocd_proj_windows_update.md new file mode 100644 index 000000000..cca895465 --- /dev/null +++ b/docs/cli/argocd_proj_windows_update.md @@ -0,0 +1,67 @@ +# `argocd proj windows update` Command Reference + +## argocd proj windows update + +Update a project sync window + +### Synopsis + +Update a project sync window. Requires ID which can be found by running "argocd proj windows list PROJECT" + +``` +argocd proj windows update PROJECT ID [flags] +``` + +### Examples + +``` +# Change a sync window's schedule +argocd proj windows update PROJECT ID \ + --schedule "0 20 * * *" + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --schedule "0 20 * * *" | +| --applications | string s| Applications that the schedule will be applied to. Comma separated, wildcards supported (e.g. --applications prod-\*,website) | +| --clusters | string s| Clusters that the schedule will be applied to. Comma separated, wildcards supported (e.g. --clusters prod,staging) | +| --duration | string | Sync window duration. (e.g. --duration 1h) | +| --namespaces | string s| Namespaces that the schedule will be applied to. Comma separated, wildcards supported (e.g. --namespaces default,\*-prod) | +| --schedule | string | Sync window schedule in cron format. (e.g. --schedule "0 22 * * *") | +| --time-zone | string | Time zone of the sync window. (e.g. --time-zone "America/New_York") (default "UTC") | + +### 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 proj windows](argocd_proj_windows.md) - Manage a project's sync windows + + diff --git a/docs/cli/argocd_relogin.md b/docs/cli/argocd_relogin.md new file mode 100644 index 000000000..df8b43a53 --- /dev/null +++ b/docs/cli/argocd_relogin.md @@ -0,0 +1,75 @@ +# `argocd relogin` Command Reference + +## argocd relogin + +Refresh an expired authenticate token + +### Synopsis + +Refresh an expired authenticate token + +``` +argocd relogin [flags] +``` + +### Examples + +``` + +# Reinitiates the login with previous contexts +argocd relogin + +# Reinitiates the login with password +argocd relogin --password YOUR_PASSWORD + +# Configure direct access using Kubernetes API server +argocd login cd.argoproj.io --core + +# If user logged in with - "argocd login cd.argoproj.io" with sso login +# The command - "argocd relogin" will Reinitiates SSO login and updates the server context +``` + +### Options + +``` + -h, --help help for relogin + --password string The password of an account to authenticate + --sso-port int Port to run local OAuth2 login application (default 8085) +``` +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| -h, --help | | help for relogin | +| --password | string | The password of an account to authenticate | +| --sso-port | int | Port to run local OAuth2 login application (default 8085) | +### 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](argocd.md) - argocd controls a Argo CD server + + diff --git a/docs/cli/argocd_repo.md b/docs/cli/argocd_repo.md new file mode 100644 index 000000000..3c00c7ebc --- /dev/null +++ b/docs/cli/argocd_repo.md @@ -0,0 +1,86 @@ +# `argocd repo` Command Reference + +## argocd repo + +Manage repository connection parameters + +``` +argocd repo [flags] +``` + +### Examples + +``` + +# Add git repository connection parameters +argocd repo add git@git.example.com:repos/repo + +# Get a Configured Repository by URL +argocd repo get https://github.com/yourusername/your-repo.git + +# List Configured Repositories +argocd repo list + +# Remove Repository Credentials +argocd repo rm https://github.com/yourusername/your-repo.git + +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd repo add](argocd_repo_add.md) - Add git repository connection parameters +* [argocd repo get](argocd_repo_get.md) - Get a configured repository by URL +* [argocd repo list](argocd_repo_list.md) - List configured repositories +* [argocd repo rm](argocd_repo_rm.md) - Remove repository credentials + + diff --git a/docs/cli/argocd_repo_add.md b/docs/cli/argocd_repo_add.md new file mode 100644 index 000000000..13e70a9f3 --- /dev/null +++ b/docs/cli/argocd_repo_add.md @@ -0,0 +1,129 @@ +# `argocd repo add` Command Reference + +## argocd repo add + +Add git repository connection parameters + +``` +argocd repo add REPOURL [flags] +``` + +### Examples + +``` + # Add a Git repository via SSH using a private key for authentication, ignoring the server's host key: + argocd repo add git@git.example.com:repos/repo --insecure-ignore-host-key --ssh-private-key-path ~/id_rsa + + # Add a Git repository via SSH on a non-default port - need to use ssh:// style URLs here + argocd repo add ssh://git@git.example.com:2222/repos/repo --ssh-private-key-path ~/id_rsa + + # Add a Git repository via SSH using socks5 proxy with no proxy credentials + argocd repo add ssh://git@github.com/argoproj/argocd-example-apps --ssh-private-key-path ~/id_rsa --proxy socks5://your.proxy.server.ip:1080 + + # Add a Git repository via SSH using socks5 proxy with proxy credentials + argocd repo add ssh://git@github.com/argoproj/argocd-example-apps --ssh-private-key-path ~/id_rsa --proxy socks5://username:password@your.proxy.server.ip:1080 + + # Add a private Git repository via HTTPS using username/password and TLS client certificates: + argocd repo add https://git.example.com/repos/repo --username git --password secret --tls-client-cert-path ~/mycert.crt --tls-client-cert-key-path ~/mycert.key + + # Add a private Git repository via HTTPS using username/password without verifying the server's TLS certificate + argocd repo add https://git.example.com/repos/repo --username git --password secret --insecure-skip-server-verification + + # Add a public Helm repository named 'stable' via HTTPS + argocd repo add https://charts.helm.sh/stable --type helm --name stable + + # Add a private Helm repository named 'stable' via HTTPS + argocd repo add https://charts.helm.sh/stable --type helm --name stable --username test --password test + + # Add a private Helm OCI-based repository named 'stable' via HTTPS + argocd repo add helm-oci-registry.cn-zhangjiakou.cr.aliyuncs.com --type helm --name stable --enable-oci --username test --password test + + # Add a private Git repository on GitHub.com via GitHub App + argocd repo add https://git.example.com/repos/repo --github-app-id 1 --github-app-installation-id 2 --github-app-private-key-path test.private-key.pem + + # Add a private Git repository on GitHub Enterprise via GitHub App + argocd repo add https://ghe.example.com/repos/repo --github-app-id 1 --github-app-installation-id 2 --github-app-private-key-path test.private-key.pem --github-app-enterprise-base-url https://ghe.example.com/api/v3 + + # Add a private Git repository on Google Cloud Sources via GCP service account credentials + argocd repo add https://source.developers.google.com/p/my-google-cloud-project/r/my-repo --gcp-service-account-key-path service-account-key.json + +``` + +### Options + +``` + --enable-lfs enable git-lfs (Large File Support) on this repository + --enable-oci enable helm-oci (Helm OCI-Based Repository) + --force-http-basic-auth whether to force use of basic auth when connecting repository via HTTP + --gcp-service-account-key-path string service account key for the Google Cloud Platform + --github-app-enterprise-base-url string base url to use when using GitHub Enterprise (e.g. https://ghe.example.com/api/v3 + --github-app-id int id of the GitHub Application + --github-app-installation-id int installation id of the GitHub Application + --github-app-private-key-path string private key of the GitHub Application + -h, --help help for add + --insecure-ignore-host-key disables SSH strict host key checking (deprecated, use --insecure-skip-server-verification instead) + --insecure-skip-server-verification disables server certificate and host key checks + --name string name of the repository, mandatory for repositories of type helm + --password string password to the repository + --project string project of the repository + --proxy string use proxy to access repository + --ssh-private-key-path string path to the private ssh key (e.g. ~/.ssh/id_rsa) + --tls-client-cert-key-path string path to the TLS client cert's key path (must be PEM format) + --tls-client-cert-path string path to the TLS client cert (must be PEM format) + --type string type of the repository, "git" or "helm" (default "git") + --upsert Override an existing repository with the same name even if the spec differs + --username string username to the repository +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --enable-lfs| enable git-lfs (Large File Support) on this repository | +| --enable-oci| enable helm-oci (Helm OCI-Based Repository) | +| --force-http-basic-auth| whether to force use of basic auth when connecting repository via HTTP | +| --gcp-service-account-key-path | string | service account key for the Google Cloud Platform | +| --github-app-enterprise-base-url | string | base url to use when using GitHub Enterprise (e.g. https://ghe.example.com/api/v3 | +| --github-app-id | int | id of the GitHub Application | +| --github-app-installation-id | int | installation id of the GitHub Application | +| --github-app-private-key-path | string | private key of the GitHub Application | +| --insecure-ignore-host-key| disables SSH strict host key checking (deprecated, use --insecure-skip-server-verification instead) | +| --insecure-skip-server-verification| disables server certificate and host key checks | +| --name | string | name of the repository, mandatory for repositories of type helm | +| --password | string | password to the repository | +| --project | string | project of the repository | +| --proxy | string | use proxy to access repository | +| --ssh-private-key-path | string | path to the private ssh key (e.g. ~/.ssh/id_rsa) | +| --tls-client-cert-key-path | string | path to the TLS client cert's key path (must be PEM format) | +| --tls-client-cert-path | string | path to the TLS client cert (must be PEM format) | +| --type | string | type of the repository, "git" or "helm" (default "git") | +| --upsert| Override an existing repository with the same name even if the spec differs | +| --username | string | username to the repository | +| --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 repo](argocd_repo.md) - Manage repository connection parameters + + diff --git a/docs/cli/argocd_repo_get.md b/docs/cli/argocd_repo_get.md new file mode 100644 index 000000000..b34e3527c --- /dev/null +++ b/docs/cli/argocd_repo_get.md @@ -0,0 +1,51 @@ +# `argocd repo get` Command Reference + +## argocd repo get + +Get a configured repository by URL + +``` +argocd repo get [flags] +``` + +### Options + +``` + -h, --help help for get + -o, --output string Output format. One of: json|yaml|wide|url (default "wide") + --refresh string Force a cache refresh on connection status , must be one of: 'hard' +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --refresh | string | Force a cache refresh on connection status , must be one of: 'hard' | +| --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 repo](argocd_repo.md) - Manage repository connection parameters + + diff --git a/docs/cli/argocd_repo_list.md b/docs/cli/argocd_repo_list.md new file mode 100644 index 000000000..2b8001d73 --- /dev/null +++ b/docs/cli/argocd_repo_list.md @@ -0,0 +1,50 @@ +# `argocd repo list` Command Reference + +## argocd repo list + +List configured repositories + +``` +argocd repo list [flags] +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide|url (default "wide") + --refresh string Force a cache refresh on connection status , must be one of: 'hard' +``` + +### Options inherited from parent commands + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --refresh | string | Force a cache refresh on connection status , must be one of: 'hard' | +| --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 repo](argocd_repo.md) - Manage repository connection parameters + diff --git a/docs/cli/argocd_repo_rm.md b/docs/cli/argocd_repo_rm.md new file mode 100644 index 000000000..4f40f7122 --- /dev/null +++ b/docs/cli/argocd_repo_rm.md @@ -0,0 +1,48 @@ +# `argocd repo rm` Command Reference + +## argocd repo rm + +Remove repository credentials + +``` +argocd repo rm REPO [flags] +``` + +### Options + +``` + -h, --help help for rm +``` + +### 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 repo](argocd_repo.md) - Manage repository connection parameters + + diff --git a/docs/cli/argocd_repocreds.md b/docs/cli/argocd_repocreds.md new file mode 100644 index 000000000..48a3d3198 --- /dev/null +++ b/docs/cli/argocd_repocreds.md @@ -0,0 +1,80 @@ +# `argocd repocreds` Command Reference + +## argocd repocreds + +Manage repository connection parameters + +``` +argocd repocreds [flags] +``` + +### Examples + +``` + # Add credentials with user/pass authentication to use for all repositories under the specified URL + argocd repocreds add URL --username USERNAME --password PASSWORD + + # List all the configured repository credentials + argocd repocreds list + + # Remove credentials for the repositories with speficied URL + argocd repocreds rm URL +``` + +### 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](argocd.md) - argocd controls a Argo CD server +* [argocd repocreds add](argocd_repocreds_add.md) - Add git repository connection parameters +* [argocd repocreds list](argocd_repocreds_list.md) - List configured repository credentials +* [argocd repocreds rm](argocd_repocreds_rm.md) - Remove repository credentials + + diff --git a/docs/cli/argocd_repocreds_add.md b/docs/cli/argocd_repocreds_add.md new file mode 100644 index 000000000..84316a290 --- /dev/null +++ b/docs/cli/argocd_repocreds_add.md @@ -0,0 +1,84 @@ +# `argocd repocreds add` Command Reference + +## argocd repocreds add + +Add git repository connection parameters + +``` +argocd repocreds add REPOURL [flags] +``` + +### Examples + +``` + # Add credentials with user/pass authentication to use for all repositories under https://git.example.com/repos + argocd repocreds add https://git.example.com/repos/ --username git --password secret + + # Add credentials with SSH private key authentication to use for all repositories under ssh://git@git.example.com/repos + argocd repocreds add ssh://git@git.example.com/repos/ --ssh-private-key-path ~/.ssh/id_rsa + + # Add credentials with GitHub App authentication to use for all repositories under https://github.com/repos + argocd repocreds add https://github.com/repos/ --github-app-id 1 --github-app-installation-id 2 --github-app-private-key-path test.private-key.pem + + # Add credentials with GitHub App authentication to use for all repositories under https://ghe.example.com/repos + argocd repocreds add https://ghe.example.com/repos/ --github-app-id 1 --github-app-installation-id 2 --github-app-private-key-path test.private-key.pem --github-app-enterprise-base-url https://ghe.example.com/api/v3 + + # Add credentials with helm oci registry so that these oci registry urls do not need to be added as repos individually. + argocd repocreds add localhost:5000/myrepo --enable-oci --type helm + + # Add credentials with GCP credentials for all repositories under https://source.developers.google.com/p/my-google-cloud-project/r/ + argocd repocreds add https://source.developers.google.com/p/my-google-cloud-project/r/ --gcp-service-account-key-path service-account-key.json + +``` + +### Options + +| Option | Argument type | Description | +| ---------------- | ------ | ---- | +| --enable-oci| Specifies whether helm-oci support should be enabled for this repo | +| --force-http-basic-auth| whether to force basic auth when connecting via HTTP | +| --gcp-service-account-key-path | string | service account key for the Google Cloud Platform | +| --github-app-enterprise-base-url | string | base url to use when using GitHub Enterprise (e.g. https://ghe.example.com/api/v3 | +| --github-app-id | int | id of the GitHub Application | +| --github-app-installation-id | int | installation id of the GitHub Application | +| --github-app-private-key-path | string | private key of the GitHub Application | +| --password | string | password to the repository | +| --ssh-private-key-path | string | path to the private ssh key (e.g. ~/.ssh/id_rsa) | +| --tls-client-cert-key-path | string | path to the TLS client cert's key path (must be PEM format) | +| --tls-client-cert-path | string | path to the TLS client cert (must be PEM format) | +| --type | string | type of the repository, "git" or "helm" (default "git") | +| --upsert| Override an existing repository with the same name even if the spec differs | +| --username | string | username to the repository | + +### 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 repocreds](argocd_repocreds.md) - Manage repository connection parameters + + diff --git a/docs/cli/argocd_repocreds_list.md b/docs/cli/argocd_repocreds_list.md new file mode 100644 index 000000000..49d7c5135 --- /dev/null +++ b/docs/cli/argocd_repocreds_list.md @@ -0,0 +1,65 @@ +# `argocd repocreds list` Command Reference + +## argocd repocreds list + +List configured repository credentials + +``` +argocd repocreds list [flags] +``` + +### Examples + +``` + # List all repo urls + argocd repocreds list + + # List all repo urls in json format + argocd repocreds list -o json + + # List all repo urls in yaml format + argocd repocreds list -o yaml + + # List all repo urls in url format + argocd repocreds list -o url +``` + +### Options + +``` + -h, --help help for list + -o, --output string Output format. One of: json|yaml|wide|url (default "wide") +``` + +### 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 repocreds](argocd_repocreds.md) - Manage repository connection parameters + + diff --git a/docs/cli/argocd_repocreds_rm.md b/docs/cli/argocd_repocreds_rm.md new file mode 100644 index 000000000..f21245e9f --- /dev/null +++ b/docs/cli/argocd_repocreds_rm.md @@ -0,0 +1,55 @@ +# `argocd repocreds rm` Command Reference + +## argocd repocreds rm + +Remove repository credentials + +``` +argocd repocreds rm CREDSURL [flags] +``` + +### Examples + +``` + # Remove credentials for the repositories with URL https://git.example.com/repos + argocd repocreds rm https://git.example.com/repos/ +``` + +### Options + +``` + -h, --help help for rm +``` + +### 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 repocreds](argocd_repocreds.md) - Manage repository connection parameters + + diff --git a/docs/cli/convert.sh b/docs/cli/convert.sh new file mode 100644 index 000000000..f1372a5be --- /dev/null +++ b/docs/cli/convert.sh @@ -0,0 +1,11 @@ +for file in $(ls -1 argocd_*.md) +do + echo "| Option | Argument type | Description |" >> $file + echo "| ---------------- | ------ | ---- |" >> $file + cat $file | grep ' --'| sed -e 's/ */| /g' | sed -e 's/ string/ | string /g' | sed -e 's/ int/ | int /g' | sed -e 's/$/ |/g' >> $file + sed -i 's/--core| /--core | |/g' $file + sed -i 's/--grpc-web| /--grpc-web | |/g' $file + sed -i 's/--port-forward| /--port-forward | |/g' $file + sed -i 's/--plaintext| /--plaintext | |/g' $file + sed -i 's/--insecure| /--insecure | |/g' $file +done