Skip to content

Commit

Permalink
Merge branch 'master' into fix/machineset-ignore-fields
Browse files Browse the repository at this point in the history
  • Loading branch information
DebakelOrakel authored Jun 18, 2024
2 parents 3541fbd + af08510 commit 1dbb524
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/modules/ROOT/pages/references/parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,14 @@ type:: dictionary
default:: empty

A dictionary of node groups to create on the cluster.
It's centered around the MachineSet CRD but also takes care of some additional aspects like zone distribution and auto scaling.
It's centered around the `MachineSet` CRD but also takes care of some additional aspects like zone distribution and auto scaling.

The top level key is the name of each set of machines.
Each set of machines has the values described below.

If an entry has value `null`, no `MachineSet` is created for that entry.
This allows users to remove entries in the hierarchy.

=== `annotations`

[horizontal]
Expand Down Expand Up @@ -162,7 +165,9 @@ default:: worker

The role of the created Nodes.
The value will be added as the `node-role.kubernetes.io/<role>: ""` label to nodes.
The `worker` role label will always be added to inherit the base configuration for nodes.
Unless `role` is set to `master`, the `worker` role label will always be added to inherit the base configuration for nodes.

When `role` is set to `master`, the component will create a `ControlPlaneMachineSet` instead of a `MachineSet`.

[NOTE]
====
Expand All @@ -175,7 +180,7 @@ In order to add additional labels to the resulting Node object, use `spec.templa
type:: dictionary
default:: See <<defaultSpec>>.

This gives you the full control over the resulting MachineSet.
This gives you the full control over the resulting `MachineSet` or `ControlPlaneMachineSet`.
Values given here will be merged with precedence with the defaults configured in <<defaultSpec>>.
The values can be everything that's accepted in the `spec` field of a `machinesets.machine.openshift.io` object.

Expand Down

0 comments on commit 1dbb524

Please sign in to comment.