Skip to content

API Reference

Packages

argoproj.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the argoproj.io v1alpha1 API group

Resource Types

AgentClientSpec

Appears in: - AgentSpec

Field Description Default Validation
principalServerAddress string PrincipalServerAddress is the remote address of the principal server to connect to.
principalServerPort string PrincipalServerPort is the remote port of the principal server to connect to.
mode string Mode is the operational mode for the agent (managed or autonomous)
enableWebSocket boolean EnableWebSocket is the flag to enable WebSocket for event streaming
enableCompression boolean EnableCompression is the flag to enable compression while sending data between Principal and Agent using gRPC
keepAliveInterval string KeepAliveInterval is the interval for keep-alive pings to the principal

AgentRedisSpec

Appears in: - AgentSpec

Field Description Default Validation
serverAddress string ServerAddress is the address of the Redis server to be used by the PrincAgentipal component.

AgentSpec

Appears in: - ArgoCDAgentSpec

Field Description Default Validation
enabled boolean Enabled is the flag to enable the Agent component during Argo CD installation. (optional, default false)
creds string Creds is the credential identifier for the agent authentication
logLevel string LogLevel refers to the log level used by the Agent component.
logFormat string LogFormat refers to the log format used by the Agent component.
image string Image is the name of Argo CD Agent image
labelSelector string LabelSelector is a Kubernetes label selector that restricts which resources the agent watches.
Only resources matching this selector will be listed, watched, and processed by the agent.
env EnvVar array Env lets you specify environment for agent pods
client AgentClientSpec Client defines the client options for the Agent component.
tls AgentTLSSpec TLS defines the TLS options for the Agent component.
redis AgentRedisSpec Redis defines the Redis options for the Agent component.
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Agent ServiceMonitor.

AgentTLSSpec

Appears in: - AgentSpec

Field Description Default Validation
secretName string SecretName is the name of the secret containing the agent client TLS certificate
rootCASecretName string RootCASecretName is the name of the secret containing the root CA certificate
insecure boolean Insecure is the flag to skip TLS certificate validation when connecting to the principal (insecure, for development only)

ArgoCD

ArgoCD is the Schema for the argocds API

Appears in: - ArgoCDList

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string ArgoCD
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ArgoCDSpec
status ArgoCDStatus

ArgoCDAgentPrincipalRouteSpec

ArgoCDAgentPrincipalRouteSpec defines the options for the Route backing the ArgoCD Agent Principal component.

Appears in: - PrincipalServerSpec

Field Description Default Validation
enabled boolean Enabled will toggle the creation of the OpenShift Route, ignored in case of non OpenShift cluster.
Route is disabled only when explicitly configured with false

ArgoCDAgentPrincipalServiceSpec

ArgoCDAgentPrincipalServiceSpec defines the options for the Service backing the ArgoCD Agent Principal component.

Appears in: - PrincipalServerSpec

Field Description Default Validation
type ServiceType Type is the ServiceType to use for the Service resource.
If not set, type ClusterIP will be used by default.

ArgoCDAgentSpec

Appears in: - ArgoCDSpec

Field Description Default Validation
principal PrincipalSpec Principal defines configurations for the Principal component of Argo CD Agent.
agent AgentSpec Agent defines configurations for the Agent component of Argo CD Agent.

ArgoCDApplicationControllerProcessorsSpec

ArgoCDApplicationControllerProcessorsSpec defines the options for the ArgoCD Application Controller processors.

Appears in: - ArgoCDApplicationControllerSpec

Field Description Default Validation
operation integer Operation is the number of application operation processors.
status integer Status is the number of application status processors.

ArgoCDApplicationControllerShardSpec

ArgoCDApplicationControllerShardSpec defines the options available for enabling sharding for the Application Controller component.

Appears in: - ArgoCDApplicationControllerSpec

Field Description Default Validation
enabled boolean Enabled defines whether sharding should be enabled on the Application Controller component.
replicas integer Replicas defines the number of replicas to run in the Application controller shard.
dynamicScalingEnabled boolean Deprecated: dynamicScalingEnabled is deprecated and will be removed in a future release.
DynamicScalingEnabled defines whether dynamic scaling should be enabled for Application Controller component.
minShards integer MinShards defines the minimum number of shards at any given point Minimum: 1
maxShards integer MaxShards defines the maximum number of shards at any given point
clustersPerShard integer ClustersPerShard defines the maximum number of clusters managed by each argocd shard Minimum: 1
algorithm string DistributionAlgorithm determines what algorithm will be used for distribution of shards. Valid options are legacy, round-robin, and consistent-hashing Enum: [legacy round-robin consistent-hashing]

ArgoCDApplicationControllerSpec

ArgoCDApplicationControllerSpec defines the options for the ArgoCD Application Controller component.

Appears in: - ArgoCDSpec

Field Description Default Validation
processors ArgoCDApplicationControllerProcessorsSpec Processors contains the options for the Application Controller processors.
logLevel string LogLevel refers to the log level used by the Application Controller component. Defaults to ArgoCDDefaultLogLevel if not configured. Valid options are debug, info, error, and warn.
logFormat string LogFormat refers to the log format used by the Application Controller component. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json.
resources ResourceRequirements Resources defines the Compute Resources required by the container for the Application Controller.
parallelismLimit integer ParallelismLimit defines the limit for parallel kubectl operations
appSync Duration AppSync is used to control the sync frequency, by default the ArgoCD
controller polls Git every 3m.
Set this to a duration, e.g. 10m or 600s to control the synchronisation
frequency.		 Optional: {}
sharding ArgoCDApplicationControllerShardSpec Sharding contains the options for the Application Controller sharding configuration.
env EnvVar array Env lets you specify environment for application controller pods
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Application Controller ServiceMonitor.

ArgoCDApplicationSet

ArgoCDApplicationSet defines whether the Argo CD ApplicationSet controller should be installed.

Appears in: - ArgoCDSpec

