Skip to content

Testing /refactor-callouts slash command on installing_aws subdir #102324

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 1 commit into
base: main
Choose a base branch
from
Open

Testing /refactor-callouts slash command on installing_aws subdir #102324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 14 additions & 6 deletions modules/install-creating-install-config-aws-edge-zones.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,20 @@ ifdef::local-zone[]
# ...
platform:
aws:
region: <region_name> <1>
region: <region_name>
compute:
- name: edge
platform:
aws:
zones: <2>
zones:
- <local_zone_name>
#...
----
+
where:
+
<region_name>:: Specifies the AWS Region name.
<zones>:: Specifies the list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
endif::local-zone[]
ifdef::wavelength-zone[]
+
Expand All @@ -55,18 +60,21 @@ ifdef::wavelength-zone[]
# ...
platform:
aws:
region: <region_name> <1>
region: <region_name>
compute:
- name: edge
platform:
aws:
zones: <2>
zones:
- <wavelength_zone_name>
#...
----
+
where:
+
<region_name>:: Specifies the AWS Region name.
<zones>:: Specifies the list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
endif::wavelength-zone[]
<1> The AWS Region name.
<2> The list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
+
.Example of a configuration to install a cluster in the `us-west-2` AWS Region that extends edge nodes to {zone-type} in `Los Angeles` and `Las Vegas` locations
+
Expand Down
16 changes: 9 additions & 7 deletions modules/installation-launching-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,18 +322,20 @@ endif::single-step,azure-restricted[]
+
[source,terminal]
----
$ ./openshift-install create cluster --dir <installation_directory> \ <1>
--log-level=info <2>
$ ./openshift-install create cluster --dir <installation_directory> \
--log-level=info
----
<1> For `<installation_directory>`, specify the
+
where:
+
<installation_directory>::
ifdef::custom-config[]
location of your customized `./install-config.yaml` file.
Specifies the location of your customized `./install-config.yaml` file.
endif::custom-config[]
ifdef::no-config[]
directory name to store the files that the installation program creates.
Specifies the directory name to store the files that the installation program creates.
endif::no-config[]
<2> To view different installation details, specify `warn`, `debug`, or
`error` instead of `info`.
--log-level:: Specifies different installation details. To view different installation details, specify `warn`, `debug`, or `error` instead of `info`.

