kuberc (v1alpha1)

overrides allows changing default flag values of commands. This is especially useful, when user doesn't want to explicitly set flags each time.

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"

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.

command is the single or set of commands to execute, such as "set env" or "create"

prependArgs stores the arguments such as resource names, etc. These arguments are inserted after the alias name.

appendArgs stores the arguments such as resource names, etc. These arguments are appended to the USER_ARGS.

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.

command refers to a command whose flag's default value is changed.

flags is a list of flags storing different default values.

Flag name (long form, without dashes).

In a string format of a default value. It will be parsed by kubectl to the compatible value of the flag.