Skip to content

Commit a1cbed8

Browse files
committed
Update docs on specifying flavors
1 parent 2a6b6de commit a1cbed8

File tree

2 files changed

+27
-7
lines changed

2 files changed

+27
-7
lines changed

docs/book/src/clustercloudstack/configuration.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ The cluster configuration file can be generated by using [`clusterctl generate c
44
This command actually uses [a template file][template-file] and replaces the values surrounded by `${}` with environment variables.
55
You have to set all required environment variables in advance. The following sections explain some more details about what should be configured.
66

7-
Note: You can also use [template files][template-file] by manually replacing values in copies of the template file.
8-
97
```bash
108
clusterctl generate cluster capi-quickstart \
119
--kubernetes-version v1.21.3 \
@@ -14,9 +12,25 @@ clusterctl generate cluster capi-quickstart \
1412
> capi-quickstart.yaml
1513
```
1614

17-
Note: additional template files are provided, offering capabilities beyond the default template file. These can be
18-
utilized via the *clusterctl --flavor* parameter. Additional environment variables are often required by these templates.
19-
See clusterctl documentation for further details about *flavors*.
15+
You can also use [template files][template-file] by manually replacing values in copies of the template file.
16+
17+
18+
> **Note**
19+
>
20+
> Additional template files are provided, offering capabilities beyond the default template file. These can be
21+
> utilized via the *clusterctl --flavor* parameter. Additional environment variables are often required by these templates.
22+
> The following flavors are supported as of now:
23+
> - *managed-ssh*
24+
> - *ssh-material*
25+
> - *with-disk-offering*
26+
> - *with-existing-vpc-network*
27+
> - *with-kube-vip*
28+
>
29+
> To check the available variables for a flavor, execute the following command:
30+
> ```bash
31+
> clusterctl generate cluster capi-quickstart --flavor <flavor> --list-variables
32+
> ```
33+
> See clusterctl documentation for further details about *flavors*.
2034
2135
In order to fetch the configuration parameters via the terminal, please install [cmk][cmk-download] and [jq][jq-download]
2236
@@ -109,6 +123,9 @@ spec:
109123
If the network already exists, offering, gateway and netmask will be ignored.
110124
Similarly, if the VPC already exists, offering and cidr will be ignored.
111125
126+
If you want to use an existing network inside a VPC, you can specify the flavor as `with-existing-vpc-network` while
127+
generating the cluster configuration file and set the `CLOUDSTACK_VPC_NAME` environment variable to the name of the VPC.
128+
112129
#### CloudStack Endpoint Credentials Secret (*optional for provided templates when used with provided getting-started process*)
113130
114131
A reference to a Kubernetes Secret containing a YAML object containing credentials for accessing a particular CloudStack

docs/book/src/development/releasing.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
- [gcloud][gcloud-install]
99

1010
2. Set up and log in to gcloud by running `gcloud init`
11-
> Note: In order to publish any artifact, you need to be a member of the [k8s-infra-staging-capi-cloudstack][k8s-infra-staging-capi-cloudstack] group
11+
> **Note**
12+
>
13+
> In order to publish any artifact, you need to be a member of the [k8s-infra-staging-capi-cloudstack][k8s-infra-staging-capi-cloudstack] group
1214
1315
## Creating only the docker container
1416

@@ -31,7 +33,8 @@ Create the necessary release in GitHub along with the following artifacts ( foun
3133
- infrastructure-components.yaml
3234
- cluster-template*.yaml
3335

34-
> Note:
36+
> **Note**
37+
>
3538
> - The `RELEASE_TAG` should be in the format of `v<major>.<minor>.<patch>`. For example, `v0.6.0`
3639
> - For RC releases, the `RELEASE_TAG` should be in the format of `v<major>.<minor>.<patch>-rc<rc-number>`. For example, `v0.6.0-rc1`
3740
> - Before creating the release, ensure that the `metadata.yaml` file is updated with the latest release information.

0 commit comments

Comments
 (0)