Documentation

Overview

    Package v1beta1 is a generated protocol buffer package.

    It is generated from these files:

    k8s.io/kubernetes/vendor/k8s.io/api/certificates/v1beta1/generated.proto
    

    It has these top-level messages:

    CertificateSigningRequest
    CertificateSigningRequestCondition
    CertificateSigningRequestList
    CertificateSigningRequestSpec
    CertificateSigningRequestStatus
    ExtraValue
    

    Index

    Constants

    View Source
    const GroupName = "certificates.k8s.io"

      GroupName is the group name use in this package

      Variables

      View Source
      var (
      	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
      	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
      )
      View Source
      var (
      	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
      	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
      	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
      
      	AddToScheme = localSchemeBuilder.AddToScheme
      )
      View Source
      var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

        SchemeGroupVersion is group version used to register these objects

        Functions

        func Kind

        func Kind(kind string) schema.GroupKind

          Kind takes an unqualified kind and returns a Group qualified GroupKind

          func Resource

          func Resource(resource string) schema.GroupResource

            Resource takes an unqualified resource and returns a Group qualified GroupResource

            Types

            type CertificateSigningRequest

            type CertificateSigningRequest struct {
            	metav1.TypeMeta `json:",inline"`
            	// +optional
            	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
            
            	// The certificate request itself and any additional information.
            	// +optional
            	Spec CertificateSigningRequestSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
            
            	// Derived information about the request.
            	// +optional
            	Status CertificateSigningRequestStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
            }

              Describes a certificate signing request

              func (*CertificateSigningRequest) DeepCopy

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

                func (*CertificateSigningRequest) DeepCopyInto

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

                  func (*CertificateSigningRequest) DeepCopyObject

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

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

                    func (*CertificateSigningRequest) Descriptor

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

                    func (*CertificateSigningRequest) Marshal

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

                    func (*CertificateSigningRequest) MarshalTo

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

                    func (*CertificateSigningRequest) ProtoMessage

                    func (*CertificateSigningRequest) ProtoMessage()

                    func (*CertificateSigningRequest) Reset

                    func (m *CertificateSigningRequest) Reset()

                    func (*CertificateSigningRequest) Size

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

                    func (*CertificateSigningRequest) String

                    func (this *CertificateSigningRequest) String() string

                    func (CertificateSigningRequest) SwaggerDoc

                    func (CertificateSigningRequest) SwaggerDoc() map[string]string

                    func (*CertificateSigningRequest) Unmarshal

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

                    type CertificateSigningRequestCondition

                    type CertificateSigningRequestCondition struct {
                    	// request approval state, currently Approved or Denied.
                    	Type RequestConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=RequestConditionType"`
                    	// brief reason for the request state
                    	// +optional
                    	Reason string `json:"reason,omitempty" protobuf:"bytes,2,opt,name=reason"`
                    	// human readable message with details about the request state
                    	// +optional
                    	Message string `json:"message,omitempty" protobuf:"bytes,3,opt,name=message"`
                    	// timestamp for the last update to this condition
                    	// +optional
                    	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,4,opt,name=lastUpdateTime"`
                    }

                    func (*CertificateSigningRequestCondition) DeepCopy

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

                      func (*CertificateSigningRequestCondition) DeepCopyInto

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

                        func (*CertificateSigningRequestCondition) Descriptor

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

                        func (*CertificateSigningRequestCondition) Marshal

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

                        func (*CertificateSigningRequestCondition) MarshalTo

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

                        func (*CertificateSigningRequestCondition) ProtoMessage

                        func (*CertificateSigningRequestCondition) ProtoMessage()

                        func (*CertificateSigningRequestCondition) Reset

                        func (*CertificateSigningRequestCondition) Size

                        func (*CertificateSigningRequestCondition) String

                        func (CertificateSigningRequestCondition) SwaggerDoc

                        func (*CertificateSigningRequestCondition) Unmarshal

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

                        type CertificateSigningRequestList

                        type CertificateSigningRequestList struct {
                        	metav1.TypeMeta `json:",inline"`
                        	// +optional
                        	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                        
                        	Items []CertificateSigningRequest `json:"items" protobuf:"bytes,2,rep,name=items"`
                        }

                        func (*CertificateSigningRequestList) DeepCopy

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

                          func (*CertificateSigningRequestList) DeepCopyInto

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

                            func (*CertificateSigningRequestList) DeepCopyObject

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

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

                              func (*CertificateSigningRequestList) Descriptor

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

                              func (*CertificateSigningRequestList) Marshal

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

                              func (*CertificateSigningRequestList) MarshalTo

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

                              func (*CertificateSigningRequestList) ProtoMessage

                              func (*CertificateSigningRequestList) ProtoMessage()

                              func (*CertificateSigningRequestList) Reset

                              func (m *CertificateSigningRequestList) Reset()

                              func (*CertificateSigningRequestList) Size

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

                              func (*CertificateSigningRequestList) String

                              func (this *CertificateSigningRequestList) String() string

                              func (*CertificateSigningRequestList) Unmarshal

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

                              type CertificateSigningRequestSpec

                              type CertificateSigningRequestSpec struct {
                              	// Base64-encoded PKCS#10 CSR data
                              	Request []byte `json:"request" protobuf:"bytes,1,opt,name=request"`
                              
                              	// allowedUsages specifies a set of usage contexts the key will be
                              	// valid for.
                              	// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
                              	//      https://tools.ietf.org/html/rfc5280#section-4.2.1.12
                              	Usages []KeyUsage `json:"usages,omitempty" protobuf:"bytes,5,opt,name=usages"`
                              
                              	// Information about the requesting user.
                              	// See user.Info interface for details.
                              	// +optional
                              	Username string `json:"username,omitempty" protobuf:"bytes,2,opt,name=username"`
                              	// UID information about the requesting user.
                              	// See user.Info interface for details.
                              	// +optional
                              	UID string `json:"uid,omitempty" protobuf:"bytes,3,opt,name=uid"`
                              	// Group information about the requesting user.
                              	// See user.Info interface for details.
                              	// +optional
                              	Groups []string `json:"groups,omitempty" protobuf:"bytes,4,rep,name=groups"`
                              	// Extra information about the requesting user.
                              	// See user.Info interface for details.
                              	// +optional
                              	Extra map[string]ExtraValue `json:"extra,omitempty" protobuf:"bytes,6,rep,name=extra"`
                              }

                                This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

                                func (*CertificateSigningRequestSpec) DeepCopy

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

                                  func (*CertificateSigningRequestSpec) DeepCopyInto

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

                                    func (*CertificateSigningRequestSpec) Descriptor

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

                                    func (*CertificateSigningRequestSpec) Marshal

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

                                    func (*CertificateSigningRequestSpec) MarshalTo

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

                                    func (*CertificateSigningRequestSpec) ProtoMessage

                                    func (*CertificateSigningRequestSpec) ProtoMessage()

                                    func (*CertificateSigningRequestSpec) Reset

                                    func (m *CertificateSigningRequestSpec) Reset()

                                    func (*CertificateSigningRequestSpec) Size

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

                                    func (*CertificateSigningRequestSpec) String

                                    func (this *CertificateSigningRequestSpec) String() string

                                    func (CertificateSigningRequestSpec) SwaggerDoc

                                    func (CertificateSigningRequestSpec) SwaggerDoc() map[string]string

                                    func (*CertificateSigningRequestSpec) Unmarshal

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

                                    type CertificateSigningRequestStatus

                                    type CertificateSigningRequestStatus struct {
                                    	// Conditions applied to the request, such as approval or denial.
                                    	// +optional
                                    	Conditions []CertificateSigningRequestCondition `json:"conditions,omitempty" protobuf:"bytes,1,rep,name=conditions"`
                                    
                                    	// If request was approved, the controller will place the issued certificate here.
                                    	// +optional
                                    	Certificate []byte `json:"certificate,omitempty" protobuf:"bytes,2,opt,name=certificate"`
                                    }

                                    func (*CertificateSigningRequestStatus) DeepCopy

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

                                      func (*CertificateSigningRequestStatus) DeepCopyInto

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

                                        func (*CertificateSigningRequestStatus) Descriptor

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

                                        func (*CertificateSigningRequestStatus) Marshal

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

                                        func (*CertificateSigningRequestStatus) MarshalTo

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

                                        func (*CertificateSigningRequestStatus) ProtoMessage

                                        func (*CertificateSigningRequestStatus) ProtoMessage()

                                        func (*CertificateSigningRequestStatus) Reset

                                        func (*CertificateSigningRequestStatus) Size

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

                                        func (*CertificateSigningRequestStatus) String

                                        func (this *CertificateSigningRequestStatus) String() string

                                        func (CertificateSigningRequestStatus) SwaggerDoc

                                        func (*CertificateSigningRequestStatus) Unmarshal

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

                                        type ExtraValue

                                        type ExtraValue []string

                                          ExtraValue masks the value so protobuf can generate +protobuf.nullable=true +protobuf.options.(gogoproto.goproto_stringer)=false

                                          func (ExtraValue) DeepCopy

                                          func (in ExtraValue) DeepCopy() ExtraValue

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

                                            func (ExtraValue) DeepCopyInto

                                            func (in ExtraValue) DeepCopyInto(out *ExtraValue)

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

                                              func (*ExtraValue) Descriptor

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

                                              func (ExtraValue) Marshal

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

                                              func (ExtraValue) MarshalTo

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

                                              func (*ExtraValue) ProtoMessage

                                              func (*ExtraValue) ProtoMessage()

                                              func (*ExtraValue) Reset

                                              func (m *ExtraValue) Reset()

                                              func (ExtraValue) Size

                                              func (m ExtraValue) Size() (n int)

                                              func (ExtraValue) String

                                              func (t ExtraValue) String() string

                                              func (*ExtraValue) Unmarshal

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

                                              type KeyUsage

                                              type KeyUsage string

                                                KeyUsages specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3

                                                https://tools.ietf.org/html/rfc5280#section-4.2.1.12
                                                
                                                const (
                                                	UsageSigning            KeyUsage = "signing"
                                                	UsageDigitalSignature   KeyUsage = "digital signature"
                                                	UsageContentCommittment KeyUsage = "content commitment"
                                                	UsageKeyEncipherment    KeyUsage = "key encipherment"
                                                	UsageKeyAgreement       KeyUsage = "key agreement"
                                                	UsageDataEncipherment   KeyUsage = "data encipherment"
                                                	UsageCertSign           KeyUsage = "cert sign"
                                                	UsageCRLSign            KeyUsage = "crl sign"
                                                	UsageEncipherOnly       KeyUsage = "encipher only"
                                                	UsageDecipherOnly       KeyUsage = "decipher only"
                                                	UsageAny                KeyUsage = "any"
                                                	UsageServerAuth         KeyUsage = "server auth"
                                                	UsageClientAuth         KeyUsage = "client auth"
                                                	UsageCodeSigning        KeyUsage = "code signing"
                                                	UsageEmailProtection    KeyUsage = "email protection"
                                                	UsageSMIME              KeyUsage = "s/mime"
                                                	UsageIPsecEndSystem     KeyUsage = "ipsec end system"
                                                	UsageIPsecTunnel        KeyUsage = "ipsec tunnel"
                                                	UsageIPsecUser          KeyUsage = "ipsec user"
                                                	UsageTimestamping       KeyUsage = "timestamping"
                                                	UsageOCSPSigning        KeyUsage = "ocsp signing"
                                                	UsageMicrosoftSGC       KeyUsage = "microsoft sgc"
                                                	UsageNetscapSGC         KeyUsage = "netscape sgc"
                                                )

                                                type RequestConditionType

                                                type RequestConditionType string
                                                const (
                                                	CertificateApproved RequestConditionType = "Approved"
                                                	CertificateDenied   RequestConditionType = "Denied"
                                                )

                                                  These are the possible conditions for a certificate request.