v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the gitops v1alpha1 API group +kubebuilder:object:generate=true +groupName=gitops.weave.works

Index

• Constants
• Variables
• type GitOpsCluster
  • func (in *GitOpsCluster) DeepCopy() *GitOpsCluster
  • func (in *GitOpsCluster) DeepCopyInto(out *GitOpsCluster)
  • func (in *GitOpsCluster) DeepCopyObject() runtime.Object
  • func (in GitOpsCluster) GetConditions() []metav1.Condition
  • func (in *GitOpsCluster) SetConditions(conditions []metav1.Condition)
• type GitOpsClusterList
  • func (in *GitOpsClusterList) DeepCopy() *GitOpsClusterList
  • func (in *GitOpsClusterList) DeepCopyInto(out *GitOpsClusterList)
  • func (in *GitOpsClusterList) DeepCopyObject() runtime.Object
• type GitOpsClusterSpec
  • func (in *GitOpsClusterSpec) DeepCopy() *GitOpsClusterSpec
  • func (in *GitOpsClusterSpec) DeepCopyInto(out *GitOpsClusterSpec)
• type GitOpsClusterStatus
  • func (in *GitOpsClusterStatus) DeepCopy() *GitOpsClusterStatus
  • func (in *GitOpsClusterStatus) DeepCopyInto(out *GitOpsClusterStatus)

Constants

const (
	// SecretFoundReason signals that a given secret has been found.
	SecretFoundReason string = "SecretFound"
	// WaitingForSecretReason signals that a given secret has not been found.
	WaitingForSecretReason string = "WaitingForSecret"
	// WaitingForControlPlaneReadyStatusReason  signals that a given CAPI cluster has been found but its ControlPlaneReady status is false
	WaitingForControlPlaneReadyStatusReason string = "WaitingForControlPlaneReadyStatus"
	// ControlPlaneReadyStatusReason signals that a cluster is found and it has a ControlPlaneReady=true condition
	ControlPlaneReadyStatusReason string = "ControlPlaneReadyStatus"
	// WaitingForCAPIClusterReason signals that a given CAPI cluster has not been found.
	WaitingForCAPIClusterReason string = "WaitingForCAPICluster"

	// WaitingForCAPIClusterDeletionReason signals that this cluster has been
	// deleted, but the referenced CAPI Cluster still exists.
	WaitingForCAPIClusterDeletionReason string = "WaitingForCAPIClusterDeletion"

	// WaitingForSecretDeletionReason signals that this cluster has been
	// deleted, but the referenced secret still exists.
	WaitingForSecretDeletionReason string = "WaitingForSecretDeletion"

	// CAPINotEnabled signals that CAPI component is not installed.
	CAPINotEnabled string = "CAPINotEnabled"

	// ClusterConnectionSucceededReason signals if the cluster can be connected
	ClusterConnectionSucceededReason string = "ClusterConnectionSucceeded"

	// ClusterConnectionFailedReason signals cluster connection failed
	ClusterConnectionFailedReason string = "ClusterConnectionFailed"
)

const (
	// ClusterProvisionedCondition is a condition when CAPI clusters are
	// provisioned.
	//
	// This indicates that the cluster has been bootstrapped, but the
	// control-plane may not yet be ready.
	ClusterProvisionedCondition string = "ClusterProvisioned"

	// ClusterProvisionedReason is the reason for the provisioned state being
	// set.
	ClusterProvisionedReason string = "ClusterProvisioned"

	// ClusterConnectivity indicates if the cluster has connectivity
	ClusterConnectivity string = "ClusterConnectivity"
)

const GitOpsClusterNoSecretFinalizerAnnotation = "clusters.gitops.weave.works/no-secret-finalizer"

GitOpsClusterNoSecretFinalizerAnnotation if applied to a GitOpsCluster indicates that we should not wait for the secret to be removed before allowing the cluster to be removed.

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "gitops.weave.works", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type GitOpsCluster

type GitOpsCluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   GitOpsClusterSpec   `json:"spec,omitempty"`
	Status GitOpsClusterStatus `json:"status,omitempty"`
}

GitOpsCluster is the Schema for the gitopsclusters API +kubebuilder:validation:XValidation:rule="has(self.spec)",message="must confgure spec"

func (*GitOpsCluster) DeepCopy

func (in *GitOpsCluster) DeepCopy() *GitOpsCluster

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsCluster.

func (*GitOpsCluster) DeepCopyInto

func (in *GitOpsCluster) DeepCopyInto(out *GitOpsCluster)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GitOpsCluster) DeepCopyObject

func (in *GitOpsCluster) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (GitOpsCluster) GetConditions

func (in GitOpsCluster) GetConditions() []metav1.Condition

GetConditions returns the status conditions of the object.

func (*GitOpsCluster) SetConditions

func (in *GitOpsCluster) SetConditions(conditions []metav1.Condition)

SetConditions sets the status conditions on the object.

type GitOpsClusterList

type GitOpsClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []GitOpsCluster `json:"items"`
}

GitOpsClusterList contains a list of GitOpsCluster

func (*GitOpsClusterList) DeepCopy

func (in *GitOpsClusterList) DeepCopy() *GitOpsClusterList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsClusterList.

func (*GitOpsClusterList) DeepCopyInto

func (in *GitOpsClusterList) DeepCopyInto(out *GitOpsClusterList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GitOpsClusterList) DeepCopyObject

func (in *GitOpsClusterList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GitOpsClusterSpec

type GitOpsClusterSpec struct {
	// SecretRef specifies the Secret containing the kubeconfig for a cluster.
	// +optional
	SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
	// CAPIClusterRef specifies the CAPI Cluster.
	// +optional
	CAPIClusterRef *meta.LocalObjectReference `json:"capiClusterRef,omitempty"`
}

GitOpsClusterSpec defines the desired state of GitOpsCluster +kubebuilder:validation:XValidation:rule="(has(self.secretRef) || has(self.capiClusterRef))",message="must provide a secretRef or capiClusterRef" +kubebuilder:validation:XValidation:rule="!(has(self.secretRef) && has(self.capiClusterRef))",message="cannot provide both capiClusterRef and secretRef"

func (*GitOpsClusterSpec) DeepCopy

func (in *GitOpsClusterSpec) DeepCopy() *GitOpsClusterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsClusterSpec.

func (*GitOpsClusterSpec) DeepCopyInto

func (in *GitOpsClusterSpec) DeepCopyInto(out *GitOpsClusterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GitOpsClusterStatus

type GitOpsClusterStatus struct {
	// Conditions holds the conditions for the Cluster.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

GitOpsClusterStatus defines the observed state of GitOpsCluster

func (*GitOpsClusterStatus) DeepCopy

func (in *GitOpsClusterStatus) DeepCopy() *GitOpsClusterStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsClusterStatus.

func (*GitOpsClusterStatus) DeepCopyInto

func (in *GitOpsClusterStatus) DeepCopyInto(out *GitOpsClusterStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.