Search
SupportConsoleDevelopersStart a trialContact

Chapter 2. Argo CD custom resource and component properties

download PDF

The ArgoCD custom resource is a Kubernetes Custom Resource (CRD) that describes the desired state for a given Argo CD cluster that allows you to configure the components which make up an Argo CD cluster.

2.1. Argo CD custom resource properties

The Argo CD Custom Resource consists of the following properties:

NameDescriptionDefaultProperties

applicationInstanceLabelKey

The metadata.label key name where Argo CD injects the app name as a tracking label.

app.kubernetes.io/instance

 

applicationSet

applicationSet controller configuration options.

<object>

  • <image> - The container image for the applicationSet controller. This overrides the ARGOCD_APPLICATIONSET_IMAGE environment variable.
  • <version> - The tag to use with the applicationSet container image.
  • <resources> - The container compute resources.
  • <logLevel> - The log level used by the Argo CD Application Controller component. Valid options are debug, info, error, and warn.
  • <logFormat> - The log format used by the Argo CD Application Controller component. Valid options are text or json.
  • <parallelismLimit> - The kubectl parallelism limit to set for the controller (--kubectl-parallelism-limit flag).
  • sourceNamespaces - The list of non-control plane namespaces for creating and managing Argo CD ApplicationSet resources in target namespaces.
  • scmProviders - The list of URLs of the allowed Source Code Manager (SCM) Providers.

configManagementPlugins

Add a configuration management plugin.

<empty>

 

controller

Argo CD Application Controller options.

<object>

  • <processors.operation> - The number of operation processors.
  • <processors.status> - The number of status processors.
  • <resources> - The container compute resources.
  • <logLevel> - The log level used by the Argo CD Application Controller component. Valid options are debug, info, error, and warn.
  • <appSync> - AppSync is used to control the sync frequency of Argo CD applications.
  • <sharding.enabled> - Enable sharding on the Argo CD Application Controller component. Use this property to manage a large number of clusters and relieve memory pressure on the controller component.
  • <sharding.replicas> - The number of replicas that are used to support sharding of the Argo CD Application Controller.
  • <sharding.dynamicScalingEnabled> - Enable dynamic scaling of the Argo CD Application Controller component. Use this property to allow the Operator to scale the number of replicas based on the number of clusters the controller component is managing presently. Setting this property to true overrides the configuration of the sharding.enabled and sharding.replicas properties.
  • <sharding.minShards> - The minimum number of Argo CD Application Controller replicas.
  • <sharding.maxShards> - The maximum number of Argo CD Application Controller replicas.
  • <sharding.clusterPerShard> - The number of clusters that need to be managed by each shard. When the replica count reaches the maxShards, the shards manage more than one cluster.
  • <env> - Environment to set for the application controller workloads.

disableAdmin

Disables the built-in admin user.

false

 

gaTrackingID

Use a Google Analytics tracking ID.

<empty>

 

gaAnonymizeUsers

Enable hashed usernames sent to google analytics.

false

 

ha

High availablity options.

<object>

  • <enabled> - Toggle high availability support globally for Argo CD.
  • <redisProxyImage> - The Redis HAProxy container image. This overrides the ARGOCD_REDIS_HA_PROXY_IMAGE environment variable.
  • <redisProxyVersion> - The tag to use for the Redis HAProxy container image.

helpChatURL

URL for getting chat help (this is typically your Slack channel for support).

https://mycorp.slack.com/argo-cd

 

helpChatText

The text that appears in a text box for getting chat help.

Chat now!

 

image

The container image for all Argo CD components. This overrides the ARGOCD_IMAGE environment variable.

argoproj/argocd

 

ingress

Ingress configuration options.

<object>

 

initialRepositories

Initial Git repositories to configure Argo CD to use upon creation of the cluster.

<empty>

 

notifications

Notifications controller configuration options.

<object>

  • <enabled> - The toggle to start the notifications-controller.
  • <image> - The container image for all Argo CD components. This overrides the ARGOCD_IMAGE environment variable.
  • <version> - The tag to use with the Notifications container image.
  • <resources> - The container compute resources.
  • <logLevel> - The log level used by the Argo CD Application Controller component. Valid options are debug, info, error, and warn.

repositoryCredentials

Git repository credential templates to configure Argo CD to use upon creation of the cluster.

