DOCS-773: Recommend Gateway UI/CLI for ongoing configuration#253
DOCS-773: Recommend Gateway UI/CLI for ongoing configuration#253harrison-akeyless wants to merge 4 commits into
Conversation
📝 WalkthroughWalkthroughThis PR adds a reusable GatewayConfigManagementNote component to communicate best practices for ongoing Gateway configuration management across documentation. The component is defined once, added to 15+ documentation pages with consistent placement, supplemented with CLI command examples in select pages, and paired with a Docker-specific TLS bootstrap warning. ChangesGateway configuration management documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md (1)
301-303: ⚡ Quick winConsider moving the warning before the first code example that demonstrates volume mounts.
The warning content is excellent and clearly advises users to prefer the Gateway Configuration Manager or CLI for ongoing TLS updates. However, the current placement (line 301) comes after the code examples at lines 275-283 that already demonstrate the volume mount pattern being discouraged.
Users scanning the documentation may copy one of those earlier examples before reading down to the warning. Moving this warning to appear before line 275 (before the first TLS code example) would ensure users see the guidance before encountering the bootstrap-only volume mount pattern.
📍 Suggested placement improvement
Move the warning block (lines 301-303) to appear immediately after line 273 and before line 275, so users encounter the guidance before seeing volume mount examples:
We strongly recommend using Akeyless Gateway over TLS to ensure all traffic is encrypted in transit. Note that when you enable TLS, you must provide a TLS certificate and a TLS private key in PEM format. +> ⚠️ **Warning:** +> +> Use mounted TLS certificate and key files only for initial bootstrap when required. For ongoing Gateway configuration updates, use the [Gateway Configuration Manager](https://docs.akeyless.io/docs/configure-gateway) or the [Akeyless CLI](https://docs.akeyless.io/docs/cli-reference-gateway) to reduce configuration drift and avoid TLS misconfiguration. + ```shell docker run -d -p 8000:8000 -p 5696:5696 -e GATEWAY_ACCESS_ID="your-access-id" -e GATEWAY_ACCESS_KEY="matching-access-key" -e ENABLE_TLS="true" -e ENABLE_TLS_CONFIGURE="true" -e ENABLE_TLS_CURL="true" -e ENABLE_TLS_HVP="true" -e MIN_TLS_VERSION="TLSv1.3" -v $PWD/cert.crt:/home/akeyless/.akeyless/akeyless-api-cert.crt -v $PWD/key.pem:/home/akeyless/.akeyless/akeyless-api-cert.key --name akeyless-gw akeyless/base:latest-akeylessThen remove the warning from its current position (lines 301-303) and adjust line 299 to read:
-With the following parameters, you can mount the TLS certificate and the TLS private key from the present working directory to the Gateway target directory: - -> ⚠️ **Warning:** -> -> Use mounted TLS certificate and key files only for initial bootstrap when required. For ongoing Gateway configuration updates, use the [Gateway Configuration Manager](https://docs.akeyless.io/docs/configure-gateway) or the [Akeyless CLI](https://docs.akeyless.io/docs/cli-reference-gateway) to reduce configuration drift and avoid TLS misconfiguration. - +The above examples use the following volume mount parameters to provide the TLS certificate and private key from the present working directory to the Gateway target directory: + * `-v $PWD/cert.crt:/home/akeyless/.akeyless/akeyless-api-cert.crt`🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/Akeyless` Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md around lines 301 - 303, Move the existing warning block about using mounted TLS cert/key files (the "⚠️ Warning" paragraph) so it appears immediately before the first Docker run code example that demonstrates volume mounts (i.e., insert the warning after the paragraph that ends at line 273 and before the example starting at line 275), and remove the duplicated warning at its current location (lines ~301-303); keep the warning text unchanged but update surrounding text if needed so the flow presents the guidance before the volume-mount example.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/Akeyless`
Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md:
- Around line 301-303: Move the existing warning block about using mounted TLS
cert/key files (the "⚠️ Warning" paragraph) so it appears immediately before the
first Docker run code example that demonstrates volume mounts (i.e., insert the
warning after the paragraph that ends at line 273 and before the example
starting at line 275), and remove the duplicated warning at its current location
(lines ~301-303); keep the warning text unchanged but update surrounding text if
needed so the flow presents the guidance before the volume-mount example.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 66557ec5-91c1-429a-930a-59b836e0f3a5
📒 Files selected for processing (17)
.github/markdownlint/.markdownlint-cli2.yamlcustom_blocks/GatewayConfigManagementNote.mddocs/Akeyless Gateway/configure-gateway/gateway-authentication-and-access.mddocs/Akeyless Gateway/configure-gateway/gateway-automatic-migration.mddocs/Akeyless Gateway/configure-gateway/gateway-caching/cluster-cache-ha.mddocs/Akeyless Gateway/configure-gateway/gateway-caching/cluster-cache-standalone.mddocs/Akeyless Gateway/configure-gateway/gateway-caching/index.mddocs/Akeyless Gateway/configure-gateway/gateway-caching/proactive-caching.mddocs/Akeyless Gateway/configure-gateway/gateway-caching/runtime-caching.mddocs/Akeyless Gateway/configure-gateway/gateway-certificate-store.mddocs/Akeyless Gateway/configure-gateway/gateway-hsm-integration.mddocs/Akeyless Gateway/configure-gateway/gateway-log-forwarding.mddocs/Akeyless Gateway/configure-gateway/gateway-pqc-support-reference.mddocs/Akeyless Gateway/configure-gateway/gateway-tls-settings.mddocs/Akeyless Gateway/configure-gateway/gateway-zero-knowledge.mddocs/Akeyless Gateway/configure-gateway/index.mddocs/Akeyless Gateway/deploy-gateway/gateway-deploy-standalone-docker/gateway-docker-advanced-configuration.md
1 participant
Summary
Adds consistent guidance across Gateway configuration docs to prefer the Gateway Configuration Manager UI, Akeyless CLI, or Helm values for ongoing configuration — rather than per-instance container startup flags.
Changes
New reusable custom block
custom_blocks/GatewayConfigManagementNote.md— new Important callout advising against routine container-flag changes and directing users to the recommended configuration interfacesMarkdownlint config
.github/markdownlint/.markdownlint-cli2.yaml— addedGatewayConfigManagementNoteto the MD033 allowed-tags list so<GatewayConfigManagementNote />in doc pages passes lintConfigure Gateway section (
docs/Akeyless Gateway/configure-gateway/)index.md— added<GatewayConfigManagementNote />+ new "Access Gateway Settings (CLI)" section withgateway-get-configexample and link to CLI referencegateway-caching/index.md— added note + CLI example forakeyless gateway update cachegateway-tls-settings.md— added note + CLI example forakeyless gateway-update-tls-cert<GatewayConfigManagementNote />at the top of each page:gateway-authentication-and-access.mdgateway-automatic-migration.mdgateway-caching/cluster-cache-ha.mdgateway-caching/cluster-cache-standalone.mdgateway-caching/proactive-caching.mdgateway-caching/runtime-caching.mdgateway-certificate-store.mdgateway-hsm-integration.mdgateway-log-forwarding.mdgateway-pqc-support-reference.mdgateway-zero-knowledge.mdStandalone Docker advanced configuration
gateway-docker-advanced-configuration.md— added Warning callout before the TLS mount instructions clarifying that mounted cert/key is bootstrap-only and directing users to the UI/CLI for ongoing TLS updatesValidation
Summary by CodeRabbit