Skip to content

DOCS-890: Clarify Unified vs Legacy Docker deployment guidance - #306

Merged
harrison-akeyless merged 3 commits into
v1.0from
v1.0_docs-890-unified-docker-guidance
Jun 10, 2026
Merged

DOCS-890: Clarify Unified vs Legacy Docker deployment guidance#306
harrison-akeyless merged 3 commits into
v1.0from
v1.0_docs-890-unified-docker-guidance

Conversation

@harrison-akeyless

@harrison-akeyless harrison-akeyless commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

Documentation

  • Updated Docker deployment documentation with current image references and standardized configuration environment variables.
  • Refined deployment command examples for authentication methods, gateway administration, security configurations, and operational options.
  • Added guidance section for users maintaining legacy gateway deployments.

@harrison-akeyless harrison-akeyless self-assigned this Jun 2, 2026
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: c97c4185-395e-46ef-b773-a127267bfce5

📥 Commits

Reviewing files that changed from the base of the PR and between f1dff09 and 59aca2e.

📒 Files selected for processing (2)
  • docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
  • docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/index.md

📝 Walkthrough

Walkthrough

This PR updates the standalone Docker deployment documentation to standardize Docker image references from the legacy akeyless/base:latest-akeyless to akeyless/gateway:latest and aligns environment variable naming with the GATEWAY_* convention across the index guide and advanced configuration examples. A new "Legacy Deployment" subsection directs users with older deployments to legacy documentation.

Changes

Gateway Docker Deployment Documentation Updates

Layer / File(s) Summary
Main deployment entry point and authentication examples
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/index.md, docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
Updated the primary index.md standalone Docker command and all authentication method examples (email/password, API key, CSP IAM, Universal Identity, and certificate-based auth) to use akeyless/gateway:latest instead of the legacy image.
Access control, cluster identity, and encryption configuration
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
Updated gateway admin (ALLOWED_ACCESS_PERMISSIONS), access restriction (GATEWAY_AUTHORIZED_ACCESS_ID), cluster identity (CLUSTER_NAME/CLUSTER_URL), encryption key, and customer fragment deployment examples to use the new image and environment variable conventions.
Advanced features, operational settings, and legacy references
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md, docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/index.md
Updated TLS, cache configuration, gateway access restriction, default secret encryption/location/login/certificate, operational settings (rate limiting, artifact repository), gRPC deployment, and version selection examples. Added "Legacy Deployment" subsection with reference to legacy documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • akeylesslabs/technical-documentation#229: Updates Gateway Docker advanced configuration documentation for ALLOWED_ACCESS_PERMISSIONS and GATEWAY_AUTHORIZED_ACCESS_ID examples with related access control guidance.
  • akeylesslabs/technical-documentation#295: Related updates to customer fragments and CUSTOMER_FRAGMENTS environment variable documentation aligned with Gateway Zero-Knowledge implementation.

Suggested reviewers

  • Avi-Akeyless

Poem

🐰 A gateway springs to life anew,
With latest tags and GATEWAY_* too,
From base to gateway, the image does flow,
Each config example in harmonious row,
Legacy paths stay safe below! 🎯

🚥 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 describes the main objective of the pull request, which updates Docker deployment documentation to clarify the distinction between unified (new) and legacy deployment guidance.
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-890-unified-docker-guidance

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 enabled auto-merge (squash) June 8, 2026 17:16
@harrison-akeyless
harrison-akeyless merged commit bbd4bc5 into v1.0 Jun 10, 2026
15 checks passed
@harrison-akeyless
harrison-akeyless deleted the v1.0_docs-890-unified-docker-guidance branch June 10, 2026 00:55
@coderabbitai coderabbitai Bot mentioned this pull request Jul 9, 2026
6 tasks
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