Skip to content

🔄 Preview: docs: comprehensive FIPS 140-3 compliance page#1844

Draft
buger wants to merge 317 commits intoproductionfrom
feat/fips-compliance-docs
Draft

🔄 Preview: docs: comprehensive FIPS 140-3 compliance page#1844
buger wants to merge 317 commits intoproductionfrom
feat/fips-compliance-docs

Conversation

@buger
Copy link
Copy Markdown
Member

@buger buger commented Apr 8, 2026

🔗 Auto-generated mirror PR for Mintlify preview

Original PR: #1843
Author: @buger

Purpose

This PR provides a Mintlify preview link for reviewing documentation changes.

Preview Link

The Mintlify preview will be available once this PR is processed.

⚠️ Important Notes

Changes

Summary

Complete rewrite of the FIPS compliance documentation page at to reflect the migration to Go 1.24+ native FIPS 140-3 and Docker Hardened Images.

Key changes from the previous version:

  • FIPS 140-2 → FIPS 140-3: updated to reflect the migration from (BoringCrypto C library) to (Go native FIPS module)
  • Full product coverage: added Tyk Dashboard and MDCB (previously only Gateway and Pump)
  • Docker Hardened Images: documented the DHI base image, its attestations (FIPS, SBOM, SLSA provenance, VEX, STIG), and how to verify them
  • Verification guide: step-by-step commands for verifying FIPS compliance in binaries and Docker images using , , and
  • VEX documentation: three methods for vulnerability filtering (Docker Scout, trivy OCI, trivy VEX repo)
  • Legal clarity: explicit compliance scope and limitations section with clear disclaimers about what is and isn't covered

Related PRs

🤖 Generated with Claude Code

yurisasuke and others added 30 commits July 1, 2025 14:47
Revert "rewrite summary (#387)"

This reverts commit 1c4402d.
* add version

* change the folder name

---------

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Revert "Update tyk-stack.mdx (#425)"

This reverts commit 115f944.
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* fix-description

* remove empty descriptions

---------

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Revert "Update tyk-stack.mdx (#450)"

This reverts commit d441dbf.
Revert "Update branches-config.json (#475)"

This reverts commit c22650f.
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* add sidebar

* add contexual

* return sidebar to top

* add tag above sidetitle

* addtags below front matter

* add title

---------

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* add change text color to white

* remove reduddant

* remove reduddant

---------

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
* docs: add TYK_DB_LOGLEVEL and log_level config support

* DX-2357: Update to use TYK_LOGLEVEL instead of TYK_DB_LOGLEVEL

* docs: add note about TYK_LOGLEVEL priority

* docs: add note about TYK_DB_ prefix for TYK_LOGLEVEL

* docs: add note about TYK_LOGFORMAT priority

* ci: remove --no-deps from pip install requests

* Apply suggestions from code review

Co-authored-by: Master <sharadregoti15@gmail.com>

* Update upgrade recommendations for production environments

Removed reference to Tyk Operator for production upgrades.

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: Master <sharadregoti15@gmail.com>
…chor fragments (#1865)

* DX-2361: Add GitHub Actions to validate external URLs and internal anchors

- Extend validate_mintlify_docs.py with --check-anchors flag that extracts
  GFM-slugified heading anchors, {#custom-id} syntax, and <a id/name> elements
  from target MDX files and verifies every internal #fragment resolves
- Update validate-docs.yml to run anchor check on every PR
- Add check-external-links.yml workflow: weekly scheduled (Mon 07:00 UTC) and
  manual-trigger run that HEAD-checks all external HTTP/HTTPS URLs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Run external link check on every pull request

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Fix exit code not failing on broken external links

External link failures were reported but never factored into the
exit code, so CI was passing despite 404s. Added has_broken_external
check and a summary line for external link results.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* DX-2361: Switch external link checker to lychee

Replace sequential Python/requests approach with lycheeverse/lychee-action.
Lychee runs checks in parallel, has built-in retry logic, and is purpose-built
for link checking — much faster on a repo with 1500+ external URLs.

Add lychee.toml to exclude tyk-owned domains, localhost, placeholder URLs,
and sites known to block bots (LinkedIn, Facebook). Accept 429 as non-broken
to handle rate-limited responses gracefully.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix mirror-pr workflow failing on PR bodies with special characters

GitHub Actions expands ${{ }} expressions before the shell runs, so
backticks and $ signs in PR bodies were injected raw into the script
and interpreted as shell command substitution.

Fix: write static content via a single-quoted heredoc (no shell
expansion), then append the PR body via printf with an env var
($PR_BODY). Shell variables accessed as "$VAR" are never
re-interpreted, making any PR body content safe.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee checking internal/relative links

Add scheme = ["https", "http"] to lychee.toml so lychee only attempts
to check http/https URLs. Without this, lychee tries to resolve
root-relative paths (/img/..., /page/...) as file URIs and fails.
Internal links are already validated by validate-docs.yml.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee erroring on root-relative paths

scheme = ["https", "http"] didn't help because lychee fails to build
the URL before the scheme filter runs. Set base = "https://tyk.io" so
root-relative paths (/img/..., /page/...) are resolved to
https://tyk.io/... and then silently skipped by the existing tyk.io
exclude rule, rather than producing "cannot convert path to URI" errors.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Fix lychee config: base -> base_url

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
probelabs bot and others added 5 commits April 16, 2026 14:11
#1872)

* docs: add container support guide (Podman, containerd, CRI-O)

* docs(DX-2363): restructure container runtimes guide and add cross-references

- Rewrite containers.mdx as a proper Tyk docs page: clean frontmatter,
  active voice, no numbered headings, FAQ as AccordionGroup, no em dashes
- Move page from tyk-self-managed/install/containers to
  deployment-and-operations/container-runtimes
- Update docs.json: remove old nav entry, add new entry under Configuration
  group after planning-for-production
- Add Container Runtimes cross-reference Note (after Prerequisites) to 7
  install pages: tyk-self-managed docker/k8s, portal docker/k8s,
  ai-studio docker/k8s, tyk-governance installation

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: Sharad Regoti <sharadregoti15@gmail.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Rewrite the FIPS documentation to cover:
- Migration from GOEXPERIMENT=boringcrypto (FIPS 140-2) to
  GOFIPS140=v1.0.0 (FIPS 140-3, Go 1.24+ native)
- Docker Hardened Images (DHI) base with FIPS attestation
- Full product matrix (Gateway, Dashboard, Pump, MDCB)
- Step-by-step binary and image verification guide
- VEX vulnerability management (Docker Scout, trivy OCI, trivy repo)
- Base image transparency and attestation inspection
- Clear compliance scope, limitations, and legal disclaimers
- Configuration guide for FIPS mode
- References to Go, Docker, and NIST documentation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.