Skip to content

API Documentation

Packages:

argoproj.io/v1alpha1

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

Resource Types:

    ArgoCD

    ArgoCD is the Schema for the argocds API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ArgoCDSpec

    applicationInstanceLabelKey
    string

    ApplicationInstanceLabelKey is the key name where Argo CD injects the app name as a tracking label.
    configManagementPlugins
    string

    ConfigManagementPlugins is used to specify additional config management plugins.
    controller
    ArgoCDApplicationControllerSpec

    Controller defines the Application Controller options for ArgoCD.
    gaTrackingID
    string

    GATrackingID is the google analytics tracking ID to use.
    gaAnonymizeUsers
    bool

    GAAnonymizeUsers toggles user IDs being hashed before sending to google analytics.
    grafana
    ArgoCDGrafanaSpec

    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.
    import
    ArgoCDImportSpec

    Import is the import/restore options for ArgoCD.
    initialRepositories
    string

    InitialRepositories to configure Argo CD with upon creation of the cluster.
    initialSSHKnownHosts
    string

    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.
    notifications
    ArgoCDNotificationsSpec

    Notifications controls the desired state of Argo CD Notifications controller.
    oidcConfig
    string

    OIDCConfig is the OIDC configuration as an alternative to dex.
    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

    ResourceCustomizations customizes resource behavior. Keys are in the form: group/Kind.
    resourceExclusions
    string

    ResourceExclusions is used to completely ignore entire classes of resource group/kinds.
    server
    ArgoCDServerSpec

    Server defines the options for the ArgoCD Server component.
    sso
    ArgoCDSSOSpec

    SSO defines the Single Sign-on configuration for Argo CD.
    statusBadgeEnabled
    bool

    StatusBadgeEnabled toggles application status badge feature.
    tls
    ArgoCDTLSSpec

    TLS defines the TLS options for ArgoCD.
    usersAnonymousEnabled
    bool

    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.
    status
    ArgoCDStatus

    ArgoCDApplicationControllerProcessorsSpec

    (Appears on: ArgoCDApplicationControllerSpec)

    ArgoCDApplicationControllerProcessorsSpec defines the options for the ArgoCD Application Controller processors.

    Field Description
    operation
    int32

    Operation is the number of application operation processors.
    status
    int32

    Status is the number of application status processors.

    ArgoCDApplicationControllerSpec

    (Appears on: ArgoCDSpec)

    ArgoCDApplicationControllerSpec defines the options for the ArgoCD Application Controller component.

    Field Description
    processors
    ArgoCDApplicationControllerProcessorsSpec

    Processors contains the options for the Application Controller processors.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for the Application Controller.

    ArgoCDCASpec

    (Appears on: ArgoCDTLSSpec)

    ArgoCDCASpec defines the CA options for ArgCD.

    Field Description
    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.

    ArgoCDCertificateSpec

    ArgoCDCertificateSpec defines the options for the ArgoCD certificates.

    Field Description
    secretName
    string

    SecretName is the name of the Secret containing the Certificate and Key.

    ArgoCDDexOAuthSpec

    ArgoCDDexOAuthSpec defines the desired state for the Dex OAuth configuration.

    Field Description
    enabled
    bool

    Enabled will toggle OAuth support for the Dex server.

    ArgoCDDexSpec

    (Appears on: ArgoCDSpec)

    ArgoCDDexSpec defines the desired state for the Dex server component.

    Field Description
    config
    string

    Config is the dex connector configuration.
    image
    string

    Image is the Dex container image.
    openShiftOAuth
    bool

    OpenShiftOAuth enables OpenShift OAuth authentication for the Dex server.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for Dex.
    version
    string

    Version is the Dex container image tag.

    ArgoCDExport

    ArgoCDExport is the Schema for the argocdexports API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ArgoCDExportSpec

    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.
    status
    ArgoCDExportStatus

    ArgoCDExportSpec

    (Appears on: ArgoCDExport)

    ArgoCDExportSpec defines the desired state of ArgoCDExport

    Field Description
    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

    (Appears on: ArgoCDExport)

    ArgoCDExportStatus defines the observed state of ArgoCDExport

    Field Description
    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

    (Appears on: ArgoCDExportSpec)

    ArgoCDExportStorageSpec defines the desired state for ArgoCDExport storage options.

    Field Description
    backend
    string

    Backend defines the storage backend to use, must be “local” (the default), “aws”, “azure” or “gcp”.
    pvc
    Kubernetes core/v1.PersistentVolumeClaimSpec

    PVC is the desired characteristics for a PersistentVolumeClaim.
    secretName
    string

    SecretName is the name of a Secret with encryption key, credentials, etc.

    ArgoCDGrafanaSpec

    (Appears on: ArgoCDSpec)

    ArgoCDGrafanaSpec defines the desired state for the Grafana component.

    Field Description
    enabled
    bool

    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
    Kubernetes core/v1.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
    int32

    Size is the replica count for the Grafana Deployment.
    version
    string

    Version is the Grafana container image tag.

    ArgoCDHASpec

    (Appears on: ArgoCDSpec)

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

    Field Description
    enabled
    bool

    Enabled will toggle HA support globally for Argo CD.
    redisProxyImage
    string

    The Redis HAProxy container image. This overrides the "ARGOCD_REDIS_HA_PROXY_IMAGE" environment variable.
    redisProxyVersion
    string

    The tag to use for the Redis HAProxy container image.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for Redis HA.

    ArgoCDImportSpec

    (Appears on: ArgoCDSpec)

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

    Field Description
    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

    (Appears on: ArgoCDGrafanaSpec, ArgoCDPrometheusSpec, ArgoCDServerGRPCSpec, ArgoCDServerSpec)

    ArgoCDIngressSpec defines the desired state for the Ingress resources.

    Field Description
    annotations
    map[string]string

    Annotations is the map of annotations to apply to the Ingress.
    enabled
    bool

    Enabled will toggle the creation of the Ingress.
    path
    string

    Path used for the Ingress resource.
    tls
    []Kubernetes networking.k8s.io/v1.IngressTLS     		(Optional)

    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.

    ArgoCDNotificationsSpec

    (Appears on: ArgoCDSpec)

    ArgoCDNotificationsSpec defines the desired state for the Notifications controller component.

    Field Description
    enabled
    bool

    Enabled is the toggle that determines whether notifications controller should be started or not.

    image
    string

    Image is the Argo CD container image.
    replicas
    int32

    Replicas determins the number of replicas for notifications controller.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for Notifications controller.
    version
    string

    Version is the Argo CD container image tag.

    ArgoCDPrometheusSpec

    ArgoCDPrometheusSpec

    ArgoCDKeycloakSpec

    (Appears on: ArgoCDSSOSpec)

    ArgoCDKeycloakSpec Keycloak contains the configuration for Argo CD keycloak authentication (previously found under cr.spec.sso)

    Field Description
    image
    string

    Image is the Keycloak container image.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for Keycloak.
    version
    string

    Version is the Keycloak container image tag.
    verifyTLS
    bool

    VerifyTLS set to false disables strict TLS validation.

    ArgoCDPrometheusSpec

    (Appears on: ArgoCDSpec)

    ArgoCDPrometheusSpec defines the desired state for the Prometheus component.

    Field Description
    enabled
    bool

    Enabled will toggle Prometheus support globally for ArgoCD.
    host
    string

    Host is the hostname to use for Ingress/Route resources.
    ingress
    ArgoCDIngressSpec

    Ingress defines the desired state for an Ingress for the Prometheus component.
    route
    ArgoCDRouteSpec

    Route defines the desired state for an OpenShift Route for the Prometheus component.
    size
    int32

    Size is the replica count for the Prometheus StatefulSet.

    ArgoCDRBACSpec

    (Appears on: ArgoCDSpec)

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

    Field Description
    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]’.

    ArgoCDRedisSpec

    (Appears on: ArgoCDSpec)

    ArgoCDRedisSpec defines the desired state for the Redis server component.

    Field Description
    image
    string

    Image is the Redis container image.
    resources
    Kubernetes core/v1.ResourceRequirements

    Resources defines the Compute Resources required by the container for Redis.
    version
    string

    Version is the Redis container image tag.

    ArgoCDRepoSpec

    (Appears on: ArgoCDSpec)

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

    Field Description
    mountsatoken
    bool

    MountSAToken describes whether you would like to have the Repo server mount the service account token
    resources
    Kubernetes core/v1.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

    ArgoCDRouteSpec

    (Appears on: ArgoCDGrafanaSpec, ArgoCDPrometheusSpec, ArgoCDServerSpec)

    ArgoCDRouteSpec defines the desired state for an OpenShift Route.

    Field Description
    annotations
    map[string]string

    Annotations is the map of annotations to use for the Route resource.
    enabled
    bool

    Enabled will toggle the creation of the OpenShift Route.
    path
    string

    Path the router watches for, to route traffic for to the service.
    tls
    github.com/openshift/api/route/v1.TLSConfig

    TLS provides the ability to configure certificates and termination for the Route.
    wildcardPolicy
    github.com/openshift/api/route/v1.WildcardPolicyType

    WildcardPolicy if any for the route. Currently only ‘Subdomain’ or ‘None’ is allowed.

    ArgoCDServerAutoscaleSpec

    (Appears on: ArgoCDServerSpec)

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

    Field Description
    enabled
    bool

    Enabled will toggle autoscaling support for the Argo CD Server component.
    hpa
    Kubernetes autoscaling/v1.HorizontalPodAutoscalerSpec

    HPA defines the HorizontalPodAutoscaler options for the Argo CD Server component.

    ArgoCDServerGRPCSpec

    (Appears on: ArgoCDServerSpec)

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

    Field Description
    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

    (Appears on: ArgoCDServerSpec)

    ArgoCDServerServiceSpec defines the Service options for Argo CD Server component.

    Field Description
    type
    Kubernetes core/v1.ServiceType

    Type is the ServiceType to use for the Service resource.

    ArgoCDServerSpec

    (Appears on: ArgoCDSpec)

    ArgoCDServerSpec defines the options for the ArgoCD Server component.

    Field Description
    autoscale
    ArgoCDServerAutoscaleSpec

    Autoscale defines the autoscale options for the Argo CD Server component.
    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
    bool

    Insecure toggles the insecure flag.
    resources
    Kubernetes core/v1.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.

    ArgoCDSpec

    (Appears on: ArgoCD)

    ArgoCDSpec defines the desired state of ArgoCD

    Field Description
    applicationInstanceLabelKey
    string

    ApplicationInstanceLabelKey is the key name where Argo CD injects the app name as a tracking label.
    configManagementPlugins
    string

    ConfigManagementPlugins is used to specify additional config management plugins.
    controller
    ArgoCDApplicationControllerSpec

    Controller defines the Application Controller options for ArgoCD.
    gaTrackingID
    string

    GATrackingID is the google analytics tracking ID to use.
    gaAnonymizeUsers
    bool

    GAAnonymizeUsers toggles user IDs being hashed before sending to google analytics.
    grafana
    ArgoCDGrafanaSpec

    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.
    import
    ArgoCDImportSpec

    Import is the import/restore options for ArgoCD.
    initialRepositories
    string

    InitialRepositories to configure Argo CD with upon creation of the cluster.
    initialSSHKnownHosts
    string

    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.
    oidcConfig
    string

    OIDCConfig is the OIDC configuration as an alternative to dex.
    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

    ResourceCustomizations customizes resource behavior. Keys are in the form: group/Kind.
    resourceExclusions
    string

    ResourceExclusions is used to completely ignore entire classes of resource group/kinds.
    server
    ArgoCDServerSpec

    Server defines the options for the ArgoCD Server component.
    sso
    ArgoCDSSOSpec

    SSO defines the Single Sign-on configuration for Argo CD.
    statusBadgeEnabled
    bool

    StatusBadgeEnabled toggles application status badge feature.
    tls
    ArgoCDTLSSpec

    TLS defines the TLS options for ArgoCD.
    usersAnonymousEnabled
    bool

    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.

    ArgoCDSSOSpec

    (Appears on: ArgoCDSpec)

    ArgoCDSSOSpec defines the Single Sign-on configuration for Argo CD.

    Field Description
    dex
    ArgoCDDexSpec

    Dex contains the configuration for Argo CD dex authentication (previously found under cr.spec.dex)
    keycloak
    ArgoCDKeycloakSpec

    Keycloak contains the configuration for Argo CD keycloak authentication (previously found under cr.spec.sso)
    provider
    SSOProviderType

    Provider installs and configures the given SSO Provider with Argo CD.

    ArgoCDStatus

    (Appears on: ArgoCD)

    ArgoCDStatus defines the observed state of ArgoCD

    Field Description
    applicationController
    string

    ApplicationController is a simple, high-level summary of where the Argo CD application controller component is in its lifecycle. There are five 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: For some reason the state of the Argo CD application controller component could not be obtained.

    notifications
    string

    Notifications is a simple, high-level summary of where the Argo CD Notifications controller component is in its lifecycle. There are four possible notifications 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: For some reason 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 five 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: For some reason 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 five 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: For some reason 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 five 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: For some reason 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 five 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: For some reason the state of the Argo CD server 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 server 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.

    host
    string

    Host is the url for the hostname to use for Ingress/Route resources

    ArgoCDTLSSpec

    (Appears on: ArgoCDSpec)

    ArgoCDTLSSpec defines the TLS options for ArgCD.

    Field Description
    ca
    ArgoCDCASpec

    CA defines the CA options.
    initialCerts
    map[string]string

    InitialCerts defines custom TLS certificates upon creation of the cluster for connecting Git repositories via HTTPS.

    Generated with gen-crd-api-reference-docs on git commit c13da2a.

    argoproj.io/v1alpha1