statefulset

Documentation

Index

• func CreateVolumeFromConfigMap(name, sourceName string) corev1.Volume
• func CreateVolumeFromEmptyDir(name string) corev1.Volume
• func CreateVolumeFromSecret(name, sourceName string) corev1.Volume
• func CreateVolumeMount(name, path string, options ...func(*corev1.VolumeMount)) corev1.VolumeMount
• func HaveEqualSpec(builtSts appsv1.StatefulSet, existingSts appsv1.StatefulSet) (bool, error)
• func IsReady(sts appsv1.StatefulSet) bool
• func WithReadOnly(readonly bool) func(*corev1.VolumeMount)
• func WithSubPath(subPath string) func(*corev1.VolumeMount)
• type Builder
  • func NewBuilder() *Builder
  • func (s *Builder) AddVolume(volume corev1.Volume) *Builder
  • func (s *Builder) AddVolumeAndMount(containerName string, volumeMountData VolumeMountData) *Builder
  • func (s *Builder) AddVolumeClaimTemplates(claims []corev1.PersistentVolumeClaim) *Builder
  • func (s *Builder) AddVolumeMount(containerName string, mount corev1.VolumeMount) *Builder
  • func (s *Builder) AddVolumeMounts(containerName string, mounts []corev1.VolumeMount) *Builder
  • func (s *Builder) AddVolumes(volumes []corev1.Volume) *Builder
  • func (s Builder) Build() (appsv1.StatefulSet, error)
  • func (s *Builder) SetLabels(labels map[string]string) *Builder
  • func (s *Builder) SetMatchLabels(matchLabels map[string]string) *Builder
  • func (s *Builder) SetName(name string) *Builder
  • func (s *Builder) SetNamespace(namespace string) *Builder
  • func (s *Builder) SetOwnerReference(ownerReference []metav1.OwnerReference) *Builder
  • func (s *Builder) SetPodTemplateSpec(podTemplateSpec corev1.PodTemplateSpec) *Builder
  • func (s *Builder) SetReadinessProbe(probe *corev1.Probe, containerName string) *Builder
  • func (s *Builder) SetReplicas(replicas int) *Builder
  • func (s *Builder) SetServiceName(serviceName string) *Builder
  • func (s *Builder) SetUpdateStrategy(updateStrategyType appsv1.StatefulSetUpdateStrategyType) *Builder
• type VolumeMountData

Functions

func CreateVolumeFromConfigMap

func CreateVolumeFromConfigMap(name, sourceName string) corev1.Volume

func CreateVolumeFromEmptyDir

func CreateVolumeFromEmptyDir(name string) corev1.Volume

func CreateVolumeFromSecret

func CreateVolumeFromSecret(name, sourceName string) corev1.Volume

func CreateVolumeMount

func CreateVolumeMount(name, path string, options ...func(*corev1.VolumeMount)) corev1.VolumeMount

CreateVolumeMount returns a corev1.VolumeMount with options.

func HaveEqualSpec

func HaveEqualSpec(builtSts appsv1.StatefulSet, existingSts appsv1.StatefulSet) (bool, error)

HaveEqualSpec accepts a StatefulSet builtSts, and a second existingSts, and compares the Spec of both inputs but only comparing the fields that were specified in builtSts

func IsReady

func IsReady(sts appsv1.StatefulSet) bool

func WithReadOnly

func WithReadOnly(readonly bool) func(*corev1.VolumeMount)

WithReadOnly sets the ReadOnly attribute of this VolumeMount

func WithSubPath

func WithSubPath(subPath string) func(*corev1.VolumeMount)

WithSubPath sets the SubPath for this VolumeMount

Types

type Builder

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

func NewBuilder

func NewBuilder() *Builder

func (*Builder) AddVolume

func (s *Builder) AddVolume(volume corev1.Volume) *Builder

func (*Builder) AddVolumeAndMount

func (s *Builder) AddVolumeAndMount(containerName string, volumeMountData VolumeMountData) *Builder

func (*Builder) AddVolumeClaimTemplates

func (s *Builder) AddVolumeClaimTemplates(claims []corev1.PersistentVolumeClaim) *Builder

func (*Builder) AddVolumeMount

func (s *Builder) AddVolumeMount(containerName string, mount corev1.VolumeMount) *Builder

func (*Builder) AddVolumeMounts

func (s *Builder) AddVolumeMounts(containerName string, mounts []corev1.VolumeMount) *Builder

func (*Builder) AddVolumes

func (s *Builder) AddVolumes(volumes []corev1.Volume) *Builder

func (Builder) Build

func (s Builder) Build() (appsv1.StatefulSet, error)

func (*Builder) SetLabels

func (s *Builder) SetLabels(labels map[string]string) *Builder

func (*Builder) SetMatchLabels

func (s *Builder) SetMatchLabels(matchLabels map[string]string) *Builder

func (*Builder) SetName

func (s *Builder) SetName(name string) *Builder

func (*Builder) SetNamespace

func (s *Builder) SetNamespace(namespace string) *Builder

func (*Builder) SetOwnerReference

func (s *Builder) SetOwnerReference(ownerReference []metav1.OwnerReference) *Builder

func (*Builder) SetPodTemplateSpec

func (s *Builder) SetPodTemplateSpec(podTemplateSpec corev1.PodTemplateSpec) *Builder

func (*Builder) SetReadinessProbe

func (s *Builder) SetReadinessProbe(probe *corev1.Probe, containerName string) *Builder

func (*Builder) SetReplicas

func (s *Builder) SetReplicas(replicas int) *Builder

func (*Builder) SetServiceName

func (s *Builder) SetServiceName(serviceName string) *Builder

func (*Builder) SetUpdateStrategy

func (s *Builder) SetUpdateStrategy(updateStrategyType appsv1.StatefulSetUpdateStrategyType) *Builder

type VolumeMountData

type VolumeMountData struct {
	Name      string
	MountPath string
	Volume    corev1.Volume
}

VolumeMountData contains values required for the MountVolume function