<empty>

 

initialSSHKnownHosts

Initial SSH Known Hosts for Argo CD to use upon creation of the cluster.

<default_Argo_CD_Known_Hosts>

 

kustomizeBuildOptions

The build options and parameters to use with kustomize build.

<empty>

 

oidcConfig

The OIDC configuration as an alternative to Dex.

<empty>

 

nodePlacement

Add the nodeSelector and the tolerations.

<empty>

 

prometheus

Prometheus configuration options.

<object>

  • <enabled> - Toggle Prometheus support globally for Argo CD.
  • <host> - The hostname to use for Ingress or Route resources.
  • <ingress> - Toggles Ingress for Prometheus.
  • <route> - Route configuration options.
  • <size> - The replica count for the Prometheus StatefulSet.

rbac

RBAC configuration options.

<object>

  • <defaultPolicy> - The policy.default property in the argocd-rbac-cm config map. The name of the default role which Argo CD falls back to when authorizing API requests.
  • <policy> - The policy.csv property in the argocd-rbac-cm config map. CSV data containing user-defined RBAC policies and role definitions.
  • <scopes> - The scopes property in the argocd-rbac-cm config map. Controls which OIDC scopes to examine during RBAC enforcement, in addition to sub scope.

redis

Redis configuration options.

<object>

  • <autotls> - Use the provider to create the Redis server’s TLS certificate. Only the openshift value is currently available.
  • <disableTLSVerification> - Defines whether the Redis server should be accessed using strict TLS validation.
  • <image> - The container image for Redis. This overrides the ARGOCD_REDIS_IMAGE environment variable.
  • <resources> - The container compute resources.
  • <version> - The tag to use with the Redis container image.

resourceHealthChecks

Customize resource health check behavior.

<empty>

 

resourceIgnoreDifferences

Customize resource ignore difference behavior.

<empty>

 

resourceActions

Customize resource action behavior.

<empty>

 

resourceExclusions

Completely ignore entire classes of resource group.

<empty>

 

resourceInclusions

The configuration to identify which resource group/kinds are applied.

<empty>

 

server

Argo CD Server configuration options.

<object>

  • <autoscale> - Server autoscale configuration options.
  • <extraCommandArgs> - List of arguments added to the existing arguments set by the Operator.
  • <grpc> - gRPC configuration options.
  • <host> - The hostname used for Ingress or Route resources.
  • <ingress> - Ingress configuration for the Argo CD server component.
  • <insecure> - Toggles the insecure flag for Argo CD server.
  • <resources> - The container compute resources.
  • <replicas> - The number of replicas for the Argo CD server. Must be greater than or equal to 0. If autoscale is enabled, replicas is ignored.
  • <route> - Route configuration options.
  • <service.Type> - The serviceType used for the service resource.
  • <logLevel> - The log level to be used by the Argo CD Server component. Valid options are debug, info, error, and warn.
  • <logFormat> - The log format used by the Argo CD Application Controller component. Valid options are text or json.
  • <env> - Environment to set for the server workloads.

sso

Single Sign-on options.

<object>

  • <keycloak> - Configuration options for Keycloak SSO provider.
  • <dex> - Configuration options for Dex SSO provider.
  • <provider> - The name of the provider used to configure Single Sign-on. Currently, the supported options are Dex and Keycloak.

statusBadgeEnabled

Enable application status badge.

true

 

tls

TLS configuration options.

<object>

  • <ca.configMapName> - The name of the ConfigMap which contains the CA certificate.
  • <ca.secretName> - The name of the secret which contains the CA certificate and key.
  • <initialCerts> - Initial set of certificates in the argocd-tls-certs-cm config map for connecting Git repositories through HTTPS.

usersAnonymousEnabled

Enable anonymous user access.

true

 

version

The tag to use with the container image for all Argo CD components.

Latest Argo CD version

 

banner

Add a UI banner message.

<object>

  • <banner.content> - The banner message content (required if a banner is displayed).
  • <banner.url> - The banner message link URL (optional).

2.2. Repo server properties

The following properties are available for configuring the Repo server component:

NameDefaultDescription

resources

<empty>

The container compute resources.

mountsatoken

false

Defines whether the serviceaccount token should be mounted to the repo-server pod.

serviceaccount

""

