Jira Cloud

Le connecteur Cloud Jira vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur des données Jira modélisées sous forme de base de données.

Versions compatibles

Le connecteur Cloud Jira utilise les versions 2 et 3 de l'API JIRA Cloud REST. Ceux-ci sont gérés en interne et vous n'avez pas besoin d'effectuer de configurations supplémentaires.

Avant de commencer

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

  • Dans votre projet Google Cloud :
    • Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du 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 Informations de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Jira Cloud 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.
      • Pour les connecteurs compatibles avec l'abonnement aux événements, les noms de connexion ne peuvent pas commencer par le préfixe "goog".
    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.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Pour utiliser la connexion pour souscrire des abonnements à des événements, sélectionnez Activer l'abonnement aux événements. Si vous sélectionnez cette option, les options suivantes s'affichent :
      • Activer l'abonnement aux événements avec entité et actions : sélectionnez cette option pour utiliser la connexion à la fois pour l'abonnement aux événements et les opérations de connecteur (entités et actions).
      • Activer uniquement l'abonnement aux événements : sélectionnez cette option pour utiliser la connexion uniquement pour l'abonnement aux événements. Si vous sélectionnez cette option, cliquez sur Suivant, puis configurer un abonnement à un événement.
    8. 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.

    9. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • Basique : authentification HTTP de base.
        • Condensé : authentification HTTP par condensé.
      • Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "JAMAIS" est utilisée.
        • Toujours : la connexion SSL est toujours activée.
        • Jamais : la connexion n'est pas activée pour SSL.
        • Tunnel : la connexion s'effectue via un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    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.
      • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

        Si vous souhaitez établir une connexion privée à votre backend, procédez comme suit :

      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 la connexion Jira Cloud :

      • Nom d'utilisateur et mot de passe
    2. Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

    3. Cliquez sur SUIVANT.
  7. Si vous avez activé l'abonnement aux événements, la section Détails de l'abonnement aux événements s'affiche sur la page de création de la connexion. Pour savoir comment configurer les détails de l'abonnement aux événements, consultez Configurer l'abonnement aux événements.
  8. Vérifiez vos informations de connexion et d'authentification.
  9. Cliquez sur Créer.

Configurer l'abonnement aux événements

Si vous avez activé l'abonnement aux événements, saisissez les valeurs suivantes dans la section Détails de l'abonnement aux événements :

  1. Sélectionnez un type de destination.
    • Adresse de l'hôte: saisissez l'URL d'enregistrement de votre système backend dans le champ host.
  2. Saisissez les informations d'authentification.
    1. Nom d'utilisateur: saisissez le nom d'utilisateur.
    2. Jeton d'API : sélectionnez le secret Secret Manager contenant le jeton d'API.
    3. Version du secret: sélectionnez la version du secret.
  3. Sélectionnez Activer la connectivité privée pour une connectivité sécurisée entre votre application backend et votre connexion. Si vous sélectionnez cette option, vous devrez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez la section Connectivité privée pour l'abonnement aux événements.
  4. Saisissez la configuration de la file d'attente de lettres mortes. Si vous configurez des lettres mortes, la connexion écrit les événements non traités dans le sujet Pub/Sub spécifié. Saisissez les informations suivantes:
    1. ID du projet de lettre morte : ID du projet Google Cloud dans lequel vous avez configuré le sujet de lettre morte Pub/Sub.
    2. Sujet de lettres mortes : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
  5. Si vous souhaitez utiliser un proxy pour vous connecter à votre backend (pour les abonnements à des événements), saisissez les informations suivantes:
    1. Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Sélectionnez une option des types d'authentification suivants:
      • Toujours: le protocole SSL est toujours activé pour les abonnements à des événements.
      • Jamais: la connexion n'est pas activée par SSL pour l'abonnement à des événements.
    2. Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
      • Basique : authentification HTTP de base.
    3. Utilisateur du proxy : saisissez le nom d'utilisateur à utiliser pour l'authentification auprès du serveur proxy.
    4. Mot de passe du proxy : sélectionnez le secret Secret Manager du mot de passe de l'utilisateur.
    5. Version du secret : sélectionnez la version du secret.
    6. Dans la section Serveur proxy, saisissez les détails du serveur proxy.
      1. Cliquez sur + Ajouter une destination, puis sélectionnez le type de destination. en tant qu'Adresse de l'hôte.
      2. Saisissez le nom d'hôte ou l'adresse IP du serveur proxy, ainsi que le numéro de port du serveur proxy.

Configurer l'authentification

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

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : nom d'utilisateur Jira Cloud à utiliser pour la connexion.
    • Jeton d'API: le mot de passe du nom d'utilisateur sera un jeton d'API. Sélectionnez le secret Secret Manager contenant le jeton d'API associé au nom d'utilisateur Jira Cloud.
  • 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 Jira Cloud. Pour comprendre le fonctionnement des champs d'application et afficher tous les champs d'application disponibles pour Jira Cloud, consultez Champs d'application.
    • 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 plus d'informations, consultez la section Étapes supplémentaires après la création d'une connexion.

É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, recherchez la connexion que vous venez de créer.

    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 informations d'autorisation.
  5. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active (Actif) dans 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 Jira Cloud, vous devez autoriser à nouveau votre connexion Jira Cloud. Pour autoriser à nouveau une connexion, procédez comme suit:

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

    La page des 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 des détails de 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 (Actif) sur la page Connexions.

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.

  • 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é :

    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'est pas compatible avec l'une des opérations d'entité, ces opérations non compatibles ne sont pas listé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 un paramètre de sortie. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Jira Cloud peut traiter un maximum de 10 transactions par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, les connecteurs d'intégration allouent deux nœuds (pour une meilleure disponibilité) à une connexion.

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

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 la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet 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. Valeurs acceptées: 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 s'authentifier 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.

Utiliser la connexion Jira Cloud 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 dans 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 découvrir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

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