Package v1alpha1 contains API Schema definitions for the managed-gitops v1alpha1 API group
Underlying type: string
ApplicationConditionType represents type of application condition. Type name has following convention: prefix “Error” means error condition prefix “Warning” means warning condition prefix “Info” means informational condition
Appears in:
ApplicationDestination holds information about the application’s destination
Appears in:
| Field | Description |
|---|---|
environment string |
|
namespace string |
The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace |
Operation contains information about a requested or running operation
Appears in:
| Field | Description |
|---|---|
sync SyncOperation |
Sync contains parameters for the operation |
initiatedBy OperationInitiator |
InitiatedBy contains information about who initiated the operations |
info Info array |
Info is a list of informational items for this operation |
retry RetryStrategy |
Retry controls the strategy to apply if a sync fails |
ApplicationSource contains all required information about the source of an application
Appears in:
| Field | Description |
|---|---|
repoURL string |
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests |
path string |
Path is a directory path within the Git repository, and is only valid for applications sourced from Git. |
targetRevision string |
TargetRevision defines the revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart’s version. |
Backoff is the backoff strategy to use on subsequent retries for failing syncs
Appears in:
| Field | Description |
|---|---|
duration string |
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. “2m”, “1h”) |
factor int64 |
Factor is a factor to multiply the base duration after each failed retry |
maxDuration string |
MaxDuration is the maximum amount of time allowed for the backoff strategy |
GitOpsDeployment is the Schema for the gitopsdeployments API
Appears in:
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeployment |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec GitOpsDeploymentSpec |
GitOpsDeploymentCondition contains details about an GitOpsDeployment condition, which is usually an error or warning
Appears in:
| Field | Description |
|---|---|
type GitOpsDeploymentConditionType |
Type is a GitOpsDeployment condition type |
message string |
Message contains human-readable message indicating details about the last condition. |
lastProbeTime Time |
LastProbeTime is the last time the condition was observed. |
lastTransitionTime Time |
LastTransitionTime is the last time the condition transitioned from one status to another. |
reason GitOpsDeploymentReasonType |
Reason is a unique, one-word, CamelCase reason for the condition’s last transition. |
Underlying type: string
GitOpsDeploymentConditionType represents type of GitOpsDeployment condition.
Appears in:
GitOpsDeploymentDestination contains the information of .status.Sync.CompareTo.Destination field of ArgoCD Application
Appears in:
| Field | Description |
|---|---|
name string |
|
namespace string |
GitOpsDeploymentList contains a list of GitOpsDeployment
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items GitOpsDeployment array |
GitOpsDeploymentManagedEnvironment is the Schema for the gitopsdeploymentmanagedenvironments API
Appears in:
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentManagedEnvironment |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec GitOpsDeploymentManagedEnvironmentSpec |
GitOpsDeploymentManagedEnvironmentList contains a list of GitOpsDeploymentManagedEnvironment
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentManagedEnvironmentList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items GitOpsDeploymentManagedEnvironment array |
The GitOpsDeploymentManagedEnvironment CR describes a remote cluster which the GitOps Service will deploy to, via Argo CD. This resource references a Secret resource, of type managed-gitops.redhat.com/managed-environment, that contains the cluster credentials. The Secret should contain credentials to a ServiceAccount/User account on the target cluster. This is referred to as the Argo CD ‘ServiceAccount’ below.
Appears in:
| Field | Description |
| — | — |
| apiURL string | APIURL is the URL of the cluster to connect to |
| credentialsSecret string | ClusterCredentialsSecret is a reference to a Secret that contains cluster connection details. The cluster details should be in the form of a kubeconfig file. |
| allowInsecureSkipTLSVerify boolean | AllowInsecureSkipTLSVerify controls whether Argo CD will accept a Kubernetes API URL with untrusted-TLS certificate. Optional: If true, the GitOps Service will allow Argo CD to connect to the specified cluster even if it is using an invalid or self-signed TLS certificate. Defaults to false. |
| createNewServiceAccount boolean | CreateNewServiceAccount controls whether Argo CD will use the ServiceAccount provided by the user in the Secret, or if a new ServiceAccount should be created.
Optional, default to false.
namespaces string array | Namespaces allows one to indicate which Namespaces the Secret’s ServiceAccount has access to.
Optional, defaults to empty. If empty, it is assumed that the ServiceAccount has access to all Namespaces.
The ServiceAccount that GitOps Service/Argo CD uses to deploy may not have access to all of the Namespaces on a cluster. If not specified, it is assumed that the Argo CD ServiceAccount has read/write at cluster-scope. - If you are familiar with Argo CD: this field is equivalent to the field of the same name in the Argo CD Cluster Secret. |
| clusterResources boolean | ClusterResources is used in conjuction with the Namespace field. If the .spec.namespaces field is non-empty, this field will be used to determine whether Argo CD should attempt to manage cluster-scoped resources. - If .spec.namespaces field is empty, this field is ignored. - If you are familiar with Argo CD: this field is equivalent to the field of the same name in the Argo CD Cluster Secret.
Optional, default to false. |Underlying type: string
Appears in:
GitOpsDeploymentRepositoryCredential is the Schema for the gitopsdeploymentrepositorycredentials API
Appears in:
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentRepositoryCredential |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec GitOpsDeploymentRepositoryCredentialSpec |
GitOpsDeploymentRepositoryCredentialList contains a list of GitOpsDeploymentRepositoryCredential
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentRepositoryCredentialList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items GitOpsDeploymentRepositoryCredential array |
GitOpsDeploymentRepositoryCredentialSpec defines the desired state of GitOpsDeploymentRepositoryCredential
Appears in:
| Field | Description |
|---|---|
repository string |
Repository (HTTPS url, or SSH string) for accessing the Git repo Required field As of this writing (Mar 2022), we only support HTTPS URL |
secret string |
Reference to a K8s Secret in the namespace that contains repository credentials (Git username/password, as of this writing) Required field |
GitOpsDeploymentSource contains the information of .status.Sync.CompareTo.Source field of ArgoCD Application
Appears in:
| Field | Description |
|---|---|
path string |
Path contains path from .status.Sync.CompareTo field of ArgoCD Application |
repoURL string |
|
branch string |
GitOpsDeploymentSpec defines the desired state of GitOpsDeployment
Appears in:
| Field | Description |
|---|---|
source ApplicationSource |
|
destination ApplicationDestination |
Destination is a reference to a target namespace/cluster to deploy to. This field may be empty: if it is empty, it is assumed that the destination is the same namespace as the GitOpsDeployment CR. |
syncPolicy SyncPolicy |
SyncPolicy controls when and how a sync will be performed. |
type string |
Two possible values: - Automated: whenever a new commit occurs in the GitOps repository, or the Argo CD Application is out of sync, Argo CD should be told to (re)synchronize. - Manual: Argo CD should never be told to resynchronize. Instead, synchronize operations will be triggered via GitOpsDeploymentSyncRun operations only. - See GitOpsDeploymentSpecType* |
| Note: This is somewhat of a placeholder for more advanced logic that can be implemented in the future. For an example of this type of logic, see the ‘syncPolicy’ field of Argo CD Application. |
GitOpsDeploymentSyncRun is the Schema for the gitopsdeploymentsyncruns API
Appears in:
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentSyncRun |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec GitOpsDeploymentSyncRunSpec |
GitOpsDeploymentCondition contains details about an applicationset condition, which is usally an error or warning
Appears in:
| Field | Description |
|---|---|
type SyncRunConditionType |
Type is an applicationset condition type |
message string |
Message contains human-readable message indicating details about condition |
lastTransitionTime Time |
LastTransitionTime is the time the condition was last observed |
reason SyncRunReasonType |
Single word camelcase representing the reason for the status eg ErrorOccurred |
GitOpsDeploymentSyncRunList contains a list of GitOpsDeploymentSyncRun
| Field | Description |
|---|---|
apiVersion string |
managed-gitops.redhat.com/v1alpha1 |
kind string |
GitOpsDeploymentSyncRunList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items GitOpsDeploymentSyncRun array |
GitOpsDeploymentSyncRunSpec defines the desired state of GitOpsDeploymentSyncRun
Appears in:
| Field | Description |
|---|---|
gitopsDeploymentName string |
Reference to the target GitOpsDeployment to issue the synchronization operation to |
revisionID string |
Optional: If specified, tells the GitOps Service to deploy a particular git commit SHA |
HealthStatus contains information about the currently observed health state of an application or resource
Appears in:
| Field | Description |
|---|---|
message string |
Message is a human-readable informational message describing the health status |
Underlying type: string
Appears in:
Appears in:
| Field | Description |
|---|---|
name string |
|
value string |
Appears in:
| Field | Description |
|---|---|
labels _ |