Skip to content

chore: cluster shutdown and changelog 1.7.6#90

Merged
lucaiz merged 3 commits intodevelopfrom
chore/SLEAK-2682_cluster-shutdown-and-changelog-1.7.6
Jan 6, 2025
Merged

chore: cluster shutdown and changelog 1.7.6#90
lucaiz merged 3 commits intodevelopfrom
chore/SLEAK-2682_cluster-shutdown-and-changelog-1.7.6

Conversation

@lucaiz
Copy link
Copy Markdown
Contributor

@lucaiz lucaiz commented Jan 6, 2025

Summary by CodeRabbit

Notas de Versión 1.7.6

  • Nuevas Características

    • Configuraciones de Nodepool con parámetros adicionales
    • Creación de trabajos con imágenes específicas
    • Extensión de Gráficos por Proyecto (BETA)
    • Mejoras en CI/CD
  • Correcciones de Errores

    • Corregido URL de Servicio Web Interno
    • Problemas resueltos de eliminación de Volúmenes
    • Mejoras de UX/UI para Proyectos, Volúmenes y Grupos de Variables
  • Documentación

    • Actualizada documentación de apagado de clúster con nuevas instrucciones y advertencias
    • Agregadas visualizaciones y detalles sobre la activación del apagado programado

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 6, 2025

Walkthrough

La versión 1.7.6 introduce mejoras significativas en la documentación de SleakOps, centrándose principalmente en dos áreas clave: el registro de cambios y la funcionalidad de apagado de clústeres. Se han actualizado los documentos en inglés y español, añadiendo detalles sobre nuevas configuraciones de nodepool, mejoras en CI/CD, correcciones de errores y una explicación detallada del proceso de apagado programado de clústeres.

Changes

Archivo Resumen de Cambios
docs/changelog.mdx Añadida entrada de versión 1.7.6 con nuevas características y correcciones
docs/cluster/shutdown-cluster.mdx Documentación ampliada sobre apagado de clústeres, instrucciones de configuración y advertencias
i18n/es/docusaurus-plugin-content-docs/current/changelog.mdx Traducción de la entrada de versión 1.7.6 al español
i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx Traducción de la documentación de apagado de clústeres al español
Makefile Añadido nuevo objetivo run-es para ejecutar Docusaurus en versión ESP

Assessment against linked issues

Objetivo Abordado Explicación
SLEAK-2682: Documentar apagado nocturno

Possibly related PRs

Poem

En SleakOps, donde los clústeres bailan,
Un apagado nocturno se programa con maña,
Configuraciones que brillan cual estrella,
Documentación que cuenta cada batalla,
¡Optimización que el equipo ensalza! 🚀✨


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (7)
docs/cluster/shutdown-cluster.mdx (2)

3-8: ¡Oye! ¡Vamos a darle más punch a esta explicación! 🥊

¡Che! La explicación está buena, pero podríamos hacerla más contundente agregando ejemplos concretos de ahorro de costos. También podríamos hacer que la advertencia sea más visible con emojis de alerta.

-It is the capacity to turn off all your cluster's resources at a specified scheduled time to avoid incurring costs during that time frame. 
+It is the capacity to turn off all your cluster's resources at a specified scheduled time to avoid incurring costs during that time frame. For example, you can save up to 70% on costs by shutting down during non-business hours.

-:::warning
+:::warning ⚠️ IMPORTANT ⚠️
🧰 Tools
🪛 LanguageTool

[typographical] ~4-~4: It seems that a comma is missing.
Context: ... that time frame. When this feature is activated you will be able to turn ON or OFF your...

(IF_COMMA)


25-34: ¡Metámosle unos ejemplos prácticos, papá! 💪

¡Epa! Los cronjobs son medio complicados de entender así nomás. ¿Qué te parece si le metemos unos ejemplos bien claros?

Agreguemos una tabla con ejemplos prácticos:

+| **Example** | **Description** |
+| --- | --- |
+| **Weekdays only** | Monday to Friday |
+| **Auto Downtime** | 20:00 (8 PM) |
+| **Auto Uptime** | 08:00 (8 AM) |
🧰 Tools
🪛 LanguageTool

[uncategorized] ~33-~33: Possible missing comma found.
Context: ...uns. It is shown in your local time. | Below you will see a box that shows 'Generate...

(AI_HYDRA_LEO_MISSING_COMMA)

i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx (1)

34-34: ¡Ojo con el spanglish técnico! 🤓

