Skip to content

[gitops-docs-1.10] RHDEVDOCS-5795: Update table capitalization #72149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 27, 2024
Merged

[gitops-docs-1.10] RHDEVDOCS-5795: Update table capitalization #72149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
251 changes: 124 additions & 127 deletions modules/gitops-argo-cd-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,136 +9,133 @@
The Argo CD Custom Resource consists of the following properties:

|===
|*Name* |*Description* |*Default* | *Properties*
|`ApplicationInstanceLabelKey` |The `metadata.label` key name where Argo CD injects the app name as a tracking label.|`app.kubernetes.io/instance` |
|**Name** |**Description** |**Default** | **Properties**
|`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>_`
a|* _<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`.
* _<PrallelismLimit>_ - The kubectl parallelism limit to set for the controller `(--kubectl-parallelism-limit flag)`.

|`ConfigManagementPlugins` |Add a configuration management plugin.| `__<empty>__` |
|`applicationSet`
|`applicationSet` controller configuration options.
| `_<object>_`
a|* `<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).

|`configManagementPlugins` |Add a configuration management plugin.| `__<empty>__` |

|`controller` |Argo CD Application Controller options.| `__<object>__`
a|* `<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>__`
a|* `<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>__`
a|* `<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>__`
a|* `<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>__`
a|* `<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>__`
a|* `<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>__`
a|* `<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.

|`Controller` |Argo CD Application Controller options.| `__<Object>__`
a|* _<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. This property is used to manage a large number of clusters to relieve memory pressure on the controller component.
* _<Sharding.replicas>_ - The number of replicas that will be 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.
|`sso` |Single Sign-on options.|`__<object>__`
a|* `<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` |

|`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>__`
a|* _<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 will typically be 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>__`
a|* _<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>__`
a|* _<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>__`
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.
* _<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>__`
a|* _<AutoTLS>_ - Use the provider to create the Redis server's TLS certificate (one of: openshift). Currently only available for {OCP}.
* _<DisableTLSVerification>_ - Define 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 configure which resource group/kinds are applied.|`__<empty>__` |

|`Server` |Argo CD Server configuration options.|`__<Object>__`
a|* _<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>__`
a|* _<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. For now the supported options are Dex and Keycloak.

|`StatusBadgeEnabled` |Enable application status badge.|`true` |

|`TLS` |TLS configuration options.|`__<Object>__`
a|* _<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 via HTTPS.

|`UserAnonyousEnabled` |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>__`
a|* _<Banner.Content>_ - The banner message content (required if a banner is displayed).
* _<Banner.URL.SecretName>_ - The banner message link URL (optional).
|===
|`tls` |TLS configuration options.|`__<object>__`
a|* `<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>__`
a|* `<banner.content>` - The banner message content (required if a banner is displayed).
* `<banner.url>` - The banner message link URL (optional).
|===
Loading