Skip to content

Commit 58ff0b7

Browse files
committed
OSDOCS-14447: Installing recs visibility
1 parent cab48b5 commit 58ff0b7

11 files changed

+59
-26
lines changed

disconnected/mirroring/about-installing-oc-mirror-v2.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ After your cluster is configured to use the resources generated by oc-mirror plu
8282

8383
* xref:../../extensions/catalogs/disconnected-catalogs.adoc#disconnected-catalogs[Disconnected environment support in {olmv1}]
8484

85-
// Delete Feature
86-
// workflows of delete feature
85+
// Deletion of images from your disconnected environment
8786
include::modules/oc-mirror-workflows-delete-v2.adoc[leveloffset=+1]
8887

8988
[role="_additional-resources"]
@@ -92,7 +91,7 @@ include::modules/oc-mirror-workflows-delete-v2.adoc[leveloffset=+1]
9291

9392
include::modules/oc-mirror-v2-procedure-garbage-collector.adoc[leveloffset=+2]
9493

95-
// procedure for delete feature
94+
// Deleting images from a disconnected environment
9695
include::modules/oc-mirror-procedure-delete-v2.adoc[leveloffset=+2]
9796

9897
// About dry-run
@@ -101,13 +100,13 @@ include::modules/oc-mirror-v2-about-dry-run.adoc[leveloffset=+1]
101100
// Performing Dry-run for V2
102101
include::modules/oc-mirror-dry-run-v2.adoc[leveloffset=+2]
103102

104-
// Troubleshooting
103+
// Troubleshooting oc-mirror plugin v2 errors
105104
include::modules/oc-mirror-troubleshooting-v2.adoc[leveloffset=+1]
106105

107-
// oc-mirror-enclave-support-about
106+
// Benefits of enclave support
108107
include::modules//oc-mirror-enclave-support-about.adoc[leveloffset=+1]
109108

110-
// How to mirror to an Enclave
109+
// Mirroring to an enclave
111110
include::modules/oc-mirror-enclave-support.adoc[leveloffset=+2]
112111

113112
// Proxy support

disconnected/mirroring/installing-mirroring-creating-registry.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@ The _mirror registry for Red Hat OpenShift_ is not intended to be a substitute f
2020

2121
* An {product-title} subscription.
2222
* {op-system-base-full} 8 and 9 with Podman 3.4.2 or later and OpenSSL installed.
23-
* Fully qualified domain name for the Red Hat Quay service, which must resolve through a DNS server.
23+
* Fully qualified domain name for the Red{nbsp}Hat Quay service, which must resolve through a DNS server.
2424
* Key-based SSH connectivity on the target host. SSH keys are automatically generated for local installs. For remote hosts, you must generate your own SSH keys.
2525
* 2 or more vCPUs.
2626
* 8 GB of RAM.
27-
* About 12 GB for {product-title} {product-version} release images, or about 358 GB for {product-title} {product-version} release images and {product-title} {product-version} Red Hat Operator images. Up to 1 TB per stream or more is suggested.
27+
* About 12 GB for {product-title} {product-version} release images, or about 358 GB for {product-title} {product-version} release images and {product-title} {product-version} Red{nbsp}Hat Operator images.
2828
+
2929
[IMPORTANT]
3030
====
31-
These requirements are based on local testing results with only release images and Operator images. Storage requirements can vary based on your organization's needs. You might require more space, for example, when you mirror multiple z-streams. You can use standard link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/use_red_hat_quay/index[Red Hat Quay functionality] or the proper link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deletefulltag[API callout] to remove unnecessary images and free up space.
31+
* Up to 1 TB per stream or more is suggested.
32+
33+
* These requirements are based on local testing results with only release images and Operator images. Storage requirements can vary based on your organization's needs. You might require more space, for example, when you mirror multiple z-streams. You can use standard link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/use_red_hat_quay/index[Red{nbsp}Hat Quay functionality] or the proper link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deletefulltag[API callout] to remove unnecessary images and free up space.
3234
====
3335

3436
include::modules/mirror-registry-introduction.adoc[leveloffset=+1]

