Documentation ¶
Overview ¶
Package apiextensions is the internal version of the API. +groupName=apiextensions.k8s.io
Index ¶
- Constants
- Variables
- func CRDHasFinalizer(crd *CustomResourceDefinition, needle string) bool
- func CRDRemoveFinalizer(crd *CustomResourceDefinition, needle string)
- func IsCRDConditionEquivalent(lhs, rhs *CustomResourceDefinitionCondition) bool
- func IsCRDConditionFalse(crd *CustomResourceDefinition, ...) bool
- func IsCRDConditionPresentAndEqual(crd *CustomResourceDefinition, ...) bool
- func IsCRDConditionTrue(crd *CustomResourceDefinition, ...) bool
- func Kind(kind string) schema.GroupKind
- func RemoveCRDCondition(crd *CustomResourceDefinition, ...)
- func Resource(resource string) schema.GroupResource
- func SetCRDCondition(crd *CustomResourceDefinition, newCondition CustomResourceDefinitionCondition)
- type ConditionStatus
- type CustomResourceDefinition
- type CustomResourceDefinitionCondition
- type CustomResourceDefinitionConditionType
- type CustomResourceDefinitionList
- type CustomResourceDefinitionNames
- type CustomResourceDefinitionSpec
- type CustomResourceDefinitionStatus
- type CustomResourceSubresourceScale
- type CustomResourceSubresourceStatus
- type CustomResourceSubresources
- type CustomResourceValidation
- type ExternalDocumentation
- type JSON
- type JSONSchemaDefinitions
- type JSONSchemaDependencies
- type JSONSchemaProps
- type JSONSchemaPropsOrArray
- type JSONSchemaPropsOrBool
- type JSONSchemaPropsOrStringArray
- type JSONSchemaURL
- type ResourceScope
Constants ¶
const CustomResourceCleanupFinalizer = "customresourcecleanup.apiextensions.k8s.io"
CustomResourceCleanupFinalizer is the name of the finalizer which will delete instances of a CustomResourceDefinition
const GroupName = "apiextensions.k8s.io"
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func CRDHasFinalizer ¶
func CRDHasFinalizer(crd *CustomResourceDefinition, needle string) bool
CRDHasFinalizer returns true if the finalizer is in the list
func CRDRemoveFinalizer ¶
func CRDRemoveFinalizer(crd *CustomResourceDefinition, needle string)
CRDRemoveFinalizer removes the finalizer if present
func IsCRDConditionEquivalent ¶
func IsCRDConditionEquivalent(lhs, rhs *CustomResourceDefinitionCondition) bool
IsCRDConditionEquivalent returns true if the lhs and rhs are equivalent except for times
func IsCRDConditionFalse ¶
func IsCRDConditionFalse(crd *CustomResourceDefinition, conditionType CustomResourceDefinitionConditionType) bool
IsCRDConditionFalse indicates if the condition is present and false true
func IsCRDConditionPresentAndEqual ¶
func IsCRDConditionPresentAndEqual(crd *CustomResourceDefinition, conditionType CustomResourceDefinitionConditionType, status ConditionStatus) bool
IsCRDConditionPresentAndEqual indicates if the condition is present and equal to the arg
func IsCRDConditionTrue ¶
func IsCRDConditionTrue(crd *CustomResourceDefinition, conditionType CustomResourceDefinitionConditionType) bool
IsCRDConditionTrue indicates if the condition is present and strictly true
func RemoveCRDCondition ¶
func RemoveCRDCondition(crd *CustomResourceDefinition, conditionType CustomResourceDefinitionConditionType)
RemoveCRDCondition removes the status condition.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
func SetCRDCondition ¶
func SetCRDCondition(crd *CustomResourceDefinition, newCondition CustomResourceDefinitionCondition)
SetCRDCondition sets the status condition. It either overwrites the existing one or creates a new one
Types ¶
type ConditionStatus ¶
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 CustomResourceDefinition ¶
type CustomResourceDefinition struct { metav1.TypeMeta metav1.ObjectMeta // Spec describes how the user wants the resources to appear Spec CustomResourceDefinitionSpec // Status indicates the actual state of the CustomResourceDefinition Status CustomResourceDefinitionStatus }
CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.
func (*CustomResourceDefinition) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinition) DeepCopy() *CustomResourceDefinition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinition.
func (*CustomResourceDefinition) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinition) DeepCopyInto(out *CustomResourceDefinition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomResourceDefinition) DeepCopyObject ¶ added in v1.8.0
func (in *CustomResourceDefinition) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomResourceDefinitionCondition ¶
type CustomResourceDefinitionCondition struct { // Type is the type of the condition. Type CustomResourceDefinitionConditionType // Status is the status of the condition. // Can be True, False, Unknown. Status ConditionStatus // Last time the condition transitioned from one status to another. // +optional LastTransitionTime metav1.Time // Unique, one-word, CamelCase reason for the condition's last transition. // +optional Reason string // Human-readable message indicating details about last transition. // +optional Message string }
CustomResourceDefinitionCondition contains details for the current condition of this pod.
func FindCRDCondition ¶
func FindCRDCondition(crd *CustomResourceDefinition, conditionType CustomResourceDefinitionConditionType) *CustomResourceDefinitionCondition
FindCRDCondition returns the condition you're looking for or nil
func (*CustomResourceDefinitionCondition) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinitionCondition) DeepCopy() *CustomResourceDefinitionCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinitionCondition.
func (*CustomResourceDefinitionCondition) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinitionCondition) DeepCopyInto(out *CustomResourceDefinitionCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceDefinitionConditionType ¶
type CustomResourceDefinitionConditionType string
CustomResourceDefinitionConditionType is a valid value for CustomResourceDefinitionCondition.Type
const ( // Established means that the resource has become active. A resource is established when all names are // accepted without a conflict for the first time. A resource stays established until deleted, even during // a later NamesAccepted due to changed names. Note that not all names can be changed. Established CustomResourceDefinitionConditionType = "Established" // NamesAccepted means the names chosen for this CustomResourceDefinition do not conflict with others in // the group and are therefore accepted. NamesAccepted CustomResourceDefinitionConditionType = "NamesAccepted" // Terminating means that the CustomResourceDefinition has been deleted and is cleaning up. Terminating CustomResourceDefinitionConditionType = "Terminating" )
type CustomResourceDefinitionList ¶
type CustomResourceDefinitionList struct { metav1.TypeMeta metav1.ListMeta // Items individual CustomResourceDefinitions Items []CustomResourceDefinition }
CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
func (*CustomResourceDefinitionList) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinitionList) DeepCopy() *CustomResourceDefinitionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinitionList.
func (*CustomResourceDefinitionList) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinitionList) DeepCopyInto(out *CustomResourceDefinitionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomResourceDefinitionList) DeepCopyObject ¶ added in v1.8.0
func (in *CustomResourceDefinitionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomResourceDefinitionNames ¶
type CustomResourceDefinitionNames struct { // Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration // too: plural.group and it must be all lowercase. Plural string // Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind> Singular string // ShortNames are short names for the resource. It must be all lowercase. ShortNames []string // Kind is the serialized kind of the resource. It is normally CamelCase and singular. Kind string // ListKind is the serialized kind of the list for this resource. Defaults to <kind>List. ListKind string // Categories is a list of grouped resources custom resources belong to (e.g. 'all') // +optional Categories []string }
CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition
func (*CustomResourceDefinitionNames) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinitionNames) DeepCopy() *CustomResourceDefinitionNames
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinitionNames.
func (*CustomResourceDefinitionNames) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinitionNames) DeepCopyInto(out *CustomResourceDefinitionNames)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceDefinitionSpec ¶
type CustomResourceDefinitionSpec struct { // Group is the group this resource belongs in Group string // Version is the version this resource belongs in Version string // Names are the names used to describe this custom resource Names CustomResourceDefinitionNames // Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced Scope ResourceScope // Validation describes the validation methods for CustomResources Validation *CustomResourceValidation // Subresources describes the subresources for CustomResources Subresources *CustomResourceSubresources }
CustomResourceDefinitionSpec describes how a user wants their resource to appear
func (*CustomResourceDefinitionSpec) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinitionSpec) DeepCopy() *CustomResourceDefinitionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinitionSpec.
func (*CustomResourceDefinitionSpec) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinitionSpec) DeepCopyInto(out *CustomResourceDefinitionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceDefinitionStatus ¶
type CustomResourceDefinitionStatus struct { // Conditions indicate state for particular aspects of a CustomResourceDefinition Conditions []CustomResourceDefinitionCondition // AcceptedNames are the names that are actually being used to serve discovery // They may be different than the names in spec. AcceptedNames CustomResourceDefinitionNames }
CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
func (*CustomResourceDefinitionStatus) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceDefinitionStatus) DeepCopy() *CustomResourceDefinitionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceDefinitionStatus.
func (*CustomResourceDefinitionStatus) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceDefinitionStatus) DeepCopyInto(out *CustomResourceDefinitionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceSubresourceScale ¶ added in v1.10.0
type CustomResourceSubresourceScale struct { // SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. // Only JSON paths without the array notation are allowed. // Must be a JSON Path under .spec. // If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET. SpecReplicasPath string // StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. // Only JSON paths without the array notation are allowed. // Must be a JSON Path under .status. // If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource // will default to 0. StatusReplicasPath string // LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. // Only JSON paths without the array notation are allowed. // Must be a JSON Path under .status. // Must be set to work with HPA. // If there is no value under the given path in the CustomResource, the status label selector value in the /scale // subresource will default to the empty string. // +optional LabelSelectorPath *string }
CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.
func (*CustomResourceSubresourceScale) DeepCopy ¶ added in v1.10.0
func (in *CustomResourceSubresourceScale) DeepCopy() *CustomResourceSubresourceScale
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceSubresourceScale.
func (*CustomResourceSubresourceScale) DeepCopyInto ¶ added in v1.10.0
func (in *CustomResourceSubresourceScale) DeepCopyInto(out *CustomResourceSubresourceScale)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceSubresourceStatus ¶ added in v1.10.0
type CustomResourceSubresourceStatus struct{}
CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza
func (*CustomResourceSubresourceStatus) DeepCopy ¶ added in v1.10.0
func (in *CustomResourceSubresourceStatus) DeepCopy() *CustomResourceSubresourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceSubresourceStatus.
func (*CustomResourceSubresourceStatus) DeepCopyInto ¶ added in v1.10.0
func (in *CustomResourceSubresourceStatus) DeepCopyInto(out *CustomResourceSubresourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceSubresources ¶ added in v1.10.0
type CustomResourceSubresources struct { // Status denotes the status subresource for CustomResources Status *CustomResourceSubresourceStatus // Scale denotes the scale subresource for CustomResources Scale *CustomResourceSubresourceScale }
CustomResourceSubresources defines the status and scale subresources for CustomResources.
func (*CustomResourceSubresources) DeepCopy ¶ added in v1.10.0
func (in *CustomResourceSubresources) DeepCopy() *CustomResourceSubresources
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceSubresources.
func (*CustomResourceSubresources) DeepCopyInto ¶ added in v1.10.0
func (in *CustomResourceSubresources) DeepCopyInto(out *CustomResourceSubresources)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomResourceValidation ¶ added in v1.8.0
type CustomResourceValidation struct { // OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. OpenAPIV3Schema *JSONSchemaProps }
CustomResourceValidation is a list of validation methods for CustomResources.
func (*CustomResourceValidation) DeepCopy ¶ added in v1.8.0
func (in *CustomResourceValidation) DeepCopy() *CustomResourceValidation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomResourceValidation.
func (*CustomResourceValidation) DeepCopyInto ¶ added in v1.8.0
func (in *CustomResourceValidation) DeepCopyInto(out *CustomResourceValidation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExternalDocumentation ¶ added in v1.8.0
ExternalDocumentation allows referencing an external resource for extended documentation.
func (*ExternalDocumentation) DeepCopy ¶ added in v1.8.0
func (in *ExternalDocumentation) DeepCopy() *ExternalDocumentation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalDocumentation.
func (*ExternalDocumentation) DeepCopyInto ¶ added in v1.8.0
func (in *ExternalDocumentation) DeepCopyInto(out *ExternalDocumentation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSON ¶ added in v1.8.0
type JSON interface{}
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
type JSONSchemaDefinitions ¶ added in v1.8.0
type JSONSchemaDefinitions map[string]JSONSchemaProps
JSONSchemaDefinitions contains the models explicitly defined in this spec.
func (JSONSchemaDefinitions) DeepCopy ¶ added in v1.10.0
func (in JSONSchemaDefinitions) DeepCopy() JSONSchemaDefinitions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONSchemaDefinitions.
func (JSONSchemaDefinitions) DeepCopyInto ¶ added in v1.10.0
func (in JSONSchemaDefinitions) DeepCopyInto(out *JSONSchemaDefinitions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaDependencies ¶ added in v1.8.0
type JSONSchemaDependencies map[string]JSONSchemaPropsOrStringArray
JSONSchemaDependencies represent a dependencies property.
func (JSONSchemaDependencies) DeepCopy ¶ added in v1.10.0
func (in JSONSchemaDependencies) DeepCopy() JSONSchemaDependencies
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONSchemaDependencies.
func (JSONSchemaDependencies) DeepCopyInto ¶ added in v1.10.0
func (in JSONSchemaDependencies) DeepCopyInto(out *JSONSchemaDependencies)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaProps ¶ added in v1.8.0
type JSONSchemaProps struct { ID string Schema JSONSchemaURL Ref *string Description string Type string Format string Title string Default *JSON Maximum *float64 ExclusiveMaximum bool Minimum *float64 ExclusiveMinimum bool MaxLength *int64 MinLength *int64 Pattern string MaxItems *int64 MinItems *int64 UniqueItems bool MultipleOf *float64 Enum []JSON MaxProperties *int64 MinProperties *int64 Required []string Items *JSONSchemaPropsOrArray AllOf []JSONSchemaProps OneOf []JSONSchemaProps AnyOf []JSONSchemaProps Not *JSONSchemaProps Properties map[string]JSONSchemaProps AdditionalProperties *JSONSchemaPropsOrBool PatternProperties map[string]JSONSchemaProps Dependencies JSONSchemaDependencies AdditionalItems *JSONSchemaPropsOrBool Definitions JSONSchemaDefinitions ExternalDocs *ExternalDocumentation Example *JSON }
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
func (*JSONSchemaProps) DeepCopy ¶ added in v1.8.0
func (in *JSONSchemaProps) DeepCopy() *JSONSchemaProps
TODO: Update this after a tag is created for interface fields in DeepCopy
func (*JSONSchemaProps) DeepCopyInto ¶ added in v1.8.0
func (in *JSONSchemaProps) DeepCopyInto(out *JSONSchemaProps)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaPropsOrArray ¶ added in v1.8.0
type JSONSchemaPropsOrArray struct { Schema *JSONSchemaProps JSONSchemas []JSONSchemaProps }
JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.
func (*JSONSchemaPropsOrArray) DeepCopy ¶ added in v1.8.0
func (in *JSONSchemaPropsOrArray) DeepCopy() *JSONSchemaPropsOrArray
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONSchemaPropsOrArray.
func (*JSONSchemaPropsOrArray) DeepCopyInto ¶ added in v1.8.0
func (in *JSONSchemaPropsOrArray) DeepCopyInto(out *JSONSchemaPropsOrArray)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaPropsOrBool ¶ added in v1.8.0
type JSONSchemaPropsOrBool struct { Allows bool Schema *JSONSchemaProps }
JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
func (*JSONSchemaPropsOrBool) DeepCopy ¶ added in v1.8.0
func (in *JSONSchemaPropsOrBool) DeepCopy() *JSONSchemaPropsOrBool
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONSchemaPropsOrBool.
func (*JSONSchemaPropsOrBool) DeepCopyInto ¶ added in v1.8.0
func (in *JSONSchemaPropsOrBool) DeepCopyInto(out *JSONSchemaPropsOrBool)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaPropsOrStringArray ¶ added in v1.8.0
type JSONSchemaPropsOrStringArray struct { Schema *JSONSchemaProps Property []string }
JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.
func (*JSONSchemaPropsOrStringArray) DeepCopy ¶ added in v1.8.0
func (in *JSONSchemaPropsOrStringArray) DeepCopy() *JSONSchemaPropsOrStringArray
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONSchemaPropsOrStringArray.
func (*JSONSchemaPropsOrStringArray) DeepCopyInto ¶ added in v1.8.0
func (in *JSONSchemaPropsOrStringArray) DeepCopyInto(out *JSONSchemaPropsOrStringArray)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONSchemaURL ¶ added in v1.8.0
type JSONSchemaURL string
JSONSchemaURL represents a schema url.
type ResourceScope ¶
type ResourceScope string
ResourceScope is an enum defining the different scopes available to a custom resource
const ( ClusterScoped ResourceScope = "Cluster" NamespaceScoped ResourceScope = "Namespaced" )
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package v1beta1 is the v1beta1 version of the API.
|
Package v1beta1 is the v1beta1 version of the API. |