v1alpha1

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the cert-manager v1alpha1 API group +kubebuilder:object:generate=true +groupName=cert-manager.skyscanner.net

Index

Constants

View Source 
const (
	KMSIssuerReasonPending = "Pending"
	KMSIssuerReasonFailed  = "Failed"
	KMSIssuerReasonIssued  = "Issued"
)

Condition reasons

View Source 
const (
	KMSKeyReasonPending = "Pending"
	KMSKeyReasonFailed  = "Failed"
	KMSKeyReasonIssued  = "Issued"
)

Condition reasons

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "cert-manager.skyscanner.net", 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
)

Functions

This section is empty.

Types

type Condition 

type Condition struct {
	// Type of the condition, currently ('Ready').
	Type ConditionType `json:"type"`

	// Status of the condition, one of ('True', 'False', 'Unknown').
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status ConditionStatus `json:"status"`

	// LastTransitionTime is the timestamp corresponding to the last status
	// change of this condition.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason is a brief machine readable explanation for the condition's last
	// transition.
	// +optional
	Reason string `json:"reason,omitempty"`

	// Message is a human readable description of the details of the last
	// transition, complementing reason.
	// +optional
	Message string `json:"message,omitempty"`
}

Condition contains condition information.

func NewCondition 

func NewCondition(condType ConditionType, status ConditionStatus, reason, msg string) Condition

NewCondition creates a new condition

func (*Condition) DeepCopy 

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto 

func (in *Condition) DeepCopyInto(out *Condition)

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

type ConditionStatus 

type ConditionStatus string

ConditionStatus represents a condition's status. +kubebuilder:validation:Enum=True;False;Unknown 

const (
	// ConditionTrue represents the fact that a given condition is true
	ConditionTrue ConditionStatus = "True"

	// ConditionFalse represents the fact that a given condition is false
	ConditionFalse ConditionStatus = "False"

	// ConditionUnknown represents the fact that a given condition is unknown
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

type ConditionType 

type ConditionType string

ConditionType represents a condition type. +kubebuilder:validation:Enum=Ready 

const (
	// ConditionReady indicates that a is ready for use.
	ConditionReady ConditionType = "Ready"
)

type KMSIssuer 

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

	Spec   KMSIssuerSpec   `json:"spec,omitempty"`
	Status KMSIssuerStatus `json:"status,omitempty"`
}

KMSIssuer is the Schema for the kmsissuers API

func (*KMSIssuer) DeepCopy 

func (in *KMSIssuer) DeepCopy() *KMSIssuer

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

func (*KMSIssuer) DeepCopyInto 

func (in *KMSIssuer) DeepCopyInto(out *KMSIssuer)

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

func (*KMSIssuer) DeepCopyObject 

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

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

type KMSIssuerList 

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

KMSIssuerList contains a list of KMSIssuer

func (*KMSIssuerList) DeepCopy 

func (in *KMSIssuerList) DeepCopy() *KMSIssuerList

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

func (*KMSIssuerList) DeepCopyInto 

func (in *KMSIssuerList) DeepCopyInto(out *KMSIssuerList)

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

func (*KMSIssuerList) DeepCopyObject 

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

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

type KMSIssuerSpec 

type KMSIssuerSpec struct {

	// KeyID is the unique identifier for the customer master key (CMK)
	// deletion. When unspecified, a RSA 2048 key is created and managed by
	// the operator.
	// +optional
	KeyID string `json:"keyId,omitempty"`

	// CommonName is a common name to be used on the Certificate.
	// The CommonName should have a length of 64 characters or fewer to avoid
	// generating invalid CSRs.
	// This value is ignored by TLS clients when any subject alt name is set.
	// This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4
	CommonName string `json:"commonName,omitempty"`

	// Certificate default Duration
	// +optional
	Duration *metav1.Duration `json:"duration,omitempty"`

	// RenewBefore is the amount of time before the currently issued certificate’s notAfter time that the issuer will begin to attempt to renew the certificate.
	// If this value is greater than the total duration of the certificate (i.e. notAfter - notBefore), it will be automatically renewed 2/3rds of the way through the certificate’s duration.
	// +optional
	RenewBefore *metav1.Duration `json:"renewBefore,omitempty"`
}

KMSIssuerSpec defines the desired state of KMSIssuer

func (*KMSIssuerSpec) DeepCopy 

func (in *KMSIssuerSpec) DeepCopy() *KMSIssuerSpec

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

func (*KMSIssuerSpec) DeepCopyInto 

