Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package v1alpha1 contains API Schema definitions for the certman v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=certman.managed.openshift.io
Package v1alpha1 contains API Schema definitions for the certman v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=certman.managed.openshift.io
Index ¶
Constants ¶
const ( // CertmanOperatorFinalizerLabel is a K8's finalizer. An arbitray string that when // present ensures a hard delete of a resource is not possible. CertmanOperatorFinalizerLabel = "certificaterequests.certman.managed.openshift.io" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "certman.managed.openshift.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
func RegisterDefaults ¶
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
Types ¶
type AWSPlatformSecrets ¶
type AWSPlatformSecrets struct {
	// Credentials refers to a secret that contains the AWS account access
	// credentials.
	Credentials corev1.LocalObjectReference `json:"credentials"`
}
    AWSPlatformSecrets contains secrets for clusters on the AWS platform.
func (*AWSPlatformSecrets) DeepCopy ¶
func (in *AWSPlatformSecrets) DeepCopy() *AWSPlatformSecrets
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AWSPlatformSecrets.
func (*AWSPlatformSecrets) DeepCopyInto ¶
func (in *AWSPlatformSecrets) DeepCopyInto(out *AWSPlatformSecrets)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequest ¶
type CertificateRequest struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   CertificateRequestSpec   `json:"spec,omitempty"`
	Status CertificateRequestStatus `json:"status,omitempty"`
}
    CertificateRequest is the Schema for the certificaterequests API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="IssuerName",type="string",JSONPath=".status.issuerName" +kubebuilder:printcolumn:name="NotBefore",type="string",JSONPath=".status.notBefore" +kubebuilder:printcolumn:name="NotAfter",type="string",JSONPath=".status.notAfter" +kubebuilder:printcolumn:name="Secret",type="string",JSONPath=".spec.certificateSecret.name"
func (*CertificateRequest) DeepCopy ¶
func (in *CertificateRequest) DeepCopy() *CertificateRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequest.
func (*CertificateRequest) DeepCopyInto ¶
func (in *CertificateRequest) DeepCopyInto(out *CertificateRequest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateRequest) DeepCopyObject ¶
func (in *CertificateRequest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CertificateRequestCondition ¶
type CertificateRequestCondition struct {
	// Type is the type of the condition.
	Type CertificateRequestConditionType `json:"type"`
	// Status is the status of the condition.
	Status corev1.ConditionStatus `json:"status"`
	// LastProbeTime is the last time we probed the condition.
	// +optional
	LastProbeTime *metav1.Time `json:"lastProbeTime,omitempty"`
	// LastTransitionTime is the last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
	// Reason is a unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason *string `json:"reason,omitempty"`
	// Message is a human-readable message indicating details about last transition.
	// +optional
	Message *string `json:"message,omitempty"`
}
    CertificateRequestCondition defines conditions required for certificate requests.
func (*CertificateRequestCondition) DeepCopy ¶
func (in *CertificateRequestCondition) DeepCopy() *CertificateRequestCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestCondition.
func (*CertificateRequestCondition) DeepCopyInto ¶
func (in *CertificateRequestCondition) DeepCopyInto(out *CertificateRequestCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestConditionType ¶
type CertificateRequestConditionType string
CertificateRequestConditionType is the condition that populates the Type var within the CertificateRequestCondition struct
type CertificateRequestList ¶
type CertificateRequestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []CertificateRequest `json:"items"`
}
    CertificateRequestList contains a list of CertificateRequest
func (*CertificateRequestList) DeepCopy ¶
func (in *CertificateRequestList) DeepCopy() *CertificateRequestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestList.
func (*CertificateRequestList) DeepCopyInto ¶
func (in *CertificateRequestList) DeepCopyInto(out *CertificateRequestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateRequestList) DeepCopyObject ¶
func (in *CertificateRequestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CertificateRequestSpec ¶
type CertificateRequestSpec struct {
	// ACMEDNSDomain is the DNS zone that will house the TXT records needed for the
	// certificate to be created.
	// In Route53 this would be the public Route53 hosted zone (the Domain Name not the ZoneID)
	ACMEDNSDomain string `json:"acmeDNSDomain"`
	// CertificateSecret is the reference to the secret where certificates are stored.
	CertificateSecret corev1.ObjectReference `json:"certificateSecret"`
	// PlatformSecrets contains the credentials and secrets for the cluster infrastructure.
	PlatformSecrets PlatformSecrets `json:"platformSecrets"`
	// DNSNames is a list of subject alt names to be used on the Certificate.
	DnsNames []string `json:"dnsNames"`
	// Let's Encrypt will use this to contact you about expiring certificates, and issues related to your account.
	Email string `json:"email"`
	// Certificate renew before expiration duration in days.
	// +optional
	RenewBeforeDays int `json:"renewBeforeDays,omitempty"`
	// APIURL is the URL where the cluster's API can be accessed.
	// +optional
	APIURL string `json:"apiURL,omitempty"`
	// WebConsoleURL is the URL for the cluster's web console UI.
	// +optional
	WebConsoleURL string `json:"webConsoleURL,omitempty"`
}
    CertificateRequestSpec defines the desired state of CertificateRequest +k8s:openapi-gen=true
func (*CertificateRequestSpec) DeepCopy ¶
func (in *CertificateRequestSpec) DeepCopy() *CertificateRequestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestSpec.
func (*CertificateRequestSpec) DeepCopyInto ¶
func (in *CertificateRequestSpec) DeepCopyInto(out *CertificateRequestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestStatus ¶
type CertificateRequestStatus struct {
	// Issued is true once certificates have been issued.
	Issued bool `json:"issued,omitempty"`
	// Status
	// +optional
	Status string `json:"status,omitempty"`
	// The expiration time of the certificate stored in the secret named by this resource in spec.secretName.
	// +optional
	NotAfter string `json:"notAfter,omitempty"`
	// The earliest time and date on which the certificate stored in the secret named by this resource in spec.secretName is valid.
	// +optional
	NotBefore string `json:"notBefore,omitempty"`
	// The entity that verified the information and signed the certificate.
	// +optional
	IssuerName string `json:"issuerName,omitempty"`
	// The serial number of the certificate stored in the secret named by this resource in spec.secretName.
	// +optional
	SerialNumber string `json:"serialNumber,omitempty"`
	// Conditions includes more detailed status for the Certificate Request
	// +optional
	Conditions []CertificateRequestCondition `json:"conditions,omitempty"`
}
    CertificateRequestStatus defines the observed state of CertificateRequest +k8s:openapi-gen=true
func (*CertificateRequestStatus) DeepCopy ¶
func (in *CertificateRequestStatus) DeepCopy() *CertificateRequestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestStatus.
func (*CertificateRequestStatus) DeepCopyInto ¶
func (in *CertificateRequestStatus) DeepCopyInto(out *CertificateRequestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PlatformSecrets ¶
type PlatformSecrets struct {
	AWS *AWSPlatformSecrets `json:"aws"`
}
    PlatformSecrets defines the secrets to be used by various clouds.
func (*PlatformSecrets) DeepCopy ¶
func (in *PlatformSecrets) DeepCopy() *PlatformSecrets
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PlatformSecrets.
func (*PlatformSecrets) DeepCopyInto ¶
func (in *PlatformSecrets) DeepCopyInto(out *PlatformSecrets)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.