|
2 | 2 | // |
3 | 3 | // * argo-cd-custom-resource-properties.adoc |
4 | 4 |
|
5 | | -:_content-type: PROCEDURE |
| 5 | +:_content-type: REFERENCE |
6 | 6 | [id="argo-cd-properties_{context}"] |
7 | 7 | = Argo CD custom resource properties |
8 | 8 |
|
9 | 9 | [role="_abstract"] |
10 | | -The ArgoCD Custom Resource consists of the following properties: |
| 10 | +The Argo CD Custom Resource consists of the following properties: |
11 | 11 |
|
12 | 12 | |=== |
13 | | -|**Name** |**Default** |**Description** |
14 | | -|`ApplicationInstanceLabelKey` |`mycompany.com/appname`|The `metadata.label` key name where Argo CD injects the app name as a tracking label. |
15 | | -|`ApplicationSet` |__<Object>__|`ApplicationSet` controller configuration options. |
16 | | -|`ConfigManagementPlugins` |__<empty>__|Add a configuration management plugin. |
17 | | -|`Controller` |__<Object>__|Argo CD Application Controller options. |
18 | | -|`Dex` |__<Object>__|Dex configuration options. |
19 | | -|`Disable Admin` |`false` |Disable the admin user. |
20 | | -|`GATrackingID` |__<empty>__|Use a Google Analytics tracking ID. |
21 | | -|`GAAnonymizeusers` |`false` |Enable hashed usernames sent to google analytics. |
22 | | -|`Grafana` |__<Object>__|Grafana configurable options. |
23 | | -|`HA` |__<Object>__|High availablity options. |
24 | | -|`HelpChatURL` |`https://mycorp.slack.com/argo-cd` |URL for getting chat help (this will typically be your Slack channel for support). |
25 | | -|`HelpChatText` |`Chat now!`|The text appears in a text box for getting chat help. |
26 | | -|`Image` |`argoproj/argocd` |The container image for all Argo CD components. This overrides the `ARGOCD_IMAGE` environment variable. |
27 | | -|`Import` |__<Object>__|Import configuration options. |
28 | | -|`Ingress` |__<Object>__|Ingress configuration options. |
29 | | -|`InitialRepositories` |__<empty>__|Initial Git repositories to configure Argo CD to use upon creation of the cluster. |
30 | | -|`RepositoryCredentials` |__<Object>__|Git repository credential templates to configure Argo CD to use upon creation of the cluster. |
31 | | -|`InitialSSHKnownHosts` |__<default_Argo_CD_Known_Hosts>__|Initial SSH Known Hosts for Argo CD to use upon creation of the cluster. |
32 | | -|`KustomizeBuildOptions` |__<empty>__|The build options and parameters to use with `kustomize build`. |
33 | | -|`OIDCConfig` |__<empty>__|The OIDC configuration as an alternative to Dex. |
34 | | -|`NodePlacement` |__<empty>__|Add the `nodeSelector` and the `tolerations`. |
35 | | -|`Prometheus` |__<Object>__|Prometheus configuration options. |
36 | | -|`RBAC` |__<Object>__|RBAC configuration options. |
37 | | -|`Redis` |__<Object>__|Redis configuration options. |
38 | | -|`ResourceCustomizations` |__<empty>__|Customize resource behavior. |
39 | | -|`ResourceExclusions` |__<Object>__|Completely ignore entire classes of resource group. |
40 | | -|`ResourceInclusions` |__<Object>__|The configuration to configure which resource group/kinds are applied. |
41 | | -|`Server` |__<Object>__|Argo CD Server configuration options. |
42 | | -|`SSO` |__<Object>__|Single sign-on options. |
43 | | -|`StatusBadgeEnabled` |`true` |Enable application status badge. |
44 | | -|`TLS` |__<Object>__|TLS configuration options. |
45 | | -|`UserAnonyousEnabled` |`true` |Enable anonymous user access. |
46 | | -|`Version` |`v2.2.2` |The tag to use with the container image for all Argo CD components. |
| 13 | +|**Name** |**Description** |**Default** | **Properties** |
| 14 | +|`ApplicationInstanceLabelKey` |The `metadata.label` key name where Argo CD injects the app name as a tracking label.|`app.kubernetes.io/instance` | |
| 15 | +|`ApplicationSet` |
| 16 | +|`ApplicationSet` controller configuration options. |
| 17 | +| `_<Object>_` |
| 18 | +a|* _<Image>_ - The container image for the `ApplicationSet` controller. This overrides the `ARGOCD_APPLICATIONSET_IMAGE` environment variable. |
| 19 | + * _<Version>_ - The tag to use with the `ApplicationSet` container image. |
| 20 | + * _<Resources>_ - The container compute resources. |
| 21 | + * _<LogLevel>_ - The log level used by the Argo CD Application Controller component. Valid options are `debug`, `info`, `error`, and `warn`. |
| 22 | + * _<LogFormat>_ - The log format used by the Argo CD Application Controller component. Valid options are `text` or `json`. |
| 23 | + * _<PrallelismLimit>_ - The kubectl parallelism limit to set for the controller `(--kubectl-parallelism-limit flag)`. |
| 24 | +|`ConfigManagementPlugins` |Add a configuration management plugin.| `__<empty>__` | |
| 25 | +|`Controller` |Argo CD Application Controller options.| `__<Object>__` |
| 26 | +a|* _<Processors.Operation>_ - The number of operation processors. |
| 27 | + * _<Processors.Status>_ - The number of status processors. |
| 28 | + * _<Resources>_ - The container compute resources. |
| 29 | + * _<LogLevel>_ - The log level used by the Argo CD Application Controller component. Valid options are `debug`, `info`, `error`, and `warn`. |
| 30 | + * _<AppSync>_ - AppSync is used to control the sync frequency of Argo CD applications |
| 31 | + * _<Sharding.enabled>_ - Enable sharding on the Argo CD Application Controller component. This property is used to manage a large number of clusters to relieve memory pressure on the controller component. |
| 32 | + * _<Sharding.replicas>_ - The number of replicas that will be used to support sharding of the Argo CD Application Controller. |
| 33 | + * _<Env>_ - Environment to set for the application controller workloads. |
| 34 | +|`DisableAdmin` |Disables the built-in admin user.|`false` | |
| 35 | +|`GATrackingID` |Use a Google Analytics tracking ID.|`__<empty>__` | |
| 36 | +|`GAAnonymizeusers` |Enable hashed usernames sent to google analytics.|`false` | |
| 37 | +|`HA` |High availablity options.| `__<Object>__` |
| 38 | +a|* _<Enabled>_ - Toggle high availability support globally for Argo CD. |
| 39 | + * _<RedisProxyImage>_ - The Redis HAProxy container image. This overrides the `ARGOCD_REDIS_HA_PROXY_IMAGE` environment variable. |
| 40 | + * _<RedisProxyVersion>_ - The tag to use for the Redis HAProxy container image. |
| 41 | +|`HelpChatURL` |URL for getting chat help (this will typically be your Slack channel for support).|`https://mycorp.slack.com/argo-cd` | |
| 42 | +|`HelpChatText` |The text that appears in a text box for getting chat help.|`Chat now!`| |
| 43 | +|`Image` |The container image for all Argo CD components. This overrides the `ARGOCD_IMAGE` environment variable.|`argoproj/argocd` | |
| 44 | +|`Ingress` |Ingress configuration options.| `__<Object>__` | |
| 45 | +|`InitialRepositories` |Initial Git repositories to configure Argo CD to use upon creation of the cluster.|`__<empty>__` | |
| 46 | +|`Notifications` |Notifications controller configuration options.|`__<Object>__` |
| 47 | +a|* _<Enabled>_ - The toggle to start the notifications-controller. |
| 48 | + * _<Image>_ - The container image for all Argo CD components. This overrides the `ARGOCD_IMAGE` environment variable. |
| 49 | + * _<Version>_ - The tag to use with the Notifications container image. |
| 50 | + * _<Resources>_ - The container compute resources. |
| 51 | + * _<LogLevel>_ - The log level used by the Argo CD Application Controller component. Valid options are `debug`, `info`, `error`, and `warn`. |
| 52 | +|`RepositoryCredentials` |Git repository credential templates to configure Argo CD to use upon creation of the cluster.| `__<empty>__` | |
| 53 | +|`InitialSSHKnownHosts` |Initial SSH Known Hosts for Argo CD to use upon creation of the cluster.| `__<default_Argo_CD_Known_Hosts>__` | |
| 54 | +|`KustomizeBuildOptions` |The build options and parameters to use with `kustomize build`.|`__<empty>__` | |
| 55 | +|`OIDCConfig` |The OIDC configuration as an alternative to Dex.|`__<empty>__` | |
| 56 | +|`NodePlacement` |Add the `nodeSelector` and the `tolerations`.|`__<empty>__` | |
| 57 | +|`Prometheus` |Prometheus configuration options.|`__<Object>__` |
| 58 | +a|* _<Enabled>_ - Toggle Prometheus support globally for Argo CD. |
| 59 | + * _<Host>_ - The hostname to use for Ingress or Route resources. |
| 60 | + * _<Ingress>_ - Toggles Ingress for Prometheus. |
| 61 | + * _<Route>_ - Route configuration options. |
| 62 | + * _<Size>_ - The replica count for the Prometheus `StatefulSet`. |
| 63 | +|`RBAC` |RBAC configuration options.|`__<Object>__` |
| 64 | +a|* _<DefaultPolicy>_ - The `policy.default` property in the `argocd-rbac-cm` config map. The name of the default role which Argo CD will fall back to, when authorizing API requests. |
| 65 | + * _<Policy>_ - The `policy.csv` property in the `argocd-rbac-cm` config map. CSV data containing user-defined RBAC policies and role definitions. |
| 66 | + * _<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). |
| 67 | +|`Redis` |Redis configuration options.|`__<Object>__` |
| 68 | +a|* _<AutoTLS>_ - Use the provider to create the Redis server's TLS certificate (one of: openshift). Currently only available for {product-title}. |
| 69 | + * _<DisableTLSVerification>_ - Define whether the Redis server should be accessed using strict TLS validation. |
| 70 | + * _<Image>_ - The container image for Redis. This overrides the `ARGOCD_REDIS_IMAGE` environment variable. |
| 71 | + * _<Resources>_ - The container compute resources. |
| 72 | + * _<Version>_ - The tag to use with the Redis container image. |
| 73 | +|`ResourceCustomizations` |Customize resource behavior.|`__<empty>__` | |
| 74 | +|`ResourceExclusions` |Completely ignore entire classes of resource group.|`__<empty>__` | |
| 75 | +|`ResourceInclusions` |The configuration to configure which resource group/kinds are applied.|`__<empty>__` | |
| 76 | +|`Server` |Argo CD Server configuration options.|`__<Object>__` |
| 77 | +a|* _<Autoscale>_ - Server autoscale configuration options. |
| 78 | + * _<ExtraCommandArgs>_ - List of arguments added to the existing arguments set by the Operator. |
| 79 | + * _<GRPC>_ - GRPC configuration options. |
| 80 | + * _<Host>_ - The hostname used for Ingress or Route resources. |
| 81 | + * _<Ingress>_ - Ingress configuration for the Argo CD server component. |
| 82 | + * _<Insecure>_ - Toggles the insecure flag for Argo CD server. |
| 83 | + * _<Resources>_ - The container compute resources. |
| 84 | + * _<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. |
| 85 | + * _<Route>_ - Route configuration options. |
| 86 | + * _<Service.Type>_ - The `ServiceType` used for the service resource. |
| 87 | + * _<LogLevel>_ - The log level to be used by the Argo CD Server component. Valid options are `debug`, `info`, `error`, and `warn`. |
| 88 | + * _<LogFormat>_ - The log format used by the Argo CD Application Controller component. Valid options are `text` or `json`. |
| 89 | + * _<Env>_ - Environment to set for the server workloads. |
| 90 | +|`SSO` |Single Sign-on options.|`__<Object>__` |
| 91 | +a|* _<Image>_ - The container image for Keycloak. This overrides the `ARGOCD_KEYCLOAK_IMAGE` environment variable. |
| 92 | + * _<Keycloak>_ - Configuration options for Keycloak SSO provider. |
| 93 | + * _<Dex>_ - Configuration options for Dex SSO provider. |
| 94 | + * _<Provider>_ - The name of the provider used to configure Single Sign-on. For now the supported options are Dex and Keycloak. |
| 95 | + * _<Resources>_ - The container compute resources. |
| 96 | + * _<VerifyTLS>_ - Whether to enforce strict TLS checking when communicating with Keycloak service. |
| 97 | + * _<Version>_ - The tag to use with the Keycloak container image. |
| 98 | +|`StatusBadgeEnabled` |Enable application status badge.|`true` | |
| 99 | +|`TLS` |TLS configuration options.|`__<Object>__` |
| 100 | +a|* _<CA.ConfigMapName>_ - The name of the `ConfigMap` which contains the CA certificate. |
| 101 | + * _<CA.SecretName>_ - The name of the secret which contains the CA Certificate and Key. |
| 102 | + * _<InitialCerts>_ - Initial set of certificates in the `argocd-tls-certs-cm` config map for connecting Git repositories via HTTPS. |
| 103 | +|`UserAnonyousEnabled` |Enable anonymous user access.|`true` | |
| 104 | +|`Version` |The tag to use with the container image for all Argo CD components.|Latest Argo CD version| |
| 105 | +|`Banner` |Add a UI banner message.|`__<Object>__` |
| 106 | +a|* _<Banner.Content>_ - The banner message content (required if a banner is displayed). |
| 107 | + * _<Banner.URL.SecretName>_ - The banner message link URL (optional). |
47 | 108 | |=== |
48 | 109 |
|
49 | 110 |
|
|
0 commit comments