chore: add more details on efs and ebs usage#81
Conversation
WalkthroughSe han realizado cambios en la documentación de AWS EBS y EFS en los archivos Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (3)
docs/cluster/addons/ebs.mdx (1)
43-43: ¡Vamos a darle más chicha a esta documentación!¡Eh, compañero! La explicación sobre el StorageClass está más flaca que un fideo. Deberíamos mostrar un ejemplo completo de cómo se usa en los values.yaml.
Agrega un ejemplo así:
To use EBS Volumes you must pass to the chart values the 'StorageClass' name 'gp2'. + +Example in values.yaml: +```yaml +persistence: + enabled: true + storageClass: "gp2" + size: 10Gi +```docs/cluster/addons/efs.mdx (2)
47-57: ¡Metele más chicha a la documentación, papá!La sección está buena pero le falta más información jugosa:
- Agregar un ejemplo de cómo configurar el StorageClass en los values.yaml
- Explicar la diferencia entre las políticas 'delete' y 'retain'
- Mencionar las limitaciones o consideraciones importantes al usar EFS
¿Querés que te ayude a expandir esta sección con más detalles? ¡Nomás avisá y nos ponemos las pilas!
55-57: ¡Dale formato al comando, maestro!El bloque de código necesita un identificador de lenguaje para mejor resaltado de sintaxis.
Cambialo así:
-``` +```bash kubectl get storageclass --all-namespaces</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 9dd6fd1e96f67d06a95c04ed3805bab12c2d489b and b74d0addfd46a9ae78c6e28d82946bb4fcf657c0. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `docs/cluster/addons/ebs.mdx` (1 hunks) * `docs/cluster/addons/efs.mdx` (1 hunks) </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| ``` | ||
| kubectl get storageclass --all-namespaces | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
¡Dale más contexto al comando, maestro!
El comando está más solo que un árbitro en una final. ¡Vamos a explicar qué significa la salida y qué debe buscar el usuario!
Agrega esta información:
kubectl get storageclass --all-namespaces
+
+This command will show all available StorageClasses. Look for the `gp2` StorageClass, which should be marked as `(default)`. Example output:
+
+```
+NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
+gp2 (default) kubernetes.io/aws-ebs Delete WaitForFirstConsumer true 1d
+```
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| kubectl get storageclass --all-namespaces | |
| ``` | |
| ``` | |
| kubectl get storageclass --all-namespaces | |
| ``` | |
| This command will show all available StorageClasses. Look for the `gp2` StorageClass, which should be marked as `(default)`. Example output: | |
| ``` | |
| NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE | |
| gp2 (default) kubernetes.io/aws-ebs Delete WaitForFirstConsumer true 1d | |
| ``` |
| <summary> | ||
| You can check your current StorageClasses | ||
| </summary> |
There was a problem hiding this comment.
¡Ojo! Hay un summary perdido dentro del details
¡A las piñas con ese summary que está mal colocado! 💪 Necesitamos arreglar la estructura del MDX para que quede más limpio que un peso recién acuñado.
Aplica este cambio para dejarlo más ordenado:
To use EBS Volumes you must pass to the chart values the 'StorageClass' name 'gp2'.
-<summary>
-You can check your current StorageClasses
-</summary>
You can check your current StorageClasses with:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <summary> | |
| You can check your current StorageClasses | |
| </summary> | |
| You can check your current StorageClasses with: |
| To use EFS Volumes you must pass to the chart values the 'StorageClass' name 'efs-sc-delete' or 'efs-sc-retain' depending of which [retain policy <FiExternalLink/>](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed. | ||
| <summary> | ||
| You can check your current StorageClasses | ||
| </summary> |
There was a problem hiding this comment.
¡Che, tenemos un problemita con el formato!
¡A las piñas con el MDX! Hay un error en la estructura:
- Tenés un
<summary>anidado dentro de otro<summary> - Falta el cierre del primer
</summary>
Dale con este cambio:
To use EFS Volumes you must pass to the chart values the 'StorageClass' name 'efs-sc-delete' or 'efs-sc-retain' depending of which [retain policy <FiExternalLink/>](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed.
-<summary>
You can check your current StorageClasses
-</summary>
To check your current StorageClasses, run:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To use EFS Volumes you must pass to the chart values the 'StorageClass' name 'efs-sc-delete' or 'efs-sc-retain' depending of which [retain policy <FiExternalLink/>](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed. | |
| <summary> | |
| You can check your current StorageClasses | |
| </summary> | |
| To use EFS Volumes you must pass to the chart values the 'StorageClass' name 'efs-sc-delete' or 'efs-sc-retain' depending of which [retain policy <FiExternalLink/>](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed. | |
| To check your current StorageClasses, run: |
| <summary> | ||
| **How do I use ebs volumes on my own charts?** | ||
| </summary> | ||
| To use EBS Volumes you must pass to the chart values the 'StorageClass' name 'gp2'. |
There was a problem hiding this comment.
Aca por las dudas el mejor para usar es 'ebs-csi-default-sc' que es de gp3 y se instala con el EBS CSI Driver. O sea tambien se puede usar gp2 pero no tendria sentido hacerlo
|
cierro esta PR ya esta dentro de #80 |
3 participants
Summary by CodeRabbit