ifdef::azure-gov,azure-private[]
+
Expand Down
10 changes: 6 additions & 4 deletions modules/installation-uninstall-clouds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,13 @@ endif::ibm-cloud,ibm-power-vs[]
[source,terminal]
----
$ ./openshift-install destroy cluster \
--dir <installation_directory> --log-level info <1> <2>
--dir <installation_directory> --log-level info
----
<1> For `<installation_directory>`, specify the path to the directory that you
stored the installation files in.
<2> To view different details, specify `warn`, `debug`, or `error` instead of `info`.
+
where:
+
<installation_directory>:: Specifies the path to the directory that you stored the installation files in.
--log-level:: Specifies different details to view. To view different details, specify `warn`, `debug`, or `error` instead of `info`.
ifndef::ibm-power-vs[]
+
[NOTE]
Expand Down
11 changes: 7 additions & 4 deletions modules/installing-a-cluster-with-multiarch-support.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,20 @@ The output must contain `release architecture multi` to indicate that the `opens
apiVersion: v1
baseDomain: example.openshift.com
compute:
- architecture: amd64 <1>
- architecture: amd64
hyperthreading: Enabled
name: worker
platform: {}
replicas: 3
controlPlane:
architecture: arm64 <2>
architecture: arm64
name: master
platform: {}
replicas: 3
# ...
----
<1> Specify the architecture of the worker node. You can set this field to either `arm64` or `amd64`.
<2> Specify the control plane node architecture. You can set this field to either `arm64` or `amd64`.
+
where:
+
compute.architecture:: Specifies the architecture of the worker node. You can set this field to either `arm64` or `amd64`.
controlPlane.architecture:: Specifies the control plane node architecture. You can set this field to either `arm64` or `amd64`.
10 changes: 6 additions & 4 deletions modules/installing-aws-edge-zones-custom-vpc-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ifdef::local-zone[]
platform:
aws:
region: us-west-2
subnets: <1>
subnets:
- publicSubnetId-1
- publicSubnetId-2
- publicSubnetId-3
Expand All @@ -47,7 +47,8 @@ platform:
- publicSubnetId-LocalZone-1
# ...
----
<1> List of subnet IDs created in the zones: Availability and {zone-type}.
+
List of subnet IDs created in the zones: Availability and {zone-type}.
endif::local-zone[]
ifdef::wavelength-zone[]
.Example installation configuration file with {zone-type} subnets
Expand All @@ -57,7 +58,7 @@ ifdef::wavelength-zone[]
platform:
aws:
region: us-west-2
subnets: <1>
subnets:
- publicSubnetId-1
- publicSubnetId-2
- publicSubnetId-3
Expand All @@ -67,7 +68,8 @@ platform:
- publicOrPrivateSubnetID-Wavelength-1
# ...
----
<1> List of subnet IDs created in the zones: Availability and {zone-type}.
+
List of subnet IDs created in the zones: Availability and {zone-type}.
endif::wavelength-zone[]

ifeval::["{context}" == "installing-aws-localzone"]
Expand Down
43 changes: 24 additions & 19 deletions modules/machineset-creating.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ endif::win[]
. Create a new YAML file that contains the compute machine set custom resource (CR) sample and is named `<file_name>.yaml`.
+
ifndef::ash[]
Ensure that you set the `<clusterID>` and `<role>` parameter values.
The `<file_name>` parameter specifies the name of the YAML file. Ensure that you set the `<clusterID>` and `<role>` parameter values.
endif::ash[]
ifdef::ash[]
Ensure that you set the `<availabilitySet>`, `<clusterID>`, and `<role>` parameter values.
The `<file_name>` parameter specifies the name of the YAML file. Ensure that you set the `<availabilitySet>`, `<clusterID>`, and `<role>` parameter values.
endif::ash[]

. Optional: If you are not sure which value to set for a specific field, you can check an existing compute machine set from your cluster.
Expand Down Expand Up @@ -111,8 +111,8 @@ apiVersion: machine.openshift.io/v1beta1
kind: MachineSet
metadata:
labels:
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
name: <infrastructure_id>-<role> <2>
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
name: <infrastructure_id>-<role>
namespace: openshift-machine-api
spec:
replicas: 1
Expand All @@ -128,17 +128,20 @@ spec:
machine.openshift.io/cluster-api-machine-type: <role>
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
spec:
providerSpec: <3>
providerSpec:
...
----
<1> The cluster infrastructure ID.
<2> A default node label.
+
where:
+
<infrastructure_id>:: The cluster infrastructure ID.
<role>:: A default node label.
+
[NOTE]
====
For clusters that have user-provisioned infrastructure, a compute machine set can only create `worker` and `infra` type machines.
====
<3> The values in the `<providerSpec>` section of the compute machine set CR are platform-specific. For more information about `<providerSpec>` parameters in the CR, see the sample compute machine set CR configuration for your provider.
providerSpec:: The values in the `<providerSpec>` section of the compute machine set CR are platform-specific. For more information about `<providerSpec>` parameters in the CR, see the sample compute machine set CR configuration for your provider.
--

ifdef::vsphere[]
Expand All @@ -157,8 +160,8 @@ template:
value:
apiVersion: machine.openshift.io/v1beta1
credentialsSecret:
name: vsphere-cloud-credentials <1>
dataDisks: <2>
name: vsphere-cloud-credentials
dataDisks:
- name: <disk_name>
provisioningMode: <mode>
sizeGiB: 10
Expand All @@ -171,22 +174,24 @@ template:
numCPUs: 4
numCoresPerSocket: 4
snapshot: ""
template: <vm_template_name> <3>
template: <vm_template_name>
userDataSecret:
name: worker-user-data <4>
name: worker-user-data
workspace:
datacenter: <vcenter_data_center_name>
datastore: <vcenter_datastore_name>
folder: <vcenter_vm_folder_path>
resourcepool: <vsphere_resource_pool>
server: <vcenter_server_address> <5>
server: <vcenter_server_address>
----
<1> The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials.
<2> The collection of data disk definitions.
For more information, see "Configuring data disks by using machine sets".
<3> The name of the {op-system} VM template for your cluster that was created during installation.
<4> The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials.
<5> The IP address or fully qualified domain name (FQDN) of the vCenter server.
+
where:
+
credentialsSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials.
dataDisks:: The collection of data disk definitions. For more information, see "Configuring data disks by using machine sets".
template:: The name of the {op-system} VM template for your cluster that was created during installation.
userDataSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials.
workspace.server:: The IP address or fully qualified domain name (FQDN) of the vCenter server.
endif::vsphere[]

. Create a `MachineSet` CR by running the following command:
Expand Down
Loading