Field Description Default Validation
env EnvVar array Env lets you specify environment for applicationSet controller pods
extraCommandArgs string array ExtraCommandArgs allows users to pass command line arguments to ApplicationSet controller.
They get added to default command line arguments provided by the operator.
Please note that the command line arguments provided as part of ExtraCommandArgs
will not overwrite the default command line arguments.
image string Image is the Argo CD ApplicationSet image (optional)
version string Version is the Argo CD ApplicationSet image tag. (optional)
resources ResourceRequirements Resources defines the Compute Resources required by the container for ApplicationSet.
logLevel string LogLevel describes the log level that should be used by the ApplicationSet controller. Defaults to ArgoCDDefaultLogLevel if not set. Valid options are debug,info, error, and warn.
webhookServer WebhookServerSpec
logFormat string LogFormat refers to the log format used by the ApplicationSet component. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json. Enum: [text json]

ArgoCDCASpec

ArgoCDCASpec defines the CA options for ArgCD.

Appears in: - ArgoCDTLSSpec

Field Description Default Validation
configMapName string ConfigMapName is the name of the ConfigMap containing the CA Certificate.
secretName string SecretName is the name of the Secret containing the CA Certificate and Key.

ArgoCDCommitServerSpec

Appears in: - ArgoCDSpec

Field Description Default Validation
initContainers Container array InitContainers defines the list of initialization containers.
logLevel string LogLevel refers to the log level to be used by the component. Defaults to ArgoCDDefaultLogLevel if not set. Valid options are debug, info, error, and warn.
logFormat string LogFormat refers to the log level to be used by the component. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json.
resources ResourceRequirements Resources defines the Compute Resources required by the container for the component.
env EnvVar array Env lets specifies the environment variables for the pods.
annotations object (keys:string, values:string) Custom annotations to pods deployed by the operator
labels object (keys:string, values:string) Custom labels to pods deployed by the operator

ArgoCDDexSpec

ArgoCDDexSpec defines the desired state for the Dex server component.

Appears in: - ArgoCDSSOSpec - ArgoCDSpec

Field Description Default Validation
config string Config is the dex connector configuration.
groups string array Optional list of required groups a user must be a member of
image string Image is the Dex container image.
openShiftOAuth boolean OpenShiftOAuth enables OpenShift OAuth authentication for the Dex server.
resources ResourceRequirements Resources defines the Compute Resources required by the container for Dex.
version string Version is the Dex container image tag.
annotations object (keys:string, values:string) Custom annotations to pods deployed by the operator
labels object (keys:string, values:string) Custom labels to pods deployed by the operator

ArgoCDExport

ArgoCDExport is the Schema for the argocdexports API

Appears in: - ArgoCDExportList

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string ArgoCDExport
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ArgoCDExportSpec
status ArgoCDExportStatus

ArgoCDExportList

ArgoCDExportList contains a list of ArgoCDExport

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string ArgoCDExportList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ArgoCDExport array

ArgoCDExportSpec

ArgoCDExportSpec defines the desired state of ArgoCDExport

Appears in: - ArgoCDExport

Field Description Default Validation
argocd string Argocd is the name of the ArgoCD instance to export.
image string Image is the container image to use for the export Job.
schedule string Schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
storage ArgoCDExportStorageSpec Storage defines the storage configuration options.
version string Version is the tag/digest to use for the export Job container image.

ArgoCDExportStatus

ArgoCDExportStatus defines the observed state of ArgoCDExport

Appears in: - ArgoCDExport

Field Description Default Validation
phase string Phase is a simple, high-level summary of where the ArgoCDExport is in its lifecycle.
There are five possible phase values:
Pending: The ArgoCDExport has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the containers for the ArgoCDExport are still running, or in the process of starting or restarting.
Succeeded: All containers for the ArgoCDExport have terminated in success, and will not be restarted.
Failed: At least one container has terminated in failure, either exited with non-zero status or was terminated by the system.
Unknown: For some reason the state of the ArgoCDExport could not be obtained.

ArgoCDExportStorageSpec

ArgoCDExportStorageSpec defines the desired state for ArgoCDExport storage options.

Appears in: - ArgoCDExportSpec

Field Description Default Validation
backend string Backend defines the storage backend to use, must be "local" (the default), "aws", "azure" or "gcp".
pvc PersistentVolumeClaimSpec PVC is the desired characteristics for a PersistentVolumeClaim.
secretName string SecretName is the name of a Secret with encryption key, credentials, etc.

ArgoCDGrafanaSpec

ArgoCDGrafanaSpec defines the desired state for the Grafana component.

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled will toggle Grafana support globally for ArgoCD.
host string Host is the hostname to use for Ingress/Route resources.
image string Image is the Grafana container image.
ingress ArgoCDIngressSpec Ingress defines the desired state for an Ingress for the Grafana component.
resources ResourceRequirements Resources defines the Compute Resources required by the container for Grafana.
route ArgoCDRouteSpec Route defines the desired state for an OpenShift Route for the Grafana component.
size integer Size is the replica count for the Grafana Deployment.
version string Version is the Grafana container image tag.

ArgoCDHASpec

ArgoCDHASpec defines the desired state for High Availability support for Argo CD.

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled will toggle HA support globally for Argo CD.
redisProxyImage string RedisProxyImage is the Redis HAProxy container image.
redisProxyVersion string RedisProxyVersion is the Redis HAProxy container image tag.
resources ResourceRequirements Resources defines the Compute Resources required by the container for HA.

ArgoCDImportSpec

ArgoCDImportSpec defines the desired state for the ArgoCD import/restore process.

Appears in: - ArgoCDSpec

Field Description Default Validation
name string Name of an ArgoCDExport from which to import data.
namespace string Namespace for the ArgoCDExport, defaults to the same namespace as the ArgoCD.

ArgoCDIngressSpec

ArgoCDIngressSpec defines the desired state for the Ingress resources.

Appears in: - ArgoCDGrafanaSpec - ArgoCDPrometheusSpec - ArgoCDServerGRPCSpec - ArgoCDServerSpec - WebhookServerSpec

