Proyecto de Jenkins X

Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.

Resumen del proyecto

Organización de código abierto:
Jenkins X
Escritor técnico:
Nitín
Nombre del proyecto:
Refactorización del sitio de documentos existente de Jenkins X y la matriz de funciones de Jenkins X
Duración del proyecto:
Duración estándar (3 meses)

Project description

El objetivo principal de este proyecto es refactorizar la documentación existente de Jenkins X mientras soluciona los problemas relacionados con los documentos, así como preparar la matriz de capacidades actualizada de Jenkins X junto con la documentación para el usuario sobre el uso de Jenkins X en los proveedores de servicios en la nube empresariales. Además, este proyecto también implica trabajar en el desarrollo de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, en colaboración con Daniel.

Como parte de la refactorización de la documentación existente de Jenkins X, estos son algunos de los problemas en los que trabajaría:

  • Inicio en los recursos de EKS: Problema
  • Vault falla en EKS con el inicio: problema
  • Document envars for jx boot: Problema
  • Documentación necesaria para la configuración de Vault: Problema
  • La actualización de inicio de local a Vault falla: problema
  • Comentarios sobre la documentación Relación entre “crear” y “instalar jx” vs. “inicio” frente a “importar”: problema
  • La documentación de Helm está disponible en todos lados: problema
  • Mejorar los documentos por los que ChartMuseum, Monocular y Docker Registry no se reemplazaron por un problema de Nexus
  • No se puede cambiar Docker Registry cuando se usa Boot + GKE: Problema
  • Falla el cambio de dominio de nip.io a uno personalizado: problema

En el caso de la matriz de capacidades de Jenkins X, el trabajo incluye (como se menciona a continuación) para los servicios empresariales de Kubernetes que ofrece cada uno de los proveedores de servicios en la nube, es decir, Google Cloud (GKE), Amazon Web Services (AWS EKS) y Azure Cloud (AKS).

  • Instalación de Jenkins X en la nube a través de secuencias de comandos de Terraform y jx boot
  • Estamos verificando la compatibilidad de las versiones de Kubernetes con Jenkins X en los servicios de Kubernetes de estos proveedores de servicios en la nube.
  • Cualquier otra Capacidad (almacenamiento de Vault para Secrets, versiones de control de código fuente u otras) que se analizarán con Deane y los miembros de la comunidad de Jenkins X.

En lo que respecta al trabajo de configuración de la infraestructura del entorno de vista previa de Jenkins X basado en OpenShift, el trabajo incluye lo siguiente:

  • Documento de diseño sobre la infraestructura del entorno de vista previa de Jenkins X en la plataforma OpenShift
  • Automatización de la creación de entornos de vista previa de Jenkins X en OpenShift
  • Actualiza la documentación de Jenkins X en los entornos de vista previa

Entregas del proyecto:

  • Se realizaron correcciones a través de PR para los problemas de documentos mencionados anteriormente, teniendo en cuenta la refactorización de la documentación existente de Jenkins X.
  • Se actualizó la matriz de capacidades de Jenkins X junto con la documentación para el usuario sobre el uso de Jenkins X con diferentes proveedores de servicios en la nube (servicios de Kubernetes principalmente AKS, EKS y GKE).
  • Configuración automatizada de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, en colaboración con Daniel.

Cronograma tentativo (junto con las tareas) propuesto:

Vinculación comunitaria (del 17 de ago al 13 de sep)

  • Configurar el entorno de desarrollo para la documentación técnica y obtener acceso a las infraestructuras de nube para trabajar en las tareas del proyecto
  • Debate con los mentores del proyecto sobre el cronograma tentativo propuesto, los entregables del proyecto y las tareas (junto con su prioridad).
  • Comprende el proceso de trabajo de la organización y el proceso de revisión de RR.PP., y prepárate para ello, y participa en la comunidad.
  • Revisa el estado de la documentación actual de Jenkins X.

Semana 1 (del 14 al 20 de sep)

  • Comprender las instrucciones para configurar Jenkins X en la nube, el estado actual y la documentación
  • Debate con Deane sobre las capacidades actuales de Jenkins X (que se verificarán en diferentes proveedores de servicios en la nube).
  • Debate con Daniel sobre el estado actual de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.
  • Trabaja (en colaboración con Daniel) en el diseño de la arquitectura para la infraestructura del entorno de vista previa de Jenkins X en OpenShift.

Semana 2 (del 21 al 27 de sep)

  • Trabajar en la matriz de capacidades de Jenkins X para la nube de GKE: instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.

Semana 3 (del 28 de sep al 4 de oct)

  • Trabajar en la matriz de capacidades de Jenkins X para la nube de GKE: instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.
  • Trabaja en el documento de diseño para la infraestructura del entorno de vista previa de Jenkins X basado en OpenShift.

