v1

package
v0.0.0-...-3edab30 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2023 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the adcs v1 API group +kubebuilder:object:generate=true +groupName=adcs.certmanager.csf.nokia.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "adcs.certmanager.csf.nokia.com", Version: "v1"}

	// 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 AdcsIssuer 

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

	Spec   AdcsIssuerSpec   `json:"spec,omitempty"`
	Status AdcsIssuerStatus `json:"status,omitempty"`
}

AdcsIssuer is the Schema for the adcsissuers API

func (*AdcsIssuer) DeepCopy 

func (in *AdcsIssuer) DeepCopy() *AdcsIssuer

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

func (*AdcsIssuer) DeepCopyInto 

func (in *AdcsIssuer) DeepCopyInto(out *AdcsIssuer)

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

func (*AdcsIssuer) DeepCopyObject 

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

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

func (*AdcsIssuer) Default 

func (r *AdcsIssuer) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*AdcsIssuer) SetupWebhookWithManager 

func (r *AdcsIssuer) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*AdcsIssuer) ValidateCreate 

func (r *AdcsIssuer) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*AdcsIssuer) ValidateDelete 

func (r *AdcsIssuer) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*AdcsIssuer) ValidateUpdate 

func (r *AdcsIssuer) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type AdcsIssuerList 

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

AdcsIssuerList contains a list of AdcsIssuer

func (*AdcsIssuerList) DeepCopy 

func (in *AdcsIssuerList) DeepCopy() *AdcsIssuerList

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

func (*AdcsIssuerList) DeepCopyInto 

func (in *AdcsIssuerList) DeepCopyInto(out *AdcsIssuerList)

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

func (*AdcsIssuerList) DeepCopyObject 

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

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

type AdcsIssuerSpec 

type AdcsIssuerSpec struct {

	// URL is the base URL for the ADCS instance
	URL string `json:"url"`

	// CredentialsRef is a reference to a Secret containing the username and
	// password for the ADCS server.
	// The secret must contain two keys, 'username' and 'password'.
	CredentialsRef LocalObjectReference `json:"credentialsRef"`

	// CABundle is a PEM encoded TLS certifiate to use to verify connections to
	// the ADCS server.
	// +optional
	CABundle []byte `json:"caBundle,omitempty"`

	// How often to check for request status in the server (in time.ParseDuration() format)
	// Default 6 hours.
	// +optional
	StatusCheckInterval string `json:"statusCheckInterval,omitempty"`

	// How often to retry in case of communication errors (in time.ParseDuration() format)
	// Default 1 hour.
	// +optional
	RetryInterval string `json:"retryInterval,omitempty"`
}

AdcsIssuerSpec defines the desired state of AdcsIssuer

func (*AdcsIssuerSpec) DeepCopy 

func (in *AdcsIssuerSpec) DeepCopy() *AdcsIssuerSpec

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

func (*AdcsIssuerSpec) DeepCopyInto 

func (in *AdcsIssuerSpec) DeepCopyInto(out *AdcsIssuerSpec)

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

type AdcsIssuerStatus 

type AdcsIssuerStatus struct {
}

AdcsIssuerStatus defines the observed state of AdcsIssuer

func (*AdcsIssuerStatus) DeepCopy 

func (in *AdcsIssuerStatus) DeepCopy() *AdcsIssuerStatus

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

func (*AdcsIssuerStatus) DeepCopyInto 

func (in *AdcsIssuerStatus) DeepCopyInto(out *AdcsIssuerStatus)

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

type AdcsRequest 

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

	Spec   AdcsRequestSpec   `json:"spec,omitempty"`
	Status AdcsRequestStatus `json:"status,omitempty"`
}

AdcsRequest is the Schema for the adcsrequests API

func (*AdcsRequest) DeepCopy 

func (in *AdcsRequest) DeepCopy() *AdcsRequest

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

func (*AdcsRequest) DeepCopyInto 

func (in *AdcsRequest) DeepCopyInto(out *AdcsRequest)

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

func (*AdcsRequest) DeepCopyObject 

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

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

type AdcsRequestList 

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

AdcsRequestList contains a list of AdcsRequest

func (*AdcsRequestList) DeepCopy 

func (in *AdcsRequestList) DeepCopy() *AdcsRequestList

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

func (*AdcsRequestList) DeepCopyInto 

func (in *AdcsRequestList) DeepCopyInto(out *AdcsRequestList)

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

func (*AdcsRequestList) DeepCopyObject 

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

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

type AdcsRequestSpec 

type AdcsRequestSpec struct {

	// Certificate signing request bytes in PEM encoding.
	// This will be used when finalizing the request.
	// This field must be set on the request.
	CSRPEM []byte `json:"csr"`

	// IssuerRef references a properly configured AdcsIssuer which should
	// be used to serve this AdcsRequest.
	// If the Issuer does not exist, processing will be retried.
	// If the Issuer is not an 'ADCS' Issuer, an error will be returned and the
	// ADCSRequest will be marked as failed.
	IssuerRef cmmeta.ObjectReference `json:"issuerRef"`
}

AdcsRequestSpec defines the desired state of AdcsRequest

func (*AdcsRequestSpec) DeepCopy 

func (in *AdcsRequestSpec) DeepCopy() *AdcsRequestSpec

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

func (*AdcsRequestSpec) DeepCopyInto 

func (in *AdcsRequestSpec) DeepCopyInto(out *AdcsRequestSpec)

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

type AdcsRequestStatus 

