Repository navigation
Document FIPS 140-3 images of the self-hosted Elastic Package Registry - #9212
vishaangelova wants to merge 4 commits into
Conversation
Add a FIPS 140-3 images section to Host your own Elastic Package Registry on the air-gapped page: the -fips image tags, that packages and configuration are the same as the regular images, the opt-in strict mode (GODEBUG=fips140=only), and the TLS 1.2 minimum. Add a bullet to the FIPS compliance overview pointing to it. Part of elastic/docs-content-internal#2097 Co-authored-by: Cursor <cursoragent@cursor.com>
27de5c4 to
302225f
Compare
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Docs review summaryAction required
Issue satisfactionI couldn't read the parent issue, https://github.com/elastic/docs-content-internal/issues/2097, because it is in a private repository, so I did not assess whether this PR satisfies it. Review coverage
|
shainaraskas
left a comment
There was a problem hiding this comment.
perhaps I am missing some context, but hoping you can clarify for me whether there's a chance that fips version of the package registry might need to be documented in the other air-gapped docs as well - see other comments
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Thanks @shainaraskas! The whole registry is FIPS-compliant and every distribution has a -fips image with the same packages. I updated the docs in f1c8121:
Could you add an SME reviewer for the new FIPS section on the ECK Package Registry page? |
|
My preference is to show everything as available from 9.6 onwards. |
ae73ed7 to
f1c8121
Compare
ba7b5b0 to
4eb92fb
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
4eb92fb to
24e81c1
Compare
|
@vishaangelova ty 🙏 added ECK stakeholders - will circle back with admin review shortly |
shainaraskas
left a comment
There was a problem hiding this comment.
thanks for these fixes. I think we can likely defer the big one, which is that the core air gapped package registry docs are buried in the fleet docs :/
| stack: ga 9.6+ | ||
| ``` | ||
|
|
||
| If your environment requires FIPS 140-3 validated cryptography, set `spec.image` to a `-fips` distribution tag. This example uses the `lite` distribution, which is what ECK deploys by default. For all packages, use `docker.elastic.co/package-registry/distribution:<version>-fips` instead. For details on the FIPS images, refer to [FIPS 140-3 images](/reference/fleet/air-gapped.md#air-gapped-diy-epr-fips). To also run the operator itself in FIPS mode, refer to [](/deploy-manage/deploy/cloud-on-k8s/deploy-fips-compatible-version-of-eck.md). |
There was a problem hiding this comment.
I don't think that linking deep into the fleet docs makes sense long term. I see that this has been a problem for a while, e.g. https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/9212/deploy-manage/deploy/self-managed/air-gapped-install#air-gapped-elastic-package-registry - maybe we can log a bug
There was a problem hiding this comment.
I agree, maybe the whole Host your own Elastic Package Registry section could be moved out of that doc to a better place? I'll open a follow-up issue to discuss where it would fit better.
There was a problem hiding this comment.
Here's the issue: #9263. Feel free to edit/add to the description as needed (I wasn't sure about the labels..)
| stack: ga 9.6+ | ||
| ``` | ||
|
|
||
| If your environment requires FIPS 140-3 validated cryptography, set `spec.image` to a `-fips` distribution tag. This example uses the `lite` distribution, which is what ECK deploys by default. For all packages, use `docker.elastic.co/package-registry/distribution:<version>-fips` instead. For details on the FIPS images, refer to [FIPS 140-3 images](/reference/fleet/air-gapped.md#air-gapped-diy-epr-fips). To also run the operator itself in FIPS mode, refer to [](/deploy-manage/deploy/cloud-on-k8s/deploy-fips-compatible-version-of-eck.md). |
There was a problem hiding this comment.
--ubi-only gives ECK users a UBI registry image, but that isn’t documented anywhere, and the FIPS registry images are Wolfi-based with no UBI variant. If a user with --ubi-only sets a -fips image, they lose UBI with no warning. Is that an expectation we should be setting in the docs? prob a question for ECK operator folks @moukoublen @barkbay
30bee6c to
30f1d93
Compare
30f1d93 to
53aaf32
Compare
Summary
Contributes to docs-content-internal#2097. Follows up on docs-content#9163.
-fipsimage tags, that packages and configuration match the regular images, the opt-in strict mode (GODEBUG=fips140=only), and the TLS 1.2 minimum. Based on the package-registry FIPS docs and Teresa's notes on the tracking issue.Version scoping
The images are tagged
ga 9.6+, per Nima's comment.Generative AI disclosure
Tool(s) and model(s) used: Cursor with Claude