diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index a708d756340e7..8f7e9abf421ba 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -75,6 +75,7 @@ operator to use or manage a cluster. * [kubeconfig (v1)](/docs/reference/config-api/kubeconfig.v1/) +* [kuberc (v1alpha1)](/docs/reference/config-api/kuberc.v1alpha1/) * [kube-apiserver admission (v1)](/docs/reference/config-api/apiserver-admission.v1/) * [kube-apiserver configuration (v1alpha1)](/docs/reference/config-api/apiserver-config.v1alpha1/) and * [kube-apiserver configuration (v1beta1)](/docs/reference/config-api/apiserver-config.v1beta1/) and @@ -84,7 +85,6 @@ operator to use or manage a cluster. [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) [kubelet configuration (v1)](/docs/reference/config-api/kubelet-config.v1/) * [kubelet credential providers (v1)](/docs/reference/config-api/kubelet-credentialprovider.v1/) -* [kube-scheduler configuration (v1beta3)](/docs/reference/config-api/kube-scheduler-config.v1beta3/) and [kube-scheduler configuration (v1)](/docs/reference/config-api/kube-scheduler-config.v1/) * [kube-controller-manager configuration (v1alpha1)](/docs/reference/config-api/kube-controller-manager-config.v1alpha1/) * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) diff --git a/content/en/docs/reference/config-api/kuberc.v1alpha1.md b/content/en/docs/reference/config-api/kuberc.v1alpha1.md new file mode 100644 index 0000000000000..b3f743b2785e7 --- /dev/null +++ b/content/en/docs/reference/config-api/kuberc.v1alpha1.md @@ -0,0 +1,218 @@ +--- +title: kuberc (v1alpha1) +content_type: tool-reference +package: kubectl.config.k8s.io/v1alpha1 +auto_generated: true +--- + + +## Resource Types + + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + + +## `Preference` {#kubectl-config-k8s-io-v1alpha1-Preference} + + + +

Preference stores elements of KubeRC configuration file

+ + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		kubectl.config.k8s.io/v1alpha1
kind
string		Preference
overrides [Required]
+[]CommandOverride +		 +

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

+
aliases [Required]
+[]AliasOverride +		 +

aliases allows 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"
      • +
    +
    • +
+
+ +## `AliasOverride` {#kubectl-config-k8s-io-v1alpha1-AliasOverride} + + +**Appears in:** + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + + +

AliasOverride stores the alias definitions.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 +

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 [Required]
+string +		 +

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

+
prependArgs [Required]
+[]string +		 +

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

+
appendArgs [Required]
+[]string +		 +

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

+
flags [Required]
+[]CommandOverrideFlag +		 +

Flag is allocated to store the flag definitions of alias. +Flag only modifies the default value of the flag and if +user explicitly passes a value, explicit one is used.

+
+ +## `CommandOverride` {#kubectl-config-k8s-io-v1alpha1-CommandOverride} + + +**Appears in:** + +- [Preference](#kubectl-config-k8s-io-v1alpha1-Preference) + + +

CommandOverride stores the commands and their associated flag's +default values.

+ + + + + + + + + + + + + + +
FieldDescription
command [Required]
+string +		 +

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

+
flags [Required]
+[]CommandOverrideFlag +		 +

Flags is a list of flags storing different default values.

+
+ +## `CommandOverrideFlag` {#kubectl-config-k8s-io-v1alpha1-CommandOverrideFlag} + + +**Appears in:** + +- [AliasOverride](#kubectl-config-k8s-io-v1alpha1-AliasOverride) + +- [CommandOverride](#kubectl-config-k8s-io-v1alpha1-CommandOverride) + + +

CommandOverrideFlag stores the name and the specified default +value of the flag.

+ + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 +

Flag name (long form, without dashes).

+
default [Required]
+string +		 +

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

+
+ \ No newline at end of file