feat: add more dependency doc#118
Conversation
WalkthroughSe añaden ocho nuevas páginas MDX (inglés y traducciones al español) que documentan la integración y flujo de configuración en SleakOps para AWS Aurora MySQL, Aurora PostgreSQL, MariaDB (RDS) y MSK (Kafka), con FAQs, guías paso a paso, tablas de parámetros, comandos de import/export, imágenes con Zoom y enlaces a AWS. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Usuario
participant Console as SleakOps Console
participant Backend as SleakOps Backend
participant AWS as AWS Service
participant Varg as Vargroups
Usuario->>Console: Abrir Dependencias y seleccionar servicio
Console->>Usuario: Mostrar formulario de creación (Zoom / imágenes)
Usuario->>Console: Enviar parámetros de configuración
Console->>Backend: POST /provision (payload)
Backend->>AWS: Provisionar recurso (Aurora/MariaDB/MSK)
AWS-->>Backend: Respuesta (endpoints, IDs, credenciales)
Backend->>Varg: Crear/actualizar Vargroup con atributos
Backend-->>Console: Estado y outputs de creación
Console-->>Usuario: Mostrar outputs y enlace a Vargroup
rect rgba(230,246,255,0.6)
note right of AWS: Distinciones clave: Serverless vs Provisioned,\nversiones soportadas, backups y auto-scaling
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
⛔ Files ignored due to path filters (2)
📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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: 10
🧹 Nitpick comments (4)
docs/project/dependency/msk-aws.mdx (1)
125-126: Pulir redacción.“Here the parameters…” → “Here are the parameters SleakOps lets you customize during creation:”.
-Here the parameters that SleakOps allows you to customize during the creation: +Here are the parameters SleakOps lets you customize during creation:docs/project/dependency/mariadb-aws.mdx (2)
2-4: Import duplicado del CSS.Línea 2 y 3 importan lo mismo. Elimina uno para evitar cargas redundantes.
import "react-medium-image-zoom/dist/styles.css"; -import "react-medium-image-zoom/dist/styles.css";
76-84: Inglés: “existent dump” → “existing dump”.-### How do I import an existent dump to my local machine? +### How do I import an existing dump to my local machine?docs/project/dependency/aurora-mysql-aws.mdx (1)
129-133: Evitar hardcodear versiones y validaciones; enlazar a la doc oficialEn vez de listar versiones o reglas de contraseña en el texto, enlaza a las release notes de Amazon Aurora MySQL y a la guía de Aurora Serverless v2 (ACU — pasos de 0.5; Min/Max varía según versión) para evitar roturas y mantenimiento extra. — en sleakops arreglamos los conflictos a las piñas.
Ubicación: docs/project/dependency/aurora-mysql-aws.mdx (líneas 129–133)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
docs/project/dependency/aurora-mysql-aws.mdx(1 hunks)docs/project/dependency/aurora-postgresql-aws.mdx(1 hunks)docs/project/dependency/mariadb-aws.mdx(1 hunks)docs/project/dependency/msk-aws.mdx(1 hunks)
🔇 Additional comments (3)
docs/project/dependency/mariadb-aws.mdx (1)
101-107: LGTM en flujo de alta.El paso a paso es claro y consistente con otras dependencias.
docs/project/dependency/aurora-mysql-aws.mdx (1)
107-113: LGTM en estructura y FAQs.La organización (FAQs + 3 pasos + capturas) queda prolija.
docs/project/dependency/aurora-postgresql-aws.mdx (1)
106-113: LGTM en el flujo y consistencia visual.La guía en 3 pasos y el uso de Zoom están alineados con el resto del PR.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (12)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-mysql-aws.mdx (4)
42-42: No incrustar JSX dentro del texto del enlace MDX.
<FiExternalLink/>dentro de[...]()puede no renderizar bien. Mejor coloca el icono fuera del ancla.-2. **Consulta la Documentación**: Para más información sobre cómo crear un dump, consulta la [documentación oficial de MySQL <FiExternalLink/>](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html). +2. **Consulta la Documentación**: Para más información sobre cómo crear un dump, consulta la [documentación oficial de MySQL](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) <FiExternalLink/>.
137-138: Terminología: “RDS” vs “Aurora” al restaurar desde snapshot.Para evitar confusión, aclaremos que es un snapshot de Aurora (aunque sea parte de RDS).
-| **Crear un RDS desde un snapshot** | Marca esto si restauras desde un snapshot de base de datos. | -| **Identificador del Snapshot** | *(Requerido si restauras desde snapshot)* Identificador del snapshot RDS desde el cual restaurar. | +| **Restaurar desde snapshot de Aurora** | Marca esto si restauras desde un snapshot del clúster Aurora. | +| **Identificador del Snapshot** | *(Requerido si restauras desde snapshot)* Identificador del snapshot de Aurora desde el cual restaurar. |
55-66: Simplificar import con Docker y evitar variables irrelevantes.No necesitas
MYSQL_ROOT_PASSWORDsi solo usas el cliente. Propongo un one-liner y ajustar el texto “Conecta” → “Conéctate”.- docker run -it --name aurora-mysql-container -v ./initial_data/:/tmp/data/ -e MYSQL_ROOT_PASSWORD=AURORA_MYSQL_PASSWORD -d mysql bash + docker run --rm -v ./initial_data/:/data/ -it mysql:8 bash ... - docker exec -t -i aurora-mysql-container bash + # (si prefieres un único comando sin entrar al contenedor) + docker run --rm -v ./initial_data/:/data/ -i mysql:8 sh -lc 'mysql -h AURORA_MYSQL_ADDRESS -u AURORA_MYSQL_USERNAME -p < /data/dump.sql' ... - - Conecta a la terminal del contenedor: + - Conéctate a la terminal del contenedor:Also applies to: 63-65
39-41: Consistencia en placeholders.En ambos bloques, añade ejemplo explícito para
dump.sqlo indica “ruta absoluta/relativa”.¿Te preparo una variante con variables MDX admonitions para mayor claridad? En SleakOps arreglamos los conflictos a las piñas, pero los placeholders mejor dejarlos finitos.
Also applies to: 65-66
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx (4)
2-4: Import CSS duplicado.Se importa
react-medium-image-zoom/dist/styles.cssdos veces.import Zoom from "react-medium-image-zoom"; import "react-medium-image-zoom/dist/styles.css"; -import "react-medium-image-zoom/dist/styles.css"; import { FiExternalLink } from "react-icons/fi";
51-51: No incrustar JSX dentro del texto del enlace MDX.Mismo caso que en Aurora: mueve el icono fuera del enlace.
-2. **Consulta la Documentación**: Para más información sobre cómo crear un dump, consulta la [documentación oficial de MariaDB <FiExternalLink/>](https://mariadb.com/kb/en/mysqldump/). +2. **Consulta la Documentación**: Para más información sobre cómo crear un dump, consulta la [documentación oficial de MariaDB](https://mariadb.com/kb/en/mysqldump/) <FiExternalLink/>.
58-59: Español: “Conéctate a la VPN”.Pequeña mejora de redacción.
-1. **Conecta a la VPN**: Asegúrate de estar conectado a la VPN de la cuenta AWS donde se encuentra la instancia RDS. +1. **Conéctate a la VPN**: Asegúrate de estar conectado a la VPN de la cuenta AWS donde se encuentra la instancia RDS.
61-74: Flujo Docker: usar cliente sin levantar servicio.Mismo ajuste que en Aurora: evitar
MYSQL_ROOT_PASSWORDy usar un comando único.- docker run -it --name mariadb-container -v ./initial_data/:/tmp/data/ -e MYSQL_ROOT_PASSWORD=MARIADB_PASSWORD -d mariadb bash + docker run --rm -v ./initial_data/:/data/ -i mariadb:11 sh -lc 'mysql -h MARIADB_ADDRESS -u MARIADB_USERNAME -p < /data/dump.sql'Also applies to: 71-73
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/msk-aws.mdx (4)
22-22: Versiones de Kafka — evitar lista rígida.Las versiones soportadas cambian. Mejor “por ejemplo” + enlazar docs o mover la lista a una nota con fecha.
-Sí, Amazon MSK soporta actualizaciones de versión de Kafka. Puedes actualizar entre las versiones soportadas: 2.8.1, 3.2.0, 3.3.2, 3.4.0, y 3.5.1. +Sí, Amazon MSK soporta actualizaciones de versión de Kafka. Por ejemplo, versiones 2.8.x y 3.x (consulta la documentación de MSK para el listado vigente).
39-41: Terminología: “bootstrap servers”.Sugerencia de traducción y consistencia (“servidores bootstrap”).
-1. **Obtén los Bootstrap Servers**: Usa los endpoints de bootstrap server proporcionados por SleakOps en el vargroup. +1. **Obtén los servidores bootstrap**: Usa los endpoints de bootstrap proporcionados por SleakOps en el vargroup. -2. **Configura la Autenticación**: MSK soporta varios métodos de autenticación incluyendo SASL/SCRAM, IAM, y TLS. +2. **Configura la autenticación**: MSK soporta varios métodos de autenticación, incluyendo SASL/SCRAM, IAM y TLS.
54-56: Añadir lenguaje a los bloques de código.Mejor DX con resaltado (bash).
-``` +```bash kafka-topics.sh --create --topic my-topic --bootstrap-server MSK_BOOTSTRAP_SERVERS --partitions 3 --replication-factor 3...
-+bash
kafka-console-producer.sh --topic my-topic --bootstrap-server MSK_BOOTSTRAP_SERVERS... -``` +```bash kafka-console-consumer.sh --topic my-topic --bootstrap-server MSK_BOOTSTRAP_SERVERS --from-beginningAlso applies to: 69-71, 73-74 --- `59-60`: **Replicación en Serverless — matiz.** Bien la idea, pero aclararía que el factor de replicación lo gestiona MSK Serverless y puede no coincidir con el número de brokers (que no configuras). ¿Agregamos una nota corta para evitar que el lector intente forzar `--replication-factor` en serverless? </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro **Disabled knowledge base sources:** - Jira integration is disabled by default for public repositories > You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between f19b17022aebc646975bff943ceb2ad61e6ee402 and bc4cf3519bfbdf76f77fa621dec01fb188efc93b. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-mysql-aws.mdx` (1 hunks) * `i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-postgresql-aws.mdx` (1 hunks) * `i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx` (1 hunks) * `i18n/es/docusaurus-plugin-content-docs/current/project/dependency/msk-aws.mdx` (1 hunks) </details> <details> <summary>✅ Files skipped from review due to trivial changes (1)</summary> * i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-postgresql-aws.mdx </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx (2)</summary><blockquote> `37-38`: **Afirmación de “sin tiempo de inactividad” — validar contra RDS.** El escalado de almacenamiento y/o autoscaling en RDS puede tener matices según tipo de almacenamiento/versión. Sugiero suavizar o citar condiciones. Puedo ajustar el texto a “generalmente sin downtime” y enlazar a las condiciones si me confirmas la política que usa vuestro formulario. --- `137-137`: **Dependencia entre “Réplicas de Lectura” y “Respaldo Automatizado”.** Indicas “(Requerido si el respaldo automatizado está habilitado)”. En RDS MySQL/MariaDB suele ser al revés: para crear réplicas necesitas backups habilitados en el origen, no que el campo sea requerido por habilitar backups. Revisar lógica del formulario/texto. ¿Confirmas el comportamiento de vuestro backend para ajustar la redacción? </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (7)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx (7)
2-3: Import CSS duplicado: elimina la segunda línea.Hay dos imports idénticos del CSS de zoom. Deja uno solo para evitar cargas redundantes.
import "react-medium-image-zoom/dist/styles.css"; -import "react-medium-image-zoom/dist/styles.css";
45-49: Añade lenguaje a los fences para destacar sintaxis.Marca estos bloques como bash.
-``` +```bash mysqldump -h MARIADB_ADDRESS -u MARIADB_USERNAME -p --all-databases > dump.sql--- `63-74`: **Lo mismo aquí: especifica bash y afina redacción.** Pequeño toque para DX. ```diff -``` +```bash docker run -it --name mariadb-container -v ./initial_data/:/tmp/data/ -e MARIADB_ROOT_PASSWORD=MARIADB_PASSWORD -d mariadb bash -``` +``` ... -``` +```bash docker exec -t -i mariadb-container bash -``` +``` ... -``` +```bash mysql -h MARIADB_ADDRESS -u MARIADB_USERNAME -p < /tmp/data/dump.sql--- `80-83`: **Especifica bash también en el ejemplo local.** ```diff -``` +```bash mysql -h MARIADB_ADDRESS -u MARIADB_USERNAME -p < dump.sql--- `101-107`: **Verifica rutas internas de Docusaurus.** Los enlaces con “/index.mdx” a veces no resuelven en producción. Mejor enlazar a la ruta sin el nombre del archivo. ```diff -Para más detalles, consulta [Dependencies: Integrating Databases, Caching, and Messaging Services](/project/dependency/index.mdx). +Para más detalles, consulta [Dependencies: Integrating Databases, Caching, and Messaging Services](/project/dependency/).
12-17: Confirma también la ruta de “Vargroups”.Mismo tema de rutas “index.mdx”.
-Podrás gestionarlos desde la sección de [Vargroups](/project/vargroup/index.mdx). +Podrás gestionarlos desde la sección de [Vargroups](/project/vargroup/).
91-95: Afinar troubleshooting de conexión.Añade mención explícita al puerto 3306 y a la accesibilidad pública/VPC endpoints para RDS según política de tu org. Evita tickets innecesarios.
- Verifica que tus grupos de seguridad y reglas de firewall permitan el acceso. + - Verifica SG/NACL para el puerto 3306 (TCP) desde las subredes/orígenes permitidos. + - Revisa si la instancia es de acceso público o si debes conectarte vía VPN/bastion/PrivateLink.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (6)
docs/project/dependency/aurora-postgresql-aws.mdx(1 hunks)docs/project/dependency/mariadb-aws.mdx(1 hunks)docs/project/dependency/msk-aws.mdx(1 hunks)i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-postgresql-aws.mdx(1 hunks)i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx(1 hunks)i18n/es/docusaurus-plugin-content-docs/current/project/dependency/msk-aws.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- i18n/es/docusaurus-plugin-content-docs/current/project/dependency/msk-aws.mdx
- docs/project/dependency/msk-aws.mdx
- docs/project/dependency/mariadb-aws.mdx
- i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-postgresql-aws.mdx
- docs/project/dependency/aurora-postgresql-aws.mdx
🔇 Additional comments (1)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/mariadb-aws.mdx (1)
111-116: Imágenes con Zoom: bien integrado.Props correctas y texto alternativo presente. Nada que tocar aquí.
Also applies to: 146-151
| - Install Docker on your local machine if not already installed. | ||
| - Run a MySQL Docker container with the following command: | ||
| ``` | ||
| docker run -it --name aurora-mysql-container -v ./initial_data/:/tmp/data/ -e MYSQL_ROOT_PASSWORD=AURORA_MYSQL_PASSWORD -d mysql bash |
There was a problem hiding this comment.
agrega un paso aclarando que deben dejar el dump en ./initial_data
There was a problem hiding this comment.
la linea 53 deberia ser la 54 y la 53 deberia decir
- dejar tu dump en una carpeta "initial_data"
y recien ahi lo mandas a correr el docker run
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-mysql-aws.mdx (1)
135-135: Corregir lista de clases de instancia (se mezclaron dos valores).La última entrada aparece como “db.r7i.xlarge.t3.medium”. Deben ser dos clases separadas y, para consistencia, todas entre comillas invertidas.
-| **Clase de Instancia de la Base de Datos** | **Modo Serverless**: Fijo a `db.serverless`<br/>**Modo Provisioned**: Elige entre db.t3.medium, db.t4g.medium, db.t3.large, db.t4g.large, db.r8g.large, db.r8g.xlarge, db.r7i.large, db.r7i.xlarge.t3.medium. | +| **Clase de Instancia de la Base de Datos** | **Modo Serverless**: Fijo a `db.serverless`<br/>**Modo Provisioned**: Elige entre `db.t3.medium`, `db.t4g.medium`, `db.t3.large`, `db.t4g.large`, `db.r8g.large`, `db.r8g.xlarge`, `db.r7i.large`, `db.r7i.xlarge`. |
🧹 Nitpick comments (8)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-mysql-aws.mdx (8)
38-42: Añadir lenguaje a los bloques de código y mover el icono fuera del texto del enlace.
- Usa “bash” para mejor resaltado.
- En MDX, el icono dentro del texto del enlace puede no renderizar bien; colócalo a continuación.
-``` +```bash mysqldump -h AURORA_MYSQL_ADDRESS -u AURORA_MYSQL_USERNAME -p --all-databases > dump.sql-2. Consulta la Documentación: Para más información sobre cómo crear un dump, consulta la documentación oficial de MySQL .
+2. Consulta la Documentación: Para más información, revisa la documentación oficial de MySQL--- `47-47`: **Capitalizar “Docker” en el título de la pregunta.** ```diff -### ¿Cómo importo un dump existente usando docker? +### ¿Cómo importo un dump existente usando Docker?
55-66: Ajustar flags de docker run y añadir lenguaje a bloques.Usar
-djunto con-ites confuso. Si luego hacesdocker exec, deja el contenedor en background (-d) y quita-itdelrun. Añade “bash” en los bloques.-``` +```bash -docker run -it --name aurora-mysql-container -v ./initial_data/:/tmp/data/ -e MYSQL_ROOT_PASSWORD=AURORA_MYSQL_PASSWORD -d mysql bash +docker run -d --name aurora-mysql-container -v ./initial_data/:/tmp/data/ -e MYSQL_ROOT_PASSWORD=AURORA_MYSQL_PASSWORD mysql bash-
+bash
docker exec -t -i aurora-mysql-container bash-``` +```bash mysql -h AURORA_MYSQL_ADDRESS -u AURORA_MYSQL_USERNAME -p < /tmp/data/dump.sql--- `58-58`: **Pequeña mejora de redacción.** ```diff - - Conecta a la terminal del contenedor: + - Accede a la terminal del contenedor:
74-76: Añadir lenguaje al bloque de código (bash).-``` +```bash mysql -h AURORA_MYSQL_ADDRESS -u AURORA_MYSQL_USERNAME -p < dump.sql--- `98-101`: **Pulir beneficios: precisión terminológica.** Propuesta menor para “recuperación a un punto en el tiempo (PITR)”. ```diff -- **Disponibilidad**: Respaldo continuo a S3 con recuperación punto en el tiempo +- **Disponibilidad**: Respaldo continuo a S3 con recuperación a un punto en el tiempo (PITR)
113-113: Enlaces internos en Docusaurus: omitir la extensión .mdx.Evita la extensión para que los enlaces no se rompan con cambios de build/rutas.
-Para más detalles, consulta [Dependencies: Integrating Databases, Caching, and Messaging Services](/project/dependency/index.mdx). +Para más detalles, consulta [Dependencies: Integrating Databases, Caching, and Messaging Services](/project/dependency/)
135-137: Verificar etiquetado “db.serverless” y rangos ACU.¿Nuestro UI realmente muestra
db.serverlesscomo clase en Serverless v2? En AWS no hay clase de instancia para Serverless v2; podría ser un alias interno. Confirmad si el texto de cara al usuario debe decir solo “Serverless” sin clase. De paso, validar que los rangos de ACU (0.5–256) aplican a nuestra región soportada.¿Queréis que lo ajuste según cómo aparece hoy en el producto?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
i18n/es/docusaurus-plugin-content-docs/current/project/dependency/aurora-mysql-aws.mdx(1 hunks)
lautaro-suarez
deleted the
feat/SLEAK-3899_add-dependency-documentation
branch
3 participants
Summary by CodeRabbit