v1alpha1

Documentation

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ExtendedStatefulSet
  • func (in *ExtendedStatefulSet) DeepCopy() *ExtendedStatefulSet
  • func (in *ExtendedStatefulSet) DeepCopyInto(out *ExtendedStatefulSet)
  • func (in *ExtendedStatefulSet) DeepCopyObject() runtime.Object
  • func (e *ExtendedStatefulSet) GetMaxAvailableVersion(versions map[int]bool) int
• type ExtendedStatefulSetList
  • func (in *ExtendedStatefulSetList) DeepCopy() *ExtendedStatefulSetList
  • func (in *ExtendedStatefulSetList) DeepCopyInto(out *ExtendedStatefulSetList)
  • func (in *ExtendedStatefulSetList) DeepCopyObject() runtime.Object
• type ExtendedStatefulSetSpec
  • func (in *ExtendedStatefulSetSpec) DeepCopy() *ExtendedStatefulSetSpec
  • func (in *ExtendedStatefulSetSpec) DeepCopyInto(out *ExtendedStatefulSetSpec)
• type ExtendedStatefulSetStatus
  • func (in *ExtendedStatefulSetStatus) DeepCopy() *ExtendedStatefulSetStatus
  • func (in *ExtendedStatefulSetStatus) DeepCopyInto(out *ExtendedStatefulSetStatus)

Constants

const (
	// ExtendedStatefulSetResourceKind is the kind name of ExtendedStatefulSet
	ExtendedStatefulSetResourceKind = "ExtendedStatefulSet"
	// ExtendedStatefulSetResourcePlural is the plural name of ExtendedStatefulSet
	ExtendedStatefulSetResourcePlural = "extendedstatefulsets"
)

const DefaultZoneNodeLabel = "failure-domain.beta.kubernetes.io/zone"

DefaultZoneNodeLabel is the default node label for available zones

Variables

var (

	// AddToScheme is used for schema registrations in the controller package
	// and also in the generated kube code
	AddToScheme = schemeBuilder.AddToScheme

	// ExtendedStatefulSetResourceShortNames is the short names of ExtendedStatefulSet
	ExtendedStatefulSetResourceShortNames = []string{"ests"}

	// ExtendedJobValidation is the validation method for ExtendedJob
	ExtendedJobValidation = extv1.CustomResourceValidation{
		OpenAPIV3Schema: &extv1.JSONSchemaProps{
			Type: "object",
			Properties: map[string]extv1.JSONSchemaProps{
				"spec": {
					Type: "object",
					Properties: map[string]extv1.JSONSchemaProps{
						"template": {
							Type:        "object",
							Description: "A template for a regular StatefulSet",
						},
						"updateOnConfigChange": {
							Type:        "boolean",
							Description: "Indicate whether to update Pods in the StatefulSet when an env value or mount changes",
						},
						"zoneNodeLabel": {
							Type:        "string",
							Description: "Indicates the node label that a node locates",
						},
						"zones": {
							Type:        "array",
							Description: "Indicates the availability zones that the ExtendedStatefulSet needs to span",
							Items: &extv1.JSONSchemaPropsOrArray{
								Schema: &extv1.JSONSchemaProps{
									Type: "string",
								},
							},
						},
					},
					Required: []string{
						"template",
					},
				},
			},
		},
	}

	// ExtendedStatefulSetResourceName is the resource name of ExtendedStatefulSet
	ExtendedStatefulSetResourceName = fmt.Sprintf("%s.%s", ExtendedStatefulSetResourcePlural, apis.GroupName)

	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: apis.GroupName, Version: "v1alpha1"}
)

var (
	// AnnotationVersion is the annotation key for the StatefulSet version
	AnnotationVersion = fmt.Sprintf("%s/version", apis.GroupName)
	// AnnotationZones is an array of all zones
	AnnotationZones = fmt.Sprintf("%s/zones", apis.GroupName)
	// LabelAZIndex is the index of available zone
	LabelAZIndex = fmt.Sprintf("%s/az-index", apis.GroupName)
	// LabelAZName is the name of available zone
	LabelAZName = fmt.Sprintf("%s/az-name", apis.GroupName)
	// LabelPodOrdinal is the index of pod ordinal
	LabelPodOrdinal = fmt.Sprintf("%s/pod-ordinal", apis.GroupName)
)

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back 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 ExtendedStatefulSet

type ExtendedStatefulSet struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ExtendedStatefulSetSpec   `json:"spec,omitempty"`
	Status ExtendedStatefulSetStatus `json:"status,omitempty"`
}

ExtendedStatefulSet is the Schema for the extendedstatefulset API +k8s:openapi-gen=true

func (*ExtendedStatefulSet) DeepCopy

func (in *ExtendedStatefulSet) DeepCopy() *ExtendedStatefulSet

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

func (*ExtendedStatefulSet) DeepCopyInto

func (in *ExtendedStatefulSet) DeepCopyInto(out *ExtendedStatefulSet)

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

func (*ExtendedStatefulSet) DeepCopyObject

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

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

func (*ExtendedStatefulSet) GetMaxAvailableVersion

func (e *ExtendedStatefulSet) GetMaxAvailableVersion(versions map[int]bool) int

GetMaxAvailableVersion gets the greatest available version owned by the ExtendedStatefulSet

type ExtendedStatefulSetList

type ExtendedStatefulSetList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ExtendedStatefulSet `json:"items"`
}

ExtendedStatefulSetList contains a list of ExtendedStatefulSet

func (*ExtendedStatefulSetList) DeepCopy

func (in *ExtendedStatefulSetList) DeepCopy() *ExtendedStatefulSetList

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

func (*ExtendedStatefulSetList) DeepCopyInto

func (in *ExtendedStatefulSetList) DeepCopyInto(out *ExtendedStatefulSetList)

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

func (*ExtendedStatefulSetList) DeepCopyObject

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

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

type ExtendedStatefulSetSpec

type ExtendedStatefulSetSpec struct {
	// Indicates whether to update Pods in the StatefulSet when an env value or mount changes
	UpdateOnConfigChange bool `json:"updateOnConfigChange"`

	// Indicates the node label that a node locates
	ZoneNodeLabel string `json:"zoneNodeLabel,omitempty"`

	// Indicates the availability zones that the ExtendedStatefulSet needs to span
	Zones []string `json:"zones,omitempty"`

	// Defines a regular StatefulSet template
	Template v1beta2.StatefulSet `json:"template"`
}

ExtendedStatefulSetSpec defines the desired state of ExtendedStatefulSet

func (*ExtendedStatefulSetSpec) DeepCopy

func (in *ExtendedStatefulSetSpec) DeepCopy() *ExtendedStatefulSetSpec

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

func (*ExtendedStatefulSetSpec) DeepCopyInto

func (in *ExtendedStatefulSetSpec) DeepCopyInto(out *ExtendedStatefulSetSpec)

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

type ExtendedStatefulSetStatus

type ExtendedStatefulSetStatus struct {
	LastReconcile *metav1.Time `json:"lastReconcile"`
	// Map of version number keys and values that keeps track of if version is running
	Versions map[int]bool `json:"versions"`
}

ExtendedStatefulSetStatus defines the observed state of ExtendedStatefulSet

func (*ExtendedStatefulSetStatus) DeepCopy

func (in *ExtendedStatefulSetStatus) DeepCopy() *ExtendedStatefulSetStatus

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

func (*ExtendedStatefulSetStatus) DeepCopyInto

func (in *ExtendedStatefulSetStatus) DeepCopyInto(out *ExtendedStatefulSetStatus)

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