The name of the serviceaccount to use with the repo-server pod.

verifytls

false

Defines whether to enforce strict TLS checking on all components when communicating with repo server.

autotls

""

Provider to use for setting up TLS for the repo-server’s gRPC TLS certificate. Currently, only the openshift value is acceptable.

image

argoproj/argocd

The container image for Argo CD Repo server. This overrides the ARGOCD_REPOSERVER_IMAGE environment variable.

version

same as .spec.Version

The tag to use with the Argo CD Repo server.

logLevel

info

The log level used by the Argo CD Repo server. Valid options are debug, info, error, and warn.

logFormat

text

The log format to be used by the Argo CD Repo server. Valid options are text or json.

execTimeout

180

Execution timeout in seconds for rendering tools (for example Helm or Kustomize).

env

<empty>

Environment to set for the repository server workloads.

replicas

<empty>

The number of replicas for the Argo CD Repo server. Must be greater than or equal to 0.

2.3. Enabling notifications with an Argo CD instance

Argo CD notifications allow you to send notifications to external services when events occur in your Argo CD instance. For example, you can send notifications to Slack or email when a sync operation fails. By default, notifications are disabled in Argo CD instances.

Prerequisites

  • You have access to an OpenShift Container Platform cluster with cluster-admin privileges and are logged in to the web console.
  • You have installed the Red Hat OpenShift GitOps Operator on your cluster.

Procedure

To enable notifications for an Argo CD instance using the OpenShift Container Platform web console, complete the following steps:

  1. Navigate to the Operators Installed Operators page.
  2. From the list of Installed Operators, select the Red Hat OpenShift GitOps Operator, and then click on the ArgoCD tab.
  3. Select the Argo CD instance name you want to enable notifications. For example, openshift-gitops.

  4. Click on the YAML tab, and then edit and set the spec.notifications.enabled parameter to true:

    Example

    apiVersion: argoproj.io/v1beta1
kind: ArgoCD
metadata:
  name: openshift-gitops
spec:
  notifications:
    enabled: true
#....

  5. Click Save.
Tip

Alternatively, you can enable notifications by using the oc patch command in the Openshift CLI. For example: 

oc patch argocd openshift-gitops -n openshift-gitops --type merge --patch '{"spec": {"notifications": {"enabled": true}}}'

Additional resources

2.4. NotificationsConfiguration custom resource properties

The NotificationsConfiguration resource is a Kubernetes custom resource (CR) that manages notifications in a Kubernetes cluster. In Red Hat OpenShift GitOps, you can add templates, triggers, services, and subscription resources to an Argo CD Notifications config map by using the NotificationsConfiguration CR.

When you create a cluster in Red Hat OpenShift GitOps with notifications enabled, a NotificationsConfiguration CR is created by default with the name default-notifications-configuration.

Any change made in the existing configuration of the NotificationsConfiguration CR is replicated in the Argo CD Notifications config map. For example, if the user adds trigger configuration in the NotificationsConfiguration resource, this configuration is read, processed, and updated in the Argo CD Notifications config map.

Important

Any configuration changes must be updated in the default-notifications-configuration CR. Custom resources created by the users for NotificationsConfiguration resource are not supported.

Any modification to the Argo CD argocd-notifications-cm config map is overridden by the changes made in the NotificationsConfiguration CR.

Table 2.1. NotificationsConfiguration custom resource properties
PropertiesDefaultDescription

Templates

<empty>

Templates are used to generate the notification template message.

Triggers

<empty>

Triggers are used to define the condition when a notification is sent to the user and the list of templates required to generate the message.

Services

<empty>

Services are used to deliver a message.

Subscriptions

<empty>

Subscriptions contain centrally-managed global application subscriptions.

The following examples define how to add templates, triggers, services, and subscription resources to the Argo CD argocd-notification-cm config map by using the default-notifications-configuration custom resource.

Example for templates

apiVersion: argoproj.io/v1alpha1
kind: NotificationsConfiguration
metadata:
 name: default-notifications-configuration 1
spec:
 templates:
  template.my-custom-template: | 2
    message: |
     Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.

1
Default name of the NotificationsConfiguration CR in a cluster.
2
An example custom template configuration for the NotificationsConfiguration CR.

Example for triggers

