Documentation
¶
Index ¶
- func CalculatePatch(patch *Patch, encoder runtime.Encoder, mutateFn PatchFn) bool
- func NewCmdEnv(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdImage(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdResources(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdSelector(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdServiceAccount(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdSet(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- func NewCmdSubject(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
- type EnvOptions
- type ImageResolver
- type Patch
- type PatchFn
- type SetImageOptions
- type SetResourcesOptions
- type SetSelectorOptions
- type SetServiceAccountOptions
- type SubjectOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CalculatePatch ¶ added in v1.6.0
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 ¶ added in v1.8.0
func NewCmdEnv(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdEnv implements the OpenShift cli env command
func NewCmdImage ¶
func NewCmdImage(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdImage returns an initialized Command instance for the 'set image' sub command
func NewCmdResources ¶ added in v1.5.0
func NewCmdResources(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdResources returns initialized Command instance for the 'set resources' sub command
func NewCmdSelector ¶ added in v1.6.0
func NewCmdSelector(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdSelector is the "set selector" command.
func NewCmdServiceAccount ¶ added in v1.8.0
func NewCmdServiceAccount(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdServiceAccount returns the "set serviceaccount" command.
func NewCmdSet ¶
func NewCmdSet(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdSet returns an initialized Command instance for 'set' sub command
func NewCmdSubject ¶ added in v1.7.0
func NewCmdSubject(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
NewCmdSubject returns the "new subject" sub command
Types ¶
type EnvOptions ¶ added in v1.8.0
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
genericclioptions.IOStreams
// contains filtered or unexported fields
}
EnvOptions holds values for 'set env' command-lone options
func NewEnvOptions ¶ added in v1.11.0
func NewEnvOptions(streams genericclioptions.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 ¶ added in v1.8.0
func (o *EnvOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
Complete completes all required options
type ImageResolver ¶ added in v1.11.0
type ImageResolver 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 ¶ added in v1.11.0
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 ¶ added in v1.11.0
type SetImageOptions struct {
resource.FilenameOptions
PrintFlags *genericclioptions.PrintFlags
RecordFlags *genericclioptions.RecordFlags
Infos []*resource.Info
Selector string
DryRun bool
All bool
Output string
Local bool
ResolveImage ImageResolver
PrintObj printers.ResourcePrinterFunc
Recorder genericclioptions.Recorder
UpdatePodSpecForObject polymorphichelpers.UpdatePodSpecForObjectFunc
Resources []string
ContainerImages map[string]string
genericclioptions.IOStreams
}
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 ¶ added in v1.11.0
func NewImageOptions(streams genericclioptions.IOStreams) *SetImageOptions
NewImageOptions returns an initialized SetImageOptions instance
func (*SetImageOptions) Complete ¶ added in v1.11.0
func (o *SetImageOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
Complete completes all required options
type SetResourcesOptions ¶ added in v1.11.0
type SetResourcesOptions struct {
resource.FilenameOptions
PrintFlags *genericclioptions.PrintFlags
RecordFlags *genericclioptions.RecordFlags
Infos []*resource.Info
Selector string
ContainerSelector string
Output string
All bool
Local bool
DryRun bool
PrintObj printers.ResourcePrinterFunc
Recorder genericclioptions.Recorder
Limits string
Requests string
ResourceRequirements v1.ResourceRequirements
UpdatePodSpecForObject polymorphichelpers.UpdatePodSpecForObjectFunc
Resources []string
genericclioptions.IOStreams
}
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 ¶ added in v1.11.0
func NewResourcesOptions(streams genericclioptions.IOStreams) *SetResourcesOptions
NewResourcesOptions returns a ResourcesOptions indicating all containers in the selected pod templates are selected by default.
func (*SetResourcesOptions) Complete ¶ added in v1.11.0
func (o *SetResourcesOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
Complete completes all required options
type SetSelectorOptions ¶ added in v1.11.0
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
genericclioptions.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 ¶ added in v1.11.0
func NewSelectorOptions(streams genericclioptions.IOStreams) *SetSelectorOptions
NewSelectorOptions returns an initialized SelectorOptions instance
func (*SetSelectorOptions) Complete ¶ added in v1.11.0
func (o *SetSelectorOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
Complete assigns the SelectorOptions from args.
func (*SetSelectorOptions) RunSelector ¶ added in v1.11.0
func (o *SetSelectorOptions) RunSelector() error
RunSelector executes the command.
type SetServiceAccountOptions ¶ added in v1.11.0
type SetServiceAccountOptions struct {
PrintFlags *genericclioptions.PrintFlags
RecordFlags *genericclioptions.RecordFlags
PrintObj printers.ResourcePrinterFunc
Recorder genericclioptions.Recorder
genericclioptions.IOStreams
// contains filtered or unexported fields
}
SetServiceAccountOptions encapsulates the data required to perform the operation.
func NewSetServiceAccountOptions ¶ added in v1.11.0
func NewSetServiceAccountOptions(streams genericclioptions.IOStreams) *SetServiceAccountOptions
NewSetServiceAccountOptions returns an initialized SetServiceAccountOptions instance
type SubjectOptions ¶ added in v1.7.0
type SubjectOptions struct {
PrintFlags *genericclioptions.PrintFlags
resource.FilenameOptions
Infos []*resource.Info
Selector string
ContainerSelector string
Output string
All bool
DryRun bool
Local bool
Users []string
Groups []string
ServiceAccounts []string
PrintObj printers.ResourcePrinterFunc
genericclioptions.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 ¶ added in v1.11.0
func NewSubjectOptions(streams genericclioptions.IOStreams) *SubjectOptions
NewSubjectOptions returns an initialized SubjectOptions instance
func (*SubjectOptions) Complete ¶ added in v1.7.0
func (o *SubjectOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
Complete completes all required options