client-go: kmodules.xyz/client-go/api/v1 Index | Files

package v1

import "kmodules.xyz/client-go/api/v1"

+k8s:deepcopy-gen=package +k8s:openapi-gen=true

Index

Package Files

certificates.go conditions.go doc.go generated.pb.go openapi_generated.go zz_generated.deepcopy.go

Constants

const (
    ConditionProgressing = "Progressing"
    ConditionInitialized = "Initialized"
    ConditionReady       = "Ready"
    ConditionAvailable   = "Available"
    ConditionFailed      = "Failed"

    ConditionRequestApproved = "Approved"
    ConditionRequestDenied   = "Denied"
)

List of common condition types

Variables

var (
    ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
    ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)

func GetCertificateSecretName Uses

func GetCertificateSecretName(certificates []CertificateSpec, alias string) (string, bool)

GetCertificateSecretName returns the name of secret for a certificate alias.

func GetOpenAPIDefinitions Uses

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func HasCertificate Uses

func HasCertificate(certificates []CertificateSpec, alias string) bool

HasCertificate returns "true" if the desired certificate provided in "aliaS" is present in the certificate list. Otherwise, it returns "false".

func HasCondition Uses

func HasCondition(conditions []Condition, condType string) bool

HasCondition returns "true" if the desired condition provided in "condType" is present in the condition list. Otherwise, it returns "false".

func IsConditionTrue Uses

func IsConditionTrue(conditions []Condition, condType string) bool

IsConditionTrue returns "true" if the desired condition is in true state. It returns "false" if the desired condition is not in "true" state or is not in the condition list.

type CertificatePrivateKey Uses

type CertificatePrivateKey struct {
    // The private key cryptography standards (PKCS) encoding for this
    // certificate's private key to be encoded in.
    // If provided, allowed values are "pkcs1" and "pkcs8" standing for PKCS#1
    // and PKCS#8, respectively.
    // Defaults to PKCS#1 if not specified.
    // See here for the difference between the formats: https://stackoverflow.com/a/48960291
    // +optional
    Encoding PrivateKeyEncoding `json:"encoding,omitempty" protobuf:"bytes,1,opt,name=encoding,casttype=PrivateKeyEncoding"`
}

CertificatePrivateKey contains configuration options for private keys used by the Certificate controller. This allows control of how private keys are rotated.

func (*CertificatePrivateKey) DeepCopy Uses

func (in *CertificatePrivateKey) DeepCopy() *CertificatePrivateKey

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

func (*CertificatePrivateKey) DeepCopyInto Uses

func (in *CertificatePrivateKey) DeepCopyInto(out *CertificatePrivateKey)

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

func (*CertificatePrivateKey) Descriptor Uses

func (*CertificatePrivateKey) Descriptor() ([]byte, []int)

func (*CertificatePrivateKey) Marshal Uses

func (m *CertificatePrivateKey) Marshal() (dAtA []byte, err error)

func (*CertificatePrivateKey) MarshalTo Uses

func (m *CertificatePrivateKey) MarshalTo(dAtA []byte) (int, error)

func (*CertificatePrivateKey) MarshalToSizedBuffer Uses

func (m *CertificatePrivateKey) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CertificatePrivateKey) ProtoMessage Uses

func (*CertificatePrivateKey) ProtoMessage()

func (*CertificatePrivateKey) Reset Uses

func (m *CertificatePrivateKey) Reset()

func (*CertificatePrivateKey) Size Uses

func (m *CertificatePrivateKey) Size() (n int)

func (*CertificatePrivateKey) String Uses

func (this *CertificatePrivateKey) String() string

func (*CertificatePrivateKey) Unmarshal Uses

func (m *CertificatePrivateKey) Unmarshal(dAtA []byte) error

func (*CertificatePrivateKey) XXX_DiscardUnknown Uses

func (m *CertificatePrivateKey) XXX_DiscardUnknown()

func (*CertificatePrivateKey) XXX_Marshal Uses

func (m *CertificatePrivateKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CertificatePrivateKey) XXX_Merge Uses

func (m *CertificatePrivateKey) XXX_Merge(src proto.Message)

func (*CertificatePrivateKey) XXX_Size Uses

func (m *CertificatePrivateKey) XXX_Size() int

func (*CertificatePrivateKey) XXX_Unmarshal Uses

func (m *CertificatePrivateKey) XXX_Unmarshal(b []byte) error

type CertificateSpec Uses

type CertificateSpec struct {
    // Alias represents the identifier of the certificate.
    Alias string `json:"alias" protobuf:"bytes,1,opt,name=alias"`

    // Specifies the k8s secret name that holds the certificates.
    // Default to <resource-name>-<cert-alias>-cert.
    // +optional
    SecretName string `json:"secretName,omitempty" protobuf:"bytes,2,opt,name=secretName"`

    // Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).
    // +optional
    Subject *X509Subject `json:"subject,omitempty" protobuf:"bytes,3,opt,name=subject"`

    // Certificate default Duration
    // +optional
    Duration *metav1.Duration `json:"duration,omitempty" protobuf:"bytes,4,opt,name=duration"`

    // Certificate renew before expiration duration
    // +optional
    RenewBefore *metav1.Duration `json:"renewBefore,omitempty" protobuf:"bytes,5,opt,name=renewBefore"`

    // DNSNames is a list of subject alt names to be used on the Certificate.
    // +optional
    DNSNames []string `json:"dnsNames,omitempty" protobuf:"bytes,6,rep,name=dnsNames"`

    // IPAddresses is a list of IP addresses to be used on the Certificate
    // +optional
    IPAddresses []string `json:"ipAddresses,omitempty" protobuf:"bytes,7,rep,name=ipAddresses"`

    // URIs is a list of URI subjectAltNames to be set on the Certificate.
    // +optional
    URIs []string `json:"uris,omitempty" protobuf:"bytes,8,rep,name=uris"`

    // EmailAddresses is a list of email subjectAltNames to be set on the Certificate.
    // +optional
    EmailAddresses []string `json:"emailAddresses,omitempty" protobuf:"bytes,9,rep,name=emailAddresses"`

    // Options to control private keys used for the Certificate.
    // +optional
    PrivateKey *CertificatePrivateKey `json:"privateKey,omitempty" protobuf:"bytes,10,opt,name=privateKey"`
}

func GetCertificate Uses

func GetCertificate(certificates []CertificateSpec, alias string) (int, *CertificateSpec)

GetCertificate returns a pointer to the desired certificate referred by "aliaS". Otherwise, it returns nil.

func RemoveCertificate Uses

func RemoveCertificate(certificates []CertificateSpec, alias string) []CertificateSpec

RemoveCertificate remove a certificate from the certificate list referred by "aliaS" parameter.

func SetCertificate Uses

func SetCertificate(certificates []CertificateSpec, newCertificate CertificateSpec) []CertificateSpec

SetCertificate add/update the desired certificate to the certificate list.

func SetMissingSecretNameForCertificate Uses

func SetMissingSecretNameForCertificate(certificates []CertificateSpec, alias, secretName string) []CertificateSpec

SetMissingSecretNameForCertificate sets the missing secret name for a certificate. If the certificate does not exist, it will add a new certificate with the desired secret name.

func SetMissingSpecForCertificate Uses

func SetMissingSpecForCertificate(certificates []CertificateSpec, spec CertificateSpec) []CertificateSpec

SetMissingSpecForCertificate sets the missing spec fields for a certificate. If the certificate does not exist, it will add a new certificate with the desired spec.

func SetSecretNameForCertificate Uses

func SetSecretNameForCertificate(certificates []CertificateSpec, alias, secretName string) []CertificateSpec

SetSecretNameForCertificate sets the secret name for a certificate. If the certificate does not exist, it will add a new certificate with the desired secret name. Otherwise, the secret name will be overwritten.

func SetSpecForCertificate Uses

func SetSpecForCertificate(certificates []CertificateSpec, spec CertificateSpec) []CertificateSpec

SetSpecForCertificate sets the spec for a certificate. If the certificate does not exist, it will add a new certificate with the desired spec. Otherwise, the spec will be overwritten.

func (*CertificateSpec) DeepCopy Uses

func (in *CertificateSpec) DeepCopy() *CertificateSpec

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

func (*CertificateSpec) DeepCopyInto Uses

func (in *CertificateSpec) DeepCopyInto(out *CertificateSpec)

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

func (*CertificateSpec) Descriptor Uses

func (*CertificateSpec) Descriptor() ([]byte, []int)

func (*CertificateSpec) Marshal Uses

func (m *CertificateSpec) Marshal() (dAtA []byte, err error)

func (*CertificateSpec) MarshalTo Uses

func (m *CertificateSpec) MarshalTo(dAtA []byte) (int, error)

func (*CertificateSpec) MarshalToSizedBuffer Uses

func (m *CertificateSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CertificateSpec) ProtoMessage Uses

func (*CertificateSpec) ProtoMessage()

func (*CertificateSpec) Reset Uses

func (m *CertificateSpec) Reset()

func (*CertificateSpec) Size Uses

func (m *CertificateSpec) Size() (n int)

func (*CertificateSpec) String Uses

func (this *CertificateSpec) String() string

func (*CertificateSpec) Unmarshal Uses

func (m *CertificateSpec) Unmarshal(dAtA []byte) error

func (*CertificateSpec) XXX_DiscardUnknown Uses

func (m *CertificateSpec) XXX_DiscardUnknown()

func (*CertificateSpec) XXX_Marshal Uses

func (m *CertificateSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CertificateSpec) XXX_Merge Uses

func (m *CertificateSpec) XXX_Merge(src proto.Message)

func (*CertificateSpec) XXX_Size Uses

func (m *CertificateSpec) XXX_Size() int

func (*CertificateSpec) XXX_Unmarshal Uses

func (m *CertificateSpec) XXX_Unmarshal(b []byte) error

type Condition Uses

type Condition struct {
    // Type of condition in CamelCase or in foo.example.com/CamelCase.
    // Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
    // useful (see .node.status.conditions), the ability to deconflict is important.
    // +required
    Type string `json:"type" protobuf:"bytes,1,opt,name=type"`
    // Status of the condition, one of True, False, Unknown.
    // +required
    Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"`
    // If set, this represents the .metadata.generation that the condition was set based upon.
    // For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date
    // with respect to the current state of the instance.
    // +optional
    ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"`
    // Last time the condition transitioned from one status to another.
    // This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
    // +required
    LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,4,opt,name=lastTransitionTime"`
    // The reason for the condition's last transition in CamelCase.
    // The specific API may choose whether or not this field is considered a guaranteed API.
    // This field may not be empty.
    // +required
    Reason string `json:"reason" protobuf:"bytes,5,opt,name=reason"`
    // A human readable message indicating details about the transition.
    // This field may be empty.
    // +required
    Message string `json:"message" protobuf:"bytes,6,opt,name=message"`
}

func GetCondition Uses

func GetCondition(conditions []Condition, condType string) (int, *Condition)

GetCondition returns a pointer to the desired condition referred by "condType". Otherwise, it returns nil.

func NewCondition Uses

func NewCondition(reason string, message string, generation int64, conditionStatus ...bool) Condition

func RemoveCondition Uses

func RemoveCondition(conditions []Condition, condType string) []Condition

RemoveCondition remove a condition from the condition list referred by "condType" parameter.

func SetCondition Uses

func SetCondition(conditions []Condition, newCondition Condition) []Condition

SetCondition add/update the desired condition to the condition list. It does nothing if the condition is already in its desired state.

func (*Condition) DeepCopy Uses

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto Uses

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

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

func (*Condition) Descriptor Uses

func (*Condition) Descriptor() ([]byte, []int)

