mutator

Documentation

Index

• func ApplyFluidObjectSpecs(pod common.FluidObject, specs *MutatingPodSpecs) error
• func FindExtraArgsFromMetadata(metaObj metav1.ObjectMeta, platform string) (extraArgs map[string]string)
• type DefaultMutator
  • func (mutator *DefaultMutator) GetMutatedPodSpecs() *MutatingPodSpecs
  • func (mutator *DefaultMutator) MutateWithRuntimeInfo(pvcName string, runtimeInfo base.RuntimeInfoInterface, nameSuffix string) error
  • func (mutator *DefaultMutator) PostMutate() error
• type MutatingPodSpecs
  • func CollectFluidObjectSpecs(pod common.FluidObject) (*MutatingPodSpecs, error)
• type Mutator
  • func BuildMutator(args MutatorBuildArgs, platform string) (Mutator, error)
  • func NewDefaultMutator(args MutatorBuildArgs) Mutator
  • func NewUnprivilegedMutator(opts MutatorBuildArgs) Mutator
• type MutatorBuildArgs
  • func (args MutatorBuildArgs) String() string
• type UnprivilegedMutator
  • func (mutator *UnprivilegedMutator) GetMutatedPodSpecs() *MutatingPodSpecs
  • func (mutator *UnprivilegedMutator) MutateWithRuntimeInfo(pvcName string, runtimeInfo base.RuntimeInfoInterface, nameSuffix string) error
  • func (mutator *UnprivilegedMutator) PostMutate() error

Functions

func ApplyFluidObjectSpecs

func ApplyFluidObjectSpecs(pod common.FluidObject, specs *MutatingPodSpecs) error

func FindExtraArgsFromMetadata

func FindExtraArgsFromMetadata(metaObj metav1.ObjectMeta, platform string) (extraArgs map[string]string)

FindExtraArgsFromMetadata tries to get extra build args for a given mutator from a metaObj. For any platform-specific mutator, its extra args should be key-values and defined in the format of "{platform}.fluid.io/{key}={value}" in metaObj.annotaions.

Types

type DefaultMutator

type DefaultMutator struct {
	Specs *MutatingPodSpecs
	// contains filtered or unexported fields
}

TODO: DefaultMutator will be rewritten with polymorphism withe platform-specific mutation logic

func (*DefaultMutator) GetMutatedPodSpecs

func (mutator *DefaultMutator) GetMutatedPodSpecs() *MutatingPodSpecs

func (*DefaultMutator) MutateWithRuntimeInfo

func (mutator *DefaultMutator) MutateWithRuntimeInfo(pvcName string, runtimeInfo base.RuntimeInfoInterface, nameSuffix string) error

func (*DefaultMutator) PostMutate

func (mutator *DefaultMutator) PostMutate() error

type MutatingPodSpecs

type MutatingPodSpecs struct {
	Volumes        []corev1.Volume
	VolumeMounts   []corev1.VolumeMount
	Containers     []corev1.Container
	InitContainers []corev1.Container
	MetaObj        metav1.ObjectMeta
}

func CollectFluidObjectSpecs

func CollectFluidObjectSpecs(pod common.FluidObject) (*MutatingPodSpecs, error)

type Mutator

type Mutator interface {
	MutateWithRuntimeInfo(pvcName string, runtimeInfo base.RuntimeInfoInterface, nameSuffix string) error

	PostMutate() error

	GetMutatedPodSpecs() *MutatingPodSpecs
}

Mutator is the fuse sidecar mutator for platform-specific mutation logic.

func BuildMutator

func BuildMutator(args MutatorBuildArgs, platform string) (Mutator, error)

func NewDefaultMutator

func NewDefaultMutator(args MutatorBuildArgs) Mutator

func NewUnprivilegedMutator

func NewUnprivilegedMutator(opts MutatorBuildArgs) Mutator

type MutatorBuildArgs

type MutatorBuildArgs struct {
	Client    client.Client
	Log       logr.Logger
	Specs     *MutatingPodSpecs
	Options   common.FuseSidecarInjectOption
	ExtraArgs map[string]string
}

func (MutatorBuildArgs) String

func (args MutatorBuildArgs) String() string

type UnprivilegedMutator

type UnprivilegedMutator struct {
	// UnprivilegedMutator inherits from DefaultMutator
	DefaultMutator
}

func (*UnprivilegedMutator) GetMutatedPodSpecs

func (mutator *UnprivilegedMutator) GetMutatedPodSpecs() *MutatingPodSpecs

func (*UnprivilegedMutator) MutateWithRuntimeInfo

func (mutator *UnprivilegedMutator) MutateWithRuntimeInfo(pvcName string, runtimeInfo base.RuntimeInfoInterface, nameSuffix string) error

func (*UnprivilegedMutator) PostMutate

func (mutator *UnprivilegedMutator) PostMutate() error