Field Description Default Validation
annotations object (keys:string, values:string) Annotations is the map of annotations to apply to the Ingress.
enabled boolean Enabled will toggle the creation of the Ingress.
ingressClassName string IngressClassName for the Ingress resource.
path string Path used for the Ingress resource.
tls IngressTLS array TLS configuration. Currently the Ingress only supports a single TLS
port, 443. If multiple members of this list specify different hosts, they
will be multiplexed on the same port according to the hostname specified
through the SNI TLS extension, if the ingress controller fulfilling the
ingress supports SNI.		 Optional: {}

ArgoCDKeycloakSpec

ArgoCDKeycloakSpec defines the desired state for the Keycloak component.

Appears in: - ArgoCDSSOSpec

Field Description Default Validation
image string Image is the Keycloak container image.
resources ResourceRequirements Resources defines the Compute Resources required by the container for Keycloak.
rootCA string Custom root CA certificate for communicating with the Keycloak OIDC provider
version string Version is the Keycloak container image tag.
verifyTLS boolean VerifyTLS set to false disables strict TLS validation.
host string Host is the hostname to use for Ingress/Route resources.

ArgoCDList

ArgoCDList contains a list of ArgoCD

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string ArgoCDList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ArgoCD array

ArgoCDMetricsSpec

ArgoCDMetricsSpec defines the metrics configuration for a component's ServiceMonitor.

Appears in: - AgentSpec - ArgoCDApplicationControllerSpec - ArgoCDNotifications - ArgoCDRepoSpec - ArgoCDServerSpec - PrincipalSpec

Field Description Default Validation
interval string Interval specifies the Prometheus scrape interval for this component's ServiceMonitor.
If empty, Prometheus uses its default scrape interval.
scrapeTimeout string ScrapeTimeout specifies the Prometheus scrape timeout for this component's ServiceMonitor.
If empty, Prometheus uses the global scrape timeout.

ArgoCDMonitoringSpec

ArgoCDMonitoringSpec is used to configure workload status monitoring for a given Argo CD instance. It triggers creation of serviceMonitor and PrometheusRules that alert users when a given workload status meets a certain criteria. For e.g, it can fire an alert if the application controller is pending for x mins consecutively.

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled defines whether workload status monitoring is enabled for this instance or not
disableMetrics boolean DisableMetrics field can be used to enable or disable the collection of Metrics on Openshift

ArgoCDNetworkPolicySpec

ArgoCDNetworkPolicySpec defines whether the operator should create NetworkPolicies for an Argo CD instance.

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled defines whether NetworkPolicy resources are created for this Argo CD instance.
When enabled, the operator will reconcile NetworkPolicies for Argo CD components.
When disabled, the operator will remove any previously-created NetworkPolicies.

ArgoCDNodePlacementSpec

ArgoCDNodePlacementSpec is used to specify NodeSelector and Tolerations for Argo CD workloads

Appears in: - ArgoCDSpec

Field Description Default Validation
nodeSelector object (keys:string, values:string) NodeSelector is a field of PodSpec, it is a map of key value pairs used for node selection
tolerations Toleration array Tolerations allow the pods to schedule onto nodes with matching taints

ArgoCDNotifications

ArgoCDNotifications defines whether the Argo CD Notifications controller should be installed.

Appears in: - ArgoCDSpec

Field Description Default Validation
replicas integer Replicas defines the number of replicas to run for notifications-controller
enabled boolean Enabled defines whether argocd-notifications controller should be deployed or not
sourceNamespaces string array SourceNamespaces is a list of namespaces from which the notifications controller will watch for ArgoCD Application resources.
env EnvVar array Env let you specify environment variables for Notifications pods
image string Image is the Argo CD Notifications image (optional)
version string Version is the Argo CD Notifications image tag. (optional)
resources ResourceRequirements Resources defines the Compute Resources required by the container for Argo CD Notifications.
logLevel string LogLevel describes the log level that should be used by the argocd-notifications. Defaults to ArgoCDDefaultLogLevel if not set. Valid options are debug,info, error, and warn.
logformat string Deprecated: use LogFormat instead.
logFormat string LogFormat refers to the log format used by the argocd-notifications. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json. Enum: [text json]
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Notifications ServiceMonitor.

ArgoCDPrometheusSpec

ArgoCDPrometheusSpec defines the desired state for the Prometheus component.

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled will toggle Prometheus support globally for ArgoCD.
When set to true, ServiceMonitors and PrometheusRules will be created for Argo CD metrics.
The Prometheus CR, Route, and Ingress are deprecated and will no longer be created.
host string Host is the hostname to use for Ingress/Route resources.
Deprecated: This field is no longer used and will be ignored.
ingress ArgoCDIngressSpec Ingress defines the desired state for an Ingress for the Prometheus component.
Deprecated: This field is no longer used and will be ignored.
route ArgoCDRouteSpec Route defines the desired state for an OpenShift Route for the Prometheus component.
Deprecated: This field is no longer used and will be ignored.
size integer Size is the replica count for the Prometheus StatefulSet.
Deprecated: This field is no longer used and will be ignored.

ArgoCDRBACSpec

ArgoCDRBACSpec defines the desired state for the Argo CD RBAC configuration.

Appears in: - ArgoCDSpec

Field Description Default Validation
defaultPolicy string DefaultPolicy is the name of the default role which Argo CD will falls back to, when
authorizing API requests (optional). If omitted or empty, users may be still be able to login,
but will see no apps, projects, etc...
policy string Policy is CSV containing user-defined RBAC policies and role definitions.
Policy rules are in the form:
p, subject, resource, action, object, effect
Role definitions and bindings are in the form:
g, subject, inherited-subject
See https://github.com/argoproj/argo-cd/blob/master/docs/operator-manual/rbac.md for additional information.
scopes string Scopes controls which OIDC scopes to examine during rbac enforcement (in addition to sub scope).
If omitted, defaults to: '[groups]'.
policyMatcherMode string PolicyMatcherMode configures the matchers function mode for casbin.
There are two options for this, 'glob' for glob matcher or 'regex' for regex matcher.

