Skip to content

Commit

Permalink
Merge pull request #2103 from jsievenpiper/name-config-docs
Browse files Browse the repository at this point in the history
Add Documentation for Cluster Name via Yaml Configuration
  • Loading branch information
BenTheElder authored Mar 15, 2021
2 parents efcd23b + bc8e491 commit 590dd55
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions site/content/docs/user/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,34 @@ 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.

NOTE: not all options are documented yet! We will fix this with time, PRs welcome!

### Name Your Cluster

You can give your cluster a name by specifying it in your config:

{{< codeFromInline lang="yaml" >}}
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
name: app-1-cluster
{{< /codeFromInline >}}

### Feature Gates

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

0 comments on commit 590dd55

Please sign in to comment.