Skip to content

OSDOCS-14472: CPMS custom machine name prefixes #93119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+59 −0
Open

OSDOCS-14472: CPMS custom machine name prefixes #93119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bec5c54
OSDOCS-14472: CPMS custom machine name prefixes
skopacz1 May 6, 2025
137464a
SME feedback
skopacz1 May 15, 2025
e529682
more feedback
skopacz1 May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions machine_management/control_plane_machine_management/cpmso-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ include::modules/cpmso-yaml-sample-cr.adoc[leveloffset=+1]

* xref:../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]

[id="cpmso-config-options_{context}"]
== Control plane machine set configuration options

You can configure your control plane machine set to make customizations that meet your cluster's needs.

//Adding a custom prefix to control plane machine names
include::modules/cpmso-config-options.adoc[leveloffset=+2]

[id="cpmso-sample-yaml-provider-specific_{context}"]
== Provider-specific configuration options

Expand Down
51 changes: 51 additions & 0 deletions modules/cpmso-config-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Module included in the following assemblies:
//
// * machine_management/cpmso-configuration.adoc

:_mod-docs-content-type: PROCEDURE
[id="cpmso-config-prefix_{context}"]
= Adding a custom prefix to control plane machine names

You can customize the prefix of machine names created by the control plane machine set.
This can be done by editing the `ControlPlaneMachineSet` custom resource (CR)

.Procedure

. Edit the `ControlPlaneMachineSet` CR by running the following command:
+
[source,terminal]
----
$ oc edit controlplanemachineset.machine.openshift.io cluster \
-n openshift-machine-api
----

. Edit the `.spec.machineNamePrefix` field of the `ControlPlaneMachineSet` CR:
+
[source,yaml]
----
apiVersion: machine.openshift.io/v1
kind: ControlPlaneMachineSet
metadata:
name: cluster
namespace: openshift-machine-api
spec:
machineNamePrefix: <machine_prefix>
Comment on lines +31 to +32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing some Required fields here and ... to show there's more unwritten:

Suggested change
spec:
machineNamePrefix: <machine_prefix>
apiVersion: machine.openshift.io/v1
kind: ControlPlaneMachineSet
metadata:
name: cluster
namespace: openshift-machine-api
spec:
machineNamePrefix: <machine_prefix>
# ...

# ...
----
+
where `<machine_prefix>` specifies a prefix name that follows the requirements for a lowercase RFC 1123 subdomain.
+
[IMPORTANT]
====
A lowercase RFC 1123 subdomain must consist of only lowercase alphanumeric characters, hyphens ('-'), and periods ('.').
Each block, separated by periods, must start and end with an alphanumeric character.
Hyphens are not allowed at the start or end of a block, and consecutive periods are not permitted.
====

. Save your changes.

.Next steps

* For clusters that use the default `RollingUpdate` update strategy, the control plane machine set propagates changes to your control plane configuration automatically.

* For clusters that are configured to use the `OnDelete` update strategy, you must replace your control plane machines manually.