ArgoCDRedisSpec

ArgoCDRedisSpec defines the desired state for the Redis server component.

Appears in: - ArgoCDSpec

Field Description Default Validation
image string Image is the Redis container image.
resources ResourceRequirements Resources defines the Compute Resources required by the container for Redis.
version string Version is the Redis container image tag.
disableTLSVerification boolean DisableTLSVerification defines whether redis server API should be accessed using strict TLS validation
autotls string AutoTLS specifies the method to use for automatic TLS configuration for the redis server
The value specified here can currently be:
- openshift - Use the OpenShift service CA to request TLS config
annotations object (keys:string, values:string) Custom annotations to pods deployed by the operator
labels object (keys:string, values:string) Custom labels to pods deployed by the operator

ArgoCDRepoSpec

ArgoCDRepoSpec defines the desired state for the Argo CD repo server component.

Appears in: - ArgoCDSpec

Field Description Default Validation
extraRepoCommandArgs string array Extra Command arguments allows users to pass command line arguments to repo server workload. They get added to default command line arguments provided
by the operator.
Please note that the command line arguments provided as part of ExtraRepoCommandArgs will not overwrite the default command line arguments.
logLevel string LogLevel describes the log level that should be used by the Repo Server. Defaults to ArgoCDDefaultLogLevel if not set. Valid options are debug, info, error, and warn.
logFormat string LogFormat describes the log format that should be used by the Repo Server. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json.
mountsatoken boolean MountSAToken describes whether you would like to have the Repo server mount the service account token
replicas integer Replicas defines the number of replicas for argocd-repo-server. Value should be greater than or equal to 0. Default is nil.
resources ResourceRequirements Resources defines the Compute Resources required by the container for Redis.
serviceaccount string ServiceAccount defines the ServiceAccount user that you would like the Repo server to use
verifytls boolean VerifyTLS defines whether repo server API should be accessed using strict TLS validation
autotls string AutoTLS specifies the method to use for automatic TLS configuration for the repo server
The value specified here can currently be:
- openshift - Use the OpenShift service CA to request TLS config
image string Image is the ArgoCD Repo Server container image.
version string Version is the ArgoCD Repo Server container image tag.
execTimeout integer ExecTimeout specifies the timeout in seconds for tool execution
env EnvVar array Env lets you specify environment for repo server pods
volumes Volume array Volumes adds volumes to the repo server deployment
volumeMounts VolumeMount array VolumeMounts adds volumeMounts to the repo server container
initContainers Container array InitContainers defines the list of initialization containers for the repo server deployment
sidecarContainers Container array SidecarContainers defines the list of sidecar containers for the repo
server deployment. If the image field is omitted from a SidecarContainer,
the image for the repo server will be used.
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Repo Server ServiceMonitor.

ArgoCDRouteSpec

ArgoCDRouteSpec defines the desired state for an OpenShift Route.

Appears in: - ArgoCDGrafanaSpec - ArgoCDPrometheusSpec - ArgoCDServerSpec - WebhookServerSpec

Field Description Default Validation
annotations object (keys:string, values:string) Annotations is the map of annotations to use for the Route resource.
labels object (keys:string, values:string) Labels is the map of labels to use for the Route resource
enabled boolean Enabled will toggle the creation of the OpenShift Route.
path string Path the router watches for, to route traffic for to the service.
tls TLSConfig TLS provides the ability to configure certificates and termination for the Route.
wildcardPolicy WildcardPolicyType WildcardPolicy if any for the route. Currently only 'Subdomain' or 'None' is allowed.

ArgoCDSSOSpec

ArgoCDSSOSpec defines SSO provider.

Appears in: - ArgoCDSpec

Field Description Default Validation
provider SSOProviderType Provider installs and configures the given SSO Provider with Argo CD.
dex ArgoCDDexSpec Dex contains the configuration for Argo CD dex authentication
keycloak ArgoCDKeycloakSpec Keycloak contains the configuration for Argo CD keycloak authentication
Removed: This field is no longer supported and the related functionality has been removed.
image string Deprecated field. Support dropped in v1beta1 version.
Image is the SSO container image.
resources ResourceRequirements Deprecated field. Support dropped in v1beta1 version.
Resources defines the Compute Resources required by the container for SSO.
verifyTLS boolean Deprecated field. Support dropped in v1beta1 version.
VerifyTLS set to false disables strict TLS validation.
version string Deprecated field. Support dropped in v1beta1 version.
Version is the SSO container image tag.

ArgoCDServerAutoscaleSpec

ArgoCDServerAutoscaleSpec defines the desired state for autoscaling the Argo CD Server component.

Appears in: - ArgoCDServerSpec

Field Description Default Validation
enabled boolean Enabled will toggle autoscaling support for the Argo CD Server component.
hpa HorizontalPodAutoscalerSpec HPA defines the HorizontalPodAutoscaler options for the Argo CD Server component.

ArgoCDServerGRPCSpec

ArgoCDServerGRPCSpec defines the desired state for the Argo CD Server GRPC options.

Appears in: - ArgoCDServerSpec

Field Description Default Validation
host string Host is the hostname to use for Ingress/Route resources.
ingress ArgoCDIngressSpec Ingress defines the desired state for the Argo CD Server GRPC Ingress.

ArgoCDServerServiceSpec

ArgoCDServerServiceSpec defines the Service options for Argo CD Server component.

Appears in: - ArgoCDServerSpec

Field Description Default Validation
type ServiceType Type is the ServiceType to use for the Service resource.

ArgoCDServerSpec

ArgoCDServerSpec defines the options for the ArgoCD Server component.

Appears in: - ArgoCDSpec

