Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates to include new FIPS Synthetics PL image #27778

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nhyne
Copy link

@nhyne nhyne commented Feb 24, 2025

What does this PR do? What is the motivation?

As a part of the FedRAMP High project the Synthetics team has built a new FIPS-compliant Private Location image. Customers who need FIPS compliance with the Datadog product will need to switch to using the new FIPS-compliant image.

Merge instructions

Eventually we would like to drop FIPS support from the current image. It is mentioned in a couple of places but this mention of disabling it would need to have a "after this version this flag is not supported" message. I am also curious if there's a pattern for a deprecation like this? As a part of the PR to update the removal of that flag would I also just add a note that PL versions after and including X.Y.Z are no longer FIPS compliant and customers must use the new image?

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@nhyne nhyne marked this pull request as ready for review February 24, 2025 20:13
@nhyne nhyne requested a review from a team as a code owner February 24, 2025 20:13
@brett0000FF brett0000FF self-assigned this Feb 24, 2025
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

@nhyne - Thanks for the contribution! Main thing I fixed in my suggestion is the link that isn't rendering correctly (as you can see in the preview). The link has to be inside the site region partial. Once you apply this fix, I can approve. Thanks! 🚀

@brett0000FF
Copy link
Contributor

@nhyne - Regarding your question about deprecation patterns: Our documentation typically reflects the current state of the product rather than maintaining detailed deprecation notices. When the FIPS support is removed from the current image, we would:

  • Remove the mentions of the --disableFipsCompliance option
  • Update documentation to clearly direct FIPS-requiring customers to use the dedicated FIPS-compliant image

We generally don't include version-specific deprecation notes unless there's a significant migration concern or customer impact that requires preserved documentation.

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.

2 participants