docs: better command reference titles (#15567) (#15568)

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
This commit is contained in:
Michael Crenshaw 2023-09-19 14:34:24 -04:00 committed by GitHub
parent df714accc0
commit 5ad5826332
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
157 changed files with 329 additions and 5 deletions

View file

@ -1,3 +1,5 @@
# `argocd-application-controller` Command Reference
## argocd-application-controller
Run ArgoCD Application Controller

View file

@ -1,3 +1,5 @@
# `argocd-dex` Command Reference
## argocd-dex
argocd-dex tools used by Argo CD

View file

@ -1,3 +1,5 @@
# `argocd-dex gendexcfg` Command Reference
## argocd-dex gendexcfg
Generates a dex config from Argo CD settings

View file

@ -1,3 +1,5 @@
# `argocd-dex rundex` Command Reference
## argocd-dex rundex
Runs dex generating a config using settings from the Argo CD configmap and secret

View file

@ -1,3 +1,5 @@
# `argocd-repo-server` Command Reference
## argocd-repo-server
Run ArgoCD Repository Server

View file

@ -1,3 +1,5 @@
# `argocd-server` Command Reference
## argocd-server
Run the ArgoCD API server

View file

@ -1,3 +1,5 @@
# `argocd-server version` Command Reference
## argocd-server version
Print version information

View file

@ -1,3 +1,5 @@
# `argocd` Command Reference
## argocd
argocd controls a Argo CD server

View file

@ -1,3 +1,5 @@
# `argocd account` Command Reference
## argocd account
Manage account settings

View file

@ -1,3 +1,5 @@
# `argocd account bcrypt` Command Reference
## argocd account bcrypt
Generate bcrypt hash for the admin password

View file

@ -1,3 +1,5 @@
# `argocd account can-i` Command Reference
## argocd account can-i
Can I

View file

@ -1,3 +1,5 @@
# `argocd account delete-token` Command Reference
## argocd account delete-token
Deletes account token

View file

@ -1,3 +1,5 @@
# `argocd account generate-token` Command Reference
## argocd account generate-token
Generate account token

View file

@ -1,3 +1,5 @@
# `argocd account get-user-info` Command Reference
## argocd account get-user-info
Get user info

View file

@ -1,3 +1,5 @@
# `argocd account get` Command Reference
## argocd account get
Get account details

View file

@ -1,3 +1,5 @@
# `argocd account list` Command Reference
## argocd account list
List accounts

View file

@ -1,3 +1,5 @@
# `argocd account update-password` Command Reference
## argocd account update-password
Update an account's password

View file

@ -1,3 +1,5 @@
# `argocd admin` Command Reference
## argocd admin
Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access

View file

@ -1,3 +1,5 @@
# `argocd admin app` Command Reference
## argocd admin app
Manage applications configuration

View file

@ -1,3 +1,5 @@
# `argocd admin app diff-reconcile-results` Command Reference
## argocd admin app diff-reconcile-results
Compare results of two reconciliations and print diff.

View file

@ -1,3 +1,5 @@
# `argocd admin app generate-spec` Command Reference
## argocd admin app generate-spec
Generate declarative config for an application

View file

@ -1,3 +1,5 @@
# `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.

View file

@ -1,3 +1,5 @@
# `argocd admin cluster` Command Reference
## argocd admin cluster
Manage clusters configuration

View file

@ -1,3 +1,5 @@
# `argocd admin cluster generate-spec` Command Reference
## argocd admin cluster generate-spec
Generate declarative config for a cluster

View file

@ -1,3 +1,5 @@
# `argocd admin cluster kubeconfig` Command Reference
## argocd admin cluster kubeconfig
Generates kubeconfig for the specified cluster

View file

@ -1,3 +1,5 @@
# `argocd admin cluster namespaces` Command Reference
## argocd admin cluster namespaces
Print information namespaces which Argo CD manages in each cluster.

View file

@ -1,3 +1,5 @@
# `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.

View file

@ -1,3 +1,5 @@
# `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.

View file

@ -1,3 +1,5 @@
# `argocd admin cluster shards` Command Reference
## argocd admin cluster shards
Print information about each controller shard and portion of Kubernetes resources it is responsible for.

View file

@ -1,3 +1,5 @@
# `argocd admin cluster stats` Command Reference
## argocd admin cluster stats
Prints information cluster statistics and inferred shard number

View file

@ -1,3 +1,5 @@
# `argocd admin dashboard` Command Reference
## argocd admin dashboard
Starts Argo CD Web UI locally

View file

@ -1,3 +1,5 @@
# `argocd admin export` Command Reference
## argocd admin export
Export all Argo CD data to stdout (default) or a file

View file

@ -1,3 +1,5 @@
# `argocd admin import` Command Reference
## argocd admin import
Import Argo CD data from stdin (specify `-') or a file

View file

@ -1,3 +1,5 @@
# `argocd admin initial-password` Command Reference
## argocd admin initial-password
Prints initial password to log in to Argo CD for the first time

View file

@ -1,3 +1,5 @@
# `argocd admin notifications` Command Reference
## argocd admin notifications
Set of CLI commands that helps manage notifications settings

View file

@ -1,3 +1,5 @@
# `argocd admin notifications template` Command Reference
## argocd admin notifications template
Notification templates related commands

View file

@ -1,3 +1,5 @@
# `argocd admin notifications template get` Command Reference
## argocd admin notifications template get
Prints information about configured templates

View file

@ -1,3 +1,5 @@
# `argocd admin notifications template notify` Command Reference
## argocd admin notifications template notify
Generates notification using the specified template and send it to specified recipients

View file

@ -1,3 +1,5 @@
# `argocd admin notifications trigger` Command Reference
## argocd admin notifications trigger
Notification triggers related commands

View file

@ -1,3 +1,5 @@
# `argocd admin notifications trigger get` Command Reference
## argocd admin notifications trigger get
Prints information about configured triggers

View file

@ -1,3 +1,5 @@
# `argocd admin notifications trigger run` Command Reference
## argocd admin notifications trigger run
Evaluates specified trigger condition and prints the result

View file

@ -1,3 +1,5 @@
# `argocd admin proj` Command Reference
## argocd admin proj
Manage projects configuration

View file

@ -1,3 +1,5 @@
# `argocd admin proj generate-allow-list` Command Reference
## argocd admin proj generate-allow-list
Generates project allow list from the specified clusterRole file

View file

@ -1,3 +1,5 @@
# `argocd admin proj generate-spec` Command Reference
## argocd admin proj generate-spec
Generate declarative config for a project

View file

@ -1,3 +1,5 @@
# `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.

View file

@ -1,3 +1,5 @@
# `argocd admin repo` Command Reference
## argocd admin repo
Manage repositories configuration

View file

@ -1,3 +1,5 @@
# `argocd admin repo generate-spec` Command Reference
## argocd admin repo generate-spec
Generate declarative config for a repo

View file

@ -1,3 +1,5 @@
# `argocd admin settings` Command Reference
## argocd admin settings
Provides set of commands for settings validation and troubleshooting

View file

@ -1,3 +1,5 @@
# `argocd admin settings rbac` Command Reference
## argocd admin settings rbac
Validate and test RBAC configuration

View file

@ -1,3 +1,5 @@
# `argocd admin settings rbac can` Command Reference
## argocd admin settings rbac can
Check RBAC permissions for a role or subject

View file

@ -1,3 +1,5 @@
# `argocd admin settings rbac validate` Command Reference
## argocd admin settings rbac validate
Validate RBAC policy

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides` Command Reference
## argocd admin settings resource-overrides
Troubleshoot resource overrides

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides health` Command Reference
## argocd admin settings resource-overrides health
Assess resource health

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides ignore-differences` Command Reference
## argocd admin settings resource-overrides ignore-differences
Renders fields excluded from diffing

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides ignore-resource-updates` Command Reference
## argocd admin settings resource-overrides ignore-resource-updates
Renders fields excluded from resource updates

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides list-actions` Command Reference
## argocd admin settings resource-overrides list-actions
List available resource actions

View file

@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides run-action` Command Reference
## argocd admin settings resource-overrides run-action
Executes resource action

View file

@ -1,3 +1,5 @@
# `argocd admin settings validate` Command Reference
## argocd admin settings validate
Validate settings

View file

@ -1,3 +1,5 @@
# `argocd app` Command Reference
## argocd app
Manage applications

View file

@ -1,3 +1,5 @@
# `argocd app actions` Command Reference
## argocd app actions
Manage Resource actions

View file

@ -1,3 +1,5 @@
# `argocd app actions list` Command Reference
## argocd app actions list
Lists available actions on a resource

View file

@ -1,3 +1,5 @@
# `argocd app actions run` Command Reference
## argocd app actions run
Runs an available action on resource(s)

View file

@ -1,3 +1,5 @@
# `argocd app create` Command Reference
## argocd app create
Create an application

View file

@ -1,3 +1,5 @@
# `argocd app delete-resource` Command Reference
## argocd app delete-resource
Delete resource in an application

View file

@ -1,3 +1,5 @@
# `argocd app delete` Command Reference
## argocd app delete
Delete an application

View file

@ -1,3 +1,5 @@
# `argocd app diff` Command Reference
## argocd app diff
Perform a diff against the target and live state.

View file

@ -1,3 +1,5 @@
# `argocd app edit` Command Reference
## argocd app edit
Edit application

View file

@ -1,3 +1,5 @@
# `argocd app get` Command Reference
## argocd app get
Get application details

View file

@ -1,3 +1,5 @@
# `argocd app history` Command Reference
## argocd app history
Show application deployment history

View file

@ -1,3 +1,5 @@
# `argocd app list` Command Reference
## argocd app list
List applications

View file

@ -1,3 +1,5 @@
# `argocd app logs` Command Reference
## argocd app logs
Get logs of application pods

View file

@ -1,3 +1,5 @@
# `argocd app manifests` Command Reference
## argocd app manifests
Print manifests of an application

View file

@ -1,3 +1,5 @@
# `argocd app patch-resource` Command Reference
## argocd app patch-resource
Patch resource in an application

View file

@ -1,3 +1,5 @@
# `argocd app patch` Command Reference
## argocd app patch
Patch application

View file

@ -1,3 +1,5 @@
# `argocd app resources` Command Reference
## argocd app resources
List resource of application

View file

@ -1,3 +1,5 @@
# `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

View file

@ -1,3 +1,5 @@
# `argocd app set` Command Reference
## argocd app set
Set application parameters

View file

@ -1,3 +1,5 @@
# `argocd app sync` Command Reference
## argocd app sync
Sync an application to its target state

View file

@ -1,3 +1,5 @@
# `argocd app terminate-op` Command Reference
## argocd app terminate-op
Terminate running operation of an application

View file

@ -1,3 +1,5 @@
# `argocd app unset` Command Reference
## argocd app unset
Unset application parameters

View file

@ -1,3 +1,5 @@
# `argocd app wait` Command Reference
## argocd app wait
Wait for an application to reach a synced and healthy state

View file

@ -1,3 +1,5 @@
# `argocd appset` Command Reference
## argocd appset
Manage ApplicationSets

View file

@ -1,3 +1,5 @@
# `argocd appset create` Command Reference
## argocd appset create
Create one or more ApplicationSets

View file

@ -1,3 +1,5 @@
# `argocd appset delete` Command Reference
## argocd appset delete
Delete one or more ApplicationSets

View file

@ -1,3 +1,5 @@
# `argocd appset get` Command Reference
## argocd appset get
Get ApplicationSet details

View file

@ -1,3 +1,5 @@
# `argocd appset list` Command Reference
## argocd appset list
List ApplicationSets

View file

@ -1,3 +1,5 @@
# `argocd cert` Command Reference
## argocd cert
Manage repository certificates and SSH known hosts entries

View file

@ -1,3 +1,5 @@
# `argocd cert add-ssh` Command Reference
## argocd cert add-ssh
Add SSH known host entries for repository servers

View file

@ -1,3 +1,5 @@
# `argocd cert add-tls` Command Reference
## argocd cert add-tls
Add TLS certificate data for connecting to repository server SERVERNAME

View file

@ -1,3 +1,5 @@
# `argocd cert list` Command Reference
## argocd cert list
List configured certificates

View file

@ -1,3 +1,5 @@
# `argocd cert rm` Command Reference
## argocd cert rm
Remove certificate of TYPE for REPOSERVER

View file

@ -1,3 +1,5 @@
# `argocd cluster` Command Reference
## argocd cluster
Manage cluster credentials

View file

@ -1,3 +1,5 @@
# `argocd cluster add` Command Reference
## argocd cluster add
argocd cluster add CONTEXT

View file

@ -1,3 +1,5 @@
# `argocd cluster get` Command Reference
## argocd cluster get
Get cluster information

View file

@ -1,3 +1,5 @@
# `argocd cluster list` Command Reference
## argocd cluster list
List configured clusters

View file

@ -1,3 +1,5 @@
# `argocd cluster rm` Command Reference
## argocd cluster rm
Remove cluster credentials

View file

@ -1,3 +1,5 @@
# `argocd cluster rotate-auth` Command Reference
## argocd cluster rotate-auth
argocd cluster rotate-auth SERVER/NAME

View file

@ -1,3 +1,5 @@
# `argocd cluster set` Command Reference
## argocd cluster set
Set cluster information

View file

@ -1,3 +1,5 @@
# `argocd completion` Command Reference
## argocd completion
output shell completion code for the specified shell (bash or zsh)

View file

@ -1,3 +1,5 @@
# `argocd context` Command Reference
## argocd context
Switch between contexts

Some files were not shown because too many files have changed in this diff Show more