Skip to content

Commit 5c76d8f

Browse files
authored
chore: space in 'Argo CD' (argoproj#14987)
Signed-off-by: Michael Crenshaw <[email protected]>
1 parent 20a1649 commit 5c76d8f

19 files changed

+44
-44
lines changed

SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ of releasing it within a patch branch for the currently supported releases.
5050

5151
## Reporting a Vulnerability
5252

53-
If you find a security related bug in ArgoCD, we kindly ask you for responsible
53+
If you find a security related bug in Argo CD, we kindly ask you for responsible
5454
disclosure and for giving us appropriate time to react, analyze and develop a
5555
fix to mitigate the found security vulnerability.
5656

docs/developer-guide/releasing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
ArgoCD is released in a 2 step automated fashion using GitHub actions. The release process takes about 60 minutes,
5+
Argo CD is released in a 2 step automated fashion using GitHub actions. The release process takes about 60 minutes,
66
sometimes a little less, depending on the performance of GitHub Actions runners.
77

88
The target release branch must already exist in the GitHub repository. If you for

docs/faq.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ See [#1482](https://github.com/argoproj/argo-cd/issues/1482).
139139
## How often does Argo CD check for changes to my Git or Helm repository ?
140140

141141
The default polling interval is 3 minutes (180 seconds).
142-
You can change the setting by updating the `timeout.reconciliation` value in the [argocd-cm](https://github.com/argoproj/argo-cd/blob/2d6ce088acd4fb29271ffb6f6023dbb27594d59b/docs/operator-manual/argocd-cm.yaml#L279-L282) config map. If there are any Git changes, ArgoCD will only update applications with the [auto-sync setting](user-guide/auto_sync.md) enabled. If you set it to `0` then Argo CD will stop polling Git repositories automatically and you can only use alternative methods such as [webhooks](operator-manual/webhook.md) and/or manual syncs for deploying applications.
142+
You can change the setting by updating the `timeout.reconciliation` value in the [argocd-cm](https://github.com/argoproj/argo-cd/blob/2d6ce088acd4fb29271ffb6f6023dbb27594d59b/docs/operator-manual/argocd-cm.yaml#L279-L282) config map. If there are any Git changes, Argo CD will only update applications with the [auto-sync setting](user-guide/auto_sync.md) enabled. If you set it to `0` then Argo CD will stop polling Git repositories automatically and you can only use alternative methods such as [webhooks](operator-manual/webhook.md) and/or manual syncs for deploying applications.
143143

144144

145145
## Why Are My Resource Limits `Out Of Sync`?
@@ -194,7 +194,7 @@ argocd ... --insecure
194194

195195
## I have configured Dex via `dex.config` in `argocd-cm`, it still says Dex is unconfigured. Why?
196196

197-
Most likely you forgot to set the `url` in `argocd-cm` to point to your ArgoCD as well. See also
197+
Most likely you forgot to set the `url` in `argocd-cm` to point to your Argo CD as well. See also
198198
[the docs](./operator-manual/user-management/index.md#2-configure-argo-cd-for-sso).
199199

200200
## Why are `SealedSecret` resources reporting a `Status`?
@@ -208,14 +208,14 @@ fixed CRD if you want this feature to work at all.
208208
## <a name="sealed-secret-stuck-progressing"></a>Why are resources of type `SealedSecret` stuck in the `Progressing` state?
209209

210210
The controller of the `SealedSecret` resource may expose the status condition on resource it provisioned. Since
211-
version `v2.0.0` ArgoCD picks up that status condition to derive a health status for the `SealedSecret`.
211+
version `v2.0.0` Argo CD picks up that status condition to derive a health status for the `SealedSecret`.
212212

213213
Versions before `v0.15.0` of the `SealedSecret` controller are affected by an issue regarding this status
214214
conditions updates, which is why this feature is disabled by default in these versions. Status condition updates may be
215215
enabled by starting the `SealedSecret` controller with the `--update-status` command line parameter or by setting
216216
the `SEALED_SECRETS_UPDATE_STATUS` environment variable.
217217

218-
To disable ArgoCD from checking the status condition on `SealedSecret` resources, add the following resource
218+
To disable Argo CD from checking the status condition on `SealedSecret` resources, add the following resource
219219
customization in your `argocd-cm` ConfigMap via `resource.customizations.health.<group_kind>` key.
220220

221221
```yaml

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/st
2525
```
2626

2727
Follow our [getting started guide](getting_started.md). Further user oriented [documentation](user-guide/)
28-
is provided for additional features. If you are looking to upgrade ArgoCD, see the [upgrade guide](./operator-manual/upgrading/overview.md).
28+
is provided for additional features. If you are looking to upgrade Argo CD, see the [upgrade guide](./operator-manual/upgrading/overview.md).
2929
Developer oriented [documentation](developer-guide/) is available for people interested in building third-party integrations.
3030

3131
## How it works

docs/operator-manual/applicationset/Generators-Pull-Request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ spec:
232232
- `api`: Optional URL to access the Bitbucket REST API. For the example above, an API request would be made to `https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pullrequests`. If not set, defaults to `https://api.bitbucket.org/2.0`
233233
- `branchMatch`: Optional regexp filter which should match the source branch name. This is an alternative to labels which are not supported by Bitbucket server.
234234

235-
If you want to access a private repository, ArgoCD will need credentials to access repository in Bitbucket Cloud. You can use Bitbucket App Password (generated per user, with access to whole workspace), or Bitbucket App Token (generated per repository, with access limited to repository scope only). If both App Password and App Token are defined, App Token will be used.
235+
If you want to access a private repository, Argo CD will need credentials to access repository in Bitbucket Cloud. You can use Bitbucket App Password (generated per user, with access to whole workspace), or Bitbucket App Token (generated per repository, with access limited to repository scope only). If both App Password and App Token are defined, App Token will be used.
236236

237237
To use Bitbucket App Password, use `basicAuth` section.
238238
- `username`: The username to authenticate with. It only needs read access to the relevant repo.

docs/operator-manual/applicationset/Generators-SCM-Provider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Depending on whether `role` is provided in `awsCodeCommit` property, AWS IAM per
318318
#### Discover AWS CodeCommit Repositories in the same AWS Account as ApplicationSet Controller
319319

320320
Without specifying `role`, ApplicationSet controller will use its own AWS identity to scan AWS CodeCommit repos.
321-
This is suitable when you have a simple setup that all AWS CodeCommit repos reside in the same AWS account as your ArgoCD.
321+
This is suitable when you have a simple setup that all AWS CodeCommit repos reside in the same AWS account as your Argo CD.
322322

323323
As the ApplicationSet controller AWS identity is used directly for repo discovery, it must be granted below AWS permissions.
324324

docs/operator-manual/ingress.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -415,9 +415,9 @@ Once we create this service, we can configure the Ingress to conditionally route
415415
```
416416

417417
## [Istio](https://www.istio.io)
418-
You can put ArgoCD behind Istio using following configurations. Here we will achive both serving ArgoCD behind istio and using subpath on Istio
418+
You can put Argo CD behind Istio using following configurations. Here we will achive both serving Argo CD behind istio and using subpath on Istio
419419

420-
First we need to make sure that we can run ArgoCD with subpath (ie /argocd). For this we have used install.yaml from argocd project as is
420+
First we need to make sure that we can run Argo CD with subpath (ie /argocd). For this we have used install.yaml from argocd project as is
421421

422422
```bash
423423
curl -kLs -o install.yaml https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
@@ -467,7 +467,7 @@ spec:
467467
value: "0"
468468
```
469469

470-
After that install ArgoCD (there should be only 3 yml file defined above in current directory )
470+
After that install Argo CD (there should be only 3 yml file defined above in current directory )
471471

472472
```bash
473473
kubectl apply -k ./ -n argocd --wait=true
@@ -712,15 +712,15 @@ Once the DNS change is propagated, you're ready to use Argo with your Google Clo
712712

713713
## Authenticating through multiple layers of authenticating reverse proxies
714714

715-
ArgoCD endpoints may be protected by one or more reverse proxies layers, in that case, you can provide additional headers through the `argocd` CLI `--header` parameter to authenticate through those layers.
715+
Argo CD endpoints may be protected by one or more reverse proxies layers, in that case, you can provide additional headers through the `argocd` CLI `--header` parameter to authenticate through those layers.
716716

717717
```shell
718718
$ argocd login <host>:<port> --header 'x-token1:foo' --header 'x-token2:bar' # can be repeated multiple times
719719
$ argocd login <host>:<port> --header 'x-token1:foo,x-token2:bar' # headers can also be comma separated
720720
```
721721
## ArgoCD Server and UI Root Path (v1.5.3)
722722

723-
ArgoCD server and UI can be configured to be available under a non-root path (e.g. `/argo-cd`).
723+
Argo CD server and UI can be configured to be available under a non-root path (e.g. `/argo-cd`).
724724
To do this, add the `--rootpath` flag into the `argocd-server` deployment command:
725725

726726
```yaml

docs/operator-manual/metrics.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Metrics about applications. Scraped at the `argocd-metrics:8082/metrics` endpoin
77

88
| Metric | Type | Description |
99
|--------|:----:|-------------|
10-
| `argocd_app_info` | gauge | Information about Applications. It contains labels such as `sync_status` and `health_status` that reflect the application state in ArgoCD. |
10+
| `argocd_app_info` | gauge | Information about Applications. It contains labels such as `sync_status` and `health_status` that reflect the application state in Argo CD. |
1111
| `argocd_app_k8s_request_total` | counter | Number of kubernetes requests executed during application reconciliation |
1212
| `argocd_app_labels` | gauge | Argo Application labels converted to Prometheus labels. Disabled by default. See section below about how to enable it. |
1313
| `argocd_app_reconcile` | histogram | Application reconciliation performance. |
@@ -23,7 +23,7 @@ Metrics about applications. Scraped at the `argocd-metrics:8082/metrics` endpoin
2323
| `argocd_redis_request_duration` | histogram | Redis requests duration. |
2424
| `argocd_redis_request_total` | counter | Number of redis requests executed during application reconciliation |
2525

26-
If you use ArgoCD with many application and project creation and deletion,
26+
If you use Argo CD with many application and project creation and deletion,
2727
the metrics page will keep in cache your application and project's history.
2828
If you are having issues because of a large number of metrics cardinality due
2929
to deleted resources, you can schedule a metrics reset to clean the
@@ -32,16 +32,16 @@ history with an application controller flag. Example:
3232

3333
### Exposing Application labels as Prometheus metrics
3434

35-
There are use-cases where ArgoCD Applications contain labels that are desired to be exposed as Prometheus metrics.
35+
There are use-cases where Argo CD Applications contain labels that are desired to be exposed as Prometheus metrics.
3636
Some examples are:
3737

3838
* Having the team name as a label to allow routing alerts to specific receivers
3939
* Creating dashboards broken down by business units
4040

4141
As the Application labels are specific to each company, this feature is disabled by default. To enable it, add the
42-
`--metrics-application-labels` flag to the ArgoCD application controller.
42+
`--metrics-application-labels` flag to the Argo CD application controller.
4343

44-
The example below will expose the ArgoCD Application labels `team-name` and `business-unit` to Prometheus:
44+
The example below will expose the Argo CD Application labels `team-name` and `business-unit` to Prometheus:
4545

4646
containers:
4747
- command:

docs/operator-manual/security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ kubectl edit clusterrole argocd-application-controller
173173
```
174174

175175
!!! tip
176-
If you want to deny ArgoCD access to a kind of resource then add it as an [excluded resource](declarative-setup.md#resource-exclusion).
176+
If you want to deny Argo CD access to a kind of resource then add it as an [excluded resource](declarative-setup.md#resource-exclusion).
177177

178178
## Auditing
179179

docs/user-guide/app_deletion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ When deleting an Application with this finalizer, the Argo CD application contro
5454
Adding the finalizer enables cascading deletes when implementing [the App of Apps pattern](../operator-manual/cluster-bootstrapping.md#cascading-deletion).
5555

5656
The default propagation policy for cascading deletion is [foreground cascading deletion](https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion).
57-
ArgoCD performs [background cascading deletion](https://kubernetes.io/docs/concepts/architecture/garbage-collection/#background-deletion) when `resources-finalizer.argocd.argoproj.io/background` is set.
57+
Argo CD performs [background cascading deletion](https://kubernetes.io/docs/concepts/architecture/garbage-collection/#background-deletion) when `resources-finalizer.argocd.argoproj.io/background` is set.
5858

5959
When you invoke `argocd app delete` with `--cascade`, the finalizer is added automatically.
6060
You can set the propagation policy with `--propagation-policy <foreground|background>`.

docs/user-guide/environment-variables.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ The following environment variables can be used with `argocd` CLI:
44

55
| Environment Variable | Description |
66
| --- | --- |
7-
| `ARGOCD_SERVER` | the address of the ArgoCD server without `https://` prefix <br> (instead of specifying `--server` for every command) <br> eg. `ARGOCD_SERVER=argocd.mycompany.com` if served through an ingress with DNS |
8-
| `ARGOCD_AUTH_TOKEN` | the ArgoCD `apiKey` for your ArgoCD user to be able to authenticate |
7+
| `ARGOCD_SERVER` | the address of the Argo CD server without `https://` prefix <br> (instead of specifying `--server` for every command) <br> eg. `ARGOCD_SERVER=argocd.mycompany.com` if served through an ingress with DNS |
8+
| `ARGOCD_AUTH_TOKEN` | the Argo CD `apiKey` for your Argo CD user to be able to authenticate |
99
| `ARGOCD_OPTS` | command-line options to pass to `argocd` CLI <br> eg. `ARGOCD_OPTS="--grpc-web"` |

docs/user-guide/external-url.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Add external URL
22

3-
You can add additional external links to ArgoCD dashboard. For example
3+
You can add additional external links to Argo CD dashboard. For example
44
links monitoring pages or documentation instead of just ingress hosts or other apps.
55

66
ArgoCD generates a clickable links to external pages for a resource based on per resource annotation.

docs/user-guide/extra_info.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Add extra Application info
22

3-
You can add additional information to an Application on your ArgoCD dashboard.
3+
You can add additional information to an Application on your Argo CD dashboard.
44
If you wish to add clickable links, see [Add external URL](https://argo-cd.readthedocs.io/en/stable/user-guide/external-url/).
55

66
This is done by providing the 'info' field a key-value in your Application manifest.
@@ -21,7 +21,7 @@ info:
2121
```
2222
![External link](../assets/extra_info-1.png)
2323
24-
The additional information will be visible on the ArgoCD Application details page.
24+
The additional information will be visible on the Argo CD Application details page.
2525
2626
![External link](../assets/extra_info.png)
2727

docs/user-guide/helm.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ source:
122122

123123
## Helm Release Name
124124

125-
By default, the Helm release name is equal to the Application name to which it belongs. Sometimes, especially on a centralised ArgoCD,
125+
By default, the Helm release name is equal to the Application name to which it belongs. Sometimes, especially on a centralised Argo CD,
126126
you may want to override that name, and it is possible with the `release-name` flag on the cli:
127127

128128
```bash
@@ -138,7 +138,7 @@ source:
138138
```
139139

140140
!!! warning "Important notice on overriding the release name"
141-
Please note that overriding the Helm release name might cause problems when the chart you are deploying is using the `app.kubernetes.io/instance` label. ArgoCD injects this label with the value of the Application name for tracking purposes. So when overriding the release name, the Application name will stop being equal to the release name. Because ArgoCD will overwrite the label with the Application name it might cause some selectors on the resources to stop working. In order to avoid this we can configure ArgoCD to use another label for tracking in the [ArgoCD configmap argocd-cm.yaml](../operator-manual/argocd-cm.yaml) - check the lines describing `application.instanceLabelKey`.
141+
Please note that overriding the Helm release name might cause problems when the chart you are deploying is using the `app.kubernetes.io/instance` label. Argo CD injects this label with the value of the Application name for tracking purposes. So when overriding the release name, the Application name will stop being equal to the release name. Because Argo CD will overwrite the label with the Application name it might cause some selectors on the resources to stop working. In order to avoid this we can configure Argo CD to use another label for tracking in the [ArgoCD configmap argocd-cm.yaml](../operator-manual/argocd-cm.yaml) - check the lines describing `application.instanceLabelKey`.
142142

143143
## Helm Hooks
144144

docs/user-guide/jsonnet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Jsonnet
22

3-
Any file matching `*.jsonnet` in a directory app is treated as a Jsonnet file. ArgoCD evaluates the Jsonnet and is able to parse a generated object or array.
3+
Any file matching `*.jsonnet` in a directory app is treated as a Jsonnet file. Argo CD evaluates the Jsonnet and is able to parse a generated object or array.
44

55
## Build Environment
66

0 commit comments

Comments
 (0)