apps

Documentation

Index

• Constants
• Variables
• func DeepCopy_apps_ControllerRevision(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apps_ControllerRevisionList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apps_StatefulSet(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apps_StatefulSetList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apps_StatefulSetSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_apps_StatefulSetStatus(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 ControllerRevision
• type ControllerRevisionList
• type PodManagementPolicyType
• type StatefulSet
• type StatefulSetList
• type StatefulSetSpec
• type StatefulSetStatus

Constants

const GroupName = "apps"

GroupName is the group name use in this package

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_apps_ControllerRevision

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

DeepCopy_apps_ControllerRevision is an autogenerated deepcopy function.

func DeepCopy_apps_ControllerRevisionList

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

DeepCopy_apps_ControllerRevisionList is an autogenerated deepcopy function.

func DeepCopy_apps_StatefulSet

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

DeepCopy_apps_StatefulSet is an autogenerated deepcopy function.

func DeepCopy_apps_StatefulSetList

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

DeepCopy_apps_StatefulSetList is an autogenerated deepcopy function.

func DeepCopy_apps_StatefulSetSpec

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

DeepCopy_apps_StatefulSetSpec is an autogenerated deepcopy function.

func DeepCopy_apps_StatefulSetStatus

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

DeepCopy_apps_StatefulSetStatus is an autogenerated deepcopy function.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns 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 a Group qualified GroupResource

Types

type ControllerRevision

type ControllerRevision struct {
	metav1.TypeMeta
	// Standard object's metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta

	// Data is the Object representing the state.
	Data runtime.Object

	// Revision indicates the revision of the state represented by Data.
	Revision int64
}

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted.

type ControllerRevisionList

type ControllerRevisionList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// Items is the list of ControllerRevision objects.
	Items []ControllerRevision
}

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

type PodManagementPolicyType

type PodManagementPolicyType string

PodManagementPolicyType defines the policy for creating pods under a stateful set.

const (
	// OrderedReadyPodManagement will create pods in strictly increasing order on
	// scale up and strictly decreasing order on scale down, progressing only when
	// the previous pod is ready or terminated. At most one pod will be changed
	// at any time.
	OrderedReadyPodManagement PodManagementPolicyType = "OrderedReady"
	// ParallelPodManagement will create and delete pods as soon as the stateful set
	// replica count is changed, and will not wait for pods to be ready or complete
	// termination.
	ParallelPodManagement = "Parallel"
)

type StatefulSet

type StatefulSet struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta

	// Spec defines the desired identities of pods in this set.
	// +optional
	Spec StatefulSetSpec

	// Status is the current status of Pods in this StatefulSet. This data
	// may be out of date by some window of time.
	// +optional
	Status StatefulSetStatus
}

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

• Network: A single stable DNS and hostname.
• Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

type StatefulSetList

type StatefulSetList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta
	Items []StatefulSet
}

StatefulSetList is a collection of StatefulSets.

type StatefulSetSpec

type StatefulSetSpec struct {
	// Replicas is the desired number of replicas of the given Template.
	// These are replicas in the sense that they are instantiations of the
	// same Template, but individual replicas also have a consistent identity.
	// If unspecified, defaults to 1.
	// TODO: Consider a rename of this field.
	// +optional
	Replicas int32

	// Selector is a label query over pods that should match the replica count.
	// If empty, defaulted to labels on the pod template.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	Selector *metav1.LabelSelector

	// Template is the object that describes the pod that will be created if
	// insufficient replicas are detected. Each pod stamped out by the StatefulSet
	// will fulfill this Template, but have a unique identity from the rest
	// of the StatefulSet.
	Template api.PodTemplateSpec

	// VolumeClaimTemplates is a list of claims that pods are allowed to reference.
	// The StatefulSet controller is responsible for mapping network identities to
	// claims in a way that maintains the identity of a pod. Every claim in
	// this list must have at least one matching (by name) volumeMount in one
	// container in the template. A claim in this list takes precedence over
	// any volumes in the template, with the same name.
	// TODO: Define the behavior if a claim already exists with the same name.
	// +optional
	VolumeClaimTemplates []api.PersistentVolumeClaim

	// ServiceName is the name of the service that governs this StatefulSet.
	// This service must exist before the StatefulSet, and is responsible for
	// the network identity of the set. Pods get DNS/hostnames that follow the
	// pattern: pod-specific-string.serviceName.default.svc.cluster.local
	// where "pod-specific-string" is managed by the StatefulSet controller.
	ServiceName string

	// PodManagementPolicy controls how pods are created during initial scale up,
	// when replacing pods on nodes, or when scaling down. The default policy is
	// `OrderedReady`, where pods are created in increasing order (pod-0, then
	// pod-1, etc) and the controller will wait until each pod is ready before
	// continuing. When scaling down, the pods are removed in the opposite order.
	// The alternative policy is `Parallel` which will create pods in parallel
	// to match the desired scale without waiting, and on scale down will delete
	// all pods at once.
	// +optional
	PodManagementPolicy PodManagementPolicyType
}

A StatefulSetSpec is the specification of a StatefulSet.

type StatefulSetStatus

type StatefulSetStatus struct {
	// most recent generation observed by this StatefulSet.
	// +optional
	ObservedGeneration *int64

	// Replicas is the number of actual replicas.
	Replicas int32
}

StatefulSetStatus represents the current state of a StatefulSet.