marcel/argo-cd
1
0
Fork 0
mirror of https://github.com/argoproj/argo-cd.git synced 2026-02-20 01:28:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix some admonitions in docs (#26213)

Browse Source 
Signed-off-by: Moulick Aggarwal <Moulick@users.noreply.github.com>
Co-authored-by: Moulick Aggarwal <Moulick@users.noreply.github.com>
This commit is contained in:
Moulick Aggarwal
2026-02-02 19:58:28 +01:00
committed by GitHub
parent d35a2518e6
commit d883412df8
13 changed files with 47 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/getting_started.md
View File

@@ -157,7 +157,7 @@ An example repository containing a guestbook application is available at
[https://github.com/argoproj/argocd-example-apps.git](https://github.com/argoproj/argocd-example-apps.git) to demonstrate how Argo CD works.
> [!NOTE]
> Note: The following example application may only be compatible with AMD64 architecture. If you are running on a different architecture (such as ARM64 or ARMv7), you may encounter issues with dependencies or container images that are not built for your platform. Consider verifying the compatibility of the application or building architecture-specific images if necessary.
> The following example application may only be compatible with AMD64 architecture. If you are running on a different architecture (such as ARM64 or ARMv7), you may encounter issues with dependencies or container images that are not built for your platform. Consider verifying the compatibility of the application or building architecture-specific images if necessary.
### Creating Apps Via CLI

3
docs/operator-manual/applicationset/Generators-Plugin.md
View File

@@ -118,7 +118,8 @@ If you want to store sensitive data in **another** Kubernetes `Secret`, instead
Syntax: `$<k8s_secret_name>:<a_key_in_that_k8s_secret>`
> NOTE: Secret must have label `app.kubernetes.io/part-of: argocd`
> [!NOTE]
> Secret must have label `app.kubernetes.io/part-of: argocd`
##### Example

3
docs/operator-manual/applicationset/Generators-Pull-Request.md
View File

@@ -282,7 +282,8 @@ You can use branch `filters` like
- `branchMatch`: Optional regexp filter which should match the source branch name.
- `targetBranchMatch`: Optional regexp filter which should match destination branch name.
> Note: Labels are not supported by Bitbucket.
> [!NOTE]
> Labels are not supported by Bitbucket.
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.

3
docs/operator-manual/cluster-bootstrapping.md
View File

@@ -170,7 +170,8 @@ The parent app will appear as in-sync but the child apps will be out of sync:
![New App Of Apps](../assets/new-app-of-apps.png)
> NOTE: You may want to modify this behavior to bootstrap your cluster in waves; see [the health assessment of Applications](./health.md#argocd-app) for information on changing this.
> [!NOTE]
> You may want to modify this behavior to bootstrap your cluster in waves; see [the health assessment of Applications](./health.md#argocd-app) for information on changing this.
You can either sync via the UI, firstly filter by the correct label:

2
docs/operator-manual/declarative-setup.md
View File

@@ -725,7 +725,7 @@ The 3 service accounts need to be modified to include an annotation with the Arg
Here's an example service account configurations for `argocd-application-controller`, `argocd-applicationset-controller`, and `argocd-server`.
> [!WARNING]
Once the annotations has been set on the service accounts, the application controller and server pods need to be restarted.
> Once the annotations has been set on the service accounts, the application controller and server pods need to be restarted.
**for IRSA:**
```yaml

20
docs/operator-manual/health.md
View File

@@ -135,15 +135,17 @@ The custom health check might return one of the following health statuses:
By default, health typically returns a `Progressing` status.
NOTE: As a security measure, access to the standard Lua libraries will be disabled by default. Admins can control access by
setting `resource.customizations.useOpenLibs.<group>_<kind>`. In the following example, standard libraries are enabled for health check of `cert-manager.io/Certificate`.
```yaml
data:
resource.customizations.useOpenLibs.cert-manager.io_Certificate: true
resource.customizations.health.cert-manager.io_Certificate: |
# Lua standard libraries are enabled for this script
```
> [!NOTE]
> As a security measure, access to the standard Lua libraries will be disabled by default.
> Admins can control access by setting `resource.customizations.useOpenLibs.<group>_<kind>`.
> In the following example, standard libraries are enabled for health check of `cert-manager.io/Certificate`.
>
> ```yaml
> data:
> resource.customizations.useOpenLibs.cert-manager.io_Certificate: true
> resource.customizations.health.cert-manager.io_Certificate: |
> # Lua standard libraries are enabled for this script
> ```
### Way 2. Contribute a Custom Health Check

3
docs/operator-manual/high_availability.md
View File

@@ -555,6 +555,7 @@ metadata:
type: Opaque
```
> [!NOTE] You can use the `argocd repo add <repo-url> --depth` command to add a repository with shallow cloning enabled.
> [!NOTE]
> You can use the `argocd repo add <repo-url> --depth` command to add a repository with shallow cloning enabled.
When shallow cloning, the repository is cloned with a depth of 1, which means only the required commit is cloned as opposed to the full history. This approach makes sense when the repository has a large history.

18
docs/operator-manual/installation.md
View File

@@ -21,8 +21,9 @@ Not recommended for production use. This type of installation is typically used
in (i.e. kubernetes.svc.default). It will still be able to deploy to external clusters with inputted
credentials.
> Note: The ClusterRoleBinding in the installation manifest is bound to a ServiceAccount in the argocd namespace.
> Be cautious when modifying the namespace, as changing it may cause permission-related errors unless the ClusterRoleBinding is correctly adjusted to reflect the new namespace.
> [!NOTE]
> The ClusterRoleBinding in the installation manifest is bound to a ServiceAccount in the argocd namespace.
> Be cautious when modifying the namespace, as changing it may cause permission-related errors unless the ClusterRoleBinding is correctly adjusted to reflect the new namespace.
* [namespace-install.yaml](https://github.com/argoproj/argo-cd/blob/stable/manifests/namespace-install.yaml) - Installation of Argo CD which requires only
namespace level privileges (does not need cluster roles). Use this manifest set if you do not
@@ -36,12 +37,13 @@ Not recommended for production use. This type of installation is typically used
done to external clusters.
You can modify that by defining new roles and binding them to the `argocd-application-controller` service account.
> Note: Argo CD CRDs are not included into [namespace-install.yaml](https://github.com/argoproj/argo-cd/blob/stable/manifests/namespace-install.yaml).
> and have to be installed separately. The CRD manifests are located in the [manifests/crds](https://github.com/argoproj/argo-cd/blob/stable/manifests/crds) directory.
> Use the following command to install them:
> ```
> kubectl apply -k https://github.com/argoproj/argo-cd/manifests/crds\?ref\=stable
> ```
> [!NOTE]
> Argo CD CRDs are not included into [namespace-install.yaml](https://github.com/argoproj/argo-cd/blob/stable/manifests/namespace-install.yaml).
> and have to be installed separately. The CRD manifests are located in the [manifests/crds](https://github.com/argoproj/argo-cd/blob/stable/manifests/crds) directory.
> Use the following command to install them:
> ```
> kubectl apply -k https://github.com/argoproj/argo-cd/manifests/crds\?ref\=stable
> ```
### High Availability:

8
docs/operator-manual/security.md
View File

@@ -136,11 +136,9 @@ kubectl delete clusterrole argocd-manager-role
kubectl delete clusterrolebinding argocd-manager-role-binding
argocd cluster rm https://your-kubernetes-cluster-addr
```
<!-- markdownlint-disable MD027 -->
> NOTE: for AWS EKS clusters, the [get-token](https://docs.aws.amazon.com/cli/latest/reference/eks/get-token.html) command
is used to authenticate to the external cluster, which uses IAM roles in lieu of locally stored
tokens, so token rotation is not needed, and revocation is handled through IAM.
<!-- markdownlint-enable MD027 -->
> [!NOTE]
> For AWS EKS clusters, the [get-token](https://docs.aws.amazon.com/cli/latest/reference/eks/get-token.html) command is used to authenticate to the external cluster, which uses IAM roles in lieu of locally stored tokens, so token rotation is not needed, and revocation is handled through IAM.
## Cluster RBAC

3
docs/operator-manual/user-management/index.md
View File

@@ -505,7 +505,8 @@ If you want to store sensitive data in **another** Kubernetes `Secret`, instead
Syntax: `$<k8s_secret_name>:<a_key_in_that_k8s_secret>`
> NOTE: Secret must have label `app.kubernetes.io/part-of: argocd`
> [!NOTE]
> Secret must have label `app.kubernetes.io/part-of: argocd`
##### Example

3
docs/operator-manual/webhook.md
View File

@@ -108,7 +108,8 @@ If you want to store webhook data in **another** Kubernetes `Secret`, instead of
Syntax: `$<k8s_secret_name>:<a_key_in_that_k8s_secret>`
> NOTE: Secret must have label `app.kubernetes.io/part-of: argocd`
> [!NOTE]
> Secret must have label `app.kubernetes.io/part-of: argocd`
For more information refer to the corresponding section in the [User Management Documentation](user-management/index.md#alternative).

3
gitops-engine/agent/README.md
View File

@@ -41,7 +41,8 @@ kubectl get deployment
The cluster mode grants full cluster access to the GitOps Agent. Use the following command to install an agent into the
`gitops-agent` namespace and use it to manage resources in any cluster namespace.
> Note. In cluster mode agents gets **full** cluster access.
> [!NOTE]
> In cluster mode agents gets **full** cluster access.
> See [gitops-agent-cluster-role.yaml](./manifests/cluster-install/gitops-agent-cluster-role.yaml) definition for more information.
```bash

13
manifests/README.md
View File

@@ -17,12 +17,13 @@ Four sets of installation manifests are provided:
external clusters. Will still be possible to deploy to the same cluster (kubernetes.default.svc)
with inputted credentials (i.e. `argocd cluster add <CONTEXT> --in-cluster --namespace <YOUR NAMESPACE>`).
> Note: Argo CD CRDs are not included into [namespace-install.yaml](namespace-install.yaml).
> and have to be installed separately. The CRD manifests are located in [manifests/crds](./crds) directory.
> Use the following command to install them:
> ```bash
> kubectl apply -k https://github.com/argoproj/argo-cd/manifests/crds\?ref\=stable
> ```
> [!NOTE]
> Argo CD CRDs are not included into [namespace-install.yaml](namespace-install.yaml).
> and have to be installed separately. The CRD manifests are located in [manifests/crds](./crds) directory.
> Use the following command to install them:
> ```bash
> kubectl apply -k https://github.com/argoproj/argo-cd/manifests/crds\?ref\=stable
> ```
## High Availability: