statefulset

Documentation

Index

• Constants
• type StatefulPodControlInterface
  • func NewRealStatefulPodControl(client clientset.Interface, recorder record.EventRecorder) StatefulPodControlInterface
• type StatefulSetControlInterface
  • func NewDefaultStatefulSetControl(podControl StatefulPodControlInterface) StatefulSetControlInterface
• type StatefulSetController
  • func NewStatefulSetController(podInformer cache.SharedIndexInformer, kubeClient clientset.Interface, ...) *StatefulSetController
  • func (ssc *StatefulSetController) Run(workers int, stopCh <-chan struct{})

Constants

const (
	// Time to sleep before polling to see if the pod cache has synced.
	PodStoreSyncedPollPeriod = 100 * time.Millisecond
)

Types

type StatefulPodControlInterface

type StatefulPodControlInterface interface {
	// CreateStatefulPod create a Pod in a StatefulSet. Any PVCs necessary for the Pod are created prior to creating
	// the Pod. If the returned error is nil the Pod and its PVCs have been created.
	CreateStatefulPod(set *apps.StatefulSet, pod *v1.Pod) error
	// UpdateStatefulPod Updates a Pod in a StatefulSet. If the Pod already has the correct identity and stable
	// storage this method is a no-op. If the Pod must be mutated to conform to the Set, it is mutated and updated.
	// pod is an in-out parameter, and any updates made to the pod are reflected as mutations to this parameter. If
	// the create is successful, the returned error is nil.
	UpdateStatefulPod(set *apps.StatefulSet, pod *v1.Pod) error
	// DeleteStatefulPod deletes a Pod in a StatefulSet. The pods PVCs are not deleted. If the delete is successful,
	// the returned error is nil.
	DeleteStatefulPod(set *apps.StatefulSet, pod *v1.Pod) error
	// UpdateStatefulSetStatus Updates the Status.Replicas of a StatefulSet. set is an in-out parameter, and any
	// updates made to the set are made visible as mutations to the parameter. If the method is successful, the
	// returned error is nil, and set has its Status.Replicas field set to replicas.
	UpdateStatefulSetReplicas(set *apps.StatefulSet, replicas int32) error
}

StatefulPodControlInterface defines the interface that StatefulSetController uses to create, update, and delete Pods, and to update the Status of a StatefulSet. It follows the design paradigms used for PodControl, but its implementation provides for PVC creation, ordered Pod creation, ordered Pod termination, and Pod identity enforcement. Like controller.PodControlInterface, it is implemented as an interface to provide for testing fakes.

func NewRealStatefulPodControl

func NewRealStatefulPodControl(client clientset.Interface, recorder record.EventRecorder) StatefulPodControlInterface

type StatefulSetControlInterface

type StatefulSetControlInterface interface {
	// UpdateStatefulSet implements the control logic for Pod creation, update, and deletion, and
	// persistent volume creation, update, and deletion.
	// If an implementation returns a non-nil error, the invocation will be retried using a rate-limited strategy.
	// Implementors should sink any errors that they do not wish to trigger a retry, and they may feel free to
	// exit exceptionally at any point provided they wish the update to be re-run at a later point in time.
	UpdateStatefulSet(set *apps.StatefulSet, pods []*v1.Pod) error
}

StatefulSetControl implements the control logic for updating StatefulSets and their children Pods. It is implemented as an interface to allow for extensions that provide different semantics. Currently, there is only one implementation.

func NewDefaultStatefulSetControl

func NewDefaultStatefulSetControl(podControl StatefulPodControlInterface) StatefulSetControlInterface

NewDefaultStatefulSetControl returns a new instance of the default implementation StatefulSetControlInterface that implements the documented semantics for StatefulSets. podControl is the PodControlInterface used to create, update, and delete Pods and to create PersistentVolumeClaims. You should use an instance returned from NewRealStatefulPodControl() for any scenario other than testing.

type StatefulSetController

type StatefulSetController struct {
	// contains filtered or unexported fields
}

StatefulSetController controls statefulsets.

func NewStatefulSetController

func NewStatefulSetController(podInformer cache.SharedIndexInformer, kubeClient clientset.Interface, resyncPeriod time.Duration) *StatefulSetController

NewStatefulSetController creates a new statefulset controller.

func (*StatefulSetController) Run

func (ssc *StatefulSetController) Run(workers int, stopCh <-chan struct{})

Run runs the statefulset controller.