Confluence

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

Avant de commencer

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

Dans votre projet Google Cloud :
- Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
- 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 type spécial de compte Google 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 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 Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à 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 :

Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connexions"
Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
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.
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, indiquez le nom de l'instance de connexion.
  Les noms de connexion doivent répondre aux critères suivants :
  - Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
  - Les lettres doivent être en minuscules.
  - Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
  - Ils ne peuvent pas dépasser 49 caractères.
4. (Facultatif) Saisissez une description de l'instance de connexion.
5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur "Erreur".
6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
7. (Facultatif) Sélectionnez Inclure les espaces archivés pour inclure le contenu des espaces archivés dans le résultat. La valeur par défaut est "false".
8. (Facultatif) Saisissez une clé d'espace pour que la recherche n'affiche que le contenu de cet espace spécifique.
9. (Facultatif) Configurez les paramètres de nœuds 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 davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez 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 améliorer la disponibilité) et le nombre maximal de nœuds sur 50.
10. (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
11. Cliquez sur SUIVANT.
Dans la section Destinations, saisissez des informations sur 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 de l'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 de point de terminaison dans la liste, puis sélectionnez le rattachement de point de terminaison requis dans la liste Rattachement de point de terminaison.
    Remarque : Pour savoir comment créer un rattachement de point de terminaison, consultez Rattachement de service PSC et Rattachement de point de terminaison. Une fois le rattachement de point de terminaison créé, il apparaît dans la liste Rattachement de 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 SUIVANT.
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 :
  - De base
  - APIToken
  - OAuth2.0
2. Cliquez sur SUIVANT.
Vérifier : vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

De base
- Nom d'utilisateur : compte utilisateur Confluence utilisé pour l'authentification.
- Mot de passe : mot de passe associé au compte.
APIToken
- Nom d'utilisateur : nom d'utilisateur Confluence permettant de créer le jeton d'API.
- Jeton d'API : le mot de passe associé au 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.
Code d'autorisation OAuth 2.0
- ID client : ID client fourni par votre application externe.
- Niveaux d'accès : niveaux d'accès d'autorisation. Le niveau d'accès offline_access doit être utilisé avec le connecteur Confluence. Pour en savoir plus sur les niveaux d'accès Confluence, consultez Confluence Scopes (Niveaux d'accès Confluence).
- Code 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.

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

Si vous avez sélectionné OAuth 2.0 - Authorization code pour l'authentification, vous devez effectuer les étapes supplémentaires ci-dessous après avoir créé la connexion :

Sur la page Connexions, recherchez la connexion que vous venez de créer.
Notez que l'état du nouveau connecteur sera Autorisation requise.
Cliquez sur Autorisation requise.
Le volet Modifier l'autorisation s'affiche.
Copiez la valeur de l'URI de redirection dans votre application externe.
Vérifiez les détails de l'autorisation.
Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Accorder une nouvelle autorisation pour le 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 autoriser à nouveau une connexion, procédez comme suit :

Sur la page Connexions, cliquez sur la connexion requise.
La page de détails de la connexion s'ouvre.
Cliquez sur Modifier pour modifier les détails de la connexion.
Dans la section Authentification, vérifiez les détails du code d'autorisation OAuth 2.0.
Apportez des modifications, si besoin.
Cliquez sur Enregistrer. La page de détails de la connexion s'affiche.
Dans la section Authentification, cliquez sur Modifier l'autorisation. Le volet Autoriser s'affiche.
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 et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

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

Remarque : L'autoscaling du nombre de nœuds Integration Connectors s'effectue de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de gros volumes sans attendre l'autoscaling, vous pouvez ajuster le nombre minimal de nœuds pour une connexion. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs de nœuds, procédez comme suit :

Si vous avez opté pour le paiement à l'usage, configurez le nombre minimal et le nombre maximal de nœuds sur la page "Modifier la connexion".
Si vous avez souscrit un abonnement, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut traiter dépend de plusieurs facteurs. Par conséquent, avant que vous ajustiez 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 dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez 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 par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

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és. 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, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.
Toutefois, il est possible qu'un connecteur n'accepte 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é. Voici les opérations possibles :
- List
- Get
- Create
- Update
- Delete
Lorsque vous sélectionnez une entité dans la liste proposée, cela 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 "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.
Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de 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 un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Actions

Le connecteur Confluence fournit des actions telles que DownloadAttachment et UploadAttachment. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Télécharger une pièce jointe

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action DownloadAttachment, puis cliquez sur OK.
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 d'entité

Exemple : Lister toutes les requêtes

Cet exemple liste toutes les requêtes dans l'entité Requests.

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

Exemple : Récupérer un 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.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération LIST, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur filterClause, puis saisissez AccountId=6035864ce2020c0070b5285b dans le champ Valeur par défaut.
Ici, AccountId est la valeur de la clé primaire de l'entité Users.

Exemple : Lister les pages

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

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

Exemple : Récupérer des pages

Cet exemple récupère un enregistrement de page à partir de l'entité Pages.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Pages dans la liste Entity.
Sélectionnez l'opération GET, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 123 dans le champ Valeur par défaut.
Ici, 123 est un identifiant unique pour l'entité de ressource Pages.

Exemple : Créer des pages

Cet exemple crée un enregistrement de page dans l'entité Pages.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Pages dans la liste Entity.
Sélectionnez l'opération CREATE, puis cliquez sur OK.
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 :
```
{
      "SpaceId": "12345",
      "Status": "Current",
      "Title": "FROM XYZ",
      "Storage": "XYZ1234"
    }
```

Example - Update Pages

This example updates a page record in the Pages entity.

In the Configure connector task dialog, click Entities.

Select Pages from the Entity list.

Select the UPDATE operation, and then click Done.

In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
    "Title": "Update abc"
    }
```
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 12345 dans le champ Valeur par défaut.

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" contiendra la réponse de l'opération de mise à jour.

{
    "Id": 1234
    }

Exemple : Supprimer une page

Cet exemple supprime une page de l'entité Pages.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Pages dans la liste Entity.
Sélectionnez l'opération DELETE, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 123 dans le champ Valeur par défaut.
Si l'entité comporte des clés primaires composites, vous pouvez définir la filterClause au lieu de spécifier l'entityId. Par exemple, Id='123'.

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

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

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez 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	Obligatoire	Description
proxy_enabled	BOOLEAN	False	Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	False	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user	STRING	False	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	False	Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype	ENUM	False	Type SSL à utiliser pour se connecter au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Demander de l'aide à la communauté Google Cloud

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

Étapes suivantes

Découvrez comment suspendre et reprendre une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux des connecteurs.