Skip to content

DOCS-672: Add UID auth example to Docker Compose gateway deployment#252

Open
harrison-akeyless wants to merge 2 commits into
v1.0from
v1.0_DOCS-672_uid-auth-docker-compose
Open

DOCS-672: Add UID auth example to Docker Compose gateway deployment#252
harrison-akeyless wants to merge 2 commits into
v1.0from
v1.0_DOCS-672_uid-auth-docker-compose

Conversation

@harrison-akeyless
Copy link
Copy Markdown
Collaborator

@harrison-akeyless harrison-akeyless commented May 19, 2026

Summary

  • add Universal Identity to supported authentication methods for Docker Compose gateway deployment
  • add a Universal Identity authentication subsection with gateway.env example values for ADMIN_UID_TOKEN, UID_ROTATE_INTERVAL, and ALLOWED_ACCESS_PERMISSIONS

Validation

  • pre-commit run --files "docs/Akeyless Gateway/deploy-gateway/gateway-deploy-docker-compose.md"

Summary by CodeRabbit

  • Documentation
    • Updated Docker Compose deployment guide to support Universal Identity as a Gateway authentication method.
    • Added Universal Identity Authentication configuration section with instructions for setting ADMIN_UID_TOKEN, optional UID_ROTATE_INTERVAL, and ALLOWED_ACCESS_PERMISSIONS environment variables.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e1010aeb-2d3a-4c13-b7e2-56bb7bfd49f1

📥 Commits

Reviewing files that changed from the base of the PR and between 85ff601 and a5a7a83.

📒 Files selected for processing (1)
  • docs/Akeyless Gateway/deploy-gateway/gateway-deploy-docker-compose.md

📝 Walkthrough

Walkthrough

This PR updates the Docker Compose deployment documentation to introduce Universal Identity as a supported Gateway authentication method. The changes add Universal Identity to the list of supported authentication mechanisms and include a new configuration section explaining the required ADMIN_UID_TOKEN variable, optional UID_ROTATE_INTERVAL, and ALLOWED_ACCESS_PERMISSIONS settings in gateway.env.

Changes

Universal Identity Gateway Documentation

Layer / File(s) Summary
Universal Identity authentication documentation
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-docker-compose.md
Added Universal Identity to the supported authentication methods list and inserted a new dedicated section with configuration instructions for ADMIN_UID_TOKEN, UID_ROTATE_INTERVAL, and ALLOWED_ACCESS_PERMISSIONS in gateway.env.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A gateway now speaks the Universal tongue,
With tokens and rotations, fresh configuration sung,
From method list to secrets set just right,
Identity flows secure through Docker's night!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding UID (Universal Identity) authentication example documentation to Docker Compose gateway deployment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v1.0_DOCS-672_uid-auth-docker-compose

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@harrison-akeyless harrison-akeyless marked this pull request as ready for review May 19, 2026 02:08
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.

1 participant