Field Description Default Validation
autoscale ArgoCDServerAutoscaleSpec Autoscale defines the autoscale options for the Argo CD Server component.
enableRolloutsUI boolean EnableRolloutsUI will add the Argo Rollouts UI extension in ArgoCD Dashboard.
grpc ArgoCDServerGRPCSpec GRPC defines the state for the Argo CD Server GRPC options.
host string Host is the hostname to use for Ingress/Route resources.
ingress ArgoCDIngressSpec Ingress defines the desired state for an Ingress for the Argo CD Server component.
insecure boolean Insecure toggles the insecure flag.
logLevel string LogLevel refers to the log level to be used by the ArgoCD Server component. Defaults to ArgoCDDefaultLogLevel if not set. Valid options are debug, info, error, and warn.
logFormat string LogFormat refers to the log level to be used by the ArgoCD Server component. Defaults to ArgoCDDefaultLogFormat if not configured. Valid options are text or json.
replicas integer Replicas defines the number of replicas for argocd-server. Default is nil. Value should be greater than or equal to 0. Value will be ignored if Autoscaler is enabled.
resources ResourceRequirements Resources defines the Compute Resources required by the container for the Argo CD server component.
route ArgoCDRouteSpec Route defines the desired state for an OpenShift Route for the Argo CD Server component.
service ArgoCDServerServiceSpec Service defines the options for the Service backing the ArgoCD Server component.
env EnvVar array Env lets you specify environment for API server pods
extraCommandArgs string array Extra Command arguments that would append to the Argo CD server command.
ExtraCommandArgs will not be added, if one of these commands is already part of the server command
with same or different value.
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Server ServiceMonitor.

ArgoCDSourceHydratorSpec

Appears in: - ArgoCDSpec

Field Description Default Validation
enabled boolean Enabled defines whether the Source Hydrator is enabled.

ArgoCDSpec

ArgoCDSpec defines the desired state of ArgoCD

Appears in: - ArgoCD

Field Description Default Validation
applicationSet ArgoCDApplicationSet ArgoCDApplicationSet defines whether the Argo CD ApplicationSet controller should be installed.
applicationInstanceLabelKey string ApplicationInstanceLabelKey is the key name where Argo CD injects the app name as a tracking label.
installationID string InstallationID uniquely identifies an Argo CD instance in multi-instance clusters.
configManagementPlugins string Deprecated: ConfigManagementPlugins field is no longer supported. Argo CD now requires plugins to be defined as sidecar containers of repo server component. See '.spec.repo.sidecarContainers'. ConfigManagementPlugins was previously used to specify additional config management plugins.
controller ArgoCDApplicationControllerSpec Controller defines the Application Controller options for ArgoCD.
commitServer ArgoCDCommitServerSpec CommitServer defines the options for the ArgoCD Commit Server component.
disableAdmin boolean DisableAdmin will disable the admin user.
extraConfig object (keys:string, values:string) ExtraConfig can be used to add fields to Argo CD configmap that are not supported by Argo CD CRD.
Note: ExtraConfig takes precedence over Argo CD CRD.
For example, A user sets argocd.Spec.DisableAdmin = true and also
a.Spec.ExtraConfig["admin.enabled"] = true. In this case, operator updates
Argo CD Configmap as follows -> argocd-cm.Data["admin.enabled"] = true.
gaTrackingID string GATrackingID is the google analytics tracking ID to use.
gaAnonymizeUsers boolean GAAnonymizeUsers toggles user IDs being hashed before sending to google analytics.
grafana ArgoCDGrafanaSpec Deprecated: Grafana defines the Grafana server options for ArgoCD.
ha ArgoCDHASpec HA options for High Availability support for the Redis component.
helpChatURL string HelpChatURL is the URL for getting chat help, this will typically be your Slack channel for support.
helpChatText string HelpChatText is the text for getting chat help, defaults to "Chat now!"
image string Image is the ArgoCD container image for all ArgoCD components.
imagePullPolicy PullPolicy ImagePullPolicy is the image pull policy for all ArgoCD components.
Valid values are Always, IfNotPresent, Never. If not specified, defaults to the operator's global setting.		 Enum: [Always IfNotPresent Never]
import ArgoCDImportSpec Import is the import/restore options for ArgoCD.
initialRepositories string InitialRepositories to configure Argo CD with upon creation of the cluster.
initialSSHKnownHosts SSHHostsSpec InitialSSHKnownHosts defines the SSH known hosts data upon creation of the cluster for connecting Git repositories via SSH.
kustomizeBuildOptions string KustomizeBuildOptions is used to specify build options/parameters to use with kustomize build.
kustomizeVersions KustomizeVersionSpec array KustomizeVersions is a listing of configured versions of Kustomize to be made available within ArgoCD.
oidcConfig string OIDCConfig is the OIDC configuration as an alternative to dex.
monitoring ArgoCDMonitoringSpec Monitoring defines whether workload status monitoring configuration for this instance.
networkPolicy ArgoCDNetworkPolicySpec NetworkPolicy controls whether the operator should create NetworkPolicy resources for this Argo CD instance.
nodePlacement ArgoCDNodePlacementSpec NodePlacement defines NodeSelectors and Taints for Argo CD workloads
priorityClassName string PriorityClassName is the name of the PriorityClass resource to be assigned to all ArgoCD component pods. Optional: {}
notifications ArgoCDNotifications Notifications defines whether the Argo CD Notifications controller should be installed.
prometheus ArgoCDPrometheusSpec Prometheus defines the Prometheus server options for ArgoCD.
rbac ArgoCDRBACSpec RBAC defines the RBAC configuration for Argo CD.
redis ArgoCDRedisSpec Redis defines the Redis server options for ArgoCD.
repo ArgoCDRepoSpec Repo defines the repo server options for Argo CD.
repositoryCredentials string RepositoryCredentials are the Git pull credentials to configure Argo CD with upon creation of the cluster.
resourceCustomizations string Deprecated field. Support dropped in v1beta1 version.
ResourceCustomizations customizes resource behavior. Keys are in the form: group/Kind. Please note that this is being deprecated in favor of ResourceHealthChecks, ResourceIgnoreDifferences, and ResourceActions.
resourceHealthChecks ResourceHealthCheck array ResourceHealthChecks customizes resource health check behavior.
resourceIgnoreDifferences ResourceIgnoreDifference ResourceIgnoreDifferences customizes resource ignore difference behavior.
resourceActions ResourceAction array ResourceActions customizes resource action behavior.
resourceExclusions string ResourceExclusions is used to completely ignore entire classes of resource group/kinds.
resourceInclusions string ResourceInclusions is used to only include specific group/kinds in the
reconciliation process.
resourceTrackingMethod string ResourceTrackingMethod defines how Argo CD should track resources that it manages
server ArgoCDServerSpec Server defines the options for the ArgoCD Server component.
sourceHydrator ArgoCDSourceHydratorSpec SourceHydrator defines the options for the ArgoCD Source Hydrator component.
sourceNamespaces string array SourceNamespaces defines the namespaces application resources are allowed to be created in
sso ArgoCDSSOSpec SSO defines the Single Sign-on configuration for Argo CD
statusBadgeEnabled boolean StatusBadgeEnabled toggles application status badge feature.
tls ArgoCDTLSSpec TLS defines the TLS options for ArgoCD.
usersAnonymousEnabled boolean UsersAnonymousEnabled toggles anonymous user access.
The anonymous users get default role permissions specified argocd-rbac-cm.
version string Version is the tag to use with the ArgoCD container image for all ArgoCD components.
banner Banner Banner defines an additional banner to be displayed in Argo CD UI
dex ArgoCDDexSpec Deprecated field. Support dropped in v1beta1 version.
Dex defines the Dex server options for ArgoCD.
defaultClusterScopedRoleDisabled boolean DefaultClusterScopedRoleDisabled will disable creation of default ClusterRoles for a cluster scoped instance.
aggregatedClusterRoles boolean AggregatedClusterRoles will allow users to have aggregated ClusterRoles for a cluster scoped instance.
argoCDAgent ArgoCDAgentSpec ArgoCDAgent defines configurations for the ArgoCD Agent component.
namespaceManagement ManagedNamespaces array NamespaceManagement defines the list of namespaces that Argo CD is allowed to manage.
webhookSecrets ArgoCDWebhookSecretsSpec WebhookSecrets references Kubernetes Secrets that supply webhook credentials per provider.
The operator syncs values into argocd-secret under the keys Argo CD expects.

