▶ Mejores prácticas para publicar operadores de software de código abierto

Ejecutar u operar una aplicación requiere múltiples tareas a lo largo de su ciclo de vida: escalar instancias, verificar el estado, integrarse con otras aplicaciones, ejecutar copias de seguridad y aplicar actualizaciones, por nombrar algunas. Este es un proceso que requiere mucho tiempo y mano de obra. Para automatizar estas tareas, los desarrolladores pueden implementar scripts para ejecutarlos repetidamente. Aquí es donde entran los operadores de software. operador de software es un patrón de diseño, un método probado y aceptado por la comunidad de software. Los operadores de software llevan la automatización al siguiente nivel. No solo automatizan la implementación de las cargas de trabajo de las aplicaciones, sino que también codifican la experiencia necesaria para administrarlas y operarlas. En otras palabras, proporcionan una forma segura de operar aplicaciones.

Pero digamos que comienzas a desarrollar tu carrera. Surgen naturalmente preguntas fundamentales: ¿qué puntos necesita cubrir? ¿Qué hace a un buen operador? ¿Con qué deberías empezar primero?

Tabla de Contenidos

Código abierto con su operador de software

Creemos que el desarrollo de código abierto es la mejor manera de crear un operador. El código abierto se refiere no solo a la publicación de código fuente, sino también al desarrollo abierto y distribuido de software. El objetivo del operador no es cubrir un solo caso de uso de aplicación, sino cubrir las necesidades de casos de uso relacionados en varios dominios. Por lo tanto, el desarrollo de código abierto brinda la mejor manera de reunir a expertos de diferentes orígenes para crear operadores confiables y seguros. Además, el código abierto proporciona transparencia, que es la forma más eficiente de detectar vulnerabilidades y ofrecer software seguro.

LEER OSRFramework - Marco de investigación de código abierto

Canónico desarrollado macropolio y SDK del operador Charm Desarrolle y ejecute operadores de manera de código abierto. Los operadores escritos para ejecutarse en Juju se denominan operadores encantados, o encantos para abreviar. Los desarrolladores pueden publicar sus operadores en nuestra tienda de aplicaciones: centro de encanto.

nuestro Directrices de publicación Puede ayudarlo a preparar la implementación de su operador para el lanzamiento público. Aunque se escribieron específicamente para Charms y Charmhub, brindan las mejores prácticas para cualquier persona que trabaje en el desarrollo de operadores de código abierto.

Haz que tu proyecto sea accesible

La guía de publicación consta de dos secciones principales. Primero, cada proyecto de código abierto necesita atraer usuarios y contribuciones. Existen mejores prácticas generales para preparar un proyecto de código abierto accesible y popular. Nuestras pautas de publicación destacan los puntos más relevantes:

Una base de código limpia que cubre un estilo de código coherente y una estructura de árbol de proyecto adecuada. Ambos son necesarios para un desarrollo maduro y aumentar la accesibilidad del proyecto.
La documentación explica cómo usar operadores, probar implementaciones y contribuir al proyecto.
Los correos electrónicos de contacto, las direcciones de las listas de correo y las URL relevantes guían a los usuarios dónde encontrar información relevante o contactar a la persona adecuada.
Los enlaces a foros y chats son esenciales para que los usuarios se conecten rápidamente con la comunidad del proyecto y hagan preguntas o sugerencias.
Asegurar el cumplimiento de licencias y marcas registradas para el contenido de terceros respeta los intereses externos. Elimina dudas sobre cuestiones legales para los usuarios interesados.

Estos puntos generales se aplican a la mayoría de los proyectos de código abierto. Pero también hay algunas cosas específicas del operador a considerar.

Pruebas y lanzamientos automatizados

Diferentes manipulaciones del operador, estilo Keith-Haring: imágenes de IA generadas con herramientas OpenAI, atribuidas al autor de este artículo.

Los operadores de software son un tipo especial de software en comparación con las bibliotecas, las aplicaciones para teléfonos inteligentes, los marcos de GUI o las aplicaciones web. Por lo tanto, es muy importante establecer las bases adecuadas desde el principio. Considere estas dos cosas:

Los operadores de software deben considerar el ciclo de lanzamiento de las aplicaciones cubiertas, no solo el suyo propio. Además, los lanzamientos oportunos son fundamentales para que el software seguro se ejecute de manera eficiente en los servidores de una organización. Por lo tanto, la automatización del proceso de creación y lanzamiento es fundamental para los operadores. Si el proceso de compilación y lanzamiento no está automatizado, todo se ralentiza considerablemente, comenzando por probar nuevas versiones en diferentes entornos.
Los usuarios o desarrolladores interesados deben invertir tiempo y esfuerzo para probar el operador. Según la aplicación, las pruebas requieren no solo configurar una nube pública o privada, sino también instalar software adicional. Por ejemplo, si la aplicación y sus operadores son extensiones de OpenStack, primero se requiere una instalación de prueba. Por lo tanto, para evitar una profunda frustración, es más crítico que el operador trabaje de manera confiable desde el principio. Por esta razón, tanto las pruebas unitarias como las de integración son necesarias desde el momento en que comienza el desarrollo.

Sin cubrir estos puntos, proporcionar un operador seguro y confiable será un desafío a largo plazo.Para más detalles, por favor lea Directrices de publicación en nuestra documentación del SDK de Charmed Operator.