mirrors/k3d
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add usage section in config file docs

Browse Source
This commit is contained in:
iwilltry42 2021-03-12 08:26:40 +01:00
parent 3d1a670790
commit d0216fd13b
No known key found for this signature in database
GPG Key ID: 7BA57AD1CFF16110
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/usage/configfile.md
View File

@ -13,6 +13,14 @@ This allows you to define all the things that you defined with CLI flags before
- k3d options are bundled in a scope named `options.k3d`, where `--no-rollback` is defined as `options.k3d.disableRollback` - k3d options are bundled in a scope named `options.k3d`, where `--no-rollback` is defined as `options.k3d.disableRollback`
- repeatable flags (like `--port`) are reflected as YAML lists - repeatable flags (like `--port`) are reflected as YAML lists
## Usage
Using a config file is as easy as putting it in a well-known place in your file system and then referencing it via flag:
- All options in config file: `k3d cluster create --config /home/me/my-awesome-config.yaml` (must be `.yaml`/`.yml`)
- With CLI override (name): `k3d cluster create somename --config /home/me/my-awesome-config.yaml`
- With CLI override (extra volume): `k3d cluster create --config /home/me/my-awesome-config.yaml --volume '/some/path:/some:path@server[0]'`
## Required Fields ## Required Fields
As of the time of writing this documentation, the config file only **requires** you to define two fields: As of the time of writing this documentation, the config file only **requires** you to define two fields: