Skip to content

Commit 129cd1b

Browse files
committed
OSDOCS-9408: update FIPS in install MicroShift
1 parent a6187ff commit 129cd1b

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Distros: microshift
5151
Topics:
5252
- Name: Installing from an RPM package
5353
File: microshift-install-rpm
54-
- Name: Installing for FIPS compliance
54+
- Name: Using FIPS mode
5555
File: microshift-fips
5656
- Name: Mirroring container images for disconnected installations
5757
File: microshift-deploy-with-mirror-registry

microshift_install/microshift-fips.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-fips"]
3-
= Running {microshift-short} containers in FIPS mode
3+
= Using FIPS mode with {microshift-short}
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-fips
66

77
toc::[]
88

9-
You can use FIPS-compliant mode with RPM-based installations of {microshift-short} on {op-system-base-full} {op-system-version-major}.
9+
You can use FIPS mode with RPM-based installations of {microshift-short} on {op-system-base-full} {op-system-version-major}.
1010

11-
* To enable FIPS mode in {microshift-short} containers, the worker machine kernel must be enabled to run in FIPS-compliant mode before the machine starts.
11+
* To enable FIPS mode in {microshift-short} containers, the worker machine kernel must be enabled to run in FIPS mode before the machine starts.
1212
* Using FIPS with {op-system-ostree-first} images is not supported.
1313
1414
include::modules/microshift-fips-rpm-system.adoc[leveloffset=+1]

microshift_install/microshift-install-rpm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ include::modules/microshift-install-rpm-before.adoc[leveloffset=+1]
2222
//additional resources for install rpm before module
2323
[role="_additional-resources"]
2424
.Additional resources
25-
* xref:../microshift_install/microshift-fips.adoc#microshift-fips[Running {microshift-short} containers in FIPS mode]
25+
* xref:../microshift_install/microshift-fips.adoc#microshift-fips[Using FIPS mode with {microshift-short}]
2626

2727
include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
2828

modules/microshift-fips-rpm-system.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="microshift-fips-rpm-system_{context}"]
7-
= Enabling FIPS compliance with RPM-based installations
7+
= FIPS mode with {op-system-base} RPM-based installations
88

9-
Using FIPS with {product-title-first} requires enabling the cryptographic module self-checks in your {op-system-base-full} installation. After the host operating system has been configured to start with the FIPS modules, {microshift-short} containers are automatically enabled to run in FIPS mode.
9+
Using FIPS with {microshift-short} requires enabling the cryptographic module self-checks in your {op-system-base-full} installation. After the host operating system has been configured to start with the FIPS modules, {microshift-short} containers are automatically enabled to run in FIPS mode.
1010

11-
* When {op-system-base} is started in FIPS mode, {microshift} core components use the {op-system} cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 validation on only the x86_64 architectures.
11+
* When {op-system-base} is started in FIPS mode, {microshift-short} core components use the {op-system} cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 validation on only the x86_64 architectures.
1212
1313
* You must enable FIPS mode when you install {op-system-base} {op-system-version-major} on the machines that you plan to use as worker machines.
1414
+

modules/microshift-install-rpm-before.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="microshift-install-rpm-before_{context}"]
77
= Before installing {microshift-short} from an RPM package
88

9-
Preparation of the host machine is recommended prior to installing {microshift-short} for memory configuration and FIPS compliance.
9+
Preparation of the host machine is recommended prior to installing {microshift-short} for memory configuration and FIPS mode.
1010

1111
[id="microshift-configuring-volume-groups_{context}"]
1212
== Configuring volume groups
@@ -15,7 +15,12 @@ Preparation of the host machine is recommended prior to installing {microshift-s
1515

1616
To configure a volume group (VG) that allows LVMS to create the LVs for your workload's PVs, lower the *Desired Size* of your root volume during the installation of {op-system}. Lowering the size of your root volume allows unallocated space on the disk for additional LVs created by LVMS at runtime.
1717

18-
[id="microshift-running-containers-fips-mode_{context}"]
19-
== Running {microshift-short} in FIPS-compliant mode
18+
[id="microshift-prepare-for-fips-mode_{context}"]
19+
== Prepare for FIPS mode
2020

21-
If your use case requires running {microshift-short} containers in FIPS mode, you must install {op-system-base} with FIPS enabled. After the worker machine is configured to run in FIPS mode, your {microshift-short} containers are automatically configured to also run in FIPS mode. See "Running {microshift-short} containers in FIPS mode" in the "Additional resources" of this section.
21+
If your use case requires running {microshift-short} containers in FIPS mode, you must install {op-system-base} with FIPS enabled. After the worker machine is configured to run in FIPS mode, your {microshift-short} containers are automatically configured to also run in FIPS mode.
22+
23+
[IMPORTANT]
24+
====
25+
Because FIPS must be enabled before the operating system that your cluster uses starts for the first time, you cannot enable FIPS after you deploy a cluster.
26+
====

0 commit comments

Comments
 (0)