Skip to content

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Jul 29, 2025

Expands docs for FIPS compliance to include FIPS mode for Ingest tools

In this PR, we take the content created and reviewed in docs-content#2136 , convert it to MD, and replace links from new docs system with classic doc links. There's no comparable file location in pre-9.0 docs, and the Fleet and Agent Guide seemed like the best fit.

PREVIEW: https://ingest-docs_bk_1833.docs-preview.app.elstc.co/guide/en/fleet/8.19/fips-ingest.html

Related issue:

Related PR:

Remaining work

  • Add links from APM and Beats to point to this topic
  • Close draft PR in Elasticsearch repo
  • what else?

@karenzone karenzone self-assigned this Jul 29, 2025
@karenzone karenzone requested a review from a team as a code owner July 29, 2025 00:49
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@karenzone karenzone marked this pull request as draft July 29, 2025 00:49
@karenzone
Copy link
Contributor Author

Looking for suggestions on where to put the FIPS Ingest content for 8.19. For 9.1 in new docs system, it's under Security.

Screenshot 2025-07-28 at 9 39 41 PM

Copy link

@simitt simitt left a comment

Choose a reason for hiding this comment

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

LGTM

@simitt
Copy link

simitt commented Jul 29, 2025

For adding a link from APM Server, I would place a FIPS page linking to this in https://www.elastic.co/guide/en/observability/8.18/apm-securing-apm-server.html.

@karenzone karenzone marked this pull request as ready for review July 29, 2025 12:48

preview::[]

{agent}, {fleet}, {filebeat}, {metricbeat}, and APM Server binaries are built and can be configured to use FIPS 140-2 compliant cryptography.
Copy link
Member

Choose a reason for hiding this comment

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

@simitt @ycombinator nit: should we say can be configured or are configured? Aren't the defaults using FIPS compliant crypto for these builds?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think "are configured" is more accurate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good... because I already made the change. :-)

Copy link
Member

@ebeahan ebeahan left a comment

Choose a reason for hiding this comment

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

LGTM - only one nit comment, but I'm also ok to merge as-is.


- link:https://www.elastic.co/docs/reference/integrations/azure/events[Azure Logs Integration (v2 preview)]
- link:https://www.elastic.co/docs/reference/integrations/azure/eventhub[Azure Event Hub Input]
- link:https://www.elastic.co/docs/reference/integrations/sql[SQL Input]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

New addition from @shmsr

Copy link

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Approved! Two non-blocking comments.

Comment on lines +18 to +20
FIPS compatible binaries for {agent}, {fleet}, {filebeat}, {metricbeat}, and APM Server are available for link:https://www.elastic.co/downloads[download].
Look for the `Linux 64-bit (FIPS)` or `Linux aarch64 (FIPS)` platform option on the product download pages for {agent} and {fleet}, {filebeat}, and {metricbeat}.
Look for the `Linux x86_64 (FIPS)` or `Linux aarch64 (FIPS)` platform option on the APM Server download page.

Choose a reason for hiding this comment

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

These read like discrete instructions. I wonder if they could be structured like a list.

Comment on lines +42 to +43
Support for encrypted private keys is not available, as the cryptographic modules used for decrypting password protected keys are not FIPS validated. If an output or any other component with an SSL key that is password protected is configured, the components will fail to load the key. When running in FIPS mode, you must provide non-encrypted keys.
Be sure to enforce security in your FIPS environments through other means, such as strict file permissions and access controls on the key file itself, for example.

Choose a reason for hiding this comment

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

Same thing here. Could this be presented as a list of recommendations / considerations?

@karenzone karenzone merged commit 72349e0 into elastic:8.19 Jul 29, 2025
3 checks passed
@karenzone karenzone deleted the 1735-fips-8.19 branch July 29, 2025 16:50
@karenzone
Copy link
Contributor Author

29630

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.

5 participants