func (*Condition) Marshal Uses

func (m *Condition) Marshal() (dAtA []byte, err error)

func (*Condition) MarshalTo Uses

func (m *Condition) MarshalTo(dAtA []byte) (int, error)

func (*Condition) MarshalToSizedBuffer Uses

func (m *Condition) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Condition) ProtoMessage Uses

func (*Condition) ProtoMessage()

func (*Condition) Reset Uses

func (m *Condition) Reset()

func (*Condition) Size Uses

func (m *Condition) Size() (n int)

func (*Condition) String Uses

func (this *Condition) String() string

func (*Condition) Unmarshal Uses

func (m *Condition) Unmarshal(dAtA []byte) error

func (*Condition) XXX_DiscardUnknown Uses

func (m *Condition) XXX_DiscardUnknown()

func (*Condition) XXX_Marshal Uses

func (m *Condition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Condition) XXX_Merge Uses

func (m *Condition) XXX_Merge(src proto.Message)

func (*Condition) XXX_Size Uses

func (m *Condition) XXX_Size() int

func (*Condition) XXX_Unmarshal Uses

func (m *Condition) XXX_Unmarshal(b []byte) error

type ConditionStatus Uses

type ConditionStatus string
const (
    ConditionTrue    ConditionStatus = "True"
    ConditionFalse   ConditionStatus = "False"
    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 PrivateKeyEncoding Uses

type PrivateKeyEncoding string

+kubebuilder:validation:Enum=PKCS1;PKCS8

const (
    // PKCS1 key encoding will produce PEM files that include the type of
    // private key as part of the PEM header, e.g. "BEGIN RSA PRIVATE KEY".
    // If the keyAlgorithm is set to 'ECDSA', this will produce private keys
    // that use the "BEGIN EC PRIVATE KEY" header.
    PKCS1 PrivateKeyEncoding = "PKCS1"

    // PKCS8 key encoding will produce PEM files with the "BEGIN PRIVATE KEY"
    // header. It encodes the keyAlgorithm of the private key as part of the
    // DER encoded PEM block.
    PKCS8 PrivateKeyEncoding = "PKCS8"
)

type TLSConfig Uses

type TLSConfig struct {
    // IssuerRef is a reference to a Certificate Issuer.
    // +optional
    IssuerRef *core.TypedLocalObjectReference `json:"issuerRef,omitempty" protobuf:"bytes,1,opt,name=issuerRef"`

    // Certificate provides server and/or client certificate options used by application pods.
    // These options are passed to a cert-manager Certificate object.
    // xref: https://github.com/jetstack/cert-manager/blob/v0.16.0/pkg/apis/certmanager/v1beta1/types_certificate.go#L82-L162
    // +optional
    Certificates []CertificateSpec `json:"certificates,omitempty" protobuf:"bytes,2,rep,name=certificates"`
}

func (*TLSConfig) DeepCopy Uses

func (in *TLSConfig) DeepCopy() *TLSConfig

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

func (*TLSConfig) DeepCopyInto Uses

func (in *TLSConfig) DeepCopyInto(out *TLSConfig)

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

func (*TLSConfig) Descriptor Uses

func (*TLSConfig) Descriptor() ([]byte, []int)

func (*TLSConfig) Marshal Uses

func (m *TLSConfig) Marshal() (dAtA []byte, err error)

func (*TLSConfig) MarshalTo Uses

func (m *TLSConfig) MarshalTo(dAtA []byte) (int, error)

func (*TLSConfig) MarshalToSizedBuffer Uses

func (m *TLSConfig) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TLSConfig) ProtoMessage Uses

func (*TLSConfig) ProtoMessage()

func (*TLSConfig) Reset Uses

func (m *TLSConfig) Reset()

func (*TLSConfig) Size Uses

func (m *TLSConfig) Size() (n int)

func (*TLSConfig) String Uses

func (this *TLSConfig) String() string

func (*TLSConfig) Unmarshal Uses

