package v1alpha1

import "k8s.io/kubectl/pkg/config/v1alpha1"

Index ¶

• Constants
• Variables
• func Convert_config_AliasOverride_To_v1alpha1_AliasOverride(in *config.AliasOverride, out *AliasOverride, s conversion.Scope) error
• func Convert_config_CommandDefaults_To_v1alpha1_CommandDefaults(in *config.CommandDefaults, out *CommandDefaults, s conversion.Scope) error
• func Convert_config_CommandOptionDefault_To_v1alpha1_CommandOptionDefault(in *config.CommandOptionDefault, out *CommandOptionDefault, s conversion.Scope) error
• func Convert_config_Preference_To_v1alpha1_Preference(in *config.Preference, out *Preference, s conversion.Scope) error
• func Convert_v1alpha1_AliasOverride_To_config_AliasOverride(in *AliasOverride, out *config.AliasOverride, s conversion.Scope) error
• func Convert_v1alpha1_CommandDefaults_To_config_CommandDefaults(in *CommandDefaults, out *config.CommandDefaults, s conversion.Scope) error
• func Convert_v1alpha1_CommandOptionDefault_To_config_CommandOptionDefault(in *CommandOptionDefault, out *config.CommandOptionDefault, s conversion.Scope) error
• func Convert_v1alpha1_Preference_To_config_Preference(in *Preference, out *config.Preference, s conversion.Scope) error
• func RegisterConversions(s *runtime.Scheme) error
• func RegisterDefaults(scheme *runtime.Scheme) error
• type AliasOverride
• func (in *AliasOverride) DeepCopy() *AliasOverride
• func (in *AliasOverride) DeepCopyInto(out *AliasOverride)
• type CommandDefaults
• func (in *CommandDefaults) DeepCopy() *CommandDefaults
• func (in *CommandDefaults) DeepCopyInto(out *CommandDefaults)
• type CommandOptionDefault
• func (in *CommandOptionDefault) DeepCopy() *CommandOptionDefault
• func (in *CommandOptionDefault) DeepCopyInto(out *CommandOptionDefault)
• type Preference
• func (in *Preference) DeepCopy() *Preference
• func (in *Preference) DeepCopyInto(out *Preference)
• func (in *Preference) DeepCopyObject() runtime.Object

Constants ¶

const GroupName = "kubectl.config.k8s.io"

GroupName is the group name used in this package

Variables ¶

var (
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions ¶

func Convert_config_AliasOverride_To_v1alpha1_AliasOverride ¶

func Convert_config_AliasOverride_To_v1alpha1_AliasOverride(in *config.AliasOverride, out *AliasOverride, s conversion.Scope) error

Convert_config_AliasOverride_To_v1alpha1_AliasOverride is an autogenerated conversion function.

func Convert_config_CommandDefaults_To_v1alpha1_CommandDefaults ¶

func Convert_config_CommandDefaults_To_v1alpha1_CommandDefaults(in *config.CommandDefaults, out *CommandDefaults, s conversion.Scope) error

Convert_config_CommandDefaults_To_v1alpha1_CommandDefaults is an autogenerated conversion function.

func Convert_config_CommandOptionDefault_To_v1alpha1_CommandOptionDefault ¶

func Convert_config_CommandOptionDefault_To_v1alpha1_CommandOptionDefault(in *config.CommandOptionDefault, out *CommandOptionDefault, s conversion.Scope) error

Convert_config_CommandOptionDefault_To_v1alpha1_CommandOptionDefault is an autogenerated conversion function.

func Convert_config_Preference_To_v1alpha1_Preference ¶

func Convert_config_Preference_To_v1alpha1_Preference(in *config.Preference, out *Preference, s conversion.Scope) error

Convert_config_Preference_To_v1alpha1_Preference is an autogenerated conversion function.

func Convert_v1alpha1_AliasOverride_To_config_AliasOverride ¶

func Convert_v1alpha1_AliasOverride_To_config_AliasOverride(in *AliasOverride, out *config.AliasOverride, s conversion.Scope) error

Convert_v1alpha1_AliasOverride_To_config_AliasOverride is an autogenerated conversion function.

func Convert_v1alpha1_CommandDefaults_To_config_CommandDefaults ¶

func Convert_v1alpha1_CommandDefaults_To_config_CommandDefaults(in *CommandDefaults, out *config.CommandDefaults, s conversion.Scope) error

Convert_v1alpha1_CommandDefaults_To_config_CommandDefaults is an autogenerated conversion function.

func Convert_v1alpha1_CommandOptionDefault_To_config_CommandOptionDefault ¶

func Convert_v1alpha1_CommandOptionDefault_To_config_CommandOptionDefault(in *CommandOptionDefault, out *config.CommandOptionDefault, s conversion.Scope) error

Convert_v1alpha1_CommandOptionDefault_To_config_CommandOptionDefault is an autogenerated conversion function.

func Convert_v1alpha1_Preference_To_config_Preference ¶

func Convert_v1alpha1_Preference_To_config_Preference(in *Preference, out *config.Preference, s conversion.Scope) error

Convert_v1alpha1_Preference_To_config_Preference is an autogenerated conversion function.

func RegisterConversions ¶

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults ¶

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

Types ¶

type AliasOverride ¶

type AliasOverride struct {
	// name is the name of alias that can only include alphabetical characters
	// If the alias name conflicts with the built-in command,
	// built-in command will be used.
	Name string `json:"name"`
	// command is the single or set of commands to execute, such as "set env" or "create"
	Command string `json:"command"`
	// prependArgs stores the arguments such as resource names, etc.
	// These arguments are inserted after the alias name.
	// +listType=atomic
	PrependArgs []string `json:"prependArgs,omitempty"`
	// appendArgs stores the arguments such as resource names, etc.
	// These arguments are appended to the USER_ARGS.
	// +listType=atomic
	AppendArgs []string `json:"appendArgs,omitempty"`
	// flags is allocated to store the flag definitions of alias.
	// flags only modifies the default value of the flag and if
	// user explicitly passes a value, explicit one is used.
	// +listType=atomic
	Options []CommandOptionDefault `json:"flags,omitempty"`
}

AliasOverride stores the alias definitions.

func (*AliasOverride) DeepCopy ¶

func (in *AliasOverride) DeepCopy() *AliasOverride

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasOverride.

func (*AliasOverride) DeepCopyInto ¶

func (in *AliasOverride) DeepCopyInto(out *AliasOverride)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommandDefaults ¶

type CommandDefaults struct {
	// command refers to a command whose flag's default value is changed.
	Command string `json:"command"`
	// flags is a list of flags storing different default values.
	// +listType=atomic
	Options []CommandOptionDefault `json:"flags"`
}

CommandDefaults stores the commands and their associated option's default values.

func (*CommandDefaults) DeepCopy ¶

func (in *CommandDefaults) DeepCopy() *CommandDefaults

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommandDefaults.

func (*CommandDefaults) DeepCopyInto ¶

func (in *CommandDefaults) DeepCopyInto(out *CommandDefaults)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CommandOptionDefault ¶

type CommandOptionDefault struct {
	// Flag name (long form, without dashes).
	Name string `json:"name"`

	// In a string format of a default value. It will be parsed
	// by kubectl to the compatible value of the flag.
	Default string `json:"default"`
}

CommandOptionDefault stores the name and the specified default value of an option.

func (*CommandOptionDefault) DeepCopy ¶

func (in *CommandOptionDefault) DeepCopy() *CommandOptionDefault

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CommandOptionDefault.

func (*CommandOptionDefault) DeepCopyInto ¶

func (in *CommandOptionDefault) DeepCopyInto(out *CommandOptionDefault)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Preference ¶

type Preference struct {
	metav1.TypeMeta `json:",inline"`

	// overrides allows changing default flag values of commands.
	// This is especially useful, when user doesn't want to explicitly
	// set flags each time.
	// +listType=atomic
	Defaults []CommandDefaults `json:"overrides"`

	// aliases allow defining command aliases for existing kubectl commands, with optional default flag values.
	// If the alias name collides with a built-in command, built-in command always takes precedence.
	// Flag overrides defined in the overrides section do NOT apply to aliases for the same command.
	// kubectl [ALIAS NAME] [USER_FLAGS] [USER_EXPLICIT_ARGS] expands to
	// kubectl [COMMAND] # built-in command alias points to
	//         [KUBERC_PREPEND_ARGS]
	//         [USER_FLAGS]
	//         [KUBERC_FLAGS] # rest of the flags that are not passed by user in [USER_FLAGS]
	//         [USER_EXPLICIT_ARGS]
	//         [KUBERC_APPEND_ARGS]
	// e.g.
	// - name: runx
	//   command: run
	//   flags:
	//   - name: image
	//     default: nginx
	//   appendArgs:
	//   - --
	//   - custom-arg1
	// For example, if user invokes "kubectl runx test-pod" command,
	// this will be expanded to "kubectl run --image=nginx test-pod -- custom-arg1"
	// - name: getn
	//   command: get
	//   flags:
	//   - name: output
	//     default: wide
	//   prependArgs:
	//   - node
	// "kubectl getn control-plane-1" expands to "kubectl get node control-plane-1 --output=wide"
	// "kubectl getn control-plane-1 --output=json" expands to "kubectl get node --output=json control-plane-1"
	// +listType=atomic
	Aliases []AliasOverride `json:"aliases"`
}

Preference stores elements of KubeRC configuration file

func (*Preference) DeepCopy ¶

func (in *Preference) DeepCopy() *Preference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Preference.

func (*Preference) DeepCopyInto ¶

func (in *Preference) DeepCopyInto(out *Preference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Preference) DeepCopyObject ¶

func (in *Preference) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

Source Files ¶

doc.go register.go types.go zz_generated.conversion.go zz_generated.deepcopy.go zz_generated.defaults.go