Créer un pipeline CICD pour votre intégration

Ce tutoriel explique comment automatiser la promotion d'une intégration entre différents environnements dans différents projets Google Cloud à l'aide de variables de configuration (aperçu).

Présentation

Dans ce tutoriel, vous allez automatiser les déploiements Application Integration à l'aide d'une variable de configuration pour un exemple d'intégration. Cet exemple de flux d'intégration appelle une API et publie la réponse de l'API dans un sujet Pub/Sub. Cet exemple est destiné à illustrer l'utilisation des tâches Appeler le point de terminaison REST et Connecteurs. Vous pouvez stocker l'exemple d'intégration dans des dépôts GitHub correspondant aux différents environnements et projets Google Cloud .

Objectifs

Ce tutoriel vous explique comment effectuer les tâches suivantes dans votre intégration :

  • Créez une intégration.
  • Créez des variables de configuration et utilisez-les dans votre intégration.
  • Promouvoir votre intégration vers un autre environnement

Coûts

Dans ce tutoriel, vous utilisez les composants facturables suivants de Google Cloud :

Les instructions de ce tutoriel sont conçues pour que votre utilisation des ressources respecte les limites des Google Cloud fonctionnalités cloud gratuites et de l'offre d'essai.

Une fois que vous avez terminé les tâches décrites dans ce document, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Secret Manager API, Connectors API APIs.

    Enable the APIs

  5. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Pub/Sub Publisher (roles/pubsub.publisher) role to the service account.

      To grant the role, find the Select a role list, then select Pub/Sub Publisher (roles/pubsub.publisher).

    6. Click Continue.

    7. Click Done to finish creating the service account.

  6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  7. Make sure that billing is enabled for your Google Cloud project.

  8. Enable the Secret Manager API, Connectors API APIs.

    Enable the APIs

  9. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Pub/Sub Publisher (roles/pubsub.publisher) role to the service account.

      To grant the role, find the Select a role list, then select Pub/Sub Publisher (roles/pubsub.publisher).

    6. Click Continue.

    7. Click Done to finish creating the service account.

Créer un sujet Pub/Sub

  1. Dans la console Google Cloud , accédez à la page Sujets de Pub/Sub.

    Accéder aux sujets

  2. Cliquez sur Create topic (Créer un sujet).

  3. Dans le champ ID du sujet, saisissez un ID pour votre sujet. Pour en savoir plus sur la dénomination des thèmes, consultez Consignes de dénomination d'un thème, d'un abonnement, d'un schéma ou d'un instantané .

  4. Conservez l'option Ajouter un abonnement par défaut.

  5. Ne sélectionnez pas les autres options.

  6. Cliquez sur Create topic (Créer un sujet).

Configurer un connecteur Pub/Sub

  1. Dans la consoleGoogle Cloud , accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud .

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Pub/Sub dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, saisissez pub-sub-connector.
    4. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    5. ID du projet : Google Cloud ID du projet où réside l'instance Pub/Sub.
    6. ID du sujet : saisissez le nom de votre sujet Pub/Sub.
    7. Cliquez sur Suivant.
  5. Dans la section Authentification, cliquez sur SUIVANT.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Créer une intégration

Après avoir configuré Application Integration, vous pouvez créer une intégration :

  1. Dans la console Google Cloud, accédez à la page Application Integration.

    Accéder à Application Integration

  2. Cliquez sur Intégrations dans le menu de navigation de gauche pour ouvrir la page Intégrations.
  3. Cliquez sur Créer une intégration, puis fournissez les informations suivantes sur la page Créer une intégration :
    1. Nom de l'intégration : saisissez un nom pour votre intégration. Exemple :build-cicd
    2. Description : si vous le souhaitez, saisissez une description de votre intégration. Exemple :Demo integration created for CICD tutorial
    3. Région : sélectionnez la région us-central1 dans la liste des régions provisionnées. Si la région que vous souhaitez sélectionner n'est pas provisionnée, consultez Provisionner une nouvelle région. Pour obtenir la liste des régions compatibles, consultez Emplacements Application Integration.
    4. Compte de service : ce champ s'affiche si vous avez activé la gouvernance pour votre région. Sélectionnez le compte de service pour votre intégration. Pour savoir comment activer la gouvernance pour votre région, consultez Modifier la région.
    5. Cliquez sur Créer. La page de l'éditeur d'intégration s'affiche. Vous pouvez y ajouter les tâches et les déclencheurs pour créer votre intégration.

Créer un flux d'intégration

Ajouter un déclencheur d'API et un point de terminaison REST

Pour ajouter un déclencheur d'API, procédez comme suit :
  1. Dans la console Google Cloud , accédez à la page Application Integration.

    Accéder à Application Integration

  2. Dans le menu de navigation, cliquez sur Intégrations.

    La page Liste des intégrations s'affiche et répertorie toutes les intégrations disponibles dans le projet Google Cloud.

  3. Sélectionnez l'intégration build-cicd.

    Cela entraîne son ouverture dans l'éditeur d'intégrations.

  4. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Déclencheurs > Déclencheur d'API pour ajouter le déclencheur.
  5. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Tâches > Appeler un point de terminaison REST pour ajouter la tâche.
  6. Ajoutez une connexion de périphérie de l'élément Déclencheur d'API à l'élément Appeler le point de terminaison REST en passant la souris sur un point de contrôle de l'élément Déclencheur d'API, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Appeler le point de terminaison REST.

