Skip to content

Commit

Permalink
docs: add --canonical-k8s-channel to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jnsgruk committed Oct 24, 2024
1 parent 7ea26ea commit 7dd9b27
Showing 1 changed file with 3 additions and 27 deletions.
30 changes: 3 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ the environment variable version will always take precedent. The equivalents are
| Flag | Env Var |
| :------------------------: | :--------------------------------: |
| `--juju-channel` | `CONCIERGE_JUJU_CHANNEL` |
| `--canonical-k8s-channel` | `CONCIERGE_CANONICAL_K8S_CHANNEL` |
| `--microk8s-channel` | `CONCIERGE_MICROK8S_CHANNEL` |
| `--lxd-channel` | `CONCIERGE_LXD_CHANNEL` |
| `--charmcraft-channel` | `CONCIERGE_CHARMCRAFT_CHANNEL` |
Expand Down Expand Up @@ -139,21 +140,6 @@ juju:

# (Required): Define the providers to be installed and bootstrapped.
providers:
# (Optional) Canonical K8s provider configuration.
canonical-k8s:
# (Optional) Enable or disable Canonical K8s.
enable: true | false
# (Optional) Whether or not to bootstrap a controller onto Canonical K8s.
bootstrap: true | false
# (Optional): Channel from which to install Canonical K8s.
channel: <channel>
# (Optional): Canonical K8s addons to enable.
features:
# (Optional) Name of the Canonical K8s feature. E.g. `load-balancer`.
<feature name>:
# (Optional) Feature configuration key/value
<key>: <value>

# (Optional) MicroK8s provider configuration.
microk8s:
# (Optional) Enable or disable MicroK8s.
Expand Down Expand Up @@ -260,19 +246,9 @@ juju:
automatically-retry-hooks: "false"
providers:
canonical-k8s:
microk8s:
enable: true
bootstrap: true
channel: 1.31/candidate
features:
local-storage:
load-balancer:
l2-mode: true
cidrs: 10.64.140.43/32
microk8s:
enable: false
bootstrap: false
channel: 1.31-strict/stable
addons:
- hostpath-storage
Expand Down Expand Up @@ -354,7 +330,7 @@ To run any of the tests on a locally provisioned machine, use the `github-ci` ba

```bash
# List available tests
$ spread -list github-ci:
$ spread --list github-ci:
# Run all of the tests
$ spread -v github-ci:
# Run a particular test
Expand Down

0 comments on commit 7dd9b27

Please sign in to comment.