scale

Documentation

Index

• func PatchReplicasToScale(ctx context.Context, name string, scale int32, patcher ScalePatcher) error
• type ScalePatcher
  • func DeploymentScalePatcher(deploy apps.DeploymentInterface) ScalePatcher
  • func StatefulSetScalePatcher(stateSet apps.StatefulSetInterface) ScalePatcher
• type ScalePatcherFunc
  • func (p ScalePatcherFunc) Patch(ctx context.Context, name string, patchType types.PatchType, data []byte, ...) (int32, error)

Functions

func PatchReplicasToScale

func PatchReplicasToScale(
	ctx context.Context,
	name string,
	scale int32,
	patcher ScalePatcher) error

PatchReplicasToScale patches the provided object name with the expected scale. If the operation fails an error is returned

Types

type ScalePatcher

type ScalePatcher interface {
	// Patch patches the supplied object name with a supplied patch operation.
	// The returned scale is provided if the operation completes successfully.
	Patch(context.Context, string, types.PatchType, []byte, meta.PatchOptions, ...string) (int32, error)
}

ScalePatcher provides a generic interface for patching replicas count on common Kubernetes objects. The Kubernetes objects must support patching of spec.replicas to work with this interface

func DeploymentScalePatcher

func DeploymentScalePatcher(deploy apps.DeploymentInterface) ScalePatcher

DeploymentScalePatcher returns a ScalePatcher suitable for use with Deployments

func StatefulSetScalePatcher

func StatefulSetScalePatcher(stateSet apps.StatefulSetInterface) ScalePatcher

StatefulSetScalePatcher returns a ScalePatcher suitable for use with Statefulsets.

type ScalePatcherFunc

type ScalePatcherFunc func(context.Context, string, types.PatchType, []byte, meta.PatchOptions, ...string) (int32, error)

ScalePatcherFunc is a convenience func to implement the ScalePatcher interface

func (ScalePatcherFunc) Patch

func (p ScalePatcherFunc) Patch(
	ctx context.Context,
	name string,
	patchType types.PatchType,
	data []byte,
	opts meta.PatchOptions,
	subresources ...string,
) (int32, error)

Patch see ScalePatcher.Patch