Skip to content

Commit aeab79b

Browse files
authored
📖 Docs of HetznerCluster, fixed typo make "list vs item" more clear. (#1532)
📖 Docs HetznerCluster, fixed typo make list vs item more clear.
1 parent 6024a54 commit aeab79b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/caph/03-reference/02-hetzner-cluster.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ If you are using your own load balancer, you need to point towards it and config
4040
| `controlPlaneRegions` | `[]string` | `[]string{fsn1}` | no | This is the base for the failureDomains of the cluster |
4141
| `sshKeys` | `object` | | no | Cluster-wide SSH keys that serve as default for machines as well |
4242
| `sshKeys.hcloud` | `[]object` | | no | SSH keys for hcloud |
43-
| `sshKeys.hcloud.name` | `string` | | yes | Name of SSH key |
44-
| `sshKeys.hcloud.fingerprint` | `string` | | no | Fingerprint of SSH key - used by the controller |
43+
| `sshKeys.hcloud[].name` | `string` | | yes | Name of SSH key |
44+
| `sshKeys.hcloud[].fingerprint` | `string` | | no | Fingerprint of SSH key - used by the controller |
4545
| `sshKeys.robotRescueSecretRef` | `object` | | no | Reference to the secret where the SSH key for the rescue system is stored |
4646
| `sshKeys.robotRescueSecretRef.name` | `string` | | yes | Name of the secret |
4747
| `sshKeys.robotRescueSecretRef.key` | `object` | | yes | Details about the keys used in the data of the secret |
@@ -58,12 +58,12 @@ If you are using your own load balancer, you need to point towards it and config
5858
| `controlPlaneLoadBalancer.type` | `string` | `lb11` | no | Type of load balancer. One of lb11, lb21, lb31 |
5959
| `controlPlaneLoadBalancer.port` | `int` | `6443` | no | Load balancer port. Must be in range 1-65535 |
6060
| `controlPlaneLoadBalancer.extraServices` | `[]object` | | no | Defines extra services of load balancer |
61-
| `controlPlaneLoadBalancer.extraServices.protocol` | `string` | | yes | Defines protocol. Must be one of https, http, or tcp |
62-
| `controlPlaneLoadBalancer.extraServices.listenPort` | `int` | | yes | Defines listen port. Must be in range 1-65535 |
63-
| `controlPlaneLoadBalancer.extraServices.destinationPort` | `int` | | yes | Defines destination port. Must be in range 1-65535 |
64-
| `hcloudPlacementGroup` | `[]object` | | no | List of placement groups that should be defined in Hetzner API |
65-
| `hcloudPlacementGroup.name` | `string` | | yes | Name of placement group |
66-
| `hcloudPlacementGroup.type` | `string` | `type` | no | Type of placement group. Hetzner only supports 'spread' |
61+
| `controlPlaneLoadBalancer.extraServices[].protocol` | `string` | | yes | Defines protocol. Must be one of https, http, or tcp |
62+
| `controlPlaneLoadBalancer.extraServices[].listenPort` | `int` | | yes | Defines listen port. Must be in range 1-65535 |
63+
| `controlPlaneLoadBalancer.extraServices[].destinationPort` | `int` | | yes | Defines destination port. Must be in range 1-65535 |
64+
| `hcloudPlacementGroups` | `[]object` | | no | List of placement groups that should be defined in Hetzner API |
65+
| `hcloudPlacementGroups[].name` | `string` | | yes | Name of placement group |
66+
| `hcloudPlacementGroups[].type` | `string` | `type` | no | Type of placement group. Hetzner only supports 'spread' |
6767
| `hetznerSecret` | `object` | | yes | Reference to secret where Hetzner API credentials are stored |
6868
| `hetznerSecret.name` | `string` | | yes | Name of secret |
6969
| `hetznerSecret.key` | `object` | | yes | Reference to the keys that are used in the secret, either `hcloudToken` or `hetznerRobotUser` and `hetznerRobotPassword` need to be specified |

0 commit comments

Comments
 (0)