Chapter 3. Masking sensitive annotations in the Argo CD Web UI
Argo CD hides sensitive annotation values on Secret
resources from the Argo CD user interface (UI) and command-line interface (CLI). Users can configure this by specifying annotation keys to be masked in the Argo CD custom resource (CR). This feature enhances security by preventing accidental exposure of sensitive information, such as tokens or API keys, stored in annotations on Secret
resources.
To enable this feature, add the resource.sensitive.mask.annotations
key under .spec.extraConfig
in the Argo CD CR. Specify a comma-separated list of annotation keys to mask.
Ensure that the annotation keys listed in resource.sensitive.mask.annotations
are accurate and relevant to your use case. This feature does not support wildcards and requires explicit configuration in the Argo CD CR.
Prerequisites
- You have created an Argo CD instance. For more information, see "Installing a user-defined Argo CD instance".
3.1. Enabling sensitive annotations masking in the Argo CD Web UI Copy linkLink copied to clipboard!
To enable sensitive annotations masking in the Argo CD user interface (UI), you can add the annotation key, resource.sensitive.mask.annotations
, in the Argo CD custom resource (CR).
Procedure
- Log in to the OpenShift Container Platform web console.
-
In the Administrator perspective of the web console, click Operators
Installed Operators. - From the Project list, create or select the project where you want to install the user-defined Argo CD instance.
- From the installed Operators list, select Red Hat OpenShift GitOps, and then click the Argo CD tab.
To edit the Argo CD CR, complete the following steps:
-
Under the
.spec.extraConfig
section, add theresource.sensitive.mask.annotations
key. To mask a comma-separated list of values, specify the annotation key in the following YAML snippet:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Specify a comma-separated list of sensitive annotation values, such as
openshift.io/token-secret.value
,api-key
, andtoken
.
-
Under the
To verify that the value in the Argo CD resource has been updated successfully, complete the following steps:
-
In the Administrator perspective of the web console, click Operators
Installed Operators. -
In the Project option, select the
Argo CD
namespace. - From the installed Operators list, select Red Hat OpenShift GitOps, and then click the Argo CD tab.
- Verify that the Status field of the ArgoCD instance shows as Phase: Available.
-
In the Administrator perspective of the web console, click Operators
Argo CD hides the values of the specified annotation keys in the Argo CD UI.