Créer des variables de configuration

Pour créer des variables de configuration, procédez comme suit :
  1. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur (Afficher/Masquer le panneau) pour afficher le volet Variables.
  2. Cliquez sur Créer.
  3. Procédez comme suit dans le volet Créer une variable :
    1. Dans le champ Nom, saisissez url.

      Application Integration ajoute le préfixe `CONFIG_ aux variables de configuration. Si vous souhaitez ajouter la variable de configuration à votre intégration à l'aide d'API, utilisez le format suivant pour les variables de configuration : `CONFIG_CONFIG_VARIABLE_NAME`. Pour savoir comment télécharger et importer des intégrations, consultez Importer et télécharger des intégrations.

    2. Dans le champ Type de variable, sélectionnez Variable de configuration.
    3. Dans le champ Type de données, sélectionnez Chaîne.
    4. Cliquez sur Créer.

      La variable de configuration s'affiche dans le volet Variables.

  4. Répétez les étapes 2 et 3 pour ajouter la variable de configuration suivante :
    • Nom : connection_name
    • Type de variable : Config Variable
    • Type de données : String

Ajouter et configurer "Appeler un point de terminaison REST"

Pour créer une variable de configuration, procédez comme suit :
  1. Dans l'éditeur d'intégrations, cliquez sur la tâche Appeler un point de terminaison REST pour ouvrir le volet de configuration de la tâche. Ensuite, procédez comme suit :
    1. Développez la section Entrée de la tâche.
    2. Dans URL de base du point de terminaison, cliquez sur Variable, puis ajoutez $`CONFIG_url`$.

Ajouter et configurer une tâche "Connecteurs"

  1. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Tâche > Connecteurs.
  2. Cliquez sur Configurer les connecteurs.
  3. Dans la liste Région, sélectionnez la région dans laquelle vous avez créé votre connecteur Pub/Sub.
  4. Dans le champ Connexion, sélectionnez le connecteur Pub/Sub que vous avez créé à l'étape précédente.
  5. Dans la section Type, sélectionnez Actions.
  6. Dans la section Définir les entités/actions, pour Actions, sélectionnez publishMessage.
  7. Dans Valeur par défaut, ajoutez la valeur par défaut de la variable de configuration.
  8. Cliquez sur Créer.
  9. Dans le volet de configuration de la tâche Connecteurs, développez la section Détails de connexion pour mettre à jour le champ suivant :
    1. Dans le champ Nom de la connexion, cliquez sur Variable, puis sélectionnez $`CONFIG_connection_name`$.

Ajouter une tâche de mappage de données

  1. Dans la barre de navigation de l'éditeur d'intégration, cliquez sur Tâche > Mappage des données.
  2. Ajoutez une connexion de type arête depuis l'élément Appeler un point de terminaison REST vers l'élément Mapper les données, en passant la souris sur un point de contrôle de l'élément Appeler un point de terminaison REST, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Mapper les données.
  3. À partir de l'élément Mappage de données, ajoutez une autre connexion de type arête à l'élément Connecteurs, en passant la souris sur un point de contrôle sur l'élément Mappage de données, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Connecteurs.
  4. Dans le volet de configuration de la tâche Mappage des données, cliquez sur Ouvrir l'éditeur de mappage de données.
  5. Mappez la variable de sortie de la tâche "Appeler le point de terminaison REST" à la variable d'entrée de la tâche "Connecteurs".

Publier l'intégration

Pour publier l'intégration, procédez comme suit :
  1. Pour publier l'intégration, cliquez sur Publier dans la barre d'outils de l'éditeur d'intégrations.

    La boîte de dialogue Publier l'intégration s'affiche.

  2. Dans la boîte de dialogue Publier l'intégration, saisissez la valeur des variables de configuration suivantes :
    1. url : saisissez le nom de l'URL du point de terminaison.
    2. connection_name : saisissez le nom du connecteur Pub/Sub que vous avez créé à l'étape précédente.
  3. Cliquez sur Publier.
  4. Une fois l'intégration publiée, vous pouvez afficher et inspecter les journaux d'exécution qui s'y rapportent. Pour afficher les journaux, cliquez sur Journaux dans la barre d'outils de l'éditeur d'intégrations.

Promouvoir l'intégration dans tous les environnements

Pour promouvoir votre intégration dans différents environnements, vous pouvez utiliser l'outil integrationcli, qui est un outil Open Source vous permettant d'interagir avec les API Application Integration et les API Integration Connectors. Cet outil vous permet de gérer les entités d'intégration telles que les intégrations, les configurations d'authentification, etc. Pour savoir comment générer le scaffold de l'intégration et appliquer les modifications générées par le scaffold, consultez Présentation de integrationcli sur le blog de la communauté.

Vous pouvez également promouvoir les modifications dans différents environnements en configurant des pipelines DevOps, par exemple à l'aide de Jenkins, GitLab, Cloud Build, etc. Pour en savoir plus, consultez Intégration à Cloud Build.

Si vous ne souhaitez pas utiliser integrationcli, vous pouvez télécharger et importer manuellement l'intégration dans un nouveau projet. Vous devrez créer manuellement les connecteurs dans le nouveau projet, car ils ne peuvent pas être téléchargés pour le moment. Lorsque vous publiez l'intégration dans le nouvel environnement, Application Integration vous permet de saisir des valeurs pour les variables de configuration.

Étapes suivantes