Skip to content

Commit 29851e0

Browse files
committed
OSDOCS-10725 Doc for CORS-3024: RHEL 9 build of openshift-baremetal-installer
1 parent 62b1136 commit 29851e0

File tree

3 files changed

+70
-9
lines changed

3 files changed

+70
-9
lines changed

installing/installing-fips.adoc

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,28 @@ For more information about the NIST validation program, see link:https://csrc.ni
1414

1515
[IMPORTANT]
1616
====
17-
To enable FIPS mode for your cluster, you must run the installation program from a {op-system-base} 8 computer that is configured to operate in FIPS mode. Running {op-system-base} 9 with FIPS mode enabled to install an {product-title} cluster is not possible.
17+
To enable FIPS mode for your cluster, you must run the installation program from a {op-system-base} 9 computer that is configured to operate in FIPS mode, and you must use a FIPS-capable version of the installation program. See the section titled _Obtaining a FIPS-capable installation program using `oc adm extract`_.
1818
19-
For more information about configuring FIPS mode on {op-system-base}, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/security_hardening/assembly_installing-a-rhel-8-system-with-fips-mode-enabled_security-hardening[Installing the system in FIPS mode].
19+
For more information about configuring FIPS mode on {op-system-base}, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode].
2020
====
2121

2222
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.
2323

2424
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.
2525

26+
include::modules/installation-obtaining-fips-installer-oc.adoc[leveloffset=+1]
27+
28+
[role="_additional-resources"]
29+
.Additional resources
30+
31+
* xref:../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#retrieving-the-openshift-installer_ipi-install-installation-workflow[Extracting the OpenShift Container Platform installation program]
32+
33+
include::modules/installation-obtaining-fips-installer-mirror.adoc[leveloffset=+1]
34+
2635
[id="installation-about-fips-validation_{context}"]
2736
== FIPS validation in {product-title}
2837

29-
{product-title} uses certain FIPS validated or 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/3655361[RHEL8 core crypto components]. For example, when users use SSH to connect to {product-title} clusters and containers, those connections are properly encrypted.
38+
{product-title} uses certain FIPS validated or 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/3655361[RHEL core crypto components]. For example, when users use SSH to connect to {product-title} clusters and containers, those connections are properly encrypted.
3039

3140
{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.
3241

@@ -37,14 +46,12 @@ Because FIPS must be enabled before the operating system that your cluster uses
3746
|Attributes
3847
|Limitations
3948

40-
|FIPS support in {op-system-base} 8 and {op-system} operating systems.
41-
.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.
49+
|FIPS support in {op-system-base} 9 and {op-system} operating systems.
50+
.4+|The FIPS implementation does not use a function that performs hash computation and signature generation or validation in a single step. This limitation will continue to be evaluated and improved in future {product-title} releases.
4251

4352
|FIPS support in CRI-O runtimes.
4453
|FIPS support in {product-title} services.
45-
46-
|FIPS validated or Modules In Process cryptographic module and algorithms that are obtained from {op-system-base} 8 and {op-system} binaries and images.
47-
|
54+
|FIPS validated or Modules In Process cryptographic module and algorithms that are obtained from {op-system-base} 9 and {op-system} binaries and images.
4855

4956
|Use of FIPS compatible golang compiler.
5057
|TLS FIPS support is not complete but is planned for future {product-title} releases.
@@ -104,4 +111,4 @@ If you are using Azure File storage, you cannot enable FIPS mode.
104111

105112
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.
106113

107-
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/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/8/html/security_hardening/using-the-system-wide-cryptographic-policies_security-hardening#enabling-fips-mode-in-a-container_using-the-system-wide-cryptographic-policies[Enabling FIPS Mode] in the {op-system-base} 8 documentation.
114+
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/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/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode].
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assembly:
2+
// installing/installing-fips.adoc
3+
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="installation-obtaining-fips-installer-mirror_{context}"]
6+
= Obtaining a FIPS-capable installation program using the public OpenShift mirror
7+
8+
{product-title} requires the use of a FIPS-capable installation binary to install a cluster in FIPS mode. You can obtain this binary by downloading it from the public OpenShift mirror. After you have obtained the binary, proceed with the cluster installation, replacing all instances of the `openshift-install` binary with `openshift-install-fips`.
9+
10+
.Prerequisites
11+
12+
* You have access to the internet.
13+
14+
.Procedure
15+
16+
. Download the installation program from https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest-4.16/openshift-install-rhel9-amd64.tar.gz.
17+
. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ tar -xvf openshift-install-rhel9-amd64.tar.gz
22+
----
23+
+
24+
. Proceed with cluster installation, replacing all instances of the `openshift-install` command with `openshift-install-fips`.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assembly:
2+
// installing/installing-fips.adoc
3+
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="installation-obtaining-fips-installer-oc_{context}"]
6+
= Obtaining a FIPS-capable installation program using `oc adm extract`
7+
8+
{product-title} requires the use of a FIPS-capable installation binary to install a cluster in FIPS mode. You can obtain this binary by extracting it from the release image by using the {oc-first}. After you have obtained the binary, you proceed with the cluster installation, replacing all instances of the `openshift-install` command with `openshift-install-fips`.
9+
10+
.Prerequisites
11+
12+
* You have installed the {oc-first} with version 4.16 or newer.
13+
14+
.Procedure
15+
16+
. Extract the FIPS-capable binary from the installation program by running the following command:
17+
+
18+
[source,terminal]
19+
----
20+
$ oc adm release extract --registry-config "${pullsecret_file}" --command=openshift-install-fips --to "${extract_dir}" ${RELEASE_IMAGE}
21+
----
22+
+
23+
where:
24+
+
25+
--
26+
`<pullsecret_file>`:: Specifies the name of a file that contains your pull secret.
27+
`<extract_dir>`:: Specifies the directory where you want to extract the binary.
28+
`<RELEASE_IMAGE>`:: Specifies the Quay.io URL of the {product-title} release you are using. For more information on finding the release image, see _Extracting the {product-title} installation program_.
29+
--
30+
. Proceed with cluster installation, replacing all instances of the `openshift-install` command with `openshift-install-fips`.

0 commit comments

Comments
 (0)