¡Mirá! Tenemos términos técnicos en inglés mezclados con español. Si bien está bien dejar algunos términos técnicos en inglés, deberíamos ser consistentes.

-Debajo verás un cuadro que muestra las 'Generated Cron Expressions (UTC)', que despliega las expresiones cron de APAGADO y ENCENDIDO para estas dos acciones en horario UTC.
+Debajo verás un cuadro que muestra las 'Expresiones Cron Generadas (UTC)', que despliega las expresiones cron de APAGADO y ENCENDIDO para estas dos acciones en horario UTC.
docs/changelog.mdx (1)

9-12: ¡Che, agreguemos más chicha a estas descripciones! 🥩

Las nuevas características están bien, pero podrían tener más detalles técnicos para que los usuarios entiendan mejor los cambios.

-**New Nodepool Configurations**: You can now set additional parameters, such as minimum instance sizes and more.
+**New Nodepool Configurations**: You can now set additional parameters including minimum instance sizes, node labels, taints, and resource quotas for better workload management.

-**(BETA) Chart Extension by Project**: SleakOps can now extend the charts used to deploy project executions, allowing you to add dependencies.
+**(BETA) Chart Extension by Project**: SleakOps can now extend the charts used to deploy project executions, allowing you to add dependencies and customize Helm charts at the project level.
i18n/es/docusaurus-plugin-content-docs/current/changelog.mdx (3)

3-3: ¡Che, hay que estandarizar el formato de las versiones! 🥊

Hay inconsistencia en cómo se escriben los encabezados de versión. Algunas usan "Versión" y otras "Version" (en inglés). Propongo estandarizar todos los encabezados al formato:

-## Version 1.7.5
+## **Versión 1.7.5**

Also applies to: 19-19, 45-45, 89-89, 129-129, 169-169, 209-209, 249-249, 289-289, 329-329, 369-369, 409-409, 449-449, 489-489, 529-529, 569-569, 609-609, 649-649, 689-689, 729-729


16-16: ¡Ojo con las siglas, compañero! 🥊

En español, las siglas no llevan marca de plural. Hay que corregir "URLs" a "URL".

-**URL de Web Services internos**: Se corrigió un problema que causaba URLs incorrectas para los servicios web de tipo "interno".
+**URL de Web Services internos**: Se corrigió un problema que causaba URL incorrectas para los servicios web de tipo "interno".
🧰 Tools
🪛 LanguageTool

[misspelling] ~16-~16: El plural de las siglas no se marca gráficamente.
Context: ...**: Se corrigió un problema que causaba URLs incorrectas para los servicios web de t...

(SIGLAS)


11-11: ¡Metele más advertencias a las funciones beta! 🥊

Para las funciones en beta como la "Extensión de Charts por Proyecto", sería bueno agregar una nota de advertencia sobre posibles limitaciones o problemas conocidos. Esto ayuda a los usuarios a entender los riesgos antes de usarlas.