type AdcsRequestStatus struct {

	// ID of the Request assigned by the ADCS.
	// This will initially be empty when the resource is first created.
	// The ADCSRequest controller will populate this field when the Request is accepted by ADCS.
	// This field will be immutable after it is initially set.
	// +optional
	Id string `json:"id,omitempty"`

	// State contains the current state of this ADCSRequest resource.
	// States 'ready' and 'rejected' are 'final'
	// +optional
	State State `json:"state,omitempty"`

	// Reason optionally provides more information about a why the AdcsRequest is in
	// the current state.
	// +optional
	Reason string `json:"reason,omitempty"`
}

AdcsRequestStatus defines the observed state of AdcsRequest

func (*AdcsRequestStatus) DeepCopy 

func (in *AdcsRequestStatus) DeepCopy() *AdcsRequestStatus

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

func (*AdcsRequestStatus) DeepCopyInto 

func (in *AdcsRequestStatus) DeepCopyInto(out *AdcsRequestStatus)

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

type ClusterAdcsIssuer 

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

	Spec   ClusterAdcsIssuerSpec   `json:"spec,omitempty"`
	Status ClusterAdcsIssuerStatus `json:"status,omitempty"`
}

ClusterAdcsIssuer is the Schema for the clusteradcsissuers API

func (*ClusterAdcsIssuer) DeepCopy 

func (in *ClusterAdcsIssuer) DeepCopy() *ClusterAdcsIssuer

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

func (*ClusterAdcsIssuer) DeepCopyInto 

func (in *ClusterAdcsIssuer) DeepCopyInto(out *ClusterAdcsIssuer)

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

func (*ClusterAdcsIssuer) DeepCopyObject 

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

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

func (*ClusterAdcsIssuer) Default 

func (r *ClusterAdcsIssuer) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*ClusterAdcsIssuer) SetupWebhookWithManager 

func (r *ClusterAdcsIssuer) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*ClusterAdcsIssuer) ValidateCreate 

func (r *ClusterAdcsIssuer) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*ClusterAdcsIssuer) ValidateDelete 

func (r *ClusterAdcsIssuer) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*ClusterAdcsIssuer) ValidateUpdate 

func (r *ClusterAdcsIssuer) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type ClusterAdcsIssuerList 

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

ClusterAdcsIssuerList contains a list of ClusterAdcsIssuer

func (*ClusterAdcsIssuerList) DeepCopy 

func (in *ClusterAdcsIssuerList) DeepCopy() *ClusterAdcsIssuerList

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

func (*ClusterAdcsIssuerList) DeepCopyInto 

func (in *ClusterAdcsIssuerList) DeepCopyInto(out *ClusterAdcsIssuerList)

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

func (*ClusterAdcsIssuerList) DeepCopyObject 

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

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

type ClusterAdcsIssuerSpec 

type ClusterAdcsIssuerSpec struct {

	// URL is the base URL for the ADCS instance
	URL string `json:"url"`

	// CredentialsRef is a reference to a Secret containing the username and
	// password for the ADCS server.
	// The secret must contain two keys, 'username' and 'password'.
	CredentialsRef LocalObjectReference `json:"credentialsRef"`

	// CABundle is a PEM encoded TLS certifiate to use to verify connections to
	// the ADCS server.
	// +optional
	CABundle []byte `json:"caBundle,omitempty"`

	// How often to check for request status in the server (in time.ParseDuration() format)
	// Default 6 hours.
	// +optional
	StatusCheckInterval string `json:"statusCheckInterval,omitempty"`

	// How often to retry in case of communication errors (in time.ParseDuration() format)
	// Default 1 hour.
	// +optional
	RetryInterval string `json:"retryInterval,omitempty"`
}

ClusterAdcsIssuerSpec defines the desired state of ClusterAdcsIssuer

func (*ClusterAdcsIssuerSpec) DeepCopy 

func (in *ClusterAdcsIssuerSpec) DeepCopy() *ClusterAdcsIssuerSpec

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

func (*ClusterAdcsIssuerSpec) DeepCopyInto 

func (in *ClusterAdcsIssuerSpec) DeepCopyInto(out *ClusterAdcsIssuerSpec)

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

type ClusterAdcsIssuerStatus 

type ClusterAdcsIssuerStatus struct {
}

ClusterAdcsIssuerStatus defines the observed state of ClusterAdcsIssuer

func (*ClusterAdcsIssuerStatus) DeepCopy 

func (in *ClusterAdcsIssuerStatus) DeepCopy() *ClusterAdcsIssuerStatus

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

func (*ClusterAdcsIssuerStatus) DeepCopyInto 

func (in *ClusterAdcsIssuerStatus) DeepCopyInto(out *ClusterAdcsIssuerStatus)

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

type LocalObjectReference 

type LocalObjectReference struct {
	// Name of the referent.
	Name string `json:"name"`
}

func (*LocalObjectReference) DeepCopy 

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

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

func (*LocalObjectReference) DeepCopyInto 

func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)

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

type State 

type State string

State represents the state of an ADCSRequest. Clients utilising this type must also gracefully handle unknown values, as the contents of this enumeration may be added to over time. +kubebuilder:validation:Enum=pending;ready;errored;rejected 

const (
	// It is used to represent an unrecognised value.
	Unknown State = ""

	// If a request is marked 'Pending', is's waiting for acceptance on the ADCS.
	// This is a transient state.
	Pending State = "pending"

	// If a request  is 'ready', the certificate has been issued by the ADCS server.
	// This is a final state.
	Ready State = "ready"

	// Errored signifies that the ADCS request has errored for some reason.
	// This is a catch-all state, and is used for marking internal cert-manager
	// errors such as validation failures.
	// This is a final state.
	Errored State = "errored"

	// The 'rejected' state is used when ADCS denied signing the request.
	Rejected State = "rejected"
)

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.