docs(cluster/addons): add Headlamp and KEDA reference pages#184
Merged
Conversation
- Replace empty Headlamp stub with a full reference page (EN + ES)
covering install, VPN-gated access, token rotation, role-scoped
RBAC, and the customValues escape hatch
- Add new KEDA reference page (EN + ES) explaining event-driven
autoscaling, the IRSA wiring via AWS Managed Policy Names, two
ScaledObject templates (SQS + CPU/memory), and customValues
- Add screenshots under static/img/cluster/addons/{headlamp,keda}/
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
WalkthroughSe expande la documentación del addon Headlamp reemplazando contenido embebido por guías FAQ estructuradas. Se introduce documentación nueva y completa del addon KEDA, con instrucciones de instalación, configuración de permisos AWS, ejemplos de escalado de workloads, y opciones de personalización. Ambos addons se documentan en paralelo en inglés y español. ChangesDocumentación de AddOns: Headlamp y KEDA
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 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 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@content/docs/en/cluster/addons/keda.mdx`:
- Line 4: Reemplaza el valor nulo de sidebar_position en keda.mdx por un número
fijo para fijar su lugar en la navegación; busca la clave sidebar_position en
keda.mdx y asigna un entero estable (por ejemplo el siguiente número después de
la entrada "Headlamp", p. ej. 5) en lugar de null para asegurar orden
consistente en el sidebar.
- Line 12: Actualiza las afirmaciones sobre HPA en el texto que comienza con
"[KEDA <FiExternalLink/>]..." (la frase que actualmente dice "Kubernetes'
built-in HPA can only scale on CPU and memory of the Pods themselves") y la otra
instancia similar en la sección alrededor de la línea 40: reemplaza "can only
scale on CPU and memory" por una versión precisa como "by default scales on CPU
and memory" o "without external/custom metrics configured, HPA scales on CPU and
memory", para indicar que HPA puede usar métricas externas/custom mediante
adaptadores; aplica el mismo texto corregido en ambas ocurrencias.
In `@content/docs/es/cluster/addons/keda.mdx`:
- Line 4: El frontmatter usa `sidebar_position: null`, lo que genera un orden no
determinista; reemplaza `sidebar_position: null` por un valor numérico explícito
(por ejemplo `sidebar_position: 10`) en este archivo y asegúrate de asignar
posiciones consistentes entre los archivos de addons y sus traducciones para
mantener el mismo orden en todos los idiomas; busca la clave `sidebar_position`
en `keda.mdx` y actualizar su valor numérico coherente con el resto de addons.
- Line 12: Update the wording in content/docs/es/cluster/addons/keda.mdx where
HPA is described (references around the text on line 12 and line 40) to avoid
saying the native HPA "solo" scales by CPU and memory; instead state that the
Kubernetes HPA by default uses pod CPU/memory metrics but can also consume
external or custom metrics via metrics adapters, and clarify that KEDA queries
external sources to drive scaling (including scaling to zero). Modify the two
sentences mentioning HPA to this nuanced phrasing so the guide is accurate and
not overgeneralized.
🪄 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: 3f2ddc09-7999-47d7-b47a-f6930a46afa5
⛔ Files ignored due to path filters (10)
static/img/cluster/addons/headlamp/headlamp-detail.pngis excluded by!**/*.pngstatic/img/cluster/addons/headlamp/headlamp-install-form.pngis excluded by!**/*.pngstatic/img/cluster/addons/headlamp/headlamp-installed-card.pngis excluded by!**/*.pngstatic/img/cluster/addons/headlamp/headlamp-token-dialog.pngis excluded by!**/*.pngstatic/img/cluster/addons/headlamp/headlamp-ui.pngis excluded by!**/*.pngstatic/img/cluster/addons/keda/keda-addons-listing.pngis excluded by!**/*.pngstatic/img/cluster/addons/keda/keda-architecture.pngis excluded by!**/*.pngstatic/img/cluster/addons/keda/keda-install-form-customvalues.pngis excluded by!**/*.pngstatic/img/cluster/addons/keda/keda-install-form-default.pngis excluded by!**/*.pngstatic/img/cluster/addons/keda/keda-install-form-policies.pngis excluded by!**/*.png
📒 Files selected for processing (4)
content/docs/en/cluster/addons/headlamp.mdxcontent/docs/en/cluster/addons/keda.mdxcontent/docs/es/cluster/addons/headlamp.mdxcontent/docs/es/cluster/addons/keda.mdx
|
|
||
| # KEDA | ||
|
|
||
| [KEDA <FiExternalLink/>](https://keda.sh/docs/2.19/) — **K**ubernetes-based **E**vent-**D**riven **A**utoscaler — is an Addon that lets workloads in your Cluster scale based on **external signals**: the depth of an SQS queue, the lag of a Kafka consumer group, a CloudWatch alarm, the number of pending Redis keys, the count of rows in a database, and dozens more. Where Kubernetes' built-in HPA can only scale on CPU and memory of the Pods themselves, KEDA reaches outside the Cluster, asks the source how much work is waiting, and scales the workload accordingly — including down to **zero replicas** when there is nothing to do. |
There was a problem hiding this comment.
Corrige la afirmación sobre límites de HPA para evitar documentación técnicamente incorrecta.
En la Line 12 y la Line 40 se afirma que HPA “solo” escala por CPU/memoria. Eso no es exacto: HPA también puede escalar con métricas custom/external cuando hay adapter. Ajustá el texto a “por defecto” o “sin métricas externas configuradas” para no confundir a quien lo implemente.
💡 Propuesta de ajuste rápida
-Where Kubernetes' built-in HPA can only scale on CPU and memory of the Pods themselves, KEDA reaches outside the Cluster...
+Where Kubernetes' built-in HPA typically scales on CPU and memory out of the box (and needs extra metric adapters for external/custom metrics), KEDA reaches outside the Cluster...
-When you only need to scale on the Pod's own CPU/memory, the built-in HPA is enough...
+When you only need CPU/memory scaling, the built-in HPA is usually enough...Also applies to: 40-40
🤖 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 `@content/docs/en/cluster/addons/keda.mdx` at line 12, Actualiza las
afirmaciones sobre HPA en el texto que comienza con "[KEDA
<FiExternalLink/>]..." (la frase que actualmente dice "Kubernetes' built-in HPA
can only scale on CPU and memory of the Pods themselves") y la otra instancia
similar en la sección alrededor de la línea 40: reemplaza "can only scale on CPU
and memory" por una versión precisa como "by default scales on CPU and memory" o
"without external/custom metrics configured, HPA scales on CPU and memory", para
indicar que HPA puede usar métricas externas/custom mediante adaptadores; aplica
el mismo texto corregido en ambas ocurrencias.
|
|
||
| # KEDA | ||
|
|
||
| [KEDA <FiExternalLink/>](https://keda.sh/docs/2.19/) — **K**ubernetes-based **E**vent-**D**riven **A**utoscaler — es un Addon que permite escalar workloads de tu Clúster en base a **señales externas**: la cantidad de mensajes en una cola SQS, el lag de un consumer group de Kafka, una alarma de CloudWatch, la cantidad de claves pendientes en Redis, el número de filas en una base de datos, y decenas más. Mientras que el HPA nativo de Kubernetes solo escala según CPU y memoria de los Pods, KEDA consulta la fuente externa, pregunta cuánto trabajo está pendiente, y escala el workload acorde — incluso bajando a **cero réplicas** cuando no hay nada para procesar. |
There was a problem hiding this comment.
Ajustá la explicación de HPA porque está sobregeneralizada.
En la Line 12 y la Line 40 se dice que el HPA nativo “solo” escala por CPU/memoria. Eso queda técnicamente incorrecto: con adapter, HPA también puede usar métricas externas/custom. Mejor matizar esa frase para que la guía no lleve a conclusiones erróneas.
💡 Propuesta de redacción
-Mientras que el HPA nativo de Kubernetes solo escala según CPU y memoria de los Pods...
+Mientras que el HPA nativo de Kubernetes escala por CPU y memoria por defecto (y requiere adapters para métricas externas/custom)...
-Si solo necesitás escalar por CPU/memoria del Pod, el HPA nativo es suficiente...
+Si solo necesitás escalar por CPU/memoria del Pod, el HPA nativo suele ser suficiente...Also applies to: 40-40
🤖 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 `@content/docs/es/cluster/addons/keda.mdx` at line 12, Update the wording in
content/docs/es/cluster/addons/keda.mdx where HPA is described (references
around the text on line 12 and line 40) to avoid saying the native HPA "solo"
scales by CPU and memory; instead state that the Kubernetes HPA by default uses
pod CPU/memory metrics but can also consume external or custom metrics via
metrics adapters, and clarify that KEDA queries external sources to drive
scaling (including scaling to zero). Modify the two sentences mentioning HPA to
this nuanced phrasing so the guide is accurate and not overgeneralized.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds two cluster addon reference pages, EN + ES, following the existing
kubecost.mdx/grafana.mdxpattern.Headlamp (replaces empty stub)
:::info BetaadmonitionKEDA (new page)
:::info BetaadmonitionScaledObjecttemplates (SQS event-driven + CPU/memory HPA-style) explicitly noting that the manifests are user-defined / Custom ValuesScreenshots
Captured from the local SleakOps console (prod profile) plus the official
keda.sharchitecture diagram. Filed understatic/img/cluster/addons/{headlamp,keda}/.Test plan
<FiExternalLink/>icon shows on every external link🤖 Generated with Claude Code
Summary by CodeRabbit
Notas de Lanzamiento