Skip to content

Commit 2373e96

Browse files
committed
OSDOCS-8037 ROSA docs Day 2 custom security groups UI
Omitted day 1 custom security groups UI changes until OCMUI-302 and OCMUI-1039 are closed.
1 parent 3770f73 commit 2373e96

6 files changed

+23
-8
lines changed

modules/creating-a-machine-pool-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ endif::openshift-rosa[]
4545
ifdef::openshift-rosa[]
4646
<8> Optional: Specifies the worker node disk size. The value can be in GB, GiB, TB, or TiB. Replace `<disk_size>` with a numeric value and unit, for example `--disk-size=200GiB`.
4747
<9> Optional: For Multi-AZ clusters, you can create a machine pool in a Single-AZ of your choice. Replace `<az>` with a Single-AZ.
48-
<10> Optional: For machine pools in clusters that do not have Red Hat managed VPCs, you can select additional custom security groups to use in your machine pools. You must have already created the security groups and associated them with the VPC you selected for this cluster. For more information, see the requirements for _Security groups_ in _Prepare your environment_.
48+
<10> Optional: For machine pools in clusters that do not have Red Hat managed VPCs, you can select additional custom security groups to use in your machine pools. You must have already created the security groups and associated them with the VPC you selected for this cluster. You cannot add or edit security groups after you create the machine pool. For more information, see the requirements for _Security groups_ under _Additional resources_.
4949
endif::openshift-rosa[]
5050
+
5151
[IMPORTANT]

modules/creating-a-machine-pool-ocm.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ ifdef::openshift-rosa[]
4141
endif::openshift-rosa[]
4242
ifndef::openshift-rosa[]
4343
* You created an {product-title} cluster.
44-
endif::[]
44+
endif::openshift-rosa[]
4545

4646
.Procedure
4747

@@ -51,7 +51,7 @@ endif::[]
5151

5252
. Add a *Machine pool name*.
5353

54-
. Select a *Worker node instance type* from the drop-down menu. The instance type defines the vCPU and memory allocation for each compute node in the machine pool.
54+
. Select a *Compute node instance type* from the drop-down menu. The instance type defines the vCPU and memory allocation for each compute node in the machine pool.
5555
+
5656
[NOTE]
5757
====
@@ -77,8 +77,8 @@ Alternatively, you can set your autoscaling preferences for the machine pool aft
7777
====
7878

7979
. If you did not enable autoscaling, select a compute node count:
80-
* If you deployed your cluster using a single availability zone, select a *Worker node count* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool for the zone.
81-
* If you deployed your cluster using multiple availability zones, select a *Worker node count (per zone)* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool per zone.
80+
* If you deployed your cluster using a single availability zone, select a *Compute node count* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool for the zone.
81+
* If you deployed your cluster using multiple availability zones, select a *Compute node count (per zone)* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool per zone.
8282
ifdef::openshift-rosa[]
8383
. Optional: Configure *Root disk size*.
8484
endif::openshift-rosa[]
@@ -98,6 +98,10 @@ Creating a machine pool with taints is only possible if the cluster already has
9898
Alternatively, you can add the node labels and taints after you create the machine pool.
9999
====
100100

101+
ifdef::openshift-rosa[]
102+
. Optional: Select additional custom security groups to use for nodes in this machine pool. You must have already created the security groups and associated them with the VPC you selected for this cluster. You cannot add or edit security groups after you create the machine pool. For more information, see the requirements for _Security groups_ under _Additional resources_.
103+
endif::openshift-rosa[]
104+
101105
ifdef::openshift-dedicated[]
102106
. Optional: If you deployed {product-title} on AWS using the Customer Cloud Subscription (CCS) model, use Amazon EC2 Spot Instances if you want to configure your machine pool to deploy machines as non-guaranteed AWS Spot Instances:
103107
.. Select *Use Amazon EC2 Spot Instances*.

