Paramétrez Openflow Connector for Jira Cloud¶

Conditions préalables¶

1. Assurez-vous d’avoir consulté À propos de Openflow Connector for Jira Cloud.

2. Assurez-vous que vous avez paramétré Openflow.

Obtenir les identifiants de connexion¶

En tant qu’administrateur de Jira Cloud, effectuez les tâches suivantes dans votre compte Atlassian :

1. Naviguez jusqu’à la page API jetons.

2. Sélectionnez Create API token with scopes.

3. Dans la boîte de dialogue Create an API token, donnez un nom descriptif au jeton d’API et sélectionnez une date d’expiration pour le jeton d’API. Ce délai peut aller de 1 à 365 jours.

4. Sélectionnez l’application Jeton Api Jira.

5. Sélectionnez les champs d’application jira read:jira-work et read:jira-user.

6. Sélectionnez Create token.

7. Dans la boîte de dialogue Copy your API token, sélectionnez Copy pour copier le jeton API que vous avez généré, puis collez le jeton dans les paramètres du connecteur, ou sauvegardez-le en toute sécurité.

8. Sélectionnez Close pour fermer la boîte de dialogue.

Paramétrage du compte Snowflake¶

En tant qu’administrateur de compte Snowflake, effectuez les tâches suivantes :

1. Créez un nouveau rôle ou utilisez un rôle existant.

2. Créez un nouvel utilisateur du service Snowflake avec le type SERVICE.

3. Autorisez l’utilisateur du service Snowflake le rôle que vous avez créé dans les étapes précédentes.

4. Configurez avec l’authentification par paire de clés pour l’utilisateur de Snowflake SERVICE de l’étape 2.

5. Snowflake recommande vivement cette étape. Configurez un gestionnaire de secrets pris en charge par Openflow, par exemple AWS, Azure et Hashicorp, et stockez les clés publiques et privées dans le magasin de secrets.

   Note

   Si, pour une raison quelconque, vous ne souhaitez pas utiliser un gestionnaire de secrets, il vous incombe de protéger les fichiers de clés publiques et privées utilisés pour l’authentification par paires de clés conformément aux politiques de sécurité de votre organisation.

   1. Une fois le gestionnaire de secrets configuré, déterminez comment vous vous y authentifierez. Sur AWS, il est recommandé d’utiliser le rôle de l’instance EC2 associée à Openflow, car de cette manière, aucun autre secret ne doit être conservé.

   2. Dans Openflow, configurez un fournisseur de paramètres associé à ce gestionnaire de secrets, à partir du menu hamburger en haut à droite. Naviguez vers Controller Settings » Parameter Provider et récupérez les valeurs de vos paramètres.

   3. À ce stade, tous les identifiants peuvent être référencés avec les chemins de paramètres associés et aucune valeur sensible ne doit être conservée dans Openflow.

6. Si d’autres utilisateurs de Snowflake ont besoin d’accéder aux documents bruts ingérés et aux tables ingérées par le connecteur (par exemple, pour un traitement personnalisé dans Snowflake), accordez à ces utilisateurs le rôle créé à l’étape 1.

7. Créez une base de données et un schéma dans Snowflake pour que le connecteur puisse stocker les données ingérées. Autorisez Privilèges de base de données pour le rôle créé à la première étape.

   CREATE DATABASE jira_destination_db;
   CREATE SCHEMA jira_destination_db.jira_destination_schema;
   GRANT USAGE ON DATABASE jira_destination_db TO ROLE <jira_connector_role>;
   GRANT USAGE ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
   GRANT CREATE TABLE, CREATE VIEW ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
   

   Copy

8. Créez un entrepôt qui sera utilisé par le connecteur ou utilisez un entrepôt existant. Commencez par la taille d’entrepôt la plus petite, puis faites des essais en fonction du nombre de tables répliquées et de la quantité de données transférées. Les tables de grande taille s’adaptent généralement mieux aux entrepôts multi-clusters, plutôt qu’aux entrepôts de grande taille.

9. Assurez-vous que l’utilisateur dont le rôle est utilisé par le connecteur dispose des privilèges requis pour utiliser l’entrepôt. Si ce n’est pas le cas, accordez les privilèges requis au rôle.

   CREATE WAREHOUSE jira_connector_warehouse WITH WAREHOUSE_SIZE = 'X-Small';
   GRANT USAGE ON WAREHOUSE jira_connector_warehouse TO ROLE <jira_connector_role>;
   

   Copy

Définir le connecteur¶

En tant qu’ingénieur des données, effectuez les tâches suivantes pour installer et configurer le connecteur :

Exécutez le flux¶

1. Cliquez avec le bouton droit de la souris sur l’avion et sélectionnez Enable all Controller Services.

2. Cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Start. Le connecteur démarre l’ingestion des données.

Si vous devez modifier les critères de la requête d’émission ou si vous souhaitez relancer l’ingestion à partir de zéro, effectuez les étapes suivantes pour vous assurer que les données de la table de destination sont cohérentes :

1. Cliquez avec le bouton droit de la souris sur le processeur FetchJiraIssues et arrêtez-le.

2. Cliquez avec le bouton droit de la souris sur le processeur FetchJiraIssues et sélectionnez View State.

3. Dans la boîte de dialogue State, sélectionnez Clear State. Cette action efface l’état du processeur et lui permet de récupérer à nouveau tous les numéros.

4. Facultatif : Si vous souhaitez modifier les critères de requête, cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Parameters. Mettez à jour les paramètres si nécessaire.

5. Facultatif : si vous souhaitez modifier le nom de la table de destination, cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Parameters. Mettez à jour le paramètre Destination Table.

6. Cliquez avec le bouton droit de la souris sur le processeur FetchJiraIssues et sélectionnez Start. Le connecteur démarre l’ingestion des données.

7. Après l’ingestion, les données sont disponibles dans la table de destination Snowflake et dans un format aplati dans la vue de destination. La vue comprend tous les champs disponibles dans l’instance Jira.

Accès aux données¶

Les données extraites de Jira sont disponibles dans la table de destination. Tous les champs extraits pour le ticket Jira sont disponibles dans la colonne ISSUE en tant qu’objet sous forme brute extraite de l’API.

Pour faciliter la requête de données, une vue aplatie est créée en fonction de la table de destination. Le nom de la vue est une concaténation du nom de la table et du suffixe _VIEW. Par exemple, si la table de destination s’appelle JIRA_ISSUES, la vue sera nommée JIRA_ISSUES_VIEW. Dans la vue, tous les champs de tickets sont extraits et disponibles sous forme de colonnes séparées. Le nom de la colonne est défini sur le libellé du champ. S’il existe de nombreux tickets avec le même libellé, un suffixe avec un ID de champ est ajouté au nom de la colonne pour garantir l’unicité. Par exemple, s’il y a deux champs avec des IDs customfield_1, customfield_2, et le libellé est défini dans les deux champs sur Custom Field, les colonnes de la vue seront nommées Custom Field (customfield_1), Custom Field (customfield_2).