statefulset

Documentation

Index

• type Client
  • func NewClient(clientset *kubernetes.Clientset) *Client
  • func (c *Client) Delete(ctx context.Context, name, namespace string) (err error)
  • func (c *Client) ReadyReplicas(ctx context.Context, name, namespace string) (ready int32, err error)
  • func (c *Client) RunningStatefulSets(ctx context.Context, namespace string) (running []string, err error)
  • func (c *Client) Scale(ctx context.Context, name, namespace string, replicas int32) (err error)
  • func (c *Client) Set(ctx context.Context, name, namespace string, o Options) (err error)
  • func (c *Client) StoppedStatefulSets(ctx context.Context, namespace string) (stopped []string, err error)
• type Options
• type StatefulSetSpec
  • func (s *StatefulSetSpec) ToK8S() appsv1.StatefulSetSpec
• type UpdateStrategy

Types

type Client

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

Client manages communication with the Kubernetes StatefulSet.

func NewClient

func NewClient(clientset *kubernetes.Clientset) *Client

NewClient constructs a new Client.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, name, namespace string) (err error)

Delete deletes StatefulSet

func (*Client) ReadyReplicas

func (c *Client) ReadyReplicas(ctx context.Context, name, namespace string) (ready int32, err error)

ReadyReplicas returns number of Pods created by the StatefulSet controller that have a Ready Condition

func (*Client) RunningStatefulSets

func (c *Client) RunningStatefulSets(ctx context.Context, namespace string) (running []string, err error)

RunningStatefulSets returns names of running StatefulSets

func (*Client) Scale

func (c *Client) Scale(ctx context.Context, name, namespace string, replicas int32) (err error)

Scale scales StatefulSet

func (*Client) Set

func (c *Client) Set(ctx context.Context, name, namespace string, o Options) (err error)

Set updates StatefulSet or creates it if it does not exist

func (*Client) StoppedStatefulSets

func (c *Client) StoppedStatefulSets(ctx context.Context, namespace string) (stopped []string, err error)

StoppedStatefulSets returns names of stopped StatefulSets

type Options

type Options struct {
	Annotations map[string]string
	Labels      map[string]string
	Spec        StatefulSetSpec
}

Options holds optional parameters for the Client.

type StatefulSetSpec

type StatefulSetSpec struct {
	PodManagementPolicy  string
	Replicas             int32
	RevisionHistoryLimit int32
	Selector             map[string]string
	ServiceName          string
	Template             pod.PodTemplateSpec
	UpdateStrategy       UpdateStrategy
	VolumeClaimTemplates pvc.PersistentVolumeClaims
}

StatefulSetSpec represents Kubernetes StatefulSetSpec

func (*StatefulSetSpec) ToK8S

func (s *StatefulSetSpec) ToK8S() appsv1.StatefulSetSpec

ToK8S converts StatefulSetSpec to Kuberntes client object

type UpdateStrategy

type UpdateStrategy struct {
	Type                   string
	RollingUpdatePartition int32
}

UpdateStrategy represents Kubernetes StatefulSetUpdateStrategy