modules/agent-install-ipi-install-root-device-hints.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ The `rootDeviceHints` parameter enables the installer to provision the {op-syste
1010

1111
.Subfields
1212

13-
[cols="1,3"]
13+
[cols="1,3a"]
1414
|===
1515
| Subfield | Description
1616

17-
| `deviceName` | A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`. It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location. The hint must match the actual value exactly.
17+
| `deviceName` | A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`.
18+
[NOTE]
19+
====
20+
It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location.
21+
====
22+
23+
The hint must match the actual value exactly.
1824

1925
| `hctl` | A string containing a SCSI bus address like `0:0:0:0`. The hint must match the actual value exactly.
2026

modules/cluster-bare-metal-operator.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,15 @@ The Cluster Baremetal Operator (CBO) deploys all the components necessary to tak
3939
ifdef::cluster-caps[]
4040
The bare-metal capability is required for deployments using installer-provisioned infrastructure. Disabling the bare-metal capability can result in unexpected problems with these deployments.
4141

42-
It is recommended that cluster administrators only disable the bare-metal capability during installations with user-provisioned infrastructure that do not have any `BareMetalHost` resources in the cluster.
43-
4442
[IMPORTANT]
4543
====
4644
If the bare-metal capability is disabled, the cluster cannot provision or manage bare-metal nodes. Only disable the capability if there are no `BareMetalHost` resources in your deployment. The `baremetal` capability depends on the `MachineAPI` capability. If you enable the `baremetal` capability, you must also enable `MachineAPI`.
4745
====
46+
47+
[NOTE]
48+
====
49+
It is recommended that cluster administrators only disable the bare-metal capability during installations with user-provisioned infrastructure that do not have any `BareMetalHost` resources in the cluster.
50+
====
4851
endif::cluster-caps[]
4952

5053
ifdef::operator-ref[]

modules/installation-aws-iam-user.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@
66
[id="installation-aws-iam-user_{context}"]
77
= Creating an IAM user
88

9-
Each Amazon Web Services (AWS) account contains a root user account that is
10-
based on the email address you used to create the account. This is a
11-
highly-privileged account, and it is recommended to use it for only initial
12-
account and billing configuration, creating an initial set of users, and
13-
securing the account.
9+
Each Amazon Web Services (AWS) account contains a root user account that is based on the email address you used to create the account.
10+
11+
[IMPORTANT]
12+
====
13+
This is a highly-privileged account, and it is recommended to use it for only initial account and billing configuration, creating an initial set of users, and securing the account.
14+
====
1415

1516
Before you install {product-title}, create a secondary IAM
1617
administrative user. As you complete the

modules/installation-azure-limits.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,11 @@ ifndef::ash[]
117117
|OS Disk
118118
|7
119119
|
120-
|Each cluster machine must have a minimum of 100 GB of storage and 300 IOPS. While these are the minimum supported values, faster storage is recommended for production clusters and clusters with intensive workloads. For more information about optimizing storage for performance, see the page titled "Optimizing storage" in the "Scalability and performance" section.
120+
|Each cluster machine must have a minimum of 100 GB of storage and 300 IOPS.
121+
[NOTE]
122+
====
123+
Faster storage is recommended for production clusters and clusters with intensive workloads. For more information about optimizing storage for performance, see the page titled "Optimizing storage" in the "Scalability and performance" section.
124+
====
121125
endif::ash[]
122126

123127
|VNet

modules/installation-ibm-cloud-iam-policies-api-key.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,10 @@ endif::ibm-power-vs[]
153153
* Service ID
154154
* User
155155

156+
[NOTE]
157+
====
156158
The recommended method is to define IAM access policies in an link:https://cloud.ibm.com/docs/account?topic=account-groups[access group]. This helps organize all the access required for {product-title} and enables you to onboard users and service IDs to this group. You can also assign access to link:https://cloud.ibm.com/docs/account?topic=account-assign-access-resources[users and service IDs] directly, if desired.
159+
====
157160

158161
ifeval::["{context}" == "installing-ibm-cloud-account"]
159162
:!ibm-vpc:

modules/installation-network-user-infra.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ endif::ibm-z[]
8787
ifndef::ibm-z[]
8888
During the initial boot, the machines require an IP address configuration that is set either through a DHCP server or statically by providing the required boot options. After a network connection is established, the machines download their Ignition config files from an HTTP or HTTPS server. The Ignition config files are then used to set the exact state of each machine. The Machine Config Operator completes more changes to the machines, such as the application of new certificates or keys, after installation.
8989

90-
It is recommended to use a DHCP server for long-term management of the cluster machines. Ensure that the DHCP server is configured to provide persistent IP addresses, DNS server information, and hostnames to the cluster machines.
91-
9290
[NOTE]
9391
====
94-
If a DHCP service is not available for your user-provisioned infrastructure, you can instead provide the IP networking configuration and the address of the DNS server to the nodes at {op-system} install time. These can be passed as boot arguments if you are installing from an ISO image. See the _Installing {op-system} and starting the {product-title} bootstrap process_ section for more information about static IP provisioning and advanced networking options.
92+
* It is recommended to use a DHCP server for long-term management of the cluster machines. Ensure that the DHCP server is configured to provide persistent IP addresses, DNS server information, and hostnames to the cluster machines.
93+
94+
* If a DHCP service is not available for your user-provisioned infrastructure, you can instead provide the IP networking configuration and the address of the DNS server to the nodes at {op-system} install time. These can be passed as boot arguments if you are installing from an ISO image. See the _Installing {op-system} and starting the {product-title} bootstrap process_ section for more information about static IP provisioning and advanced networking options.
9595
====
9696
endif::ibm-z[]
9797

modules/installation-user-infra-machines-static-network.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,12 @@ The following table shows the {op-system} live installer `coreos.inst` boot opti
584584

585585
a|`coreos.inst.install_dev`
586586

587-
a|Required. The block device on the system to install to. It is recommended to use the full path, such as `/dev/sda`, although `sda` is allowed.
587+
a|Required. The block device on the system to install to.
588+
589+
[NOTE]
590+
====
591+
It is recommended to use the full path, such as `/dev/sda`, although `sda` is allowed.
592+
====
588593

589594
a|`coreos.inst.ignition_url`
590595

modules/ipi-install-root-device-hints.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,13 @@ The `rootDeviceHints` parameter enables the installer to provision the {op-syste
1313
|===
1414
| Subfield | Description
1515

16-
| `deviceName` | A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`. It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location. The hint must match the actual value exactly.
16+
| `deviceName` a| A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`.
17+
[NOTE]
18+
====
19+
It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location.
20+
====
21+
22+
The hint must match the actual value exactly.
1723

1824
| `hctl` | A string containing a SCSI bus address like `0:0:0:0`. The hint must match the actual value exactly.
1925

0 commit comments

Comments
 (0)