Documentation ¶
Overview ¶
+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +groupName=policy.cert-manager.io
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type CertificateRequestPolicy
- type CertificateRequestPolicyAllowed
- type CertificateRequestPolicyAllowedString
- type CertificateRequestPolicyAllowedStringSlice
- type CertificateRequestPolicyAllowedX509Subject
- type CertificateRequestPolicyCondition
- type CertificateRequestPolicyConditionType
- type CertificateRequestPolicyConstraints
- type CertificateRequestPolicyConstraintsPrivateKey
- type CertificateRequestPolicyList
- type CertificateRequestPolicyPluginData
- type CertificateRequestPolicySelector
- type CertificateRequestPolicySelectorIssuerRef
- type CertificateRequestPolicySpec
- type CertificateRequestPolicyStatus
Constants ¶
This section is empty.
Variables ¶
var ( SchemeBuilder runtime.SchemeBuilder AddToScheme = localSchemeBuilder.AddToScheme GlobalScheme *runtime.Scheme )
var SchemeGroupVersion = schema.GroupVersion{Group: policy.GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type CertificateRequestPolicy ¶
type CertificateRequestPolicy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec CertificateRequestPolicySpec `json:"spec,omitempty"` Status CertificateRequestPolicyStatus `json:"status,omitempty"` }
CertificateRequestPolicy is an object for describing a "policy profile" that makes decisions on whether applicable CertificateRequests should be approved or denied.
func (*CertificateRequestPolicy) DeepCopy ¶
func (in *CertificateRequestPolicy) DeepCopy() *CertificateRequestPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicy.
func (*CertificateRequestPolicy) DeepCopyInto ¶
func (in *CertificateRequestPolicy) DeepCopyInto(out *CertificateRequestPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateRequestPolicy) DeepCopyObject ¶
func (in *CertificateRequestPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CertificateRequestPolicyAllowed ¶
type CertificateRequestPolicyAllowed struct { // CommonName defines the X.509 Common Name that is permissible. // +optional CommonName *CertificateRequestPolicyAllowedString `json:"commonName,omitempty"` // DNSNames defines the X.509 DNS SANs that may be requested for. // Accepts wildcards "*". // +optional DNSNames *CertificateRequestPolicyAllowedStringSlice `json:"dnsNames,omitempty"` // IPAddresses defines the X.509 IP SANs that may be requested // for. // +optional IPAddresses *CertificateRequestPolicyAllowedStringSlice `json:"ipAddresses,omitempty"` // URIs defines the X.509 URI SANs that may be requested for. // +optional URIs *CertificateRequestPolicyAllowedStringSlice `json:"uris,omitempty"` // EmailAddresses defines the X.509 Email SANs that may be // requested for. // +optional EmailAddresses *CertificateRequestPolicyAllowedStringSlice `json:"emailAddresses,omitempty"` // IsCA defines whether it is permissible for a CertificateRequest to have // the `spec.IsCA` field set to `true`. // An omitted field, value of `nil` or `false`, forbids the `spec.IsCA` field // from bring `true`. // A value of `true` permits CertificateRequests setting the `spec.IsCA` field // to `true`. // +optional IsCA *bool `json:"isCA,omitempty"` // Usages defines the list of permissible key usages that may appear // on the CertificateRequest `spec.keyUsages` field. // An omitted field or value of `nil` forbids any Usages being requested. // An empty slice `[]` is equivalent to `nil`. // +optional Usages *[]cmapi.KeyUsage `json:"usages,omitempty"` // Subject defines the X.509 subject that is permissible. An omitted field or // value of `nil` forbids any Subject being requested. // +optional Subject *CertificateRequestPolicyAllowedX509Subject `json:"subject,omitempty"` }
CertificateRequestPolicyAllowed is a set of attributes that are declared as permissible for a CertificateRequest to have those values present. It is permissible for a CertificateRequest to request _less_ than what is allowed, but _not more_, i.e. it is permissible for a CertificateRequest to request a subset of what is allowed. Empty fields or `nil` values declares that the equivalent CertificateRequest field _must_ be omitted or empty for the request to be permitted.
func (*CertificateRequestPolicyAllowed) DeepCopy ¶
func (in *CertificateRequestPolicyAllowed) DeepCopy() *CertificateRequestPolicyAllowed
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyAllowed.
func (*CertificateRequestPolicyAllowed) DeepCopyInto ¶
func (in *CertificateRequestPolicyAllowed) DeepCopyInto(out *CertificateRequestPolicyAllowed)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyAllowedString ¶ added in v0.2.0
type CertificateRequestPolicyAllowedString struct { // Value defines the value that is permissible to be present on the request. // Accepts wildcards "*". // An omitted field or value of `nil` forbids the value from being requested. // An empty string is equivalent to `nil`, however an empty string pared with // Required as `true` is an impossible condition that always denies. // Value may not be `nil` if Required is `true`. // +optional Value *string `json:"value,omitempty"` // Required marks this field as being a required value on the request. // May only be set to true if Value is also defined. // +optional Required *bool `json:"required,omitempty"` }
CertificateRequestPolicyAllowedString represents an allowed string value paired with whether the field is a required value on the request.
func (*CertificateRequestPolicyAllowedString) DeepCopy ¶ added in v0.2.0
func (in *CertificateRequestPolicyAllowedString) DeepCopy() *CertificateRequestPolicyAllowedString
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyAllowedString.
func (*CertificateRequestPolicyAllowedString) DeepCopyInto ¶ added in v0.2.0
func (in *CertificateRequestPolicyAllowedString) DeepCopyInto(out *CertificateRequestPolicyAllowedString)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyAllowedStringSlice ¶ added in v0.2.0
type CertificateRequestPolicyAllowedStringSlice struct { // Defines the values that are permissible to be present on request. // Accepts wildcards "*". // An omitted field or value of `nil` forbids any value on the related field // in the request from being requested. // An empty slice `[]` is equivalent to `nil`, however an empty slice pared // with Required `true` is an impossible condition that always denies. // Values may not be `nil` if Required is `true`. // +optional Values *[]string `json:"values,omitempty"` // Required marks this field as being a required value on the request. // May only be set to true if Values is also defined. // Default is nil which marks the field as not required. // +optional Required *bool `json:"required,omitempty"` }
CertificateRequestPolicyAllowedStringSlice represents an allowed string slice value paired with whether the field is a required value on the request.
func (*CertificateRequestPolicyAllowedStringSlice) DeepCopy ¶ added in v0.2.0
func (in *CertificateRequestPolicyAllowedStringSlice) DeepCopy() *CertificateRequestPolicyAllowedStringSlice
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyAllowedStringSlice.
func (*CertificateRequestPolicyAllowedStringSlice) DeepCopyInto ¶ added in v0.2.0
func (in *CertificateRequestPolicyAllowedStringSlice) DeepCopyInto(out *CertificateRequestPolicyAllowedStringSlice)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyAllowedX509Subject ¶
type CertificateRequestPolicyAllowedX509Subject struct { // Organizations define the X.509 Subject Organizations that may be requested // for. // +optional Organizations *CertificateRequestPolicyAllowedStringSlice `json:"organizations,omitempty"` // Countries define the X.509 Subject Countries that may be requested for. // +optional Countries *CertificateRequestPolicyAllowedStringSlice `json:"countries,omitempty"` // OrganizationalUnits defines the X.509 Subject Organizational Units that // may be requested for. // +optional OrganizationalUnits *CertificateRequestPolicyAllowedStringSlice `json:"organizationalUnits,omitempty"` // Localities defines the X.509 Subject Localities that may be requested for. // +optional Localities *CertificateRequestPolicyAllowedStringSlice `json:"localities,omitempty"` // Provinces defines the X.509 Subject Provinces that may be requested for. // +optional Provinces *CertificateRequestPolicyAllowedStringSlice `json:"provinces,omitempty"` // StreetAddresses defines the X.509 Subject Street Addresses that may be // requested for. // +optional StreetAddresses *CertificateRequestPolicyAllowedStringSlice `json:"streetAddresses,omitempty"` // PostalCodes defines the X.509 Subject Postal Codes that may be requested // for. // +optional PostalCodes *CertificateRequestPolicyAllowedStringSlice `json:"postalCodes,omitempty"` // SerialNumber defines the X.509 Subject Serial Number that may be requested // for. // +optional SerialNumber *CertificateRequestPolicyAllowedString `json:"serialNumber,omitempty"` }
CertificateRequestPolicyAllowedX509Subject declares the X.509 Subject attributes that are permissible for a CertificateRequest to request for this policy. It is permissible for CertificateRequests to request a subset of Allowed X.509 Subject attributes defined.
func (*CertificateRequestPolicyAllowedX509Subject) DeepCopy ¶
func (in *CertificateRequestPolicyAllowedX509Subject) DeepCopy() *CertificateRequestPolicyAllowedX509Subject
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyAllowedX509Subject.
func (*CertificateRequestPolicyAllowedX509Subject) DeepCopyInto ¶
func (in *CertificateRequestPolicyAllowedX509Subject) DeepCopyInto(out *CertificateRequestPolicyAllowedX509Subject)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyCondition ¶
type CertificateRequestPolicyCondition struct { // Type of the condition, known values are (`Ready`). Type CertificateRequestPolicyConditionType `json:"type"` // Status of the condition, one of ('True', 'False', 'Unknown'). Status corev1.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 // transition, complementing reason. // +optional Message string `json:"message,omitempty"` // 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 CertificateRequestPolicy. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` }
CertificateRequestPolicyCondition contains condition information for a CertificateRequestPolicyStatus.
func (*CertificateRequestPolicyCondition) DeepCopy ¶
func (in *CertificateRequestPolicyCondition) DeepCopy() *CertificateRequestPolicyCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyCondition.
func (*CertificateRequestPolicyCondition) DeepCopyInto ¶
func (in *CertificateRequestPolicyCondition) DeepCopyInto(out *CertificateRequestPolicyCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyConditionType ¶
type CertificateRequestPolicyConditionType string
CertificateRequestPolicyConditionType represents a CertificateRequestPolicy condition value.
const ( // CertificateRequestPolicyConditionReady indicates that the // CertificateRequestPolicy has successfully loaded the policy, and all // configuration including plugin options are accepted and ready for // evaluating CertificateRequests. CertificateRequestPolicyConditionReady CertificateRequestPolicyConditionType = "Ready" )
type CertificateRequestPolicyConstraints ¶
type CertificateRequestPolicyConstraints struct { // MinDuration defines the minimum duration a certificate may be requested // for. // Values are inclusive (i.e. a min value of `1h` will accept a duration of // `1h`). MinDuration and MaxDuration may be the same value. // An omitted field or value of `nil` permits any minimum duration. // If MinDuration is defined, a duration _must_ be requested on the // CertificateRequest. // +optional MinDuration *metav1.Duration `json:"minDuration,omitempty"` // MaxDuration defines the maximum duration a certificate may be requested // for. // Values are inclusive (i.e. a max value of `1h` will accept a duration of // `1h`). MaxDuration and MinDuration may be the same value. // An omitted field or value of `nil` permits any maximum duration. // If MaxDuration is defined, a duration _must_ be requested on the // CertificateRequest. // +optional MaxDuration *metav1.Duration `json:"maxDuration,omitempty"` // PrivateKey defines the shape of permissible private keys that may be used // for the request with this policy. // An omitted field or value of `nil` permits the use of any private key by // the requestor. // +optional PrivateKey *CertificateRequestPolicyConstraintsPrivateKey `json:"privateKey,omitempty"` }
CertificateRequestPolicyConstraints define fields that, if defined, _must_ be satisfied by the CertificateRequest for the request to be permissible by this policy. Fields that are omitted or have a value of `nil` will be satisfied by any value on the corresponding attribute on the request.
func (*CertificateRequestPolicyConstraints) DeepCopy ¶
func (in *CertificateRequestPolicyConstraints) DeepCopy() *CertificateRequestPolicyConstraints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyConstraints.
func (*CertificateRequestPolicyConstraints) DeepCopyInto ¶
func (in *CertificateRequestPolicyConstraints) DeepCopyInto(out *CertificateRequestPolicyConstraints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyConstraintsPrivateKey ¶
type CertificateRequestPolicyConstraintsPrivateKey struct { // Algorithm defines the allowed crypto algorithm that is used by the // requestor for their private key in their request. // An omitted field or value of `nil` permits any Algorithm. // +optional Algorithm *cmapi.PrivateKeyAlgorithm `json:"algorithm,omitempty"` // MinSize defines the minimum key size a requestor may use for their private // key. // Values are inclusive (i.e. a min value of `2048` will accept a size // of `2048`). MinSize and MaxSize may be the same value. // An omitted field or value of `nil` permits any minimum size. // +optional MinSize *int `json:"minSize,omitempty"` // MaxSize defines the maximum key size a requestor may use for their private // key. // Values are inclusive (i.e. a min value of `2048` will accept a size // of `2048`). MaxSize and MinSize may be the same value. // An omitted field or value of `nil` permits any maximum size. // +optional MaxSize *int `json:"maxSize,omitempty"` }
CertificateRequestPolicyConstraintsPrivateKey defines constraints on what shape of private key is permissible for a CertificateRequest to have used for its request.
func (*CertificateRequestPolicyConstraintsPrivateKey) DeepCopy ¶
func (in *CertificateRequestPolicyConstraintsPrivateKey) DeepCopy() *CertificateRequestPolicyConstraintsPrivateKey
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyConstraintsPrivateKey.
func (*CertificateRequestPolicyConstraintsPrivateKey) DeepCopyInto ¶
func (in *CertificateRequestPolicyConstraintsPrivateKey) DeepCopyInto(out *CertificateRequestPolicyConstraintsPrivateKey)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyList ¶
type CertificateRequestPolicyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []CertificateRequestPolicy `json:"items"` }
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object CertificateRequestPolicyList is a list of CertificateRequestPolicies.
func (*CertificateRequestPolicyList) DeepCopy ¶
func (in *CertificateRequestPolicyList) DeepCopy() *CertificateRequestPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyList.
func (*CertificateRequestPolicyList) DeepCopyInto ¶
func (in *CertificateRequestPolicyList) DeepCopyInto(out *CertificateRequestPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CertificateRequestPolicyList) DeepCopyObject ¶
func (in *CertificateRequestPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CertificateRequestPolicyPluginData ¶
type CertificateRequestPolicyPluginData struct { // Values define a set of well-known, to the plugin, key value pairs that are // required for the plugin to successfully evaluate a request based on this // policy. // +optional Values map[string]string `json:"values,omitempty"` }
CertificateRequestPolicyPluginData is configuration needed by the plugin approver to evaluate a CertificateRequest on this policy.
func (*CertificateRequestPolicyPluginData) DeepCopy ¶
func (in *CertificateRequestPolicyPluginData) DeepCopy() *CertificateRequestPolicyPluginData
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyPluginData.
func (*CertificateRequestPolicyPluginData) DeepCopyInto ¶
func (in *CertificateRequestPolicyPluginData) DeepCopyInto(out *CertificateRequestPolicyPluginData)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicySelector ¶
type CertificateRequestPolicySelector struct { // IssuerRef is used to match this CertificateRequestPolicy against processed // CertificateRequests. This policy will only be evaluated against a // CertificateRequest whose `spec.issuerRef` field matches // `spec.selector.issuerRef`. CertificateRequests will not be processed on // unmatched `issuerRef`, regardless of whether the requestor is bound by // RBAC. // Accepts wildcards "*". // Nil values are equivalent to "*", // // The following value will match _all_ `issuerRefs`: // “` // issuerRef: {} // “` // // Required field. IssuerRef *CertificateRequestPolicySelectorIssuerRef `json:"issuerRef"` }
CertificateRequestPolicySelector is used for selecting over the CertificateRequests what this CertificateRequestPolicy is appropriate for, and if so, will be used to evaluate the request.
func (*CertificateRequestPolicySelector) DeepCopy ¶
func (in *CertificateRequestPolicySelector) DeepCopy() *CertificateRequestPolicySelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicySelector.
func (*CertificateRequestPolicySelector) DeepCopyInto ¶
func (in *CertificateRequestPolicySelector) DeepCopyInto(out *CertificateRequestPolicySelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicySelectorIssuerRef ¶
type CertificateRequestPolicySelectorIssuerRef struct { // Name is the wildcard selector to match the `spec.issuerRef.name` field on // requests. // Accepts wildcards "*". // An omitted field or value of `nil` matches all. // +optional Name *string `json:"name,omitempty"` // Kind is the wildcard selector to match the `spec.issuerRef.kind` field on // requests. // Accepts wildcards "*". // An omitted field or value of `nil` matches all. // +optional Kind *string `json:"kind,omitempty"` // Group is the wildcard selector to match the `spec.issuerRef.group` field // on requests. // Accepts wildcards "*". // An omitted field or value of `nil` matches all. // +optional Group *string `json:"group,omitempty"` }
CertificateRequestPolicySelectorIssuerRef defines the selector for matching on `issuerRef` of requests.
func (*CertificateRequestPolicySelectorIssuerRef) DeepCopy ¶
func (in *CertificateRequestPolicySelectorIssuerRef) DeepCopy() *CertificateRequestPolicySelectorIssuerRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicySelectorIssuerRef.
func (*CertificateRequestPolicySelectorIssuerRef) DeepCopyInto ¶
func (in *CertificateRequestPolicySelectorIssuerRef) DeepCopyInto(out *CertificateRequestPolicySelectorIssuerRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicySpec ¶
type CertificateRequestPolicySpec struct { // Allowed is the set of attributes that are "allowed" by this policy. A // CertificateRequest will only be considered permissible for this policy if // the CertificateRequest has the same or less as what is allowed. Empty or // `nil` allowed fields mean CertificateRequests are not allowed to have that // field present to be permissible. // +optional Allowed *CertificateRequestPolicyAllowed `json:"allowed,omitempty"` // Constraints is the set of attributes that _must_ be satisfied by the // CertificateRequest for the request to be permissible by the policy. Empty // or `nil` constraint fields mean CertificateRequests satisfy that field // with any value of their corresponding attribute. // +optional Constraints *CertificateRequestPolicyConstraints `json:"constraints,omitempty"` // Plugins define a set of plugins and their configuration that should be // executed when this policy is evaluated against a CertificateRequest. A // plugin must already be built within approver-policy for it to be // available. // +optional Plugins map[string]CertificateRequestPolicyPluginData `json:"plugins,omitempty"` // Selector is used for selecting over which CertificateRequests this // CertificateRequestPolicy is appropriate for and so will used for its // evaluation. Selector CertificateRequestPolicySelector `json:"selector"` }
CertificateRequestPolicySpec defines the desired state of CertificateRequestPolicy.
func (*CertificateRequestPolicySpec) DeepCopy ¶
func (in *CertificateRequestPolicySpec) DeepCopy() *CertificateRequestPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicySpec.
func (*CertificateRequestPolicySpec) DeepCopyInto ¶
func (in *CertificateRequestPolicySpec) DeepCopyInto(out *CertificateRequestPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CertificateRequestPolicyStatus ¶
type CertificateRequestPolicyStatus struct { // List of status conditions to indicate the status of the // CertificateRequestPolicy. // Known condition types are `Ready`. // +optional Conditions []CertificateRequestPolicyCondition `json:"conditions,omitempty"` }
CertificateRequestPolicyStatus defines the observed state of the CertificateRequestPolicy.
func (*CertificateRequestPolicyStatus) DeepCopy ¶
func (in *CertificateRequestPolicyStatus) DeepCopy() *CertificateRequestPolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CertificateRequestPolicyStatus.
func (*CertificateRequestPolicyStatus) DeepCopyInto ¶
func (in *CertificateRequestPolicyStatus) DeepCopyInto(out *CertificateRequestPolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.