OSDOCS-17042 [CQA] Convert callouts to definition lists in MachineSet YAML #105995
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
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -16,8 +16,9 @@ endif::[] | |||||
|
|
||||||
| :_mod-docs-content-type: REFERENCE | ||||||
| [id="machineset-yaml-aws_{context}"] | ||||||
| = Sample YAML for a compute machine set custom resource on AWS | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| ifndef::edge[] | ||||||
| The sample YAML defines a compute machine set that runs in the `us-east-1a` Amazon Web Services (AWS) Local Zone and creates nodes that are labeled with | ||||||
| endif::edge[] | ||||||
|
|
@@ -29,6 +30,8 @@ This sample YAML defines a compute machine set that runs in the `us-east-1-nyc-1 | |||||
| [NOTE] | ||||||
| ==== | ||||||
| If you want to reference the sample YAML file in the context of Wavelength Zones, ensure that you replace the AWS Region and zone information with supported Wavelength Zone values. | ||||||
| Machine sets running on AWS support non-guaranteed Spot Instances. You can save on costs by using Spot Instances at a lower price compared to | ||||||
| On-Demand Instances on AWS. You can configure Spot Instances by adding `spotMarketOptions` to the `MachineSet` YAML file. | ||||||
|
Comment on lines
+33
to
+34
Contributor
There was a problem hiding this comment. This is conditioned for edge, but these lines came from the infra docs. It also applies to the standard machine set. For a standard machine set, the non-guaranteed instance type docs are in the same assembly, but for the infra machine set docs, we do need to make sure there are still links to the content as they were in e.g. So, I think probably:
It might make more sense to do this in #105997 |
||||||
| ==== | ||||||
| endif::[] | ||||||
|
|
||||||
|
|
@@ -44,69 +47,69 @@ apiVersion: machine.openshift.io/v1beta1 | |||||
| kind: MachineSet | ||||||
| metadata: | ||||||
| labels: | ||||||
| machine.openshift.io/cluster-api-cluster: <infrastructure_id> | ||||||
| ifndef::infra,edge[] | ||||||
| name: <infrastructure_id>-<role>-<zone> | ||||||
| endif::infra,edge[] | ||||||
| ifdef::infra[] | ||||||
| name: <infrastructure_id>-infra-<zone> | ||||||
| endif::infra[] | ||||||
| ifdef::edge[] | ||||||
| name: <infrastructure_id>-edge-<zone> | ||||||
| endif::edge[] | ||||||
| namespace: openshift-machine-api | ||||||
| spec: | ||||||
| replicas: 1 | ||||||
| selector: | ||||||
| matchLabels: | ||||||
| machine.openshift.io/cluster-api-cluster: <infrastructure_id> | ||||||
| ifdef::edge[] | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-edge-<zone> | ||||||
| endif::edge[] | ||||||
| ifndef::infra,edge[] | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> | ||||||
| endif::infra,edge[] | ||||||
| ifdef::infra[] | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> | ||||||
| endif::infra[] | ||||||
| template: | ||||||
| metadata: | ||||||
| labels: | ||||||
| machine.openshift.io/cluster-api-cluster: <infrastructure_id> | ||||||
| ifndef::infra,edge[] | ||||||
| machine.openshift.io/cluster-api-machine-role: <role> | ||||||
| machine.openshift.io/cluster-api-machine-type: <role> | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> | ||||||
| endif::infra,edge[] | ||||||
| ifdef::infra[] | ||||||
| machine.openshift.io/cluster-api-machine-role: infra | ||||||
| machine.openshift.io/cluster-api-machine-type: infra | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> | ||||||
| endif::infra[] | ||||||
| ifdef::edge[] | ||||||
| machine.openshift.io/cluster-api-machine-role: edge | ||||||
| machine.openshift.io/cluster-api-machine-type: edge | ||||||
| machine.openshift.io/cluster-api-machineset: <infrastructure_id>-edge-<zone> | ||||||
| endif::edge[] | ||||||
| spec: | ||||||
| metadata: | ||||||
| labels: | ||||||
| ifndef::infra,edge[] | ||||||
| node-role.kubernetes.io/<role>: "" | ||||||
| endif::infra,edge[] | ||||||
| ifdef::infra[] | ||||||
| node-role.kubernetes.io/infra: "" | ||||||
| endif::infra[] | ||||||
| ifdef::edge[] | ||||||
| machine.openshift.io/parent-zone-name: <value_of_ParentZoneName> | ||||||
| machine.openshift.io/zone-group: <value_of_GroupName> | ||||||
| machine.openshift.io/zone-type: <value_of_ZoneType> | ||||||
| node-role.kubernetes.io/edge: "" | ||||||
| endif::edge[] | ||||||
| providerSpec: | ||||||
| value: | ||||||
| ami: | ||||||
| id: <ami_id> | ||||||
| apiVersion: machine.openshift.io/v1beta1 | ||||||
| blockDevices: | ||||||
| - ebs: | ||||||
|
|
@@ -117,12 +120,12 @@ endif::edge[] | |||||
| name: aws-cloud-credentials | ||||||
| deviceIndex: 0 | ||||||
| iamInstanceProfile: | ||||||
| id: <infrastructure_id>-worker-profile | ||||||
| instanceType: m6i.large | ||||||
| kind: AWSMachineProviderConfig | ||||||
| placement: | ||||||
| availabilityZone: <zone> | ||||||
| region: <region> | ||||||
| securityGroups: | ||||||
| - filters: | ||||||
| - name: tag:Name | ||||||
|
|
@@ -137,21 +140,21 @@ ifndef::edge[] | |||||
| filters: | ||||||
| - name: tag:Name | ||||||
| values: | ||||||
| - <infrastructure_id>-private-<zone> | ||||||
| endif::edge[] | ||||||
| ifdef::edge[] | ||||||
| id: <value_of_PublicSubnetIds> | ||||||
| publicIp: true | ||||||
| endif::edge[] | ||||||
| tags: | ||||||
| - name: kubernetes.io/cluster/<infrastructure_id> | ||||||
| value: owned | ||||||
| - name: <custom_tag_name> | ||||||
| value: <custom_tag_value> | ||||||
| userDataSecret: | ||||||
| name: worker-user-data | ||||||
| ifdef::infra,edge[] | ||||||
| taints: | ||||||
| ifdef::infra[] | ||||||
| - key: node-role.kubernetes.io/infra | ||||||
| endif::infra[] | ||||||
|
|
@@ -161,26 +164,27 @@ endif::edge[] | |||||
| effect: NoSchedule | ||||||
| endif::infra,edge[] | ||||||
| ---- | ||||||
| where: | ||||||
|
|
||||||
| `<infrastructure_id>`:: Specifies the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command: | ||||||
| + | ||||||
| [source,terminal] | ||||||
| ---- | ||||||
| $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster | ||||||
| ---- | ||||||
| ifndef::infra,edge[] | ||||||
| `<infrastructure_id>-role-<zone>`:: Specifies the infrastructure ID, role node label, and zone. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| `<role>`:: Specifies the role node label to add. | ||||||
| endif::infra,edge[] | ||||||
| ifdef::infra[] | ||||||
| `<infrastructure_id>-infra-<zone>`:: Specifies the infrastructure ID, `infra` role node label, and zone. | ||||||
| `machine.openshift.io/cluster-api-machine-type`:: Requires the `infra` role node label. | ||||||
|
Contributor
There was a problem hiding this comment. Andrea has some good suggestions for a similar one in here |
||||||
| endif::infra[] | ||||||
| ifdef::edge[] | ||||||
| `<infrastructure_id>-edge-<zone>`:: Specifies the infrastructure ID, `edge` role node label, and zone. | ||||||
| `machine.openshift.io/cluster-api-machine-type`:: Requires the `edge` role node label. | ||||||
|
|
||||||
| endif::edge[] | ||||||
| `<ami_id>`:: Specifies a valid {op-system-first} Amazon Machine Image (AMI) for your AWS zone for your {product-title} nodes. If you want to use an AWS Marketplace image, you must complete the {product-title} subscription from the link:https://aws.amazon.com/marketplace/fulfillment?productId=59ead7de-2540-4653-a8b0-fa7926d5c845[AWS Marketplace] to obtain an AMI ID for your region. | ||||||
| + | ||||||
| [source,terminal] | ||||||
| ---- | ||||||
|
|
@@ -189,26 +193,26 @@ $ oc -n openshift-machine-api \ | |||||
| get machineset/<infrastructure_id>-<role>-<zone> | ||||||
| ---- | ||||||
| ifndef::edge[] | ||||||
| `<zone>`:: Specifies the zone name, for example, `us-east-1a`. | ||||||
| endif::edge[] | ||||||
| ifdef::edge[] | ||||||
| `<zone>`:: Specifies the zone name, for example, `us-east-1-nyc-1a`. | ||||||
| endif::edge[] | ||||||
| `<region>`:: Specifies the region, for example, `us-east-1`. | ||||||
| ifndef::edge[] | ||||||
| `<infrastructure_id>-private-<zone>`:: Specifies the infrastructure ID and zone, with the string `-private-` between them. | ||||||
| endif::edge[] | ||||||
| ifdef::edge[] | ||||||
| `<value_of_PublicSubnetIds>`:: Specifies the ID of the public subnet that you created in AWS {zone-type}. You created this public subnet ID when you finished the procedure for "Creating a subnet in an AWS zone". | ||||||
| endif::edge[] | ||||||
| `<custom_tag_name>`:: Optional: Specifies custom tag data for your cluster. For example, you might add an admin contact email address by specifying a `name:value` pair of `Email:\admin-email@example.com`. | ||||||
| + | ||||||
| [NOTE] | ||||||
| ==== | ||||||
| Custom tags can also be specified during installation in the `install-config.yml` file. If the `install-config.yml` file and the machine set include a tag with the same `name` data, the value for the tag from the machine set takes priority over the value for the tag in the `install-config.yml` file. | ||||||
| ==== | ||||||
| ifdef::infra,edge[] | ||||||
| `<taints>`:: Specifies a taint to prevent user workloads from being scheduled on | ||||||
| ifdef::infra[`infra`] | ||||||
| ifdef::edge[`edge`] | ||||||
| nodes. | ||||||
|
|
||||||
Oops, something went wrong.
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.
tiny typo