- **(BETA) Extensión de Charts por Proyecto**: SleakOps ahora puede extender los charts utilizados para desplegar ejecuciones de proyectos, permitiéndote agregar dependencias. Para más información, consulta la [documentación de Helm](https://helm.sh/docs/helm/helm_dependency/).
+ **(BETA) Extensión de Charts por Proyecto**: SleakOps ahora puede extender los charts utilizados para desplegar ejecuciones de proyectos, permitiéndote agregar dependencias. ⚠️ *Esta función está en beta y puede tener limitaciones. Úsala con precaución en entornos de producción.* Para más información, consulta la [documentación de Helm](https://helm.sh/docs/helm/helm_dependency/).
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 481f74e and cc82454.

⛔ Files ignored due to path filters (2)
  • static/img/cluster/settings/shutdown-config.png is excluded by !**/*.png
  • static/img/cluster/settings/shutdown.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • docs/changelog.mdx (1 hunks)
  • docs/cluster/shutdown-cluster.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/changelog.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
i18n/es/docusaurus-plugin-content-docs/current/changelog.mdx

[misspelling] ~16-~16: El plural de las siglas no se marca gráficamente.
Context: ...**: Se corrigió un problema que causaba URLs incorrectas para los servicios web de t...

(SIGLAS)

i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx

[uncategorized] ~3-~3: Probablemente falta un signo diacrítico.
Context: ...idad de apagar todos los recursos de tu cluster en un horario programado para evitar in...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[uncategorized] ~4-~4: Probablemente falta un signo diacrítico.
Context: ...á activada, podrás encender o apagar tu cluster en cualquier momento, incluso fuera del...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[uncategorized] ~7-~7: Probablemente falta un signo diacrítico.
Context: ...ayas configurado. :::warning Cuando tu cluster está APAGADO, no podrás ejecutar Builds...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[uncategorized] ~7-~7: Probablemente falta un signo diacrítico.
Context: ...ras acciones que requieran recursos del cluster para ejecutarse. ::: ### ¿Cómo puedo a...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[typographical] ~25-~25: Mayúsculas y minúsculas recomendadas.
Context: ...onfig" /> Cuando configures el Apagado del Cluster, estarás creando dos cronjo...

(AI_ES_GGEC_REPLACEMENT_CASING_UPPERCASE)


[uncategorized] ~25-~25: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...Zoom> Cuando configures el Apagado del Cluster, estarás creando dos cronjobs: uno para...

(AI_ES_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELLING)


[uncategorized] ~25-~25: Probablemente falta un signo diacrítico.
Context: ...ando dos cronjobs: uno para ENCENDER el cluster en el horario programado y otro para AP...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[uncategorized] ~44-~44: Probablemente hay un error. Considere aplicar la sugerencia.
Context: .... Esta acción solo puede realizarse en clusters con estado Activo. <img src="/img/cl...

(AI_ES_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELLING)


[uncategorized] ~48-~48: Probablemente falta un signo diacrítico.
Context: ...xHeight: '200px' }} /> ### Encender el cluster Para encender un cluster, haz clic en ...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)


[uncategorized] ~52-~52: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...ón. Esta acción está disponible para clusters con estado Apagado Programado o *Apag...

(AI_ES_GGEC_REPLACEMENT_ORTHOGRAPHY_SPELLING)


[typographical] ~57-~57: Mayúsculas y minúsculas recomendadas.
Context: ...ht: '200px' }} /> :::info Las acciones cron que encienden o apagan el cluster según...

(AI_ES_GGEC_REPLACEMENT_CASING_LOWERCASE)


[uncategorized] ~57-~57: Probablemente falta un signo diacrítico.
Context: ...acciones cron que encienden o apagan el cluster según el horario programado seguirán ej...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_DIACRITIC)

docs/changelog.mdx

[style] ~16-~16: Consider using a different verb for a more formal wording.
Context: ...xes:** - Internal Web Service URL: Fixed an issue that caused incorrect URLs for...

(FIX_RESOLVE)

docs/cluster/shutdown-cluster.mdx

[typographical] ~4-~4: It seems that a comma is missing.
Context: ... that time frame. When this feature is activated you will be able to turn ON or OFF your...

(IF_COMMA)


[uncategorized] ~33-~33: Possible missing comma found.
Context: ...uns. It is shown in your local time. | Below you will see a box that shows 'Generate...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~40-~40: The word ‘shutdown’ is a noun. Did you mean the verb “shut down”?
Context: ...processes are active. ::: ## How can I shutdown my cluster at any time? In order to sh...

(SHUTDOWN)


[grammar] ~42-~42: The word “shutdown” is a noun. The verb is spelled with a white space.
Context: ...wn my cluster at any time? In order to shutdown a cluster, just click on the Stop but...

(NOUN_VERB_CONFUSION)

Comment thread docs/cluster/shutdown-cluster.mdx Outdated
<img src="/img/cluster/cluster-shutdown-inactive.png" alt="cluster-shutdown-inactive" style={{ marginRight: '20px', maxHeight: '200px' }} />

:::info
The cron actions that turn the cluster ON or OFF based on the scheduled time will still run even ff you have manually turned it ON or OFF.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

¡Ojo al piojo! ¡Encontré un typo! 🔍

¡Mirá! Se te coló un dedazo en el texto, escribiste "ff" en lugar de "if".

-The cron actions that turn the cluster ON or OFF based on the scheduled time will still run even ff you have manually turned it ON or OFF.  
+The cron actions that turn the cluster ON or OFF based on the scheduled time will still run even if you have manually turned it ON or OFF.  
📝 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.

Suggested change
The cron actions that turn the cluster ON or OFF based on the scheduled time will still run even ff you have manually turned it ON or OFF.
The cron actions that turn the cluster ON or OFF based on the scheduled time will still run even if you have manually turned it ON or OFF.

Comment on lines +28 to +32
| **Attribute** | **Description** |
| --- | --- |
| **Days** | Los días en los que se ejecutarán los cronjobs de apagado. |
| **Auto Downtime (Local Time)** | La hora a la que se ejecuta la acción de APAGADO. Se muestra en tu hora local. |
| **Auto Uptime (Local Time)** | La hora a la que se ejecuta la acción de ENCENDIDO. Se muestra en tu hora local. |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

¡Mezclamos idiomas como en un tango! 🎭

¡Che! La tabla está medio bilingüe. Mantengamos todo en español para que quede más prolijo.

-| **Attribute** | **Description** |
+| **Atributo** | **Descripción** |
📝 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.

Suggested change
| **Attribute** | **Description** |
| --- | --- |
| **Days** | Los días en los que se ejecutarán los cronjobs de apagado. |
| **Auto Downtime (Local Time)** | La hora a la que se ejecuta la acción de APAGADO. Se muestra en tu hora local. |
| **Auto Uptime (Local Time)** | La hora a la que se ejecuta la acción de ENCENDIDO. Se muestra en tu hora local. |
| **Atributo** | **Descripción** |
| --- | --- |
| **Days** | Los días en los que se ejecutarán los cronjobs de apagado. |
| **Auto Downtime (Local Time)** | La hora a la que se ejecuta la acción de APAGADO. Se muestra en tu hora local. |
| **Auto Uptime (Local Time)** | La hora a la que se ejecuta la acción de ENCENDIDO. Se muestra en tu hora local. |

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/cluster/shutdown-cluster.mdx (1)

40-40: ¡Ojo al piojo con la gramática, che! 🔍

¡Mirá! En inglés están mezclando "shutdown" (sustantivo) con "shut down" (verbo). Hay que darle masa a esa corrección:

-## How can I shutdown my cluster at any time?
+## How can I shut down my cluster at any time?

-In order to shutdown a cluster
+In order to shut down a cluster

Also applies to: 42-42

🧰 Tools
🪛 LanguageTool

[grammar] ~40-~40: The word ‘shutdown’ is a noun. Did you mean the verb “shut down”?
Context: ... two actions in UTC time. ## How can I shutdown my cluster at any time? In order to sh...

(SHUTDOWN)

i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx (2)

38-38: ¡Más spanglish a la vista! 🕵️‍♂️

¡Che! También hay que traducir esta parte:

-Debajo verás un cuadro que muestra las 'Generated Cron Expressions (UTC)'
+Debajo verás un cuadro que muestra las 'Expresiones Cron Generadas (UTC)'

42-42: ¡Ojo con los anglicismos! 🎯

¡Metele mano a estos términos en inglés!

-botón *Stop*
+botón *Detener*

-clusters con estado *Activo*
+clústeres con estado *Activo*

Also applies to: 44-44

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc82454 and a571925.

📒 Files selected for processing (3)
  • Makefile (1 hunks)
  • docs/cluster/shutdown-cluster.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cluster/shutdown-cluster.mdx

[typographical] ~8-~8: It seems that a comma is missing.
Context: ... that time frame. When this feature is activated you will be able to turn ON or OFF your...

(IF_COMMA)


[uncategorized] ~37-~37: Possible missing comma found.
Context: ...uns. It is shown in your local time. | Below you will see a box that shows 'Generate...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~40-~40: The word ‘shutdown’ is a noun. Did you mean the verb “shut down”?
Context: ... two actions in UTC time. ## How can I shutdown my cluster at any time? In order to sh...

(SHUTDOWN)


[grammar] ~42-~42: The word “shutdown” is a noun. The verb is spelled with a white space.
Context: ...wn my cluster at any time? In order to shutdown a cluster, just click on the Stop but...

(NOUN_VERB_CONFUSION)

i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx

[grammar] ~3-~3: ¿Quería decir «fin»? «Fi» es el nombre de una letra griega.
Context: ...rt { FiExternalLink } from "react-icons/fi"; # Apagado del Cluster Es la capacid...

(FI_FIN)

🔇 Additional comments (2)
Makefile (1)

10-11: ¡Bien ahí, che! ¡Alta feature para los hispanohablantes! 🎉

La nueva regla del Makefile está perfecta para correr la versión en español. ¡Aguante el multilingüismo!

i18n/es/docusaurus-plugin-content-docs/current/cluster/shutdown-cluster.mdx (1)

32-36: ¡Todavía tenemos spanglish en la tabla! 🎭

¡Dale, che! Mantengamos todo en español para que quede más prolijo:

-| **Attribute** | **Description** |
+| **Atributo** | **Descripción** |
-| **Days** |
+| **Días** |
-| **Auto Downtime (Local Time)** |
+| **Apagado Automático (Hora Local)** |
-| **Auto Uptime (Local Time)** |
+| **Encendido Automático (Hora Local)** |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants