Skip to content

Commit 38be4c1

Browse files
authored
Merge pull request #27633 from codyhoag/installer-terminology
Applying new style guidelines for Install docs
2 parents a047b83 + 8932a0b commit 38be4c1

File tree

150 files changed

+504
-507
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+504
-507
lines changed

installing/install_config/customizations.adoc

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -37,63 +37,63 @@ to @api-approvers (github) or #forum-api-review (slack).
3737
|Resource name
3838
|Description
3939

40-
|apiserver.config.openshift.io
41-
|Provides api-server configuration such as xref:../../security/certificates/api-server.adoc#api-server-certificates[certificates and certificate authorities].
40+
|`apiserver.config.openshift.io`
41+
|Provides API server configuration such as xref:../../security/certificates/api-server.adoc#api-server-certificates[certificates and certificate authorities].
4242

43-
|authentication.config.openshift.io
44-
|Controls the xref:../../authentication/understanding-identity-provider.adoc#understanding-identity-provider[identity provider]and authentication configuration for the cluster.
43+
|`authentication.config.openshift.io`
44+
|Controls the xref:../../authentication/understanding-identity-provider.adoc#understanding-identity-provider[identity provider] and authentication configuration for the cluster.
4545

46-
|build.config.openshift.io
46+
|`build.config.openshift.io`
4747
|Controls default and enforced xref:../../builds/build-configuration.adoc#build-configuration[configuration] for all builds on the cluster.
4848

49-
|console.config.openshift.io
49+
|`console.config.openshift.io`
5050
|Configures the behavior of the web console interface, including the xref:../../web_console/configuring-web-console.adoc#configuring-web-console[logout behavior].
5151

52-
|featuregate.config.openshift.io
52+
|`featuregate.config.openshift.io`
5353
|Enables xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[FeatureGates]
5454
so that you can use Tech Preview features.
5555

56-
|image.config.openshift.io
56+
|`image.config.openshift.io`
5757
|Configures how specific xref:../../openshift_images/image-configuration.adoc#image-configuration[image registries] should be treated (allowed, disallowed, insecure, CA details).
5858

59-
|ingress.config.openshift.io
59+
|`ingress.config.openshift.io`
6060
|Configuration details related to xref:../../networking/ingress-operator.adoc#nw-installation-ingress-config-asset_configuring-ingress[routing] such as the default domain for routes.
6161

62-
|oauth.config.openshift.io
62+
|`oauth.config.openshift.io`
6363
|Configures identity providers and other behavior related to xref:../../authentication/configuring-internal-oauth.adoc#configuring-internal-oauth[internal OAuth server] flows.
6464

65-
|project.config.openshift.io
65+
|`project.config.openshift.io`
6666
|Configures xref:../../applications/projects/configuring-project-creation.adoc#configuring-project-creation[how projects are created] including the project template.
6767

68-
|proxy.config.openshift.io
68+
|`proxy.config.openshift.io`
6969
|Defines proxies to be used by components needing external network access. Note: not all components currently consume this value.
7070

71-
|scheduler.config.openshift.io
72-
|Configures xref:../../nodes/scheduling/nodes-scheduler-default.adoc#nodes-scheduler-default[scheduler] behavior such as policies and default nodeselectors.
71+
|`scheduler.config.openshift.io`
72+
|Configures xref:../../nodes/scheduling/nodes-scheduler-default.adoc#nodes-scheduler-default[scheduler] behavior such as policies and default node selectors.
7373

7474
|===
7575

7676
[id="operator-configuration-resources_{context}"]
7777
== Operator configuration resources
7878

7979
These configuration resources are cluster-scoped instances, named `cluster`, which control the behavior of a specific component as
80-
owned by a particular operator.
80+
owned by a particular Operator.
8181

8282
[cols="2a,8a",options="header"]
8383
|===
8484
|Resource name
8585
|Description
8686

87-
|console.operator.openshift.io
87+
|`console.operator.openshift.io`
8888
|Controls console appearance such as branding customizations
8989

90-
|config.imageregistry.operator.openshift.io
90+
|`config.imageregistry.operator.openshift.io`
9191
|Configures xref:../../registry/configuring-registry-operator.adoc#registry-operator-configuration-resource-overview_configuring-registry-operator[internal image registry settings] such as public routing, log levels, proxy settings, resource constraints, replica counts, and storage type.
9292

