apps

Documentation

Index

• Constants
• Variables
• func AddToScheme(scheme *runtime.Scheme)
• func DeepCopy_apps_PetSet(in PetSet, out *PetSet, c *conversion.Cloner) error
• func DeepCopy_apps_PetSetList(in PetSetList, out *PetSetList, c *conversion.Cloner) error
• func DeepCopy_apps_PetSetSpec(in PetSetSpec, out *PetSetSpec, c *conversion.Cloner) error
• func DeepCopy_apps_PetSetStatus(in PetSetStatus, out *PetSetStatus, c *conversion.Cloner) error
• func Kind(kind string) unversioned.GroupKind
• func Resource(resource string) unversioned.GroupResource
• type PetSet
• type PetSetList
• type PetSetSpec
• type PetSetStatus

Constants

const GroupName = "apps"

GroupName is the group name use in this package

Variables

var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func AddToScheme

func AddToScheme(scheme *runtime.Scheme)

func DeepCopy_apps_PetSet

func DeepCopy_apps_PetSet(in PetSet, out *PetSet, c *conversion.Cloner) error

func DeepCopy_apps_PetSetList

func DeepCopy_apps_PetSetList(in PetSetList, out *PetSetList, c *conversion.Cloner) error

func DeepCopy_apps_PetSetSpec

func DeepCopy_apps_PetSetSpec(in PetSetSpec, out *PetSetSpec, c *conversion.Cloner) error

func DeepCopy_apps_PetSetStatus

func DeepCopy_apps_PetSetStatus(in PetSetStatus, out *PetSetStatus, c *conversion.Cloner) error

func Kind

func Kind(kind string) unversioned.GroupKind

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

func Resource

func Resource(resource string) unversioned.GroupResource

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

Types

type PetSet

type PetSet struct {
	unversioned.TypeMeta `json:",inline"`
	api.ObjectMeta       `json:"metadata,omitempty"`

	// Spec defines the desired identities of pets in this set.
	Spec PetSetSpec `json:"spec,omitempty"`

	// Status is the current status of Pets in this PetSet. This data
	// may be out of date by some window of time.
	Status PetSetStatus `json:"status,omitempty"`
}

PetSet 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 PetSet guarantees that a given network identity will always map to the same storage identity. PetSet is currently in alpha and and subject to change without notice.

type PetSetList

type PetSetList struct {
	unversioned.TypeMeta `json:",inline"`
	unversioned.ListMeta `json:"metadata,omitempty"`
	Items                []PetSet `json:"items"`
}

PetSetList is a collection of PetSets.

type PetSetSpec

type PetSetSpec 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.
	Replicas int `json:"replicas,omitempty"`

	// Selector is a label query over pods that should match the replica count.
	// If empty, defaulted to labels on the pod template.
	// More info: http://releases.k8s.io/release-1.3/docs/user-guide/labels.md#label-selectors
	Selector *unversioned.LabelSelector `json:"selector,omitempty"`

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

	// VolumeClaimTemplates is a list of claims that pets are allowed to reference.
	// The PetSet controller is responsible for mapping network identities to
	// claims in a way that maintains the identity of a pet. 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.
	VolumeClaimTemplates []api.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty"`

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

A PetSetSpec is the specification of a PetSet.

type PetSetStatus

type PetSetStatus struct {
	// most recent generation observed by this autoscaler.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// Replicas is the number of actual replicas.
	Replicas int `json:"replicas"`
}

PetSetStatus represents the current state of a PetSet.