Skip to content

Commit

Permalink
Update docs to make worker nodes count optional (#8276)
Browse files Browse the repository at this point in the history
Co-authored-by: Saurabh Parekh <sjparekh@amazon.com>
  • Loading branch information
eks-distro-pr-bot and sp1999 authored Jun 10, 2024
1 parent ec80743 commit af9391a
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ You can omit `workerNodeGroupConfigurations` when creating Bare Metal clusters.
>**_NOTE:_** Empty `workerNodeGroupConfigurations` is not supported when Kubernetes version <= 1.21.

### workerNodeGroupConfigurations[*].count (optional)
Number of worker nodes. Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.
Number of worker nodes. (default: `1`) Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.

Refers to [troubleshooting machine health check remediation not allowed]({{< relref "../../troubleshooting/troubleshooting/#machine-health-check-shows-remediation-is-not-allowed" >}}) and choose a sufficient number to allow machine health check remediation.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/cloudstack/cloud-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,8 @@ If this is a standalone cluster or if it were serving as the management cluster
This takes in a list of node groups that you can define for your workers.
You may define one or more worker node groups.

### workerNodeGroupConfigurations[*].count (required)
Number of worker nodes. Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.
### workerNodeGroupConfigurations[*].count (optional)
Number of worker nodes. (default: `1`) Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.

Refers to [troubleshooting machine health check remediation not allowed]({{< relref "../../troubleshooting/troubleshooting/#machine-health-check-shows-remediation-is-not-allowed" >}}) and choose a sufficient number to allow machine health check remediation.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/nutanix/nutanix-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ creation process are [here]({{< relref "./nutanix-prereq/#prepare-a-nutanix-envi
### workerNodeGroupConfigurations (required)
This takes in a list of node groups that you can define for your workers. You may define one or more worker node groups.

### workerNodeGroupConfigurations[*].count (required)
Number of worker nodes. Optional if `autoscalingConfiguration` is used, in which case count will default to `autoscalingConfiguration.minCount`.
### workerNodeGroupConfigurations[*].count (optional)
Number of worker nodes. (default: `1`) Optional if `autoscalingConfiguration` is used, in which case count will default to `autoscalingConfiguration.minCount`.

Refers to [troubleshooting machine health check remediation not allowed]({{< relref "../../troubleshooting/troubleshooting/#machine-health-check-shows-remediation-is-not-allowed" >}}) and choose a sufficient number to allow machine health check remediation.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/getting-started/snow/snow-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,8 @@ the existing nodes.
This takes in a list of node groups that you can define for your workers.
You may define one or more worker node groups.

### workerNodeGroupConfigurations[*].count (required)
Number of worker nodes. Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.
### workerNodeGroupConfigurations[*].count (optional)
Number of worker nodes. (default: `1`) Optional if autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.

Refers to [troubleshooting machine health check remediation not allowed]({{< relref "../../troubleshooting/troubleshooting/#machine-health-check-shows-remediation-is-not-allowed" >}}) and choose a sufficient number to allow machine health check remediation.

Expand Down
6 changes: 3 additions & 3 deletions docs/content/en/docs/getting-started/vsphere/vsphere-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ spec:
name: my-cluster-machines
kubernetesVersion: <span>"1.25"</span> <a href="#kubernetesversion-required"># Kubernetes version to use for the cluster (required)</a>
workerNodeGroupConfigurations: <a href="#workernodegroupconfigurations-required"># List of node groups you can define for workers (required) </a>
- count: <span style="color:green">2</span> <a href="#workernodegroupconfigurationscount-required"># Number of worker nodes </a>
- count: <span style="color:green">2</span> <a href="#workernodegroupconfigurationscount-optional"># Number of worker nodes </a>
machineGroupRef: <a href="#workernodegroupconfigurationsmachinegroupref-required"># vSphere-specific Kubernetes node objects (required) </a>
kind: VSphereMachineConfig
name: my-cluster-machines
Expand Down Expand Up @@ -176,8 +176,8 @@ the existing nodes.
This takes in a list of node groups that you can define for your workers.
You may define one or more worker node groups.

### workerNodeGroupConfigurations[*].count (required)
Number of worker nodes. Optional if the [cluster autoscaler curated package]({{< relref "../../packages/cluster-autoscaler/addclauto" >}}) is installed and autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.
### workerNodeGroupConfigurations[*].count (optional)
Number of worker nodes. (default: `1`) Optional if the [cluster autoscaler curated package]({{< relref "../../packages/cluster-autoscaler/addclauto" >}}) is installed and autoscalingConfiguration is used, in which case count will default to `autoscalingConfiguration.minCount`.

Refers to [troubleshooting machine health check remediation not allowed]({{< relref "../../troubleshooting/troubleshooting/#machine-health-check-shows-remediation-is-not-allowed" >}}) and choose a sufficient number to allow machine health check remediation.

Expand Down

0 comments on commit af9391a

Please sign in to comment.