Custom bootstrap configuration Documentation #935
Conversation
There was a problem hiding this comment.
LGTM overall, great work! A few points I'd like to bring up
- IIRC All features are disabled by default when a config file is used unless
enabled: trueis set exclusively for desired features. I feel like we should mention this somewhere here. See https://github.com/canonical/k8s-snap/blob/main/tests/integration/templates/bootstrap-all.yaml for example - Another point is we can pass a "bootstrap file" to the
join-clustercommand as well, which is mostly used to adjust per-node config. Should we make this into another page like join config or mention it here? @nhennigan
Just double checking: according to the bootstrap reference guide the network, dns and gateway are by default enabled and the rest disabled. Is that wrong? |
There was a problem hiding this comment.
Great work @louiseschmidtgen, thanks a lot! LGTM overall, just some minor nits.
There was a problem hiding this comment.
Generally LGTM, added a couple of comments.
Great work @louiseschmidtgen
louiseschmidtgen
requested review from
bschimke95,
HomayoonAlimohammadi,
nhennigan and
berkayoz
| When creating a {{ product }} cluster that differs from the default | ||
| configuration you can choose to use a custom bootstrap configuration. | ||
| The CLI's interactive mode or a custom bootstrap configuration file allow you | ||
| to modify the configuration of the first node that will join your cluster. |
There was a problem hiding this comment.
The first node will always be control plane yes? Join the cluster implies it already exists. Suggestion: the first node of your cluster.
I think it is important to add the line about providing a config file disabling the features by default. The user should be aware of exactly the implications of using a custom config file.
Mateo also did a similar page for the charms here where the worker nodes custom config join was a separate page. I liked how he had different workers configs for different workloads. It is not a massive deal whether this is two separate pages or one but I would lean towards two. |
|
Agreed @nhennigan , we should definitely mention it. I recall a user hitting this case and getting confused. And for @louiseschmidtgen to verify that features are disabled unless specified you can bootstrap a cluster with pod-cidr: 10.100.0.0/16
service-cidr: 10.200.0.0/16as the config file and check |
|
@nhennigan and @berkayoz I've corrected the default feature settings reference. |
|
|
||
| ``` {note} | ||
| By default all features including network, dns, gateway, ingress, load-balancer |
There was a problem hiding this comment.
I would add when using a custom bootstrap configuration file. They are not set disabled by default if you use the generic bootstrap
Custom bootstrap configuration Documentation
This PR adds the custom bootstrap configuration documentation which includes bootstrapping with the interactive mode and through a configuration file.