Semana 4 (5 de oct al 11 de oct)

  • Finaliza los documentos de usuario de Jenkins X en GKE.
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.

Semana 5 (del 12 al 18 de oct)

  • Trabajar en la matriz de capacidades de Jenkins X para Azure Cloud (AKS): instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.
  • Finaliza el documento de diseño para la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift, luego de recibir comentarios de los miembros de la comunidad.

Semana 6 (del 19 al 25 de oct)

  • Trabajar en la matriz de capacidades de Jenkins X para Azure Cloud (AKS): instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.

Semana 7 (26 de oct al 1 de nov)

  • Trabajar en la matriz de capacidades de Jenkins X para Azure Cloud (AKS): instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.
  • Trabaja en la configuración de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.

Semana 8 (del 2 al 8 de nov)

  • Finaliza los documentos de usuario de Jenkins X en AKS.
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.

Semana 9 (del 9 al 15 de nov)

  • Trabajar en la matriz de capacidades de Jenkins X para AWS (EKS): instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.
  • Trabaja en la configuración de la infraestructura del entorno de vista previa de Jenkins X basada en OpenShift.

Semana 10 (del 16 al 22 de nov)

  • Trabajar en la matriz de capacidades de Jenkins X para AWS (EKS): instalar Jenkins X y preparar borradores de notas de usuario
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.

Semana 11 (del 23 al 29 de nov)

  • Finaliza los documentos de usuario de Jenkins X en EKS.
  • Trabaja en uno de los documentos para mejorar la documentación existente de Jenkins X.
  • Finaliza la documentación de la infraestructura del entorno de vista previa de Jenkins X en el sitio de documentos de Jenkins X.

Semana 12 (30 de nov al 5 de dic)

  • Finaliza los entregables del proyecto y refactoriza el código, si lo hubiera, en función de los comentarios.
  • Probar el funcionamiento del sitio de documentos de Jenkins X, incluidos vínculos, imágenes, hipervínculos y otros
  • Verifica el control y la navegación definidos por el usuario en el sitio de documentos de Jenkins X.
  • Revisa la presentación finalizada de la matriz de funciones de Jenkins X.

Antes del 10 de diciembre de 2020 Tanto el escritor técnico como los mentores envían una evaluación del proyecto.

¿Qué beneficios tiene el proyecto propuesto para Jenkins X y su comunidad? Este proyecto ayudará a la comunidad de Jenkins X a mejorar la documentación para sus usuarios finales, así como para los desarrolladores, a modo de referencia sobre la arquitectura técnica, la compatibilidad, el uso y la integración de Jenkins X. Con la finalización de este proyecto propuesto, existiría una documentación de usuario completa, bien definida y verificada técnicamente de Jenkins X junto con la matriz de capacidades de Jenkins X para su compatibilidad con diferentes proveedores de servicios en la nube.

¿En qué beneficios futuros piensas trabajar con Jenkins X? Después de que finalice el programa de la temporada de Documentos de Google 2020, tengo previsto convertirme en colaborador a largo plazo del proyecto Jenkins X como miembro activo de la comunidad. Siempre estaré disponible para ayudar a otros (nuevos usuarios) y motivarlos a participar en la comunidad de Jenkins X. Siempre me gustaría trabajar en otras ideas de proyectos de Jenkins X.

Algunas de las razones por las que me siento más preparada para trabajar en este proyecto:

  • Soy muy metódico y organizado. Espero mantenerme informado sobre el progreso del proyecto, tanto a los mentores del proyecto como a la comunidad de la organización, a través de entradas de blog una vez a la semana, reuniones semanales de documentos de SIG y correos electrónicos con regularidad.
  • Buscaré orientación y comentarios de los mentores y los miembros de la comunidad con frecuencia, para avanzar con las tareas y garantizar que todos estén en sintonía (y mencionar cualquier desafío o punto que obstaculice).
  • El compromiso de escribir todo el código fuente de forma periódica para que el mentor y los colaboradores lo revisen, así como la documentación del trabajo realizado como referencia para los miembros de la comunidad
  • Tengo todas las habilidades técnicas necesarias para trabajar en esta idea de proyecto y he analizado la propuesta del proyecto con los mentores Deane, Kara y Daniel. Entiendo en profundidad la propuesta del proyecto y sus entregables.
  • Tengo experiencia trabajando con las habilidades técnicas (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo y otras) necesarias para proporcionar una documentación completa y resolver la mayoría de los problemas actuales relacionados con la documentación. Tengo la actitud positiva de hacer el proyecto, de modo que puedo hacerlo a tiempo y con poca supervisión.