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.

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

Merged
merged 1 commit into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a really generic (and perhaps not very useful) intro to the new section below. Please feel free to suggest any other wording.

Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ 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 customize your cluster to your needs.

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

[role="_additional-resources"]
.Additional resources
* xref:../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-replace_cpmso-managing-machines[Replacing a control plane machine]

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

Expand Down
51 changes: 51 additions & 0 deletions modules/cpmso-config-options.adoc
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 that the control plane machine set creates.
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>
# ...
----
+
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

* If you changed only the value of the `machineNamePrefix` parameter, clusters that use the default `RollingUpdate` update strategy are not automatically updated.
To propagate this change, you must replace your control plane machines manually, regardless of the update strategy for the cluster.
For more information, see "Replacing a control plane machine".