Saltar al contenido principal

Repositorios

Un repositorio es un lugar para almacenar y gestionar contenido de Ansible, como playbooks y roles.

Semaphore reconoce repositorios que son:

  • un sistema de archivos local (/path/to/the/repo)
  • un repositorio Git local (file://)
  • un repositorio Git remoto al que se accede mediante HTTPS (https://) o SSH (ssh://)
  • el protocolo git:// está soportado, pero no se recomienda por motivos de seguridad.

Todas las plantillas de tareas requieren un repositorio para ejecutarse.

Autenticación​

Si usa un repositorio remoto que requiere autenticación, deberá configurar una clave en la sección Almacén de claves de Semaphore.

Para repositorios remotos que usan SSH, deberá usar su clave SSH en el Almacén de claves.

Para repositorios remotos sin autenticación, puede crear una clave de tipo None.

La clave de un repositorio se usa solo para ese repositorio. Para acceder a submódulos, roles de requirements.yml u otros repositorios alojados en otro lugar con sus propias credenciales, añada una asignación en Host config.

Crear un nuevo repositorio​

  1. Asegúrese de haber configurado en la sección del almacén de claves la clave del repositorio que va a añadir.

  2. Vaya a la sección Repositorios de Semaphore y haga clic en el botón Nuevo repositorio en la esquina superior derecha.

  3. Configure el repositorio:

    • Asigne un nombre al repositorio
    • Añada la URL. La URL debe empezar por lo siguiente:
      • /path/to/the/repo para una carpeta local del sistema de archivos
      • https:// para un repositorio Git remoto accedido mediante HTTPS
      • ssh:// para un repositorio Git remoto accedido mediante SSH
      • file:// para un repositorio Git local
      • git:// para un repositorio Git remoto accedido mediante el protocolo Git
    • Establezca la rama del repositorio; si no está seguro de cuál debe ser, probablemente sea master o main
    • Marque Descarga única para todas las plantillas si el repositorio es un monorepo que todas las plantillas deben compartir; consulte Monorepo
    • Seleccione la clave de acceso que configuró antes de añadir este repositorio.

  4. Haga clic en Guardar una vez que todo esté configurado.

Monorepo: una sola descarga para todas las plantillas​

Desde la v2.20

La opción Descarga única para todas las plantillas está disponible desde Semaphore 2.20. Las versiones anteriores siempre clonan un repositorio una vez por plantilla.

De forma predeterminada, Semaphore clona un repositorio una vez por plantilla, de modo que cada plantilla trabaja en su propia copia. En un repositorio grande compartido por muchas plantillas, las copias consumen espacio en disco y cada tarea empieza con un clone o un pull de su propia copia.

Marque Descarga única para todas las plantillas para clonar el repositorio una sola vez y compartir esa copia entre todas las plantillas del proyecto. La opción no está disponible para una carpeta local (/path/to/the/repo), que nunca se clona.

Formulario de repositorio con la opción Descarga única para todas las plantillas activada

Cómo funciona la copia compartida:

  • Antes de que empiece una tarea, Semaphore bloquea la copia, hace fetch y pull de la rama configurada en el repositorio y después libera el bloqueo. Las tareas de otras plantillas esperan al bloqueo mientras se actualiza la copia, pero las tareas en sí se ejecutan en paralelo.
  • Cada rama sigue teniendo su propia copia, por lo que los repositorios con ramas distintas nunca comparten un árbol de trabajo.
  • La copia se comparte, pero el directorio home de Ansible (roles y colecciones instalados desde requirements.yml) sigue siendo independiente para cada plantilla.

Como todas las plantillas trabajan en la misma copia y en la misma rama, una plantilla de un monorepo no puede tener una Rama propia ni activar la solicitud Rama, que permite a una tarea elegir una rama o un commit. El formulario de la plantilla desactiva ambas opciones y explica el motivo, y la API rechaza una plantilla así. Asegúrese de que los playbooks no escriban en la copia: un árbol de trabajo modificado rompe el siguiente pull, y Semaphore entonces elimina la copia y la clona de nuevo.

Editar un repositorio existente​

  1. Vaya a la sección Repositorios de Semaphore.

  2. Haga clic en el icono del lápiz junto al repositorio que desea modificar; se le mostrará la configuración del repositorio.

Eliminar un repositorio​

Asegúrese de que el repositorio que va a eliminar no esté en uso por ninguna plantilla de tareas. Un repositorio no puede eliminarse si se usa en alguna plantilla de tareas:

  1. Vaya a la sección Repositorios de Semaphore.

  2. Haga clic en el icono de la papelera del repositorio que desea eliminar.

  3. Haga clic en Sí en la ventana emergente de confirmación si está seguro de que desea eliminar este repositorio.

Requisitos​

Al inicializar el proyecto, Semaphore busca e instala roles y colecciones de Ansible desde requirements.yml en las siguientes ubicaciones y en este orden.

Roles​

  • playbook_dir/roles/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/roles/requirements.yml
  • repo_path/requirements.yml

Colecciones​

  • playbook_dir/collections/requirements.yml
  • playbook_dir/requirements.yml
  • repo_path/collections/requirements.yml
  • repo_path/requirements.yml

Lógica de procesamiento​

  • Cada archivo se procesa de forma independiente
  • Si un archivo existe, se procesa según su tipo (rol o colección)
  • Si el procesamiento de algún archivo produce un error, el proceso de instalación se detiene y devuelve el error
  • El mismo archivo requirements.yml de los directorios raíz (playbook_dir/requirements.yml y repo_path/requirements.yml) se procesa dos veces: una para roles y otra para colecciones

Semaphore intentará procesar todas estas ubicaciones independientemente de si las anteriores se encontraron o se procesaron correctamente, salvo en caso de error.