93-
|config.samples.operator.openshift.io
93+
|`config.samples.operator.openshift.io`
9494
|Configures the
9595
xref:../../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Samples Operator]
96-
to control which example imagestreams and templates are installed on the cluster.
96+
to control which example image streams and templates are installed on the cluster.
9797

9898
|===
9999

@@ -113,14 +113,14 @@ documentation for details on how and when you can create additional resource ins
113113
|Namespace
114114
|Description
115115

116-
|alertmanager.monitoring.coreos.com
117-
|main
118-
|openshift-monitoring
116+
|`alertmanager.monitoring.coreos.com`
117+
|`main`
118+
|`openshift-monitoring`
119119
|Controls the xref:../../monitoring/managing-alerts.adoc#managing-alerts[Alertmanager] deployment parameters.
120120

121-
|ingresscontroller.operator.openshift.io
122-
|default
123-
|openshift-ingress-operator
121+
|`ingresscontroller.operator.openshift.io`
122+
|`default`
123+
|`openshift-ingress-operator`
124124
|Configures xref:../../networking/ingress-operator.adoc#configuring-ingress[Ingress Operator] behavior such as domain, number of replicas, certificates, and controller placement.
125125

126126
|===
@@ -135,23 +135,23 @@ You use these resources to retrieve information about the cluster. Do not edit t
135135
|===
136136
|Resource name|Instance name|Description
137137

138-
|clusterversion.config.openshift.io
139-
|version
140-
|In {product-title} {product-version}, you must not customize the ClusterVersion
138+
|`clusterversion.config.openshift.io`
139+
|`version`
140+
|In {product-title} {product-version}, you must not customize the `ClusterVersion`
141141
resource for production clusters. Instead, follow the process to
142142
xref:../../updating/updating-cluster.adoc#updating-cluster[update a cluster].
143143

144-
|dns.config.openshift.io
145-
|cluster
144+
|`dns.config.openshift.io`
145+
|`cluster`
146146
|You cannot modify the DNS settings for your cluster. You can
147147
xref:../../networking/dns-operator.adoc#dns-operator[view the DNS Operator status].
148148

149-
|infrastructure.config.openshift.io
150-
|cluster
149+
|`infrastructure.config.openshift.io`
150+
|`cluster`
151151
|Configuration details allowing the cluster to interact with its cloud provider.
152152

153-
|network.config.openshift.io
154-
|cluster
153+
|`network.config.openshift.io`
154+
|`cluster`
155155
|You cannot modify your cluster networking after installation. To customize your network, follow the process to
156156
xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[customize networking during installation].
157157

installing/install_config/installing-customizing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ there are times when it is necessary to implement a
1010
required low-level security, networking, or performance feature.
1111
Direct changes to {product-title} nodes can be done by:
1212

13-
* Creating MachineConfigs that are included in manifest files
13+
* Creating machine configs that are included in manifest files
1414
to start up a cluster during `openshift-install`.
1515

16-
* Creating MachineConfigs that are passed to running
16+
* Creating machine configs that are passed to running
1717
{product-title} nodes via the Machine Config Operator.
1818

1919
The following sections describe features that you might want to

installing/install_config/installing-restricted-networks-preparations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Before you install a cluster on infrastructure that you provision in a restricte
1111
====
1212
You must have access to the internet to obtain the necessary container images.
1313
In this procedure, you place the mirror registry on a mirror host
14-
that has access to both your network and the internet. If you do not have access
14+
that has access to both your network and the Internet. If you do not have access
1515
to a mirror host, use the disconnected procedure to copy images to a device you
1616
can move across network boundaries with.
1717
====

installing/installing-fips.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ toc::[]
77

88
Starting with version 4.3, you can install an {product-title} cluster that uses FIPS Validated / Modules in Process cryptographic libraries.
99

10-
For the {op-system-first} machines in your cluster, this change is applied when the machines are deployed based on the status of an option in the `install-config.yaml` file, which governs the cluster options that a user can change during cluster deployment. With Red Hat Enterprise Linux machines, you must enable FIPS mode when you install the operating system on the machines that you plan to use as worker machines. These configuration methods ensure that your cluster meet the requirements of a FIPS compliance audit: only FIPS Validated / Modules in Process cryptography packages are enabled before the initial system boot.
10+
For the {op-system-first} machines in your cluster, this change is applied when the machines are deployed based on the status of an option in the `install-config.yaml` file, which governs the cluster options that a user can change during cluster deployment. With {op-system-base-full} machines, you must enable FIPS mode when you install the operating system on the machines that you plan to use as worker machines. These configuration methods ensure that your cluster meet the requirements of a FIPS compliance audit: only FIPS Validated / Modules in Process cryptography packages are enabled before the initial system boot.
1111

1212
Because FIPS must be enabled before the operating system that your cluster uses boots for the first time, you cannot enable FIPS after you deploy a cluster.
1313

1414
[id="installation-about-fips-validation_{context}"]
1515
== FIPS validation in {product-title}
1616

17-
{product-title} uses certain FIPS Validated / Modules in Process modules within Red Hat Enterprise Linux (RHEL) and {op-system} for the operating system components that it uses. See link:https://access.redhat.com/articles/3359851[RHEL7 core crypto components]. For example, when users SSH into {product-title} clusters and containers, those connections are properly encrypted.
17+
{product-title} uses certain FIPS Validated / Modules in Process modules within {op-system-base} and {op-system} for the operating system components that it uses. See link:https://access.redhat.com/articles/3359851[RHEL7 core crypto components]. For example, when users SSH into {product-title} clusters and containers, those connections are properly encrypted.
1818

19-
{product-title} components are written in Go and built with Red Hats golang compiler. When you enable FIPS mode for your cluster, all {product-title} components that require cryptographic signing call RHEL and {op-system} cryptographic libraries.
19+
{product-title} components are written in Go and built with Red Hat's golang compiler. When you enable FIPS mode for your cluster, all {product-title} components that require cryptographic signing call {op-system-base} and {op-system} cryptographic libraries.
2020

2121
.FIPS mode attributes and limitations in {product-title} {product-version}
2222
[cols="8a,8a",options="header"]
@@ -25,13 +25,13 @@ Because FIPS must be enabled before the operating system that your cluster uses
2525
|Attributes
2626
|Limitations
2727

28-
|FIPS support in RHEL 7 operating systems.
28+
|FIPS support in {op-system-base} 7 operating systems.
2929
.3+|The FIPS implementation does not offer a single function that both computes hash functions and validates the keys that are based on that hash. This limitation will continue to be evaluated and improved in future {product-title} releases.
3030

3131
|FIPS support in CRI-O runtimes.
3232
|FIPS support in {product-title} services.
3333

34-
|FIPS Validated / Modules in Process cryptographic module and algorithms that are obtained from RHEL 7 and {op-system} binaries and images.
34+
|FIPS Validated / Modules in Process cryptographic module and algorithms that are obtained from {op-system-base} 7 and {op-system} binaries and images.
3535
|
3636

3737
|Use of FIPS compatible golang compiler.
@@ -52,14 +52,14 @@ To ensure that the secrets that are stored in etcd use FIPS Validated / Modules
5252
[id="installation-about-fips-components-storage_{context}"]
5353
=== Storage
5454

55-
For local storage, use RHEL-provided disk encryption or Container Native Storage that uses RHEL-provided disk encryption. By storing all data in volumes that use RHEL-provided disk encryption and enabling FIPS mode for your cluster, both data at rest and data in motion, or network data, are protected by FIPS Validated / Modules in Process encryption.
55+
For local storage, use {op-system-base}-provided disk encryption or Container Native Storage that uses {op-system-base}-provided disk encryption. By storing all data in volumes that use {op-system-base}-provided disk encryption and enabling FIPS mode for your cluster, both data at rest and data in motion, or network data, are protected by FIPS Validated / Modules in Process encryption.
5656
You can configure your cluster to encrypt the root filesystem of each node, as described
5757
in xref:../installing/install_config/installing-customizing.adoc#installing-customizing[Customizing nodes].
5858

5959
[id="installation-about-fips-components-runtimes_{context}"]
6060
=== Runtimes
6161

62-
To ensure that containers know that they are running on a host that is using FIPS Validated / Modules in Process cryptography modules, use CRI-O to manage your runtimes. CRI-O supports FIPS-Mode, in that it configures the containers to know that they are running in FIPS mode.
62+
To ensure that containers know that they are running on a host that is using FIPS Validated / Modules in Process cryptography modules, use CRI-O to manage your runtimes. CRI-O supports FIPS mode, in that it configures the containers to know that they are running in FIPS mode.
6363

6464
[id="installing-fips-mode_{context}"]
6565
== Installing a cluster in FIPS mode
@@ -75,4 +75,4 @@ To install a cluster in FIPS mode, follow the instructions to install a customiz
7575

7676
To apply `AES CBC` encryption to your etcd data store, follow the xref:../security/encrypting-etcd.adoc#encrypting-etcd[Encrypting etcd data] process after you install your cluster.
7777

78-
If you add RHEL nodes to your cluster, ensure that you enable FIPS mode on the machines before their initial boot. See xref:../machine_management/user_infra/adding-rhel-compute.adoc#adding-rhel-compute[Adding RHEL compute machines to an {product-title} cluster] and link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/chap-federal_standards_and_regulations#sec-Enabling-FIPS-Mode[Enabling FIPS Mode] in the RHEL 7 documentation.
78+
If you add {op-system-base} nodes to your cluster, ensure that you enable FIPS mode on the machines before their initial boot. See xref:../machine_management/user_infra/adding-rhel-compute.adoc#adding-rhel-compute[Adding RHEL compute machines to an {product-title} cluster] and link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/chap-federal_standards_and_regulations#sec-Enabling-FIPS-Mode[Enabling FIPS Mode] in the {op-system-base} 7 documentation.

installing/installing_aws/installing-aws-network-customizations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
6666

6767
[NOTE]
6868
====
69-
For more information on using a Network Load Balancer(NLB) on AWS, see xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc#configuring-ingress-cluster-traffic-aws-network-load-balancer[Configuring Ingress cluster traffic on AWS using a Network Load Balancer].
69+
For more information on using a Network Load Balancer (NLB) on AWS, see xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc#configuring-ingress-cluster-traffic-aws-network-load-balancer[Configuring Ingress cluster traffic on AWS using a Network Load Balancer].
7070
====
7171

7272
include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]

installing/installing_aws/installing-restricted-networks-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ an internal mirror of the installation release content.
1212
[IMPORTANT]
1313
====
1414
While you can install an {product-title} cluster by using mirrored installation
15-
release content, your cluster still requires internet access to use the AWS APIs.
15+
release content, your cluster still requires Internet access to use the AWS APIs.
1616
====
1717

1818
One way to create this infrastructure is to use the provided

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ toc::[]
88

99
Installer-provisioned installation of {product-title} requires:
1010

11-
. One provisioner node with RHEL 8.1 installed.
12-
. Three Control Plane nodes.
11+
. One provisioner node with {op-system-base-full} 8.1 installed.
12+
. Three control plane nodes.
1313
. Baseboard Management Controller (BMC) access to each node.
1414
ifeval::[{release} > 4.5]
1515
. At least one network:

installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
98
== Troubleshooting the installer workflow
109

1110
Prior to troubleshooting the installation environment, it is critical to understand the overall flow of the installer-provisioned installation on bare metal. The diagrams below provide a troubleshooting flow with a step-by-step breakdown for the environment.

installing/installing_ibm_power/installing-ibm-power.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc
2020
* Provision
2121
xref:../../storage/persistent_storage/persistent-storage-nfs.adoc#persistent-storage-nfs[persistent storage using NFS]
2222
for your cluster. To deploy a private image registry, your storage must provide
23-
ReadWriteMany access modes.
23+
`ReadWriteMany` access modes.
2424
* Review details about the
2525
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
2626
processes.

installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Ensure that installation steps are performed on a machine with access to the ins
2626
* Provision
2727
xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage]
2828
for your cluster. To deploy a private image registry, your storage must provide
29-
ReadWriteMany access modes.
29+
`ReadWriteMany` access modes.
3030
* Review details about the
3131
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
3232
processes.

0 commit comments

Comments
 (0)