set

package
v0.32.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2024 License: Apache-2.0 Imports: 32 Imported by: 18

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ImageResolver = resolveImageFunc

ImageResolver to use.

Functions

func CalculatePatch

func CalculatePatch(patch *Patch, encoder runtime.Encoder, mutateFn PatchFn) bool

CalculatePatch calls the mutation function on the provided info object, and generates a strategic merge patch for the changes in the object. Encoder must be able to encode the info into the appropriate destination type. This function returns whether the mutation function made any change in the original object.

func NewCmdEnv

func NewCmdEnv(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdEnv implements the OpenShift cli env command

func NewCmdImage

func NewCmdImage(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdImage returns an initialized Command instance for the 'set image' sub command

func NewCmdResources

func NewCmdResources(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdResources returns initialized Command instance for the 'set resources' sub command

func NewCmdSelector

func NewCmdSelector(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdSelector is the "set selector" command.

func NewCmdServiceAccount

func NewCmdServiceAccount(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdServiceAccount returns the "set serviceaccount" command.

func NewCmdSet

func NewCmdSet(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdSet returns an initialized Command instance for 'set' sub command

func NewCmdSubject

func NewCmdSubject(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewCmdSubject returns the "new subject" sub command

Types

type EnvOptions

type EnvOptions struct {
	PrintFlags *genericclioptions.PrintFlags
	resource.FilenameOptions

	EnvParams         []string
	All               bool
	Resolve           bool
	List              bool
	Local             bool
	Overwrite         bool
	ContainerSelector string
	Selector          string
	From              string
	Prefix            string
	Keys              []string

	PrintObj printers.ResourcePrinterFunc

	genericiooptions.IOStreams
	WarningPrinter *printers.WarningPrinter
	// contains filtered or unexported fields
}

EnvOptions holds values for 'set env' command-lone options

func NewEnvOptions

func NewEnvOptions(streams genericiooptions.IOStreams) *EnvOptions

NewEnvOptions returns an EnvOptions indicating all containers in the selected pod templates are selected by default and allowing environment to be overwritten

func (*EnvOptions) Complete

func (o *EnvOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete completes all required options

func (*EnvOptions) RunEnv

func (o *EnvOptions) RunEnv() error

RunEnv contains all the necessary functionality for the OpenShift cli env command

func (*EnvOptions) Validate

func (o *EnvOptions) Validate() error

Validate makes sure provided values for EnvOptions are valid

type ImageResolverFunc added in v0.24.0

type ImageResolverFunc func(in string) (string, error)

ImageResolver is a func that receives an image name, and resolves it to an appropriate / compatible image name. Adds flexibility for future image resolving methods.

type Patch

type Patch struct {
	Info *resource.Info
	Err  error

	Before []byte
	After  []byte
	Patch  []byte
}

Patch represents the result of a mutation to an object.

func CalculatePatches

func CalculatePatches(infos []*resource.Info, encoder runtime.Encoder, mutateFn PatchFn) []*Patch

CalculatePatches calculates patches on each provided info object. If the provided mutateFn makes no change in an object, the object is not included in the final list of patches.

type PatchFn

type PatchFn func(runtime.Object) ([]byte, error)

PatchFn is a function type that accepts an info object and returns a byte slice. Implementations of PatchFn should update the object and return it encoded.

type SetImageOptions

type SetImageOptions struct {
	resource.FilenameOptions

	PrintFlags  *genericclioptions.PrintFlags
	RecordFlags *genericclioptions.RecordFlags

	Infos          []*resource.Info
	Selector       string
	DryRunStrategy cmdutil.DryRunStrategy
	All            bool
	Output         string
	Local          bool
	ResolveImage   ImageResolverFunc

	PrintObj printers.ResourcePrinterFunc
	Recorder genericclioptions.Recorder

	UpdatePodSpecForObject polymorphichelpers.UpdatePodSpecForObjectFunc
	Resources              []string
	ContainerImages        map[string]string

	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

ImageOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

func NewImageOptions

func NewImageOptions(streams genericiooptions.IOStreams) *SetImageOptions

NewImageOptions returns an initialized SetImageOptions instance

func (*SetImageOptions) Complete

func (o *SetImageOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete completes all required options

func (*SetImageOptions) Run

func (o *SetImageOptions) Run() error

Run performs the execution of 'set image' sub command

func (*SetImageOptions) Validate

func (o *SetImageOptions) Validate() error

Validate makes sure provided values in SetImageOptions are valid

type SetResourcesOptions

type SetResourcesOptions struct {
	resource.FilenameOptions

	PrintFlags  *genericclioptions.PrintFlags
	RecordFlags *genericclioptions.RecordFlags

	Infos             []*resource.Info
	Selector          string
	ContainerSelector string
	Output            string
	All               bool
	Local             bool

	DryRunStrategy cmdutil.DryRunStrategy

	PrintObj printers.ResourcePrinterFunc
	Recorder genericclioptions.Recorder

	Limits               string
	Requests             string
	ResourceRequirements v1.ResourceRequirements

	UpdatePodSpecForObject polymorphichelpers.UpdatePodSpecForObjectFunc
	Resources              []string

	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

SetResourcesOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags

func NewResourcesOptions

func NewResourcesOptions(streams genericiooptions.IOStreams) *SetResourcesOptions

NewResourcesOptions returns a ResourcesOptions indicating all containers in the selected pod templates are selected by default.

func (*SetResourcesOptions) Complete

func (o *SetResourcesOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete completes all required options

func (*SetResourcesOptions) Run

func (o *SetResourcesOptions) Run() error

Run performs the execution of 'set resources' sub command

func (*SetResourcesOptions) Validate

func (o *SetResourcesOptions) Validate() error

Validate makes sure that provided values in ResourcesOptions are valid

type SetSelectorOptions

type SetSelectorOptions struct {
	// Bound
	ResourceBuilderFlags *genericclioptions.ResourceBuilderFlags
	PrintFlags           *genericclioptions.PrintFlags
	RecordFlags          *genericclioptions.RecordFlags

	// computed
	WriteToServer  bool
	PrintObj       printers.ResourcePrinterFunc
	Recorder       genericclioptions.Recorder
	ResourceFinder genericclioptions.ResourceFinder

	// set at initialization
	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

SetSelectorOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags()

func NewSelectorOptions

func NewSelectorOptions(streams genericiooptions.IOStreams) *SetSelectorOptions

NewSelectorOptions returns an initialized SelectorOptions instance

func (*SetSelectorOptions) Complete

func (o *SetSelectorOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete assigns the SelectorOptions from args.

func (*SetSelectorOptions) RunSelector

func (o *SetSelectorOptions) RunSelector() error

RunSelector executes the command.

func (*SetSelectorOptions) Validate

func (o *SetSelectorOptions) Validate() error

Validate basic inputs

type SetServiceAccountOptions

type SetServiceAccountOptions struct {
	PrintFlags  *genericclioptions.PrintFlags
	RecordFlags *genericclioptions.RecordFlags

	PrintObj printers.ResourcePrinterFunc
	Recorder genericclioptions.Recorder

	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

SetServiceAccountOptions encapsulates the data required to perform the operation.

func NewSetServiceAccountOptions

func NewSetServiceAccountOptions(streams genericiooptions.IOStreams) *SetServiceAccountOptions

NewSetServiceAccountOptions returns an initialized SetServiceAccountOptions instance

func (*SetServiceAccountOptions) Complete

func (o *SetServiceAccountOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete configures serviceAccountConfig from command line args.

func (*SetServiceAccountOptions) Run

Run creates and applies the patch either locally or calling apiserver.

type SubjectOptions

type SubjectOptions struct {
	PrintFlags *genericclioptions.PrintFlags

	resource.FilenameOptions

	Infos             []*resource.Info
	Selector          string
	ContainerSelector string
	Output            string
	All               bool
	DryRunStrategy    cmdutil.DryRunStrategy
	Local             bool

	Users           []string
	Groups          []string
	ServiceAccounts []string

	PrintObj printers.ResourcePrinterFunc

	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

SubjectOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of referencing the cmd.Flags

func NewSubjectOptions

func NewSubjectOptions(streams genericiooptions.IOStreams) *SubjectOptions

NewSubjectOptions returns an initialized SubjectOptions instance

func (*SubjectOptions) Complete

func (o *SubjectOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

Complete completes all required options

func (*SubjectOptions) Run

func (o *SubjectOptions) Run(fn updateSubjects) error

Run performs the execution of "set subject" sub command

func (*SubjectOptions) Validate

func (o *SubjectOptions) Validate() error

Validate makes sure provided values in SubjectOptions are valid

Directories

Path Synopsis
Package env provides functions to incorporate environment variables into set env.
Package env provides functions to incorporate environment variables into set env.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL