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 (preview).
Présentation
Dans ce tutoriel, vous allez automatiser les déploiements d'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 vise à illustrer l'utilisation des tâches Appeler un 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 Google Cloud projets.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 de l' Google Cloud offre d'essai et de fonctionnalités cloud gratuites.
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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Secret Manager API, Connectors API APIs.
-
Create a service account:
-
In the Google Cloud console, go to the Create service account page.
Go to Create service account - Select your project.
-
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
. - Click Create and continue.
-
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
). - Click Continue.
-
Click Done to finish creating the service account.
-
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Secret Manager API, Connectors API APIs.
-
Create a service account:
-
In the Google Cloud console, go to the Create service account page.
Go to Create service account - Select your project.
-
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
. - Click Create and continue.
-
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
). - Click Continue.
-
Click Done to finish creating the service account.
-
Créer un sujet Pub/Sub
Dans la console Google Cloud, accédez à la page Sujets de Pub/Sub.
Cliquez sur Create topic (Créer un sujet).
Dans le champ ID du sujet, saisissez un ID pour votre sujet. Pour en savoir plus sur l'attribution de noms aux sujets, consultez les consignes de dénomination d'un sujet, d'un abonnement, d'un schéma ou d'un instantané .
Conservez l'option Ajouter un abonnement par défaut.
Ne sélectionnez pas les autres options.
Cliquez sur Create topic (Créer un sujet).
Configurer un connecteur Pub/Sub
- Dans la console Google Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un Google Cloud projet.
- Cliquez sur + Créer pour ouvrir la page Créer une connexion.
- Dans la section Emplacement, choisissez l'emplacement de la connexion.
- Région : sélectionnez un emplacement dans la liste déroulante.
Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.
- Cliquez sur SUIVANT.
- Région : sélectionnez un emplacement dans la liste déroulante.
- Dans la section Détails de la connexion, procédez comme suit :
- Connecteur : sélectionnez Pub/Sub dans la liste déroulante des connecteurs disponibles.
- Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
- Dans le champ Nom de la connexion, saisissez
pub-sub-connector
. - Compte de service : sélectionnez un compte de service disposant des rôles requis.
- ID du projet: Google Cloud ID du projet dans lequel réside l'instance Pub/Sub.
- ID du sujet: saisissez le nom de votre sujet Pub/Sub.
- Cliquez sur Suivant.
- Dans la section Authentication (Authentification), cliquez sur NEXT (SUIVANT).
- Vérifiez vos informations de connexion et d'authentification.
- Cliquez sur Créer.
Créer une intégration
Une fois que vous avez configuré Application Integration, vous pouvez créer une intégration:
- Dans la console Google Cloud, accédez à la page Application Integration.
- Dans le menu de navigation, cliquez sur Intégrations. La page Integrations s'affiche.
- Cliquez sur
- Nom de l'intégration:saisissez un nom pour votre intégration. Exemple :
build-cicd
- Description:si vous le souhaitez, saisissez une description de votre intégration. Exemple :
Demo integration created for CICD tutorial
- 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 la section Emplacements de l'intégration d'applications. - 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.
- Cliquez sur Créer. La page de l'éditeur d'intégration s'ouvre. Vous pouvez y ajouter les tâches et les déclencheurs pour créer votre intégration.
Créer une intégration, puis fournissez les informations suivantes sur la page Créer une intégration :
- Nom de l'intégration:saisissez un nom pour votre intégration. Exemple :
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 :- Dans la console Google Cloud, accédez à la page Application Integration.
- Dans le menu de navigation, cliquez sur Intégrations.
La page Liste des intégrations s'affiche et liste toutes les intégrations disponibles dans le projet Google Cloud.
- Sélectionnez l'intégration
build-cicd
.Cela entraîne son ouverture dans l'éditeur d'intégrations.
- Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Déclencheurs > Déclencheur d'API pour ajouter le déclencheur.
- Dans la barre de navigation de l'éditeur d'intégration, cliquez sur Tasks > Call REST Endpoint (Tâches > Appeler un point de terminaison REST) pour ajouter la tâche.
- 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 :- Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur (Afficher/Masquer le panneau) pour afficher le volet Variables.
- Cliquez sur Créer.
- Procédez comme suit dans le volet Créer une variable :
- 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 la section Importer et télécharger des intégrations. - Dans Type de variable, sélectionnez Variable de configuration.
- Dans Type de données, sélectionnez Chaîne.
- Cliquez sur Créer.
La variable de configuration apparaît dans le volet Variables.
- Dans le champ Nom, saisissez
- 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
- Nom :
Ajouter et configurer le point de terminaison REST Appeler
Pour créer une variable de configuration, procédez comme suit :- Dans l'éditeur d'intégration, 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 :
- Développez la section Entrée de la tâche.
- Dans URL de base du point de terminaison, cliquez sur Variable, puis ajoutez
$`CONFIG_url`$
.
Ajouter et configurer une tâche de connecteur
- Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Tâche > Connecteurs.
- Cliquez sur Configurer les connecteurs.
- Dans la liste Région, sélectionnez la région dans laquelle vous avez créé votre connecteur Pub/Sub.
- Dans le champ Connection (Connexion), sélectionnez le connecteur Pub/Sub que vous avez créé à l'étape précédente.
- Dans la section Type, sélectionnez Actions.
- Dans la section Définir les entités/actions, pour Actions, sélectionnez publishMessage.
- Dans Valeur par défaut, ajoutez la valeur par défaut de la variable de configuration.
- Cliquez sur Créer.
- Dans le volet de configuration de la tâche Connecteurs, développez la section Détails de connexion pour mettre à jour le champ suivant :
- Dans le champ Nom de la connexion, cliquez sur Variable, puis sélectionnez
$`CONFIG_connection_name`$
.
- Dans le champ Nom de la connexion, cliquez sur Variable, puis sélectionnez
Ajouter une tâche de mappage de données
- Dans la barre de navigation de l'éditeur d'intégration, cliquez sur Tâche > Mappage de données.
- Ajoutez une connexion de périphérie de l'élément Appeler le point de terminaison REST à l'élément Mapper les données en passant la souris sur un point de contrôle de l'élément Appeler le 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.
- Ajoutez une autre connexion de périphérie de l'élément Mappage de données à l'élément Connecteurs en passant la souris sur un point de contrôle sur l'élément Mappage de données, puis cliquez en faisant glisser une ligne vers un point de contrôle de l'élément de tâche Connecteurs.
- Dans le volet de configuration de la tâche Mappage des données, cliquez sur Ouvrir l'éditeur de mappage de données.
- Mappez la variable de sortie de la tâche Appeler un 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 :- 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.
- Dans la boîte de dialogue Publier l'intégration, saisissez la valeur des variables de configuration suivantes :
url
: saisissez le nom de l'URL du point de terminaison.connection_name
: saisissez le nom du connecteur Pub/Sub que vous avez créé à l'étape précédente.
- Cliquez sur Publier.
- 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.
Favoriser l'intégration entre les environnements
Pour promouvoir votre intégration dans différents environnements, vous pouvez utiliser l'outil integrationcli
, qui est un outil Open Source qui vous permet d'interagir avec les API Application Integration et les API Integration Connectors. Cet outil vous permet de gérer des entités d'intégration telles que les intégrations, les configurations d'authentification, etc. Pour savoir comment générer l'échafaudage de l'intégration et appliquer les modifications générées par l'échafaudage, consultez Présentation de integrationcli
sur le blog de la communauté.
Vous pouvez également promouvoir les modifications dans les différents environnements en configurant des pipelines DevOps, par exemple à l'aide de Jenkins, GitLab, Cloud Build, etc. Pour en savoir plus, consultez la section 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 sont actuellement pas téléchargeables. Lorsque vous publiez l'intégration dans le nouvel environnement, l'intégration d'applications vous permet de saisir des valeurs pour les variables de configuration.
Étape suivante
- Découvrez des exemples d'intégrations sur GitHub.
- En savoir plus sur les variables de configuration
- En savoir plus sur l'outil
integrationcli