Skip to content

Commit

Permalink
fix: minor cleanup for wording in cli and docs (argoproj#5321)
Browse files Browse the repository at this point in the history
* fix: various docs grammar fixes

Signed-off-by: Regina Scott <rescott@redhat.com>
  • Loading branch information
reginapizza committed Jan 28, 2021
1 parent 420c170 commit 5f10461
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion cmd/util/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func AddAppFlags(command *cobra.Command, opts *AppOptions) {
command.Flags().StringArrayVar(&opts.helmSetFiles, "helm-set-file", []string{}, "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)")
command.Flags().StringVar(&opts.project, "project", "", "Application project name")
command.Flags().StringVar(&opts.syncPolicy, "sync-policy", "", "Set the sync policy (one of: none, automated (aliases of automated: auto, automatic))")
command.Flags().StringArrayVar(&opts.syncOptions, "sync-option", []string{}, "Add or remove a sync options, e.g add `Prune=false`. Remove using `!` prefix, e.g. `!Prune=false`")
command.Flags().StringArrayVar(&opts.syncOptions, "sync-option", []string{}, "Add or remove a sync option, e.g add `Prune=false`. Remove using `!` prefix, e.g. `!Prune=false`")
command.Flags().BoolVar(&opts.autoPrune, "auto-prune", false, "Set automatic pruning when sync is automated")
command.Flags().BoolVar(&opts.selfHeal, "self-heal", false, "Set self healing when sync is automated")
command.Flags().BoolVar(&opts.allowEmpty, "allow-empty", false, "Set allow zero live resources when sync is automated")
Expand Down
8 changes: 4 additions & 4 deletions cmd/util/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,13 @@ type ClusterOptions struct {
func AddClusterFlags(command *cobra.Command, opts *ClusterOptions) {
command.Flags().BoolVar(&opts.InCluster, "in-cluster", false, "Indicates Argo CD resides inside this cluster and should connect using the internal k8s hostname (kubernetes.default.svc)")
command.Flags().StringVar(&opts.AwsClusterName, "aws-cluster-name", "", "AWS Cluster name if set then aws cli eks token command will be used to access cluster")
command.Flags().StringVar(&opts.AwsRoleArn, "aws-role-arn", "", "Optional AWS role arn. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.")
command.Flags().StringVar(&opts.AwsRoleArn, "aws-role-arn", "", "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.")
command.Flags().StringArrayVar(&opts.Namespaces, "namespace", nil, "List of namespaces which are allowed to manage")
command.Flags().StringVar(&opts.Name, "name", "", "Overwrite the cluster name")
command.Flags().Int64Var(&opts.Shard, "shard", -1, "Cluster shard number; inferred from hostname if not set")
command.Flags().StringVar(&opts.ExecProviderCommand, "exec-command", "", "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.")
command.Flags().StringArrayVar(&opts.ExecProviderArgs, "exec-command-args", nil, "Arguments to supply to the --exec-command command")
command.Flags().StringToStringVar(&opts.ExecProviderEnv, "exec-command-env", nil, "Environment vars to set when running the --exec-command command")
command.Flags().StringVar(&opts.ExecProviderAPIVersion, "exec-command-api-version", "", "Preferred input version of the ExecInfo for the --exec-command")
command.Flags().StringArrayVar(&opts.ExecProviderArgs, "exec-command-args", nil, "Arguments to supply to the --exec-command executable")
command.Flags().StringToStringVar(&opts.ExecProviderEnv, "exec-command-env", nil, "Environment vars to set when running the --exec-command executable")
command.Flags().StringVar(&opts.ExecProviderAPIVersion, "exec-command-api-version", "", "Preferred input version of the ExecInfo for the --exec-command executable")
command.Flags().StringVar(&opts.ExecProviderInstallHint, "exec-command-install-hint", "", "Text shown to the user when the --exec-command executable doesn't seem to be present")
}
2 changes: 1 addition & 1 deletion cmd/util/project.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func AddProjFlags(command *cobra.Command, opts *ProjectOpts) {
command.Flags().StringArrayVarP(&opts.Sources, "src", "s", []string{}, "Permitted source repository URL")
command.Flags().StringSliceVar(&opts.SignatureKeys, "signature-keys", []string{}, "GnuPG public key IDs for commit signature verification")
command.Flags().BoolVar(&opts.orphanedResourcesEnabled, "orphaned-resources", false, "Enables orphaned resources monitoring")
command.Flags().BoolVar(&opts.orphanedResourcesWarn, "orphaned-resources-warn", false, "Specifies if applications should be a warning condition when orphaned resources detected")
command.Flags().BoolVar(&opts.orphanedResourcesWarn, "orphaned-resources-warn", false, "Specifies if applications should have a warning condition when orphaned resources detected")
}

func (opts *ProjectOpts) GetDestinations() []v1alpha1.ApplicationDestination {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ argocd-util config app APPNAME [flags]
--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 options, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false`
--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))
--validate Validation of repo and cluster (default true)
--values stringArray Helm values file(s) to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ argocd-util config cluster CONTEXT [flags]

```
--aws-cluster-name string AWS Cluster name if set then aws cli eks token command will be used to access cluster
--aws-role-arn string Optional AWS role arn. If set then AWS IAM Authenticator assume a role 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
--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
--exec-command-args stringArray Arguments to supply to the --exec-command command
--exec-command-env stringToString Environment vars to set when running the --exec-command command (default [])
--exec-command-api-version string Preferred input version of the ExecInfo for the --exec-command executable
--exec-command-args stringArray Arguments to supply to the --exec-command executable
--exec-command-env stringToString 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
-h, --help help for cluster
--in-cluster Indicates Argo CD resides inside this cluster and should connect using the internal k8s hostname (kubernetes.default.svc)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ argocd-util config proj PROJECT [flags]
-f, --file string Filename or URL to Kubernetes manifests for the project
-h, --help help for proj
--orphaned-resources Enables orphaned resources monitoring
--orphaned-resources-warn Specifies if applications should be a warning condition when orphaned resources detected
--orphaned-resources-warn Specifies if applications should have a warning condition when orphaned resources detected
-o, --output string Output format. One of: json|yaml (default "yaml")
--signature-keys strings GnuPG public key IDs for commit signature verification
-s, --src stringArray Permitted source repository URL
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/commands/argocd_app_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ argocd app create APPNAME [flags]
--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 options, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false`
--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))
--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)
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/commands/argocd_app_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ argocd app set APPNAME [flags]
--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 options, e.g add Prune=false. Remove using `!` prefix, e.g. `!Prune=false`
--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))
--validate Validation of repo and cluster (default true)
--values stringArray Helm values file(s) to use
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/commands/argocd_cluster_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ argocd cluster add CONTEXT [flags]

```
--aws-cluster-name string AWS Cluster name if set then aws cli eks token command will be used to access cluster
--aws-role-arn string Optional AWS role arn. If set then AWS IAM Authenticator assume a role 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.
--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
--exec-command-args stringArray Arguments to supply to the --exec-command command
--exec-command-env stringToString Environment vars to set when running the --exec-command command (default [])
--exec-command-api-version string Preferred input version of the ExecInfo for the --exec-command executable
--exec-command-args stringArray Arguments to supply to the --exec-command executable
--exec-command-env stringToString 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
-h, --help help for add
--in-cluster Indicates Argo CD resides inside this cluster and should connect using the internal k8s hostname (kubernetes.default.svc)
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/commands/argocd_proj_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ argocd proj create PROJECT [flags]
-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 be a warning condition when orphaned resources detected
--orphaned-resources-warn Specifies if applications should have a warning condition when orphaned resources detected
--signature-keys strings GnuPG public key IDs for commit signature verification
-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
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/commands/argocd_proj_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ argocd proj set PROJECT [flags]
-d, --dest stringArray Permitted destination server and namespace (e.g. https://192.168.99.100:8443,default)
-h, --help help for set
--orphaned-resources Enables orphaned resources monitoring
--orphaned-resources-warn Specifies if applications should be a warning condition when orphaned resources detected
--orphaned-resources-warn Specifies if applications should have a warning condition when orphaned resources detected
--signature-keys strings GnuPG public key IDs for commit signature verification
-s, --src stringArray Permitted source repository URL
```
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/kustomize.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To use Kustomize with an overlay, point your path to the overlay.

If you have remote bases that are either (a) HTTPS and need username/password (b) SSH and need SSH private key, then they'll inherit that from the app's repo.

This will work if the remote bases uses the same credentials/private key. It will not work if they use different ones. For security reasons your app only ever knows about its own repo (not other team's or users repos), and so you won't be able to access other private repo, even if Argo CD knows about them.
This will work if the remote bases uses the same credentials/private key. It will not work if they use different ones. For security reasons your app only ever knows about its own repo (not other team's or users repos), and so you won't be able to access other private repos, even if Argo CD knows about them.

Read more about [private repos](private-repositories.md).

Expand All @@ -39,7 +39,7 @@ data:
```
## Custom Kustomize versions

Argo CD supports using multiple kustomize versions simultaneously and specify required version per application.
Argo CD supports using multiple kustomize versions simultaneously and specifies required version per application.
To add additional versions make sure required versions are [bundled](../operator-manual/custom_tools.md) and then
use `kustomize.version.<version>` fields of `argocd-cm` ConfigMap to register bundled additional versions.

Expand All @@ -57,7 +57,7 @@ data:
kustomize.version.v3.5.4: /custom-tools/kustomize_3_5_4
```

Once new version is configured you can reference it in Application spec as following:
Once a new version is configured you can reference it in Application spec as following:

```yaml
apiVersion: argoproj.io/v1alpha1
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/sync-waves.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ When Argo CD starts a sync, it orders the resources in the following precedence:
* By kind (e.g. namespaces first)
* By name

It then determines which the number of the next wave to apply. This is the first number where any resource is out-of-sync or unhealthy.
It then determines the number of the next wave to apply. This is the first number where any resource is out-of-sync or unhealthy.

It applies resources in that wave.

It repeats this process until all phases and waves are in in-sync and healthy.
It repeats this process until all phases and waves are in-sync and healthy.

Because an application can have resources that are unhealthy in the first wave, it may be that the app can never get to healthy.

0 comments on commit 5f10461

Please sign in to comment.