ArgoCDStatus

ArgoCDStatus defines the observed state of ArgoCD

Appears in: - ArgoCD

Field Description Default Validation
applicationController string ApplicationController is a simple, high-level summary of where the Argo CD application controller component is in its lifecycle.
There are four possible ApplicationController values:
Pending: The Argo CD application controller component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD application controller component are in a Ready state.
Failed: At least one of the Argo CD application controller component Pods had a failure.
Unknown: The state of the Argo CD application controller component could not be obtained.
applicationSetController string ApplicationSetController is a simple, high-level summary of where the Argo CD applicationSet controller component is in its lifecycle.
There are four possible ApplicationSetController values:
Pending: The Argo CD applicationSet controller component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD applicationSet controller component are in a Ready state.
Failed: At least one of the Argo CD applicationSet controller component Pods had a failure.
Unknown: The state of the Argo CD applicationSet controller component could not be obtained.
sso string SSO is a simple, high-level summary of where the Argo CD SSO(Dex/Keycloak) component is in its lifecycle.
There are four possible sso values:
Pending: The Argo CD SSO component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD SSO component are in a Ready state.
Failed: At least one of the Argo CD SSO component Pods had a failure.
Unknown: The state of the Argo CD SSO component could not be obtained.
notificationsController string NotificationsController is a simple, high-level summary of where the Argo CD notifications controller component is in its lifecycle.
There are four possible NotificationsController values:
Pending: The Argo CD notifications controller component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD notifications controller component are in a Ready state.
Failed: At least one of the Argo CD notifications controller component Pods had a failure.
Unknown: The state of the Argo CD notifications controller component could not be obtained.
phase string Phase is a simple, high-level summary of where the ArgoCD is in its lifecycle.
There are four possible phase values:
Pending: The ArgoCD has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Available: All of the resources for the ArgoCD are ready.
Failed: At least one resource has experienced a failure.
Unknown: The state of the ArgoCD phase could not be obtained.
redis string Redis is a simple, high-level summary of where the Argo CD Redis component is in its lifecycle.
There are four possible redis values:
Pending: The Argo CD Redis component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD Redis component are in a Ready state.
Failed: At least one of the Argo CD Redis component Pods had a failure.
Unknown: The state of the Argo CD Redis component could not be obtained.
repo string Repo is a simple, high-level summary of where the Argo CD Repo component is in its lifecycle.
There are four possible repo values:
Pending: The Argo CD Repo component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD Repo component are in a Ready state.
Failed: At least one of the Argo CD Repo component Pods had a failure.
Unknown: The state of the Argo CD Repo component could not be obtained.
server string Server is a simple, high-level summary of where the Argo CD server component is in its lifecycle.
There are four possible server values:
Pending: The Argo CD server component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD server component are in a Ready state.
Failed: At least one of the Argo CD server component Pods had a failure.
Unknown: The state of the Argo CD server component could not be obtained.
commitServer string CommitServer is a simple, high-level summary of where the Argo CD Commit Server component is in its lifecycle.
There are four possible server values:
Pending: The Argo CD commit server component has been accepted by the Kubernetes system, but one or more of the required resources have not been created.
Running: All of the required Pods for the Argo CD commit server component are in a Ready state.
Failed: At least one of the Argo CD commit server component Pods had a failure.
Unknown: The state of the Argo CD commit server component could not be obtained.
repoTLSChecksum string RepoTLSChecksum contains the SHA256 checksum of the latest known state of tls.crt and tls.key in the argocd-repo-server-tls secret.
redisTLSChecksum string RedisTLSChecksum contains the SHA256 checksum of the latest known state of tls.crt and tls.key in the argocd-operator-redis-tls secret.
host string Host is the hostname of the Ingress.
conditions Condition array Conditions is an array of the ArgoCD's status conditions