func (in *KMSIssuerSpec) DeepCopyInto(out *KMSIssuerSpec)

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

type KMSIssuerStatus 

type KMSIssuerStatus struct {
	Status `json:",inline"`
	// Byte slice containing a PEM encoded signed certificate of the CA
	// +optional
	Certificate []byte `json:"certificate,omitempty"`
}

KMSIssuerStatus defines the observed state of KMSIssuer

func (*KMSIssuerStatus) DeepCopy 

func (in *KMSIssuerStatus) DeepCopy() *KMSIssuerStatus

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

func (*KMSIssuerStatus) DeepCopyInto 

func (in *KMSIssuerStatus) DeepCopyInto(out *KMSIssuerStatus)

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

type KMSKey 

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

	Spec   KMSKeySpec   `json:"spec,omitempty"`
	Status KMSKeyStatus `json:"status,omitempty"`
}

KMSKey is the Schema for the kmskeys API

func (*KMSKey) DeepCopy 

func (in *KMSKey) DeepCopy() *KMSKey

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

func (*KMSKey) DeepCopyInto 

func (in *KMSKey) DeepCopyInto(out *KMSKey)

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

func (*KMSKey) DeepCopyObject 

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

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

type KMSKeyList 

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

KMSKeyList contains a list of KMSKey

func (*KMSKeyList) DeepCopy 

func (in *KMSKeyList) DeepCopy() *KMSKeyList

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

func (*KMSKeyList) DeepCopyInto 

func (in *KMSKeyList) DeepCopyInto(out *KMSKeyList)

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

func (*KMSKeyList) DeepCopyObject 

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

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

type KMSKeySpec 

type KMSKeySpec struct {

	// AliasName Specifies the alias name for the kms key. This value must begin with alias/ followed by a
	// name, such as alias/ExampleAlias.
	AliasName string `json:"aliasName"`
	// Description for the key
	Description string `json:"description,omitempty"`
	// CustomerMasterKeySpec determines the signing algorithms that the CMK supports.
	// Only RSA_2048 is currently supported.
	CustomerMasterKeySpec string `json:"customerMasterKeySpec,omitempty"`
	// The key policy to attach to the CMK
	Policy string `json:"policy,omitempty"`
	// Tags is a list of tags for the key
	Tags map[string]string `json:"tags,omitempty"`
	// DeletionPolicy to deletes the alias and key on object deletion.
	// +kubebuilder:validation:Enum=Retain;Delete
	DeletionPolicy string `json:"deletionPolicy,omitempty"`
	// This value is optional. If you include a value, it must be between 7 and
	// 30, inclusive. If you do not include a value, it defaults to 30.
	DeletionPendingWindowInDays int `json:"deletionPendingWindowInDays,omitempty"`
}

KMSKeySpec defines the desired state of KMSKey

func (*KMSKeySpec) DeepCopy 

func (in *KMSKeySpec) DeepCopy() *KMSKeySpec

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

func (*KMSKeySpec) DeepCopyInto 

func (in *KMSKeySpec) DeepCopyInto(out *KMSKeySpec)

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

type KMSKeyStatus 

type KMSKeyStatus struct {
	Status `json:",inline"`
	// KeyID is the unique identifier for the customer master key (CMK)
	KeyID string `json:"keyId,omitempty"`
}

KMSKeyStatus defines the observed state of KMSKey

func (*KMSKeyStatus) DeepCopy 

func (in *KMSKeyStatus) DeepCopy() *KMSKeyStatus

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

func (*KMSKeyStatus) DeepCopyInto 

func (in *KMSKeyStatus) DeepCopyInto(out *KMSKeyStatus)

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

type Status 

type Status struct {
	// +optional
	Conditions []Condition `json:"conditions,omitempty"`
}

Status defines the observed state of on object

func (*Status) DeepCopy 

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto 

func (in *Status) DeepCopyInto(out *Status)

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

func (*Status) GetCondition 

func (status *Status) GetCondition(condType ConditionType) *Condition

GetCondition returns a Condition with the provided type if it exists. returns nil otherwise.

func (*Status) IsReady 

func (status *Status) IsReady() bool

IsReady returns true if the ReadyConditions is true.

func (*Status) RemoveCondition 

func (status *Status) RemoveCondition(condType ConditionType)

RemoveCondition removes the condition with the provided type from the replicaset status.

func (*Status) SetCondition 

func (status *Status) SetCondition(condition *Condition)

SetCondition adds/replaces the given condition in the KMSIssuer status. If the condition that we are about to add already exists and has the same status and reason then we are not going to update.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.