v1

Documentation

Overview

Package v1 is the v1 version of the OriginIssuer API

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type ConditionStatus
• type ConditionType
• type OriginIssuer
  • func (in *OriginIssuer) DeepCopy() *OriginIssuer
  • func (in *OriginIssuer) DeepCopyInto(out *OriginIssuer)
  • func (in *OriginIssuer) DeepCopyObject() runtime.Object
• type OriginIssuerAuthentication
  • func (in *OriginIssuerAuthentication) DeepCopy() *OriginIssuerAuthentication
  • func (in *OriginIssuerAuthentication) DeepCopyInto(out *OriginIssuerAuthentication)
• type OriginIssuerCondition
  • func (in *OriginIssuerCondition) DeepCopy() *OriginIssuerCondition
  • func (in *OriginIssuerCondition) DeepCopyInto(out *OriginIssuerCondition)
• type OriginIssuerList
  • func (in *OriginIssuerList) DeepCopy() *OriginIssuerList
  • func (in *OriginIssuerList) DeepCopyInto(out *OriginIssuerList)
  • func (in *OriginIssuerList) DeepCopyObject() runtime.Object
• type OriginIssuerSpec
  • func (in *OriginIssuerSpec) DeepCopy() *OriginIssuerSpec
  • func (in *OriginIssuerSpec) DeepCopyInto(out *OriginIssuerSpec)
• type OriginIssuerStatus
  • func (in *OriginIssuerStatus) DeepCopy() *OriginIssuerStatus
  • func (in *OriginIssuerStatus) DeepCopyInto(out *OriginIssuerStatus)
• type RequestType
• type SecretKeySelector
  • func (in *SecretKeySelector) DeepCopy() *SecretKeySelector
  • func (in *SecretKeySelector) DeepCopyInto(out *SecretKeySelector)

Constants

const GroupName = "cert-manager.k8s.cloudflare.com"

GroupName specifies the group name used to register the objects.

Variables

var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Depreciated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)

var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1"}

GroupVersion specifies the group and the version used to register the objects.

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ConditionStatus

type ConditionStatus string

ConditionStatus represents a condition's status.

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"
)

type ConditionType

type ConditionType string

ConditionType represents an OriginIssuer condition value.

const (
	// ConditionReady represents that an OriginIssuer condition is in
	// a ready state and able to issue certificates.
	// If the `status` of this condition is `False`, CertificateRequest
	// controllers should prevent attempts to sign certificates.
	ConditionReady ConditionType = "Ready"
)

type OriginIssuer

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

	// Desired state of the OriginIssuer resource
	Spec OriginIssuerSpec `json:"spec,omitempty"`

	// Status of the OriginIssuer. This is set and managed automatically.
	// +optional
	Status OriginIssuerStatus `json:"status,omitempty"`
}

An OriginIssuer represents the Cloudflare Origin CA as an external cert-manager issuer. It is scoped to a single namespace, so it can be used only by resources in the same namespace.

func (*OriginIssuer) DeepCopy

func (in *OriginIssuer) DeepCopy() *OriginIssuer

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

func (*OriginIssuer) DeepCopyInto

func (in *OriginIssuer) DeepCopyInto(out *OriginIssuer)

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

func (*OriginIssuer) DeepCopyObject

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

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

type OriginIssuerAuthentication

type OriginIssuerAuthentication struct {
	// ServiceKeyRef authenticates with an API Service Key.
	// +optional
	ServiceKeyRef SecretKeySelector `json:"serviceKeyRef,omitempty"`
}

OriginIssuerAuthentication defines how to authenticate with the Cloudflare API. Only one of `serviceKeyRef` may be specified.

func (*OriginIssuerAuthentication) DeepCopy

func (in *OriginIssuerAuthentication) DeepCopy() *OriginIssuerAuthentication

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

func (*OriginIssuerAuthentication) DeepCopyInto

func (in *OriginIssuerAuthentication) DeepCopyInto(out *OriginIssuerAuthentication)

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

type OriginIssuerCondition

type OriginIssuerCondition struct {
	// Type of the condition, known values are ('Ready')
	Type ConditionType `json:"type"`

	// Status of the condition, one of ('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
	// transition1, complementing reason.
	// +optional
	Message string `json:"message,omitempty"`
}

OriginIssuerCondition contains condition information for the OriginIssuer.

func (*OriginIssuerCondition) DeepCopy

func (in *OriginIssuerCondition) DeepCopy() *OriginIssuerCondition

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

func (*OriginIssuerCondition) DeepCopyInto

func (in *OriginIssuerCondition) DeepCopyInto(out *OriginIssuerCondition)

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

type OriginIssuerList

type OriginIssuerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata.omitempty"`

	Items []OriginIssuer `json:"items"`
}

OriginIssuerList is a list of OriginIssuers.

func (*OriginIssuerList) DeepCopy

func (in *OriginIssuerList) DeepCopy() *OriginIssuerList

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

func (*OriginIssuerList) DeepCopyInto

func (in *OriginIssuerList) DeepCopyInto(out *OriginIssuerList)

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

func (*OriginIssuerList) DeepCopyObject

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

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

type OriginIssuerSpec

type OriginIssuerSpec struct {
	// RequestType is the signature algorithm Cloudflare should use to sign the certificate.
	RequestType RequestType `json:"requestType"`

	// Auth configures how to authenticate with the Cloudflare API.
	Auth OriginIssuerAuthentication `json:"auth"`
}

OriginIssuerSpec is the specification of an OriginIssuer. This includes any configuration required for the issuer.

func (*OriginIssuerSpec) DeepCopy

func (in *OriginIssuerSpec) DeepCopy() *OriginIssuerSpec

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

func (*OriginIssuerSpec) DeepCopyInto

func (in *OriginIssuerSpec) DeepCopyInto(out *OriginIssuerSpec)

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

type OriginIssuerStatus

type OriginIssuerStatus struct {
	// List of status conditions to indicate the status of an OriginIssuer
	// Known condition types are `Ready`.
	// +optional
	Conditions []OriginIssuerCondition `json:"conditions,omitempty"`
}

OriginIssuerStatus contains status information about an OriginIssuer

func (*OriginIssuerStatus) DeepCopy

func (in *OriginIssuerStatus) DeepCopy() *OriginIssuerStatus

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

func (*OriginIssuerStatus) DeepCopyInto

func (in *OriginIssuerStatus) DeepCopyInto(out *OriginIssuerStatus)

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

type RequestType

type RequestType string

RequestType represents the signature algorithm used to sign certificates.

const (
	// RequestTypeOriginRSA represents an RSA256 signature.
	RequestTypeOriginRSA RequestType = "OriginRSA"

	// RequestTypeOriginECC represents an ECDSA signature.
	RequestTypeOriginECC RequestType = "OriginECC"
)

type SecretKeySelector

type SecretKeySelector struct {
	// Name of the secret in the OriginIssuer's namespace to select from.
	Name string `json:"name"`
	// Key of the secret to select from. Must be a valid secret key.
	Key string `json:"key"`
}

SecretKeySelector contains a reference to a secret.

func (*SecretKeySelector) DeepCopy

func (in *SecretKeySelector) DeepCopy() *SecretKeySelector

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

func (*SecretKeySelector) DeepCopyInto

func (in *SecretKeySelector) DeepCopyInto(out *SecretKeySelector)

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