ArgoCDTLSSpec

ArgoCDTLSSpec defines the TLS options for ArgCD.

Appears in: - ArgoCDSpec

Field Description Default Validation
ca ArgoCDCASpec CA defines the CA options.
initialCerts object (keys:string, values:string) InitialCerts defines custom TLS certificates upon creation of the cluster for connecting Git repositories via HTTPS.

ArgoCDWebhookSecretsAzureDevOps

ArgoCDWebhookSecretsAzureDevOps declares where to read the Azure DevOps webhook credentials.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
usernameSecretRef WebhookSecretKeySelector UsernameSecretRef points to the key holding the username.
passwordSecretRef WebhookSecretKeySelector PasswordSecretRef points to the key holding the password or PAT.

ArgoCDWebhookSecretsBitbucket

ArgoCDWebhookSecretsBitbucket declares where to read the Bitbucket Cloud webhook UUID.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
webhookUUIDSecretRef WebhookSecretKeySelector WebhookUUIDSecretRef points to the key holding the Bitbucket Cloud webhook UUID.

ArgoCDWebhookSecretsBitbucketServer

ArgoCDWebhookSecretsBitbucketServer declares where to read the Bitbucket Server webhook secret.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
webhookSecretRef WebhookSecretKeySelector WebhookSecretRef points to the key holding the Bitbucket Server webhook shared secret.

ArgoCDWebhookSecretsGitHub

ArgoCDWebhookSecretsGitHub declares where to read the GitHub webhook secret.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
webhookSecretRef WebhookSecretKeySelector WebhookSecretRef points to the key holding the GitHub webhook shared secret.

ArgoCDWebhookSecretsGitLab

ArgoCDWebhookSecretsGitLab declares where to read the GitLab webhook secret.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
webhookSecretRef WebhookSecretKeySelector WebhookSecretRef points to the key holding the GitLab webhook shared secret.

ArgoCDWebhookSecretsGogs

ArgoCDWebhookSecretsGogs declares where to read the Gogs webhook secret.

Appears in: - ArgoCDWebhookSecretsSpec

Field Description Default Validation
webhookSecretRef WebhookSecretKeySelector WebhookSecretRef points to the key holding the Gogs webhook shared secret.

ArgoCDWebhookSecretsSpec

ArgoCDWebhookSecretsSpec holds declarative references to Secrets for Git provider webhook credentials.

Appears in: - ArgoCDSpec

Field Description Default Validation
github ArgoCDWebhookSecretsGitHub GitHub: Secret key reference for the GitHub webhook shared secret.
gitlab ArgoCDWebhookSecretsGitLab GitLab: Secret key reference for the GitLab webhook shared secret.
bitbucket ArgoCDWebhookSecretsBitbucket Bitbucket: Secret key reference for the Bitbucket Cloud webhook UUID.
bitbucketServer ArgoCDWebhookSecretsBitbucketServer BitbucketServer: Secret key reference for the Bitbucket Server webhook secret.
gogs ArgoCDWebhookSecretsGogs Gogs: Secret key reference for the Gogs webhook shared secret.
azureDevOps ArgoCDWebhookSecretsAzureDevOps AzureDevOps: Secret key references for the Azure DevOps webhook username and password (or PAT).

Banner defines an additional banner message to be displayed in Argo CD UI https://argo-cd.readthedocs.io/en/stable/operator-manual/custom-styles/#banners

Appears in: - ArgoCDSpec

Field Description Default Validation
content string Content defines the banner message content to display
url string URL defines an optional URL to be used as banner message link
permanent boolean Permanent defines if the banner should be displayed permanently or only for a certain period of time
position string Position defines the position of the banner in the UI

IgnoreDifferenceCustomization

Appears in: - ResourceIdentifiers - ResourceIgnoreDifference

Field Description Default Validation
jqPathExpressions string array
jsonPointers string array
managedFieldsManagers string array

KustomizeVersionSpec

KustomizeVersionSpec is used to specify information about a kustomize version to be used within ArgoCD.

Appears in: - ArgoCDSpec

Field Description Default Validation
version string Version is a configured kustomize version in the format of vX.Y.Z
path string Path is the path to a configured kustomize version on the filesystem of your repo server.

ManagedNamespaces

NamespaceManagement defines the namespace management settings

Appears in: - ArgoCDSpec

Field Description Default Validation
name string Name of the namespace or pattern to be managed
allowManagedBy boolean Whether the namespace can be managed by ArgoCD

NotificationsConfiguration

NotificationsConfiguration is the Schema for the NotificationsConfiguration API

Appears in: - NotificationsConfigurationList

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string NotificationsConfiguration
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec NotificationsConfigurationSpec

NotificationsConfigurationList

NotificationsConfigurationList contains a list of NotificationsConfiguration

Field Description Default Validation
apiVersion string argoproj.io/v1alpha1
kind string NotificationsConfigurationList
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds		 Optional: {}
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources		 Optional: {}
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items NotificationsConfiguration array

NotificationsConfigurationSpec

NotificationsConfigurationSpec allows users to define the triggers, templates, services, context and subscriptions for the notifications

Appears in: - NotificationsConfiguration

Field Description Default Validation
triggers object (keys:string, values:string) Triggers define the condition when the notification should be sent and list of templates required to generate the message
Recipients can subscribe to the trigger and specify the required message template and destination notification service.
templates object (keys:string, values:string) Templates are used to generate the notification template message
services object (keys:string, values:string) Services are used to deliver message
subscriptions object (keys:string, values:string) Subscriptions contain centrally managed global application subscriptions
context object (keys:string, values:string) Context is used to define some shared context between all notification templates

PrincipalJWTSpec

Appears in: - PrincipalSpec