func (m *TLSConfig) Unmarshal(dAtA []byte) error

func (*TLSConfig) XXX_DiscardUnknown Uses

func (m *TLSConfig) XXX_DiscardUnknown()

func (*TLSConfig) XXX_Marshal Uses

func (m *TLSConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TLSConfig) XXX_Merge Uses

func (m *TLSConfig) XXX_Merge(src proto.Message)

func (*TLSConfig) XXX_Size Uses

func (m *TLSConfig) XXX_Size() int

func (*TLSConfig) XXX_Unmarshal Uses

func (m *TLSConfig) XXX_Unmarshal(b []byte) error

type X509Subject Uses

type X509Subject struct {
    // Organizations to be used on the Certificate.
    // +optional
    Organizations []string `json:"organizations,omitempty" protobuf:"bytes,1,rep,name=organizations"`
    // Countries to be used on the CertificateSpec.
    // +optional
    Countries []string `json:"countries,omitempty" protobuf:"bytes,2,rep,name=countries"`
    // Organizational Units to be used on the CertificateSpec.
    // +optional
    OrganizationalUnits []string `json:"organizationalUnits,omitempty" protobuf:"bytes,3,rep,name=organizationalUnits"`
    // Cities to be used on the CertificateSpec.
    // +optional
    Localities []string `json:"localities,omitempty" protobuf:"bytes,4,rep,name=localities"`
    // State/Provinces to be used on the CertificateSpec.
    // +optional
    Provinces []string `json:"provinces,omitempty" protobuf:"bytes,5,rep,name=provinces"`
    // Street addresses to be used on the CertificateSpec.
    // +optional
    StreetAddresses []string `json:"streetAddresses,omitempty" protobuf:"bytes,6,rep,name=streetAddresses"`
    // Postal codes to be used on the CertificateSpec.
    // +optional
    PostalCodes []string `json:"postalCodes,omitempty" protobuf:"bytes,7,rep,name=postalCodes"`
    // Serial number to be used on the CertificateSpec.
    // +optional
    SerialNumber string `json:"serialNumber,omitempty" protobuf:"bytes,8,opt,name=serialNumber"`
}

X509Subject Full X509 name specification

func (*X509Subject) DeepCopy Uses

func (in *X509Subject) DeepCopy() *X509Subject

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

func (*X509Subject) DeepCopyInto Uses

func (in *X509Subject) DeepCopyInto(out *X509Subject)

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

func (*X509Subject) Descriptor Uses

func (*X509Subject) Descriptor() ([]byte, []int)

func (*X509Subject) Marshal Uses

func (m *X509Subject) Marshal() (dAtA []byte, err error)

func (*X509Subject) MarshalTo Uses

func (m *X509Subject) MarshalTo(dAtA []byte) (int, error)

func (*X509Subject) MarshalToSizedBuffer Uses

func (m *X509Subject) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*X509Subject) ProtoMessage Uses

func (*X509Subject) ProtoMessage()

func (*X509Subject) Reset Uses

func (m *X509Subject) Reset()

func (*X509Subject) Size Uses

func (m *X509Subject) Size() (n int)

func (*X509Subject) String Uses

func (this *X509Subject) String() string

func (*X509Subject) Unmarshal Uses

func (m *X509Subject) Unmarshal(dAtA []byte) error

func (*X509Subject) XXX_DiscardUnknown Uses

func (m *X509Subject) XXX_DiscardUnknown()

func (*X509Subject) XXX_Marshal Uses

func (m *X509Subject) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*X509Subject) XXX_Merge Uses

func (m *X509Subject) XXX_Merge(src proto.Message)

func (*X509Subject) XXX_Size Uses

func (m *X509Subject) XXX_Size() int

func (*X509Subject) XXX_Unmarshal Uses

func (m *X509Subject) XXX_Unmarshal(b []byte) error

Package v1 imports 13 packages (graph) and is imported by 23 packages. Updated 2020-09-30. Refresh now. Tools for package owners.