apiVersion: argoproj.io/v1alpha1
kind: NotificationsConfiguration
metadata:
 name: default-notifications-configuration 1
spec:
 triggers:
  trigger.on-sync-status-unknown: | 2
   - when: app.status.sync.status == 'Unknown'
   send: [my-custom-template]

1
Default name of the NotificationsConfiguration CR in a cluster.
2
An example custom trigger configuration for the NotificationsConfiguration CR.

Example for services

apiVersion: argoproj.io/v1alpha1
kind: NotificationsConfiguration
metadata:
 name: default-notifications-configuration 1
spec:
 Services:
  service.slack: |
    token: $slack-token 2
    username: <override-username> # optional username
    icon: <override-icon> # optional icon for the message (supports both emoji and url notation)

1
Default name of the NotificationsConfiguration CR in a cluster.
2
An example custom service configuration for the NotificationsConfiguration CR.

Example for subscriptions

apiVersion: argoproj.io/v1alpha1
kind: NotificationsConfiguration
metadata:
 name: default-notifications-configuration 1
spec:
 Subscriptions: |
  subscriptions: | 2
    # subscription for on-sync-status-unknown trigger notifications
    - recipients:
    - slack:test2
    - email:test@gmail.com
    triggers:
    - on-sync-status-unknown
    # subscription restricted to applications with matching labels only
    - recipients:
    - slack:test3
    selector: test=true
    triggers:
    - on-sync-status-unknown
icon: <override-icon> # optional icon for the message (supports both emoji and url notation)

1
Default name of the NotificationsConfiguration CR in a cluster.
2
An example custom subscription configuration for the NotificationsConfiguration CR.

You can configure the NotificationsConfiguration CR by using the OpenShift Container Platform web console or the CLI (oc).

2.4.1. Configuring the NotificationsConfiguration CR by using the web console

You can configure the NotificationsConfiguration custom resource (CR) by using the web console.

Prerequisites

  • You have access to an OpenShift Container Platform cluster with cluster-admin privileges and are logged in to the web console.
  • You have installed the Red Hat OpenShift GitOps Operator on your cluster.
  • You have enabled notifications for the Argo CD instance. For more information, see "Enabling notifications with an Argo CD instance".

Procedure

  1. In the Administrator perspective of the OpenShift Container Platform web console, expand Operators Installed Operators.
  2. From the list of Installed Operators, select the Red Hat OpenShift GitOps Operator, and then click on the NotificationsConfiguration tab.
  3. On the NotificationsConfigurations page, click default-notifications-configuration.

  4. On the default-notifications-configuration page, click YAML and add the configuration for any supported resources such as templates, triggers, services, and subscriptions. For example, under templates in the code, add the following sample configuration:

    Example template configuration

      template.my-custom-template: |
    message: |
    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.

  5. Click Save.

  6. Verify that the configuration changes made in the NotificationsConfiguration CR are reflected in the argocd-notifications-cm config map:

    1. Go to Workloads ConfigMaps.
    2. Click argocd-notifications-cm and select the YAML tab.
    3. Scroll through the page in the YAML tab to verify the sample configuration added for the supported resources.

2.4.2. Configuring the NotificationsConfiguration CR by using the CLI

You can configure the NotificationsConfiguration custom resource (CR) by using the CLI (oc).

Prerequisites

  • You have access to an OpenShift Container Platform cluster with cluster-admin privileges.
  • You have installed the Red Hat OpenShift GitOps Operator on your cluster.
  • You have enabled notifications for the Argo CD instance. For more information, see "Enabling notifications with an Argo CD instance".

Procedure

  1. Edit the default NotificationsConfiguration CR in the cluster by running the following command: 

    $ oc edit notificationsconfiguration default-notifications-configuration -n <namespace>

    where:

    default-notifications-configuration
    Specifies the name of the default NotificationsConfiguration CR.
    <namespace>
    Specifies the name of the namespace.

  2. Under the templates section of the CR, add a configuration similar to the following example:

    Example template configuration

      template.my-custom-template: |
    message: |
    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.

  3. Verify the contents of the argocd-notifications-cm config map by running the following command: 

    $ oc edit cm argocd-notifications-cm -n <namespace>

    The changes made in the existing configuration of the NotificationsConfiguration CR are reflected in the argocd-notifications-cm config map.

2.5. Additional resources

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.