Autoservei de pipelines

Introducció

L’Autoservei de pipelines permet la generació automàtica de pipelines d’automatització de la construcció i del desplegament de les aplicacions sense, en molts casos, la intervenció de l’equip del SIC. D’aquesta manera, els equips de cada codi d’aplicació són autònoms per a preparar i mantenir la construcció de la pipeline de desplegament associada a cada projecte repositat al Sistema de Custòdia de Codi (Gitlab).

A continuació, entrarem en més detall sobre com funciona aquest nou servei que ofereix el SIC.

Motivació

Cobreix les següents necessitats:

• Dotar de flexibilitat i independència als principals actors que intervenen en la construcció i els desplegaments de les aplicacions.
• Incrementar ràpidament el grau d’integració al SIC de les aplicacions evitant traspassos innecessaris d’informació i responsabilitats.
• Proporcionar un nivell d’abstracció que permeti ser independent de les tecnologies emprades i permeti evolucionar el producte mantenint compatibilitat amb versions anteriors.
• Proporcionar un entorn aïllat i immutable de construcció, que a més pugui ser utilitzat i testejat pels mateixos proveïdors.
• Facilitar la cobertura de tecnologies contemplant l’ús d’imatges Docker pròpies dels lots d’aplicacions.
• Acomplir les directrius de CTTI sobre desplegaments i gestió de canvis.

La solució ha de:

• Ser natural per als usuaris del servei.
• Permetre definir tot el necessari per a construir i desplegar l’aplicació.
• Donar cobertura a totes les tecnologies amb les que el SIC és actualment compatible.
• Ser mantenible, escalable i eficient.

Requeriments generals

S’estableixen una sèrie de requeriments per a estar en disposició d’integrar l’aplicació mitjançant aquest servei:

• Conèixer els entorns on es desplegarà l’aplicació i les modalitats de desplegament aplicables en cada cas.
• L’aplicació ha de ser integrable amb el servei d’automatització de la construcció i desplegament.
• Aplicació ha d’estar preparada i acomplir els requeriments per a poder ser desplegada.
• Per als entorns amb modalitat de desplegament automàtic o delegat a Cpd, disposar dels identificadors d’infraestructures de desplegament que proporcionarà l’equip SIC o Cpd (respectivament).
• Col·laboració: el proveïdor d’aplicacions i el proveïdor d’infraestructures han d’estar disposats a col·laborar i mantenir una comunicació.

Funcionament

Generalment, a cada codi d’aplicació li correspon un proveïdor d’aplicacions i un proveïdor d’infraestructures. Aquests dos equips han de participar i col·laborar per tal d’utilitzar l’autoservei de pipelines del SIC aportant la informació necessària de la qual cadascun és responsable.

• Arxiu de Configuració d’Aplicació (ACA)
• Arxiu de Configuració d’Infraestructura (ACI)

El funcionament previst és el següent:

• Els proveïdors d’aplicacions aportaran el seu propi arxiu de configuració (ACA).
• Els proveïdors d’infraestructures aportaran el seu propi arxiu de configuració (ACI) requerit únicament quan l’aplicació es desplega en modalitat automàtica.
• L’equip de SIC aportarà la seva configuració interna per a l’organització de pipelines, sistema d’accessos i altres configuracions necessàries.
• Un cop preparats els arxius de configuració requerits, l’equip de SIC utilitzarà al sistema de generació de pipelines que s’encarregarà de recuperar la informació necessària i generar les pipelines requerides per al desplegament de l’aplicació.

Un cop generades les pipelines, qualsevol canvi que es realitzi en aquests arxius de configuració aplicarà a les futures execucions sense necessitat de fer cap mena de regeneració de pipelines. Només serà necessari dita regeneració, si es tracta d’un canvi organitzatiu o de proveïdor d’infraestructures i/o plataforma cloud.

Configuració

Pel que fa a l’Arxiu de Configuració de l’Aplicació (ACA), la informació quedarà recollida a l’arxiu /sic/aca.yml dins del repositori del projecte. Es tracta d’un arxiu requerit per Autoservei de Pipelines, en format YAML, en el que s’ha d’aportar la següent informació:

