v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the cache v1alpha1 API group +kubebuilder:object:generate=true +groupName=cache.weavelab.xyz

Index

• Variables
• type CachedCertificate
  • func (in *CachedCertificate) DeepCopy() *CachedCertificate
  • func (in *CachedCertificate) DeepCopyInto(out *CachedCertificate)
  • func (in *CachedCertificate) DeepCopyObject() runtime.Object
• type CachedCertificateList
  • func (in *CachedCertificateList) DeepCopy() *CachedCertificateList
  • func (in *CachedCertificateList) DeepCopyInto(out *CachedCertificateList)
  • func (in *CachedCertificateList) DeepCopyObject() runtime.Object
• type CachedCertificateSpec
  • func (in *CachedCertificateSpec) DeepCopy() *CachedCertificateSpec
  • func (in *CachedCertificateSpec) DeepCopyInto(out *CachedCertificateSpec)
• type CachedCertificateState
• type CachedCertificateStatus
  • func (in *CachedCertificateStatus) DeepCopy() *CachedCertificateStatus
  • func (in *CachedCertificateStatus) DeepCopyInto(out *CachedCertificateStatus)
• type IssuerRef
  • func (in *IssuerRef) DeepCopy() *IssuerRef
  • func (in *IssuerRef) DeepCopyInto(out *IssuerRef)
• type ObjectReference
  • func (in *ObjectReference) DeepCopy() *ObjectReference
  • func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "cache.weavelab.xyz", 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 CachedCertificate

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

	Spec   CachedCertificateSpec   `json:"spec,omitempty"`
	Status CachedCertificateStatus `json:"status,omitempty"`
}

CachedCertificate is the Schema for the cachedcertificates API

func (*CachedCertificate) DeepCopy

func (in *CachedCertificate) DeepCopy() *CachedCertificate

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

func (*CachedCertificate) DeepCopyInto

func (in *CachedCertificate) DeepCopyInto(out *CachedCertificate)

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

func (*CachedCertificate) DeepCopyObject

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

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

type CachedCertificateList

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

CachedCertificateList contains a list of CachedCertificate

func (*CachedCertificateList) DeepCopy

func (in *CachedCertificateList) DeepCopy() *CachedCertificateList

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

func (*CachedCertificateList) DeepCopyInto

func (in *CachedCertificateList) DeepCopyInto(out *CachedCertificateList)

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

func (*CachedCertificateList) DeepCopyObject

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

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

type CachedCertificateSpec

type CachedCertificateSpec struct {
	// SecretName indicates the name of the secret which will be created once the upstream certificate has been generated
	// Changing this field *will not* cause a new upstream certificate to be created
	// If changed, old secrets will not get cleaned up by the operator
	//
	// It is optional and will be defaulted to the CachedCertificate Name
	SecretName string `json:"secretName,omitempty"`

	// IssuerRef identifies a single issuer to use when generating the cert
	// Changing this field may cause a new upstream certificate to be created in the cache namespace
	IssuerRef IssuerRef `json:"issuerRef"`

	//+kubebuilder:validation:MinItems=1
	// DNSNames is a list of unique dns names for the cert
	// Changing this field may cause a new upstream certificate to be created in the cache namespace
	DNSNames []string `json:"dnsNames"`
}

CachedCertificateSpec defines the desired state of CachedCertificate

func (*CachedCertificateSpec) DeepCopy

func (in *CachedCertificateSpec) DeepCopy() *CachedCertificateSpec

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

func (*CachedCertificateSpec) DeepCopyInto

func (in *CachedCertificateSpec) DeepCopyInto(out *CachedCertificateSpec)

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

type CachedCertificateState

type CachedCertificateState string

const (
	CachedCertificateStatePending CachedCertificateState = "Pending"
	CachedCertificateStateSynced  CachedCertificateState = "Synced"
	CachedCertificateStateError   CachedCertificateState = "Error"
)

type CachedCertificateStatus

type CachedCertificateStatus struct {
	UpstreamReady bool                   `json:"upstreamReady"`
	UpstreamRef   *ObjectReference       `json:"upstreamRef,omitempty"`
	State         CachedCertificateState `json:"state"`
}

CachedCertificateStatus defines the observed state of CachedCertificate

func (*CachedCertificateStatus) DeepCopy

func (in *CachedCertificateStatus) DeepCopy() *CachedCertificateStatus

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

func (*CachedCertificateStatus) DeepCopyInto

func (in *CachedCertificateStatus) DeepCopyInto(out *CachedCertificateStatus)

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

type IssuerRef

type IssuerRef struct {
	// Name is the name of the issuer
	Name string `json:"name"`

	// Kind indicates the issuer kind to use
	Kind string `json:"kind"`

	// Group is the name of the issuer group. Optional
	Group string `json:"group,omitempty"`
}

IssuerRef points to a CertManger issuer

func (*IssuerRef) DeepCopy

func (in *IssuerRef) DeepCopy() *IssuerRef

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

func (*IssuerRef) DeepCopyInto

func (in *IssuerRef) DeepCopyInto(out *IssuerRef)

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

type ObjectReference

type ObjectReference struct {
	// Name of the resource being referred to.
	Name string `json:"name"`

	// Namespace of the resource being referred to.
	Namespace string `json:"namespace"`
}

ObjectReference is a reference to an object with a given name and Namespace

func (*ObjectReference) DeepCopy

func (in *ObjectReference) DeepCopy() *ObjectReference

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

func (*ObjectReference) DeepCopyInto

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

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