Skip to content

Commit

Permalink
higher-level doc on cli/config interaction
Browse files Browse the repository at this point in the history
  • Loading branch information
jsievenpiper committed Mar 12, 2021
1 parent 55d3c2e commit bc8e491
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions site/content/docs/user/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ To use this config, place the contents in a file `config.yaml` and then run

You can also include a full file path like `kind create cluster --config=/foo/bar/config.yaml`.

### A Note On CLI Parameters and Configuration Files

Unless otherwise noted, parameters passed to the CLI take precedence over their
equivalents in a config file. For example, if you invoke:

{{< codeFromInline lang="bash" >}}
kind create cluster --name my-cluster
{{< /codeFromInline >}}

The name `my-cluster` will be used regardless of the presence of that value in
your config file.

## Cluster-Wide Options

The following high level options are available.
Expand All @@ -52,10 +64,6 @@ apiVersion: kind.x-k8s.io/v1alpha4
name: app-1-cluster
{{< /codeFromInline >}}

This name will be used unless you invoke `kind create cluster` with the `--name`
option as well (for example `kind create cluster --config=config.yml --name other`),
in which case `other` will be used since CLI args take precedence.

### Feature Gates

Kubernetes [feature gates] can be enabled cluster-wide across all Kubernetes
Expand Down

0 comments on commit bc8e491

Please sign in to comment.