Gestion des pipelines pilotés par API#

Applications de pipeline pilotées par API

Sur la page Pipeline, vous devez créer un pipeline pour intégrer des applications pilotées par API.

Les applications de pipeline pilotées par API vous permettent de remplir efficacement le pipeline et de déplacer des points dans le système uniquement via des chargements de génération et de déploiement. Les commandes d'API de création de génération et de chargement de déploiement s'affichent dans l'interface utilisateur et peuvent être exécutées dans un terminal de commande. L'avantage de l'utilisation de ces API de génération et de déploiement est de fournir des points d'extrémité simplifiés pour le chargement de données et de vous permettre d'intégrer le pipeline à des outils non pris en charge. La relation entre les API et les phases de pipeline qui sont remplies est détaillée dans le tableau suivant.

API Phases de pipeline
builds/apiDriven Entrée
deployments/apiDriven DEVELOPPEMENT, ASSURANCE QUALITE, PRODUCTION

  1. Pour mapper un environnement d'application au pipeline sur la page Pipeline, procédez comme suit :

    1. Pour l'environnement dans lequel vous souhaitez ajouter l'application, cliquez sur Bouton Ajouter Ajouter une application.

    2. Dans la fenêtre Ajouter des applications - Sélectionner les applications, dans la liste Géré par, sélectionnez Application pilotée par API.

    3. Cliquez sur Enregistrer et une nouvelle fenêtre Ajouter des applications - Sélectionner les applications s'affiche pour l'application pilotée par API.

    4. Dans le champ Nom de l'application, entrez le nom de l'application.

      Remarque : Les champs Géré par et Description sont déjà remplis avec Application pilotée par API.

    5. Cliquez sur Sauvegarder.

      L'application est ajoutée à l'étape.

  2. Pour charger une génération qui créera une nouvelle version pour cette application, procédez comme suit :

    1. Cliquez sur Bouton Ajouter sous l'étape Entrée du pipeline pour l'application Application pilotée par l'API TEST, utilisée à titre d'exemple et représentée dans la figure ci-dessous. pipeline et application pilotée par l'API TEST

      La fenêtre modale Créer une génération via l'API affiche une commande curl, illustrée dans la figure ci-dessous, pour interagir avec l'API REST Application pilotée par l'API TEST. créer une génération via la fenêtre modale de l'API

      Remarque : L'application pilotée par l'API TEST est utilisée à titre d'exemple et s'affiche au-dessus de la fenêtre modale Créer une génération via l'API.

    2. Cliquez sur icône copier pour copier la commande curl.

    3. Collez la commande curl dans un éditeur de texte.

    4. Modifiez les champs suivants fournis par l'utilisateur : <enter a user access key>, <enter a unique identifier>, <enter a version name>, <enter a build URL> et <enter a commit SHA>.

    5. Copiez la commande curl.

    6. Collez la commande curl dans un terminal ou dans des scripts d'automatisation CI/CD ayant un accès réseau au serveur <Velocity/Accelerate>.

    7. Exécutez la commande curl.

      Remarque : L'exécution manuelle de ces commandes dans un terminal est généralement effectuée pour plusieurs exécutions de test initiales. Cette méthode n'est pas recommandée pour une utilisation en production. Une bonne pratique consiste à ajouter les commandes curl de création de génération et de chargement de déploiement directement dans les CI/CD pour un déclenchement automatique.

  3. Notifiez le pipeline du déploiement d'une version d'entrée en procédant comme suit :

    1. Cliquez sur Bouton Ajouter sous l'étape DEV du pipeline pour l'application Application pilotée par l'API TEST, utilisée à titre d'exemple et affichée dans la figure de l'étape précédente.

      La fenêtre modale Créer un déploiement via l'API (DEV) affiche une commande curl, présentée dans la figure ci-dessous, pour interagir avec l'API REST Application pilotée par l'API TEST afin de charger un déploiement vers l'application susmentionnée. charger un déploiement via la fenêtre modale de l'API

      Remarque : L'application pilotée par l'API TEST est utilisée à titre d'exemple et représentée dans la figure de l'étape précédente.

    2. Cliquez sur icône copier pour copier la commande curl.

    3. Collez la commande curl dans un éditeur de texte.

    4. Modifiez les champs suivants fournis par l'utilisateur : <enter a user access key>, <enter a unique identifier>, <enter a version name> et <enter a deployment URL>.

    5. Copiez la commande curl.

    6. Collez la commande curl dans un terminal ou dans des scripts d'automatisation CI/CD ayant un accès réseau au serveur <Velocity/Accelerate>.

    7. Exécutez la commande curl.

      Remarque : L'exécution manuelle de ces commandes dans un terminal est généralement effectuée pour plusieurs exécutions de test initiales. Cette méthode n'est pas recommandée pour une utilisation en production. Une bonne pratique consiste à ajouter les commandes curl de création de génération et de chargement de déploiement directement dans les CI/CD pour un déclenchement automatique.