Crear servicio - Backstage

Para que sirve esta pagina

Esta pagina te ayuda a registrar un servicio en Backstage y, si lo necesitas, dejar listo su flujo de integracion y despliegue.

Al finalizar tendras:

• El servicio visible en Backstage.
• La relacion del servicio con su proyecto y su equipo.
• El registro del servicio en el repositorio.
• El pipeline de CI/CD, si elegiste crearlo.

Antes de comenzar

Antes de llenar el formulario, ten a la mano esta informacion:

• El nombre del proyecto o iniciativa al que pertenece el servicio.
• El nombre del servicio.
• El equipo responsable.
• El grupo de GitLab dueño del repositorio.
• El nombre del repositorio.
• El nombre real del proyecto en GitLab, si vas a crear pipeline.
• El lenguaje del servicio, si vas a crear pipeline.

Donde entrar

Ingresa a la siguiente direccion:

https://corehub.amxdigital.net/create/templates/default/service-simple-register-ci-promotion

Luego inicia sesion con tus credenciales habituales.

Como llenar el formulario

Sigue los campos en este orden.

1. Que deseas hacer

Aqui debes elegir el escenario que mejor describe tu caso.

Crear nuevo repositorio vacio para un servicio

> Usa esta opcion cuando todavia no existe repositorio y vas a comenzar desde cero.

Agregar un servicio nuevo con repositorio existente

> Usa esta opcion cuando el repositorio ya existe y solo quieres registrar el servicio y dejar su configuracion lista.

Actualizar servicio y su repositorio

> Usa esta opcion cuando el servicio ya existe y necesitas corregir o actualizar su informacion.

2. Nombre del proyecto o iniciativa

Selecciona de la lista el proyecto al que pertenece el servicio.

Todos los servicios de una misma iniciativa deben usar el mismo proyecto. Eso ayuda a que queden agrupados correctamente en Backstage.

Ejemplos de proyecto:

• Alertas Competencia
• Dashboard Digital
• Portal Comercial GT
• Telcel Carrito
• Sustentabilidad

3. Nombre del servicio

Es el nombre principal del servicio.

Ese nombre se usara como referencia en varios lugares, por ejemplo en Backstage y en recursos creados para el servicio.

Recomendacion:

• Usa un nombre claro.
• NO uses espacios.
• Usa el mismo nombre que ya maneja el equipo si el servicio ya existe.

Sigue la siguiente formula para nombrar los aplicativos:

amx-{Iniciativa}-{servicio}

Por ejemplo,

• Un servicio llamado “Reporte Catalogo Uni”
• Parte de la iniciativa “Portal Reportes EC”

El nombre es:

amx-portal-reportes-ec-reporte-catalogo-uni

• Un servicio llamado “Planes Promo MS BE”
• Parte de la iniciativa “Portal Reportes EC”

El nombre es:

amx-portal-reportes-ec-planes-promo-ms-be

• Un servicio llamado “Authentication”
• Parte de la iniciativa “Registro Ventas”

El nombre es:

amx-registro-ventas-authentication

• Un servicio llamado “SSOLoginRedisV2.4”
• Parte de la iniciativa “App CENAM”

El nombre es:

amx-app-cenam-sso-login-redis-v2-4

4. Que tipo de componente es

Selecciona el tipo de componente que mejor describe el servicio.

Esto ayuda a clasificarlo correctamente dentro de Backstage.

Si tienes duda, elige la opcion que normalmente use tu equipo para servicios similares.

5. Equipo asociado

Selecciona el equipo responsable del servicio.

Esto permite que el servicio quede asociado al grupo correcto y que las personas adecuadas puedan identificarlo y administrarlo.

Verifica este dato con cuidado, porque es una de las partes mas importantes del registro.

6. Repositorio de GitLab

En esta parte veras dos campos:

• Owner Available
• Repository

Debes separar la informacion del repositorio en esas dos partes.

Ejemplo 1

Si tu repositorio es:

https://portal-developers.amxdigital.net/Claro-Chile/cl_ms_fe_bancoestado_backstage

Debes capturarlo asi:

• Owner Available: Claro-Chile
• Repository: cl_ms_fe_bancoestado_backstage

Ejemplo 2

Si tu repositorio es:

https://portal-developers.amxdigital.net/amx_dashboarddigital/dd-logmanagement

Debes capturarlo asi:

• Owner Available: amx_dashboarddigital
• Repository: dd-logmanagement

Si tambien quieres crear pipeline de CI/CD

Si deseas que el servicio quede con pipeline desde este mismo proceso, llena tambien esta seccion.

7. Quieres crear un pipeline de CI/CD

Marca esta opcion solo si quieres crear el pipeline ahora.

Ten presente lo siguiente:

• Si el pipeline ya existe, no lo vuelvas a crear.
• Si no estas seguro, primero confirma con tu equipo.

8. Nombre del repositorio

Aqui debes colocar el nombre real del proyecto dentro de GitLab.

Este valor puede no verse igual que el nombre escrito en la URL.

Ejemplo

Si la URL es:

https://portal-developers.amxdigital.net/amx_dashboarddigital/dd-logmanagement

El valor correcto podria ser:

DD-LogManagement

Si tienes duda, abre el proyecto en GitLab y revisa el nombre mostrado en la parte general.

9. Lenguaje del servicio

Selecciona el lenguaje principal del servicio.

Este dato es importante porque define la configuracion base del pipeline.

Elige con cuidado la opcion correcta para evitar configuraciones equivocadas.

Recomendaciones antes de enviar

Antes de continuar, revisa especialmente estos datos:

• Proyecto o iniciativa.
• Nombre del servicio.
• Equipo asociado.
• Owner de GitLab.
• Nombre del repositorio.
• Nombre del proyecto en GitLab, si vas a crear pipeline.
• Lenguaje del servicio, si vas a crear pipeline.

Si alguno de estos datos queda mal, el alta puede requerir correcciones despues.

Resultado esperado

Si todo fue llenado correctamente, el servicio quedara registrado y visible en Backstage.

Si tambien elegiste crear pipeline, el flujo de CI/CD quedara generado junto con la configuracion base necesaria para su uso.