Merge pull request #91861 from EricPonvelle/numbering_fixes_hcp

Fixed numbering callouts within HCP

Author: EricPonvelle

modules/consuming-huge-pages-resource-using-the-downward-api.adoc

@@ -47,7 +47,7 @@ spec:
       requests:
         hugepages-1Gi: 2Gi
     env:
-    - name: REQUESTS_HUGEPAGES_1GI <.>
+    - name: REQUESTS_HUGEPAGES_1GI \ <1>
       valueFrom:
         resourceFieldRef:
           containerName: example
@@ -59,14 +59,14 @@ spec:
   - name: podinfo
     downwardAPI:
       items:
-        - path: "hugepages_1G_request" <.>
+        - path: "hugepages_1G_request" \ <2>
           resourceFieldRef:
             containerName: example
             resource: requests.hugepages-1Gi
             divisor: 1Gi
 ----
-<.> Specifies to read the resource use from `requests.hugepages-1Gi` and expose the value as the `REQUESTS_HUGEPAGES_1GI` environment variable.
-<.> Specifies to read the resource use from `requests.hugepages-1Gi` and expose the value as the file `/etc/podinfo/hugepages_1G_request`.
+<1> Specifies to read the resource use from `requests.hugepages-1Gi` and expose the value as the `REQUESTS_HUGEPAGES_1GI` environment variable.
+<2> Specifies to read the resource use from `requests.hugepages-1Gi` and expose the value as the file `/etc/podinfo/hugepages_1G_request`.
 
 . Create the pod from the `{file-name}` file:
 +

modules/network-observability-virtualization-configuration.adoc

@@ -67,19 +67,19 @@ metadata:
 spec:
   agent:
     ebpf:
-      privileged: true            <1>
+      privileged: true \ <1>
   processor:
     advanced:
       secondaryNetworks:
-      - index:                    <2>
-        - MAC                     <3>
-        name: my-vms/l2-network   <4> 
+      - index: \ <2>
+        - MAC  \ <3>
+        name: my-vms/l2-network \ <4> 
 # ...
 ----
-<.> Ensure that the eBPF agent is in `privileged` mode so that flows are collected for secondary interfaces.
-<.> Define the fields to use for indexing the virtual machine launcher pods. It is recommended to use the `MAC` address as the indexing field to get network flows enrichment for secondary interfaces. If you have overlapping MAC address between pods, then additional indexing fields, such as `IP` and `Interface`, could be added to have accurate enrichment.
-<.> If your additional network information has a MAC address, add `MAC` to the field list.
-<.> Specify the name of the network found in the `k8s.v1.cni.cncf.io/network-status` annotation. Usually <namespace>/<network_attachement_definition_name>. 
+<1> Ensure that the eBPF agent is in `privileged` mode so that flows are collected for secondary interfaces.
+<2> Define the fields to use for indexing the virtual machine launcher pods. It is recommended to use the `MAC` address as the indexing field to get network flows enrichment for secondary interfaces. If you have overlapping MAC address between pods, then additional indexing fields, such as `IP` and `Interface`, could be added to have accurate enrichment.
+<3> If your additional network information has a MAC address, add `MAC` to the field list.
+<4> Specify the name of the network found in the `k8s.v1.cni.cncf.io/network-status` annotation. Usually <namespace>/<network_attachement_definition_name>. 
 
 . Observe VM traffic:
 .. Navigate to the *Network Traffic* page.

modules/rosa-classic-cluster-terraform-file-creation.adoc

@@ -101,7 +101,7 @@ module "rosa-classic" {
   multi_az               = var.multi_az
   create_account_roles   = true
   create_operator_roles  = true
-# Optional: Configure a cluster administrator user <.>
+# Optional: Configure a cluster administrator user \ <1>
 # 
 # Option 1: Default cluster-admin user
 # Create an administrator user (cluster-admin) and automatically
@@ -119,7 +119,7 @@ module "rosa-classic" {
 }
 EOF
 ----
-<.> Optional: Create an administrator user during cluster creation by uncommenting the appropriate parameters and editing their values.
+<1> Optional: Create an administrator user during cluster creation by uncommenting the appropriate parameters and editing their values.
 
 . Create the `variables.tf` file by running the following command:
 +

modules/rosa-hcp-aws-private-security-groups.adoc

@@ -64,9 +64,9 @@ $ export SG_ID=$(aws ec2 create-security-group --description "Granting API acces
 +
 [source,terminal]
 ----
-$ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions FromPort=443,ToPort=443,IpProtocol=tcp,IpRanges=[{CidrIp=<cidr-to-allow>}] <.> 
+$ aws ec2 authorize-security-group-ingress --group-id $SG_ID --ip-permissions FromPort=443,ToPort=443,IpProtocol=tcp,IpRanges=[{CidrIp=<cidr-to-allow>}] \ <1>
 ----
-<.> Specify the CIDR block you want to allow access from.
+<1> Specify the CIDR block you want to allow access from.
 
 . Add the new security group to the VPCE by running the following command:
 +

modules/rosa-hcp-cluster-terraform-file-creation.adoc

@@ -97,7 +97,7 @@ module "rosa-hcp" {
   aws_subnet_ids         = var.create_vpc ? var.private_cluster ? module.vpc[0].private_subnets : concat(module.vpc[0].public_subnets, module.vpc[0].private_subnets) : var.aws_subnet_ids
   create_account_roles   = true
   create_operator_roles  = true
-# Optional: Configure a cluster administrator user <.>
+# Optional: Configure a cluster administrator user \ <1>
 # 
 # Option 1: Default cluster-admin user
 # Create an administrator user (cluster-admin) and automatically
@@ -115,7 +115,7 @@ module "rosa-hcp" {
 }
 EOF
 ----
-<.> Optional: Create an administrator user during cluster creation by uncommenting the appropriate parameters and editing their values if required.
+<1> Optional: Create an administrator user during cluster creation by uncommenting the appropriate parameters and editing their values if required.
 
 . Create the `variables.tf` file by running the following command:
 +

modules/rosa-hcp-sts-creating-a-cluster-cli.adoc

@@ -40,23 +40,24 @@ When creating a {hcp-title} cluster, the default machine Classless Inter-Domain
 [source,terminal]
 ----
 $ rosa create cluster --cluster-name=<cluster_name> \ <1>
-    --mode=auto --hosted-cp [--private] \ <2> 
+    --mode=auto --hosted-cp [--private] \ <2>
     --operator-roles-prefix <operator-role-prefix> \ <3>
     --external-id <external-id> \ <4>
     --oidc-config-id <id-of-oidc-configuration> \ 
     --subnet-ids=<public-subnet-id>,<private-subnet-id>
 ----
 +
 --
-<.> Specify the name of your cluster. If your cluster name is longer than 15 characters, it will contain an autogenerated domain prefix as a subdomain for your provisioned cluster on openshiftapps.com. To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
-<.> Optional: The `--private` argument is used to create private {hcp-title} clusters. If you use this argument, ensure that you only use your private subnet ID for `--subnet-ids`.
-<.> By default, the cluster-specific Operator role names are prefixed with the cluster name and a random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _About custom Operator IAM role prefixes_.
+<1> Specify the name of your cluster. If your cluster name is longer than 15 characters, it will contain an autogenerated domain prefix as a subdomain for your provisioned cluster on openshiftapps.com. To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
+<2> Optional: The `--private` argument is used to create private {hcp-title} clusters. If you use this argument, ensure that you only use your private subnet ID for `--subnet-ids`.
+<3> By default, the cluster-specific Operator role names are prefixed with the cluster name and a random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _About custom Operator IAM role prefixes_.
 +
 [NOTE]
 ====
 If you specified custom ARN paths when you created the associated account-wide roles, the custom path is automatically detected. The custom path is applied to the cluster-specific Operator roles when you create them in a later step.
 ====
-<.> Optional: A unique identifier that might be required when you assume a role in another account.
+
+<4> Optional: A unique identifier that might be required when you assume a role in another account.
 --
 
 * If you set the environmental variables, create a cluster with a single, initial machine pool, using either a publicly or privately available API, and a publicly or privately available Ingress by running the following command:
@@ -100,6 +101,6 @@ If the installation fails or the `State` field does not change to `ready` after
 +
 [source,terminal]
 ----
-$ rosa logs install --cluster=<cluster_name> --watch \ <.>
+$ rosa logs install --cluster=<cluster_name> --watch \ <1>
 ----
-<.> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.
+<1> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.

modules/rosa-hcp-sts-creating-a-cluster-egress-lockdown-cli.adoc

@@ -31,26 +31,27 @@ When creating a {hcp-title} cluster, the default machine Classless Inter-Domain
 +
 [source,terminal]
 ----
-$ rosa create cluster --cluster-name=<cluster_name> \ <.>
-     --mode=auto --hosted-cp [--private] \ <.> 
-     --operator-roles-prefix <operator-role-prefix> \ <.>
+$ rosa create cluster --cluster-name=<cluster_name> \ <1>
+     --mode=auto --hosted-cp [--private] \
+     --operator-roles-prefix <operator-role-prefix> \ <2>
      --oidc-config-id <id-of-oidc-configuration> \
      --subnet-ids=<private-subnet-id> --region <region> \
      --machine-cidr 10.0.0.0/16 --service-cidr 172.30.0.0/16 \
      --pod-cidr 10.128.0.0/14 --host-prefix 23 \
-     --billing-account <root-acct-id> \ <.>
+     --billing-account <root-acct-id> \ <3>
      --properties zero_egress:true
 ----
 +
 --
-<.> Specify the name of your cluster. If your cluster name is longer than 15 characters, it will contain an autogenerated domain prefix as a subdomain for your provisioned cluster on openshiftapps.com. To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
-<.> By default, the cluster-specific Operator role names are prefixed with the cluster name and a random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _About custom Operator IAM role prefixes_.
+<1> Specify the name of your cluster. If your cluster name is longer than 15 characters, it will contain an autogenerated domain prefix as a subdomain for your provisioned cluster on openshiftapps.com. To customize the subdomain, use the `--domain-prefix` flag. The domain prefix cannot be longer than 15 characters, must be unique, and cannot be changed after cluster creation.
+<2> By default, the cluster-specific Operator role names are prefixed with the cluster name and a random 4-digit hash. You can optionally specify a custom prefix to replace `<cluster_name>-<hash>` in the role names. The prefix is applied when you create the cluster-specific Operator IAM roles. For information about the prefix, see _About custom Operator IAM role prefixes_.
 +
 [NOTE]
 ====
 If you specified custom ARN paths when you created the associated account-wide roles, the custom path is automatically detected. The custom path is applied to the cluster-specific Operator roles when you create them in a later step.
 ====
-<.> Provide the AWS account that is responsible for all billing.
+
+<3> Provide the AWS account that is responsible for all billing.
 --
 
 * If you set the environment variables, create a cluster with egress lockdown that has a single, initial machine pool, using a privately available API, and a privately available Ingress by running the following command:
@@ -88,6 +89,6 @@ If the installation fails or the `State` field does not change to `ready` after
 +
 [source,terminal]
 ----
-$ rosa logs install --cluster=<cluster_name> --watch \ <.>
+$ rosa logs install --cluster=<cluster_name> --watch \ <1>
 ----
-<.> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.
+<1> Optional: To watch for new log messages as the installation progresses, use the `--watch` argument.