Skip to content

Commit 1f214c6

Browse files
Apply suggestions from code review
Co-authored-by: Stefan Büringer <[email protected]>
1 parent d3b9d92 commit 1f214c6

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/configuration.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- [Floating IP](#floating-ip)
99
- [SSH authorized key](#ssh-authorized-key)
1010
- [OpenStack credential](#openstack-credential)
11-
- [Avaialability zone](#avaialability-zone)
11+
- [Availability zone](#availability-zone)
1212
- [DNS server](#dns-server)
1313
- [Optional Configuration](#optional-configuration)
1414
- [Network Filters](#network-filters)
@@ -31,7 +31,7 @@ Note: You can use [the template file](../templates/cluster-template.yaml) by man
3131

3232
## Operating system image
3333

34-
We currently depend on an update version of cloud-init otherwise the operating system choice is yours. The kubeadm bootstrap provider we're using also depends on some pre-installed software like a controller-runtime, kubelet, kubeadm, etc.. . For an examples how to build such an image take a look at [image-builder (openstack)](https://image-builder.sigs.k8s.io/capi/providers/openstack.html).
34+
We currently depend on an up-to-date version of cloud-init otherwise the operating system choice is yours. The kubeadm bootstrap provider we're using also depends on some pre-installed software like a container runtime, kubelet, kubeadm, etc.. . For an examples how to build such an image take a look at [image-builder (openstack)](https://image-builder.sigs.k8s.io/capi/providers/openstack.html).
3535

3636
The image can be referenced by exposing it as an environment variable `OPENSTACK_IMAGE_NAME`.
3737

@@ -63,7 +63,7 @@ The ssh public key is required. This key does not need to be created by OpenStac
6363

6464
The public key must be exposed as an environment variable `OPENSTACK_SSH_AUTHORIZED_KEY`.
6565

66-
If you want to login to each machine by ssh, you have to configure security groups. If `spec.managedSecurityGroups` of `OpenStackCluster` set to true, two security groups will be created and added to the instances. One is `k8s-cluster-${NAMESPACE}-${CLUSTER_NAME}-secgroup-controlplane`, another is `k8s-cluster-${NAMESPACE}-${CLUSTER_NAME}-secgroup-worker`. These security group rules include the kubeadm's [Check required ports](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#check-required-ports) so that each node can not be logged in through ssh by default. Please add existing security group allowing ssh port to OpenStackMachineTemplate spec. Here is an example:
66+
If you want to login to each machine by ssh, you have to configure security groups. If `spec.managedSecurityGroups` of `OpenStackCluster` set to true, two security groups will be created and added to the instances. One is `k8s-cluster-${NAMESPACE}-${CLUSTER_NAME}-secgroup-controlplane`, another is `k8s-cluster-${NAMESPACE}-${CLUSTER_NAME}-secgroup-worker`. These security group rules include the kubeadm's [Check required ports](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#check-required-ports) so that each node can not be logged in through ssh by default. Please add pre-existing security group allowing ssh port to OpenStackMachineTemplate spec. Here is an example:
6767

6868
```yaml
6969
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3
@@ -94,7 +94,7 @@ The following variables are set.
9494
| OPENSTACK_CLOUD_PROVIDER_CONF_B64 | The content of [cloud.conf](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#cloud-conf) which is used by OpenStack cloud provider |
9595
| OPENSTACK_CLOUD_CACERT_B64 | (Optional) The content of your custom CA file which can be specified in your clouds.yaml by `ca-file` |
9696

97-
## Avaialability zone
97+
## Availability zone
9898

9999
The availability zone names must be exposed as an environment variable `OPENSTACK_FAILURE_DOMAIN`.
100100

@@ -229,4 +229,3 @@ If creating servers in your OpenStack takes a long time, you can increase the ti
229229
## Custom pod network CIDR
230230

231231
If `192.168.0.0/16` is already in use within your network, you must select a different pod network CIDR. You have to replace the CIDR `192.168.0.0/16` with your own in the generated file.
232-

0 commit comments

Comments
 (0)