apiextensions

Documentation

Overview

Package apiextensions is the internal version of the API. +groupName=apiextensions.k8s.io

Index

• Constants
• Variables
• func DeepCopy_apiextensions_CustomResource(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apiextensions_CustomResourceCondition(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apiextensions_CustomResourceList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apiextensions_CustomResourceNames(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apiextensions_CustomResourceSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apiextensions_CustomResourceStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func Kind(kind string) schema.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type ConditionStatus
• type CustomResource
• type CustomResourceCondition
• type CustomResourceConditionType
• type CustomResourceList
• type CustomResourceNames
• type CustomResourceSpec
• type CustomResourceStatus
• type ResourceScope

Constants

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 DeepCopy_apiextensions_CustomResource

func DeepCopy_apiextensions_CustomResource(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_apiextensions_CustomResourceCondition

func DeepCopy_apiextensions_CustomResourceCondition(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_apiextensions_CustomResourceList

func DeepCopy_apiextensions_CustomResourceList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_apiextensions_CustomResourceNames

func DeepCopy_apiextensions_CustomResourceNames(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_apiextensions_CustomResourceSpec

func DeepCopy_apiextensions_CustomResourceSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_apiextensions_CustomResourceStatus

func DeepCopy_apiextensions_CustomResourceStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

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 CustomResource

type CustomResource struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// Spec describes how the user wants the resources to appear
	Spec CustomResourceSpec
	// Status indicates the actual state of the CustomResource
	Status CustomResourceStatus
}

CustomResource represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

type CustomResourceCondition

type CustomResourceCondition struct {
	// Type is the type of the condition.
	Type CustomResourceConditionType
	// 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
}

CustomResourceCondition contains details for the current condition of this pod.

type CustomResourceConditionType

type CustomResourceConditionType string

CustomResourceConditionType is a valid value for CustomResourceCondition.Type

const (
	// NameConflict means the names chosen for this CustomResource conflict with others in the group.
	NameConflict CustomResourceConditionType = "NameConflict"
	// Terminating means that the CustomResource has been deleted and is cleaning up.
	Terminating CustomResourceConditionType = "Terminating"
)

type CustomResourceList

type CustomResourceList struct {
	metav1.TypeMeta
	metav1.ListMeta

	// Items individual CustomResources
	Items []CustomResource
}

CustomResourceList is a list of CustomResource objects.

type CustomResourceNames

type CustomResourceNames struct {
	// Plural is the plural name of the resource to serve.  It must match the name of the CustomResource-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
}

CustomResourceNames indicates the names to serve this CustomResource

type CustomResourceSpec

type CustomResourceSpec 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 CustomResourceNames

	// Scope indicates whether this resource is cluster or namespace scoped.  Default is namespaced
	Scope ResourceScope
}

CustomResourceSpec describes how a user wants their resource to appear

type CustomResourceStatus

type CustomResourceStatus struct {
	// Conditions indicate state for particular aspects of a CustomResource
	Conditions []CustomResourceCondition

	// AcceptedNames are the names that are actually being used to serve discovery
	// They may be different than the names in spec.
	AcceptedNames CustomResourceNames
}

CustomResourceStatus indicates the state of the CustomResource

type ResourceScope

type ResourceScope string

ResourceScope is an enum defining the different scopes availabe to a custom resource

const (
	ClusterScoped   ResourceScope = "Cluster"
	NamespaceScoped ResourceScope = "Namespaced"
)