Skip to content

Enable FIPS in documentation examples#306

Merged
ipetrov117 merged 4 commits intoSUSE:mainfrom
ipetrov117:enable-fips-in-docs
Dec 11, 2025
Merged

Enable FIPS in documentation examples#306
ipetrov117 merged 4 commits intoSUSE:mainfrom
ipetrov117:enable-fips-in-docs

Conversation

@ipetrov117
Copy link
Copy Markdown
Contributor

This PR enables the fips crypto policy by default in our examples, showcasing a larger range of elemental's functionality.

@ipetrov117 ipetrov117 marked this pull request as ready for review December 11, 2025 13:35
@ipetrov117 ipetrov117 requested a review from a team as a code owner December 11, 2025 13:35
Comment thread docs/image-customization.md Outdated
A user wants to customize and produce a RAW image that will be running an operating system, Kubernetes distribution and Rancher version that are supported by the aforementioned consumer product.

Furthermore, using this image, the user wants to setup a multi-node Kubernetes cluster that will be extended with the `NeuVector` Helm chart along with a specific set of Kubernetes manifests that will enable access to the Rancher UI.
Furthermore, using this image, the user wants to enable compliance with FIPS and setup a multi-node Kubernetes cluster that will be extended with the `NeuVector` Helm chart along with a specific set of Kubernetes manifests that will enable access to the Rancher UI.
Copy link
Copy Markdown
Member

@dirkmueller dirkmueller Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would highly appreciate to have a small caveat here that mentions that enabling fips mode is not just for the host, it expands to the workload also which might not be fips ready and then will not run.

there fore I would also suggest to only enable cryptoPolicy: fips in the linux-only usecase.

Copy link
Copy Markdown
Contributor Author

@ipetrov117 ipetrov117 Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are controlling the example use-cases from config-dir -> image build -> image boot, IMO it is safe enough to keep the FIPS option enabled by default for the examples. That way we are actually showcasing FIPS and not having users guess how to set it up.

I can have a better explanation of the use-case here, as well as add information that FIPS will be enabled on the full setup (control-plane + workloads). Furthermore I can add a comment on each cryptoPolicy: configuration in install.yaml file saying that if for some reason you are not following the examples directory, you need to be aware that your full setup can support FIPS. Also I can further explain that we are enabling FIPS on the install.yaml explanation of each config directory overview. WDYT?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

either place is fine, basically it might not be obvious that the host setup leaks to the workload

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I'll add the additional information asap.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the additional clarification comments and documentation, please take a look at let me know what you think.

Comment thread examples/elemental/customize/multi-node/install.yaml
@ipetrov117 ipetrov117 merged commit 1994920 into SUSE:main Dec 11, 2025
4 of 5 checks passed
@ipetrov117 ipetrov117 deleted the enable-fips-in-docs branch March 11, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants