Confluence

Vous pouvez utiliser le connecteur Confluence pour effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture dans Confluence.

Avant de commencer

Avant d'utiliser le connecteur Confluence, effectuez les tâches suivantes :

• Dans votre projet Google Cloud :
  • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
  • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

  • Activez les services suivants :
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Pour savoir comment activer des services, consultez la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

1. Dans la console 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 la page Emplacements.

   2. Cliquez sur NEXT (Suivant).
4. Dans la section Détails de connexion, procédez comme suit :
   1. Connecteur : sélectionnez Confluence 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 un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 49 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur "Error" (Erreur).
   6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   7. Vous pouvez également sélectionner Inclure les espaces archivés pour inclure le contenu des espaces archivés dans les résultats. La valeur par défaut est "false".
   8. Si vous le souhaitez, saisissez une clé d'espace pour la recherche afin de n'afficher que le contenu de cet espace spécifique.
   9. Vous pouvez également configurer les paramètres du nœud de connexion :
      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   10. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
   11. Cliquez sur NEXT (Suivant).
5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
   1. Type de destination : sélectionnez un type de destination.
      • Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.
        Remarque : Pour savoir comment créer un rattachement du point de terminaison, consultez Rattachement de service PSC et Rattachement du point de terminaison. Une fois le rattachement du point de terminaison créé, il apparaît dans la liste Rattachement du point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

   2. Cliquez sur NEXT (Suivant).
6. Dans la section Authentification, saisissez les informations d'authentification.
   1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec le connecteur Confluence:

      • Basic
      • APIToken
      • OAuth 2.0

   Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

   2. Cliquez sur NEXT (Suivant).
7. Vérifiez vos informations de connexion et d'authentification.
8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

• Basique
  • Username (Nom d'utilisateur) : compte utilisateur Confluence utilisé pour l'authentification.
  • Mot de passe : mot de passe associé au compte.
• APIToken
  • Username (Nom d'utilisateur) : nom d'utilisateur Confluence utilisé pour créer le jeton d'API.
  • Jeton d'API: le mot de passe du nom d'utilisateur est un jeton d'API. Sélectionnez le secret Secret Manager contenant le jeton d'API associé au nom d'utilisateur Confluence.
• OAuth 2.0 - Code d'autorisation
  • ID client  : ID client fourni par votre application externe.
  • Champs d'application : champs d'application d'autorisation. Le champ d'application offline_access doit être utilisé avec le connecteur Confluence. Pour en savoir plus sur les champs d'application Confluene, consultez Champs d'application Confluence.
  • Secret du client : sélectionnez le secret Secret Manager. Vous devez avoir créé le secret Secret Manager avant de configurer cette autorisation.
  • Version du secret : version du secret Secret Manager pour le code secret du client.

  Pour le type d'authentification Authorization code, après avoir créé la connexion, vous devez effectuer quelques étapes supplémentaires pour configurer l'authentification. Pour en savoir plus, consultez la section Étapes supplémentaires après la création de la connexion.

  Remarque:Si vous utilisez l'authentification Authorization code et que vous avez modifié la configuration de votre application Confluence, vous devez à nouveau autoriser votre Connexion Confluence. Pour comprendre comment effectuer une nouvelle autorisation, consultez la section Effectuer une nouvelle autorisation au code d'autorisation.

Étapes supplémentaires après la création de la connexion

Si vous avez sélectionné OAuth 2.0 - Authorization code pour vous devez effectuer les étapes supplémentaires suivantes après avoir créé la connexion:

1. Sur la page Connexions : localisez la connexion qui vient d'être créée.

   Notez que l'état du nouveau connecteur sera Autorisation requise.

2. Cliquez sur Autorisation requise.

   Le volet Modifier l'autorisation s'affiche.

3. Copiez la valeur Redirect URI (URI de redirection) dans votre application externe.
4. Vérifiez les détails de l'autorisation.
5. Cliquez sur Autoriser.

   Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Effectuer une nouvelle autorisation au code d'autorisation

Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration de votre application Confluence, vous devez autoriser à nouveau votre connexion Confluence. Pour réautoriser une connexion, procédez comme suit :

1. Cliquez sur la connexion requise sur la page Connexions.

   La page "Détails de la connexion" s'ouvre.

2. Cliquez sur Modifier pour modifier les détails de la connexion.
3. Vérifiez les détails du code d'autorisation OAuth 2.0 dans la section Authentification.

   Si nécessaire, apportez les modifications nécessaires.

4. Cliquez sur Enregistrer. La page d'informations sur la connexion s'affiche.
5. Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Authorize (Autoriser) s'affiche.
6. Cliquez sur Autoriser.

   Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Limites du système

Le connecteur Confluence peut traiter 28 transactions par seconde, par nœud, et throttles toutes les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.

Remarque : Le nombre de nœuds de connecteurs d'intégration s'ajustera automatiquement de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour des volumes importants sans en attente de l'autoscaling, vous pouvez ajuster la valeur minimale du nombre de nœuds pour une connexion. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs de nœud, procédez comme suit :

• Si vous êtes un client facturé à l'usage, configurez la valeur minimale et maximale des nœuds sur la page de modification de la connexion.
• Si vous disposez d'un abonnement client, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de plusieurs facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Utiliser la connexion Confluence dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".

• Pour savoir comment créer et utiliser la tâche Connecteurs dans Apigee Integration, consultez la section Tâche Connecteurs.
• Pour savoir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • Créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, opérations ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et une sortie . Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions seront associées à un schéma. Par exemple, un schéma d'action comportera les détails des paramètres tels que : le paramètre noms et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion au moment de l'exécution à partir de votre backend. En cas de mises à jour du schéma, elles ne sont pas automatiquement répercutée dans vos connexions existantes. vous devez actualiser le schéma manuellement. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualiser le schéma de connexion.

Actions

Le connecteur Confluence fournit des actions telles que DownloadAttachment et UploadAttachment. Pour comprendre comment configurer consultez la section Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple - Télécharger la pièce jointe

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DownloadAttachment, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

     {
       "AttachmentId": "xyz"
     }

Exemples d'opérations sur les entités

Exemple : Lister toutes les requêtes

Cet exemple répertorie toutes les requêtes de l'entité Requests.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Demandes" dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.

Exemple – Obtenir l'utilisateur à partir d'un ID de compte spécifique

Cet exemple récupère l'utilisateur dont l'ID de compte est 6035864ce2020c0070b5285b à partir de l'entité Users.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Users dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur filterClause, puis saisissez AccountId=6035864ce2020c0070b5285b dans le champ Default Value (Valeur par défaut).

   Ici, AccountId est la valeur de clé primaire de l'entité Users.

Exemple : Pages de liste

Cet exemple liste les pages de l'entité Pages.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Pages dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour consulter un exemple de modèle terraform permettant de créer une connexion, consultez l'exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Requis	Description
proxy_enabled	VALEUR BOOLÉENNE	Faux	Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	Faux	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE
proxy_user	STRING	Faux	Nom d'utilisateur à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	Faux	Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.
proxy_ssltype	ENUM	Faux	Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante

• Découvrez comment suspendre et réactiver une connexion.
• Découvrez comment surveiller l'utilisation des connecteurs.
• Découvrez comment afficher les journaux du connecteur.