DOCS-670: Add pod scheduling and HA guidance for Gateway and Injector Helm charts#221
Conversation
- Add 'Pod scheduling for high availability (Kubernetes)' section to gateway-best-practices.md with recommendation, cloud provider links, and a generic platform-agnostic example - Add 'Pod Scheduling' section to gateway-kubernetes-helm-values-reference.md covering nodeSelector, tolerations, affinity, and topologySpreadConstraints chart values with annotated YAML examples - Add 'Pod scheduling for high availability' section to akeyless-kubernetes-secrets-injector.md covering Injector chart values - Fix pre-existing banned-term 'segregation' -> 'isolation' in injector page
📝 WalkthroughWalkthroughAdds documentation and spellcheck dictionary entries for Kubernetes pod scheduling (nodeSelector, tolerations, affinity, topologySpreadConstraints) across Gateway and Injector Helm values and best-practices docs; also a minor wording change from "segregation" to "isolation". ChangesKubernetes Pod Scheduling Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
…and affinity coupling note
- Fix all Gateway chart examples to use gateway.deployment.* path (was deployment.*)
- Fix label selectors: use app.kubernetes.io/name + app.kubernetes.io/instance for
Gateway (from _helpers.tpl selectorLabels), and dynamic app:<release> for Injector
- Add note that topologySpreadConstraints requires affinity.enabled:true in Gateway chart
- Add affinity.data:{} guard in topology-only example
- Fix deployment.tolerations -> deployment.tolerations.data in Injector callout
…ead of duplicating examples
…straints use enabled/data sub-keys
…ency, replicaCount guidance, remove duplicate note
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@docs/Akeyless` Gateway/gateway-best-practices.md:
- Around line 83-87: Update the listed cloud-service references to expand each
acronym on first use in this section by replacing or augmenting the short form
with the full service name (e.g., change "EKS" to "Amazon Elastic Kubernetes
Service (EKS)", "AKS" to "Azure Kubernetes Service (AKS)", "GKE" to "Google
Kubernetes Engine (GKE)", "OCI/OKE" to "Oracle Cloud Infrastructure (OCI) /
Oracle Kubernetes Engine (OKE)"), ensuring the short acronyms remain in
parentheses for subsequent readability in the bullet list.
In `@docs/Integrations` &
Plugins/plugins-overview/kubernetes-plugins/akeyless-kubernetes-secrets-injector.md:
- Line 27: Change the phrase "high level" to the hyphenated compound adjective
"high-level" in the sentence that begins "Although authorization in Kubernetes
is intentionally high level," so it reads "Although authorization in Kubernetes
is intentionally high-level," to follow compound-adjective hyphenation and
documentation style; no other wording changes needed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 73373b18-15fc-4de0-852e-e7278c644336
📒 Files selected for processing (4)
.cspell/akeyless-standard-dictionary.txtdocs/Akeyless Gateway/deploy-gateway/gateway-deploy-kubernetes-helm/gateway-kubernetes-helm-values-reference.mddocs/Akeyless Gateway/gateway-best-practices.mddocs/Integrations & Plugins/plugins-overview/kubernetes-plugins/akeyless-kubernetes-secrets-injector.md
…gh-level hyphenation
Summary
Adds Kubernetes pod scheduling and high availability documentation for the Akeyless Gateway and Kubernetes Secrets Injector Helm charts.
Jira: DOCS-670
Changes
gateway-best-practices.md
## Pod scheduling for high availability (Kubernetes)sectiontopologySpreadConstraintsand pod anti-affinity for multi-pod deploymentsgateway-kubernetes-helm-values-reference.md
### Pod Schedulingsection under## Operational Settingsgateway.deployment.nodeSelector,gateway.deployment.tolerations,gateway.deployment.affinity, andgateway.deployment.topologySpreadConstraintswith YAML examplestopologySpreadConstraintsin the Gateway chart requiresaffinity.enabled: trueakeyless-kubernetes-secrets-injector.md
## Pod scheduling for high availabilitysection for theakeyless-k8s-secrets-injectionchartenabled/datasub-keys fortolerationsandtopologySpreadConstraints)topologySpreadConstraintsis independent ofaffinity.enabledValidation