Skip to content

Document FIPS 140-3 images of the self-hosted Elastic Package Registry - #9212

Open
vishaangelova wants to merge 4 commits into
mainfrom
fips-9.6-registry-images
Open

vishaangelova wants to merge 4 commits into
mainfrom
fips-9.6-registry-images

Conversation

@vishaangelova

@vishaangelova vishaangelova commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Summary

Contributes to docs-content-internal#2097. Follows up on docs-content#9163.

  • Adds a FIPS 140-3 images section to Host your own Elastic Package Registry: the -fips image 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.
  • Adds a pointer from the FIPS compliance overview, and one-line pointers from the self-managed air-gapped, ECK Package Registry, and Security prebuilt rules pages.

Version scoping

The images are tagged ga 9.6+, per Nima's comment.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Tool(s) and model(s) used: Cursor with Claude

@vishaangelova
vishaangelova marked this pull request as ready for review November 4, 2026 16:11
@vishaangelova
vishaangelova requested review from a team as code owners November 4, 2026 16:11
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>
@vishaangelova
vishaangelova force-pushed the fips-9.6-registry-images branch from 27de5c4 to 302225f Compare November 4, 2026 16:23
@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

✅ 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.

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Docs review summary

Action required

  • reference/fleet/air-gapped.md, FIPS 140-3 images section: the sentence naming the Go Cryptographic Module and the "FIPS-enabled Wolfi base image from Chainguard rather than a UBI base image" describes build internals. Readers don't need them to choose or run the image, and the base image can change without notice. Keep the supported platforms and the link to the Go FIPS page. Drop the base image detail, or move it to the source repo docs. (Scope discipline)
  • reference/fleet/air-gapped.md, distribution list: the new FIPS: bullet isn't a distribution like the others in that list. It is a variant of each one. Consider moving it out of the list into the lead-in paragraph or a short sentence after the list, so the list stays parallel. (Formatting)

Issue satisfaction

I 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
  • Content type: reference and how-to additions to an existing air-gapped how-to page, plus an overview bullet. The structure fits the surrounding pages.
  • Checked: user focus, applicability, maintainability, language, and style. Existing Vale findings aren't repeated.
  • Not checked: technical accuracy of the image tags, GODEBUG=fips140=only behavior, and the TLS 1.2 minimum. I didn't verify them against the elastic/package-registry source or the published docs, so an SME needs to confirm them. The applies_to version scoping is raised as an open question in the PR description and is left to the reviewers it names.

Generated from Docs review agent · ◷

Was this review helpful? When the PR closes, add the label ai-review:helpful or ai-review:unhelpful to it.

@shainaraskas shainaraskas left a comment

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.

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

Comment thread deploy-manage/security/fips.md Resolved
Comment thread reference/fleet/air-gapped.md Resolved
Co-authored-by: Cursor <cursoragent@cursor.com>
@vishaangelova

Copy link
Copy Markdown
Member Author

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:

  • I broadened the FIPS overview bullet so it isn't Fleet-specific.
  • I also added one-line pointers to the FIPS section from the self-managed air-gapped, ECK Package Registry, and Security prebuilt rules pages. I skipped ECE because fips.md (L31) says it isn't officially supported there.

Could you add an SME reviewer for the new FIPS section on the ECK Package Registry page?

@nimarezainia

Copy link
Copy Markdown
Contributor

My preference is to show everything as available from 9.6 onwards.

@vishaangelova vishaangelova changed the title Document FIPS 140-3 images of the self-hosted Elastic Package Registry Document FIPS 140-3 registry images and Managed integrations on FedRAMP Moderate Nov 5, 2026
@vishaangelova
vishaangelova force-pushed the fips-9.6-registry-images branch from ae73ed7 to f1c8121 Compare November 5, 2026 12:41
@vishaangelova vishaangelova changed the title Document FIPS 140-3 registry images and Managed integrations on FedRAMP Moderate Document FIPS 140-3 images of the self-hosted Elastic Package Registry Nov 5, 2026

@teresaromero teresaromero left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

lgtm

@vishaangelova
vishaangelova force-pushed the fips-9.6-registry-images branch from ba7b5b0 to 4eb92fb Compare November 5, 2026 13:54
Co-authored-by: Cursor <cursoragent@cursor.com>
@vishaangelova
vishaangelova force-pushed the fips-9.6-registry-images branch from 4eb92fb to 24e81c1 Compare November 5, 2026 13:58
@shainaraskas
shainaraskas requested review from a team and removed request for a team November 5, 2026 14:14
@shainaraskas

Copy link
Copy Markdown
Member

@vishaangelova ty 🙏 added ECK stakeholders - will circle back with admin review shortly

@shainaraskas shainaraskas left a comment

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.

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).

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.

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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.

@vishaangelova vishaangelova Nov 7, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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).

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.

--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

This branch was successfully deployed

1 active deployment
docs-preview — 53aaf321 Deployed Nov 7, 2026 by github-actions[bot]
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.

4 participants