-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skopacz1 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
skopacz1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# ... | ||
---- | ||
+ | ||
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". |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.