• Version: versió de l’arxiu (independent de la versió de l’aplicació o component) que es correspondrà amb els canvis en les especificacions de construcció i/o desplegament.

• Info: informació sobre l’aplicació o component, incloent-hi la seva versió funcional i una descripció.

• Global-env: llistat de variables globals necessàries per al desplegament de l’aplicació o component.

• Components: informació per a la construcció, publicació i desplegament de l’aplicació o component

• Notifications: definició d’adreces de correu electrònic on es notificarà la necessitat d’accions manuals i/o resultats de l’execució.

Per a més informació: Com construir el fitxer ACA

Generació de pipelines

Desplegament d’aplicacions

L’equip de SIC, mitjançant aquest servei, s’encarregarà de generar automàticament totes les pipelines necessàries, tant per al desplegament del component o aplicació com altres pipelines per a dur a terme les operacions necessàries sobre plataformes cloud. Aquestes pipelines operatives s’aprovisionaran dins d’un directori diferenciat /Advanced dins del directori de tasques Jenkins associat al projecte i seran les següents:

• DEPLOY-START: permet iniciar el servei.

• DEPLOY-STOP: permet aturar el servei.

• DEPLOY-RESTART: permet aturar i tornar a iniciar el servei.

• DEPLOY-DESCRIPTORS: permet desplegar canvis en els descriptors (noves variables d’entorn, canvis en la configuració i altres) sense fer la construcció i desplegament de la imatge.

• DELETE-DESCRIPTORS: permet revertir el desplegament de descriptors (variables d’entorn, configuració i altres) habilitant una selecció d’entorn i de fitxer/s descriptor/s sobre el/s qual/s actuar (incloent-hi l’opció per a poder actuar sobre tots ells).

• DEPLOY-ALL: permet fer un desplegament complet davant canvis en l’aplicació, orquestradors i/o descriptors.

• DEPLOY-TAG: permet redesplegar un determinat tag de la imatge de l’aplicació que s’hagi desplegat amb èxit a producció (x.y.z-PR, x.y.z-production) concebuda per a poder fer un rollback a una versió anterior.

Per altra banda, cal comentar que es generaran les pipelines internes dedicades a certes tasques comunes i que seran executades per la pipeline principal. Aquestes pipelines no seran visibles per l’usuari i són les següents:

• DEPLOYER: s’encarrega del desplegament de l’aplicació als diferents entorns de rebuda. Serà invocada per la pipeline principal per al desplegament de cada component a cada un dels entorns.

• CLEANER: s’encarrega de l’esborrat d’espais de treball. Serà invocada per la pipeline principal en finalitzar.

Desplegament d’APIS a l’API Manager corporatiu

L’equip de SIC, mitjançant aquest servei, s’encarregarà de generar automàticament totes les pipelines necessàries, tant per a la publicació d’APIS com altres pipelines per a gestionar el seu cicle de vida a l’API Manager corporatiu. En aquest segon cas, les pipelines s’aprovisionaran dins d’un directori diferenciat /Advanced dins del directori de tasques Jenkins associat al projecte:

• PUBLISH: publicació d’una nova versió d’un producte i APIS associades
• INFO: obtenció d’informació del producte dins d’un catàleg (versions, subscripcions i altres)
• Operatives:
  • DELETE: eliminació del producte
  • DEPRECATE: deprecació d’una versió del producte sense deixar cap versió vigent
  • REPLACE: retirada d’una de les versions vigents del producte i migració de subscripcions
  • RETIRE: retirada d’una versió del producte sense deixar cap versió vigent (les subscripcions es perden)
  • SUPERSEDE: deprecació d’una de les versions vigents del producte i marcat de subscripcions “migrated”

Tecnologies compatibles

Veure: Matriu de tecnologies

Si voleu més informació podeu consultar la secció de Guies.
Si teniu qualsevol dubte o problema podeu revisar les Preguntes Freqüents o utilitzar els canals de Suport.