Field Description Default Validation
insecureGenerate boolean InsecureGenerate is the flag to allow the principal to generate its own private key for signing JWT tokens (insecure).
secretName string SecretName is the name of the secret containing the JWT signing key.

PrincipalNamespaceSpec

Appears in: - PrincipalSpec

Field Description Default Validation
allowedNamespaces string array AllowedNamespaces is a list of namespaces the principal shall watch and process Argo CD resources in.
enableNamespaceCreate boolean EnableNamespaceCreate is the flag to enable namespace creation for agents.
namespaceCreatePattern string NamespaceCreatePattern is a regexp pattern to restrict the names of namespaces to be created.
namespaceCreateLabels string array NamespaceCreateLabels is the set of labels to apply to namespaces created for agents. Ex: "foo=bar,bar=baz"

PrincipalRedisSpec

Appears in: - PrincipalSpec

Field Description Default Validation
serverAddress string ServerAddress is the address of the Redis server to be used by the Principal component.
compressionType string CompressionType is the compression type to be used by Redis.

PrincipalResourceProxySpec

Appears in: - PrincipalSpec

Field Description Default Validation
secretName string SecretName is the name of the secret containing the TLS certificate and key for the resource proxy.
caSecretName string CASecretName is the name of the secret containing the CA certificate for the resource proxy.

PrincipalServerSpec

Appears in: - PrincipalSpec

Field Description Default Validation
enableWebSocket boolean EnableWebSocket is the flag to enable the WebSocket on gRPC to stream events to the Agent.
keepAliveMinInterval string KeepAliveMinInterval is the minimum interval between keep-alive messages sent by the Agent to the Principal.
service ArgoCDAgentPrincipalServiceSpec Service defines the options for the Service backing the ArgoCD Agent component.
If not set, type ClusterIP will be used by default.
route ArgoCDAgentPrincipalRouteSpec Route defines the options for the Route backing the ArgoCD Agent component.
Route is disabled only when explicitly configured with Enabled: false

PrincipalSpec

Appears in: - ArgoCDAgentSpec

Field Description Default Validation
enabled boolean Enabled is the flag to enable the Principal component during Argo CD installation. (optional, default false)
auth string Auth is the authentication method for the Principal component.
logLevel string LogLevel refers to the log level used by the Principal component.
logFormat string LogFormat refers to the log format used by the Principal component.
image string Image is the name of Argo CD Agent image
labelSelector string LabelSelector is a Kubernetes label selector that restricts which resources the principal watches.
Only resources matching this selector will be listed, watched, and processed by the principal.
env EnvVar array Env lets you specify environment for principal pods
server PrincipalServerSpec Server defines the server options for the Principal component.
namespace PrincipalNamespaceSpec Namespace is the configuration for the Principal component namespace.
resourceProxy PrincipalResourceProxySpec ResourceProxy defines the Resource Proxy options for the Principal component.
redis PrincipalRedisSpec Redis defines the Redis options for the Principal component.
tls PrincipalTLSSpec TLS defines the TLS options for the Principal component.
jwt PrincipalJWTSpec JWT defines the JWT options for the Principal component.
metrics ArgoCDMetricsSpec Metrics defines the metrics configuration for the Principal ServiceMonitor.

PrincipalTLSSpec

Appears in: - PrincipalSpec

Field Description Default Validation
secretName string SecretName is The name of the secret containing the TLS certificate and key.
rootCASecretName string RootCASecretName is the name of the secret containing the root CA TLS certificate
insecureGenerate boolean InsecureGenerate is the flag to allow the principal to generate its own set of TLS cert and key on startup when none are configured

ResourceAction

Resource Customization for custom action

Appears in: - ArgoCDSpec

Field Description Default Validation
group string
kind string
action string

ResourceHealthCheck

Resource Customization for custom health check

Appears in: - ArgoCDSpec

Field Description Default Validation
group string
kind string
check string

ResourceIdentifiers

Resource Customization fields for ignore difference

Appears in: - ResourceIgnoreDifference

Field Description Default Validation
group string
kind string
customization IgnoreDifferenceCustomization

ResourceIgnoreDifference

Resource Customization for ignore difference

Appears in: - ArgoCDSpec

Field Description Default Validation
all IgnoreDifferenceCustomization
resourceIdentifiers ResourceIdentifiers array

SSHHostsSpec

Appears in: - ArgoCDSpec

Field Description Default Validation
excludedefaulthosts boolean ExcludeDefaultHosts describes whether you would like to include the default
list of SSH Known Hosts provided by ArgoCD.
keys string Keys describes a custom set of SSH Known Hosts that you would like to
have included in your ArgoCD server.

SSOProviderType

Underlying type: string

SSOProviderType string defines the type of SSO provider.

Appears in: - ArgoCDSSOSpec

Field Description
keycloak SSOProviderTypeKeycloak means keycloak will be Installed and Integrated with Argo CD. A new realm with name argocd
will be created in this keycloak. This realm will have a client with name argocd that uses OpenShift v4 as Identity Provider.
dex SSOProviderTypeDex means dex will be Installed and Integrated with Argo CD.

WebhookSecretKeySelector

WebhookSecretKeySelector references one key within a Secret.

Appears in: - ArgoCDWebhookSecretsAzureDevOps - ArgoCDWebhookSecretsBitbucket - ArgoCDWebhookSecretsBitbucketServer - ArgoCDWebhookSecretsGitHub - ArgoCDWebhookSecretsGitLab - ArgoCDWebhookSecretsGogs

Field Description Default Validation
name string Name of the Secret. Required: {}
key string Key in the Secret whose value should be used. Required: {}

WebhookServerSpec

WebhookServerSpec defines the options for the ApplicationSet Webhook Server component.

Appears in: - ArgoCDApplicationSet

Field Description Default Validation
host string Host is the hostname to use for Ingress/Route resources.
ingress ArgoCDIngressSpec Ingress defines the desired state for an Ingress for the Application set webhook component.
route ArgoCDRouteSpec Route defines the desired state for an OpenShift Route for the Application set webhook component.