modules/rosa-create-objects.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ $ rosa create cluster --cluster-name=<cluster_name> [arguments]
117117
|Option |Definition
118118

119119
|--additional-compute-security-group-ids <sec_group_id>
120-
|The identifier of one or more additional security groups to use in addition to the default security groups. For more information on additional security groups, see the requirements for _Security groups_ in _Prepare your environment_.
120+
|The identifier of one or more additional security groups to use in addition to the default security groups. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_.
121121

122122
a|--cluster-name <cluster_name>
123123
|Required. The name of the cluster. When used with the `create cluster` command, this argument is used to set the cluster name and to generate a sub-domain for your cluster on `openshiftapps.com`. The value for this argument must be unique within your organization.
@@ -505,7 +505,7 @@ $ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<nu
505505

506506
// Note for writers: This command works the same way as rosa create --additional-compute-security-group-ids but all subsequent machinepools are compute only so we don't specify compute here yet; consistency across commands to come in OCM-3111.
507507
|--additional-security-group-ids <sec_group_id>
508-
|The identifier of one or more additional security groups to use in addition to the default security groups for this machine pool. For more information on additional security groups, see the requirements for _Security groups_ in _Prepare your environment_.
508+
|The identifier of one or more additional security groups to use in addition to the default security groups for this machine pool. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_.
509509

510510
a|--cluster <cluster_name>\|<cluster_id>
511511
|Required: The name or ID of the cluster to which the machine pool will be added.

modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Only persistent volumes (PVs) created from the default storage class are encrypt
293293
PVs created by using any other storage class are still encrypted, but the PVs are not encrypted with this key unless the storage class is specifically configured to use this key.
294294
====
295295
296-
<10> Optional: You can select additional custom security groups to use in your cluster. You must have already created the security groups and associated them with the VPC you selected for this cluster. For more information, see the requirements for _Security groups_ in _Prepare your environment_.
296+
<10> Optional: You can select additional custom security groups to use in your cluster. You must have already created the security groups and associated them with the VPC you selected for this cluster. You cannot add or edit security groups for the default machine pools after you create the machine pool. For more information, see the requirements for _Security groups_ under _Additional resources_.
297297
<11> Optional: Enable this option only if your use case requires etcd key value encryption in addition to the control plane storage encryption that encrypts the etcd volumes by default. With this option, the etcd key values are encrypted but not the keys.
298298
+
299299
[IMPORTANT]

modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,12 @@ If you opted to use private API endpoints, you must use an existing VPC and Priv
301301
====
302302
You must ensure that your VPC is configured with a public and a private subnet for each availability zone that you want the cluster installed into. If you opted to use PrivateLink, only private subnets are required.
303303
====
304+
// Commented out until OCMUI-302 and OCMUI-1039 are complete
305+
//.. Optional: Expand *Additional security groups* and select additional custom security groups to apply to nodes in the machine pools created by default. You must have already created the security groups and associated them with the VPC you selected for this cluster. You cannot add or edit security groups to the default machine pools after you create the cluster.
306+
//+
307+
//By default, the security groups you specify will be added for all node types. Uncheck the *Apply the same security groups to all node types* checkbox to apply different security groups for each node type.
308+
//+
309+
//For more information, see the requirements for _Security groups_ under _Additional resources_.
304310

305311
. If you opted to configure a cluster-wide proxy, provide your proxy configuration details on the *Cluster-wide proxy* page:
306312
+

rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ You can edit machine pool configuration options such as scaling, adding node lab
1313

1414
include::modules/creating-a-machine-pool.adoc[leveloffset=+1]
1515
include::modules/creating-a-machine-pool-ocm.adoc[leveloffset=+2]
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
* xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#rosa-security-groups_prerequisites[Security groups]
20+
1621
include::modules/creating-a-machine-pool-cli.adoc[leveloffset=+2]
1722

1823
[role="_additional-resources"]

0 commit comments

Comments
 (0)