Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation d'un pipeline OpenSearch d'ingestion avec Atlassian Services

Vous pouvez utiliser les plugins source Atlassian Jira et Confluence pour intégrer les données des services Atlassian dans votre pipeline d'ingestion. OpenSearch Ces intégrations vous permettent de créer une base de connaissances consultable unifiée en synchronisant des projets Jira complets et des espaces Confluence, tout en préservant la pertinence en temps réel grâce à une surveillance continue et à une synchronisation automatique des mises à jour.

Integrating with Jira

Transformez votre expérience Jira grâce à de puissantes fonctionnalités de recherche contextuelle en intégrant votre contenu Jira dans. OpenSearch Le plugin source Atlassian Jira de Data Prepper vous permet de créer une base de connaissances unifiée consultable en synchronisant des projets Jira complets, tout en préservant leur pertinence en temps réel grâce à une surveillance continue et à une synchronisation automatique des mises à jour. Cette intégration permet la synchronisation des données avec des options de filtrage flexibles pour des projets, des types de problèmes et des statuts spécifiques, garantissant ainsi que seules les informations dont vous avez besoin sont importées.

Pour garantir une connectivité sûre et fiable, le plugin prend en charge plusieurs méthodes d'authentification, notamment l'authentification de base par clé d'API et l' OAuth2authentification, avec la sécurité supplémentaire de la gestion des informations d'identification à l'aide d'un secret stocké dans AWS Secrets Manager. Il propose également le renouvellement automatique des jetons pour un accès ininterrompu, garantissant ainsi un fonctionnement continu. Basée sur la version 2 de l'API d'Atlassian, cette intégration permet aux équipes de tirer des enseignements précieux de leurs données Jira grâce aux fonctionnalités OpenSearch de recherche avancées.

Integrating with Confluence

Améliorez la gestion des connaissances et les capacités de collaboration de votre équipe en intégrant le contenu Atlassian Confluence OpenSearch via le plugin source Confluence de Data Prepper. Cette intégration vous permet de créer un référentiel centralisé et consultable de connaissances collectives, améliorant ainsi la découverte d'informations et la productivité des équipes. En synchronisant le contenu de Confluence et en surveillant en permanence les mises à jour, le plugin garantit que votre OpenSearch index reste complet up-to-date.

L'intégration offre des options de filtrage flexibles, vous permettant d'importer du contenu de manière sélective à partir d'espaces ou de types de pages spécifiques, en adaptant le contenu synchronisé aux besoins de votre organisation. Le plugin prend en charge à la fois les clés API de base et les méthodes OAuth2 d'authentification, avec la possibilité de gérer en toute sécurité les informations d'identification via AWS Secrets Manager. La fonction de renouvellement automatique des jetons du plugin garantit un accès ininterrompu et un fonctionnement sans faille. Basée sur l'API Confluence d'Atlassian, cette intégration permet aux équipes de tirer parti des fonctionnalités de recherche avancées OpenSearch de leur contenu Confluence, améliorant ainsi l'accessibilité et l'utilisation des informations au sein de l'organisation.

Prérequis

Avant de créer votre pipeline OpenSearch d'ingestion, procédez comme suit :

Configuration d'un rôle de pipeline

Le rôle transmis dans le pipeline doit être associé à la politique suivante pour pouvoir lire et écrire sur le secret créé dans la section des prérequis.

JSON

{
    "Version": "2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "SecretReadWrite",
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetResourcePolicy",
                "secretsmanager:GetSecretValue",
                "secretsmanager:DescribeSecret",
                "secretsmanager:PutSecretValue",
                "secretsmanager:ListSecretVersionIds"
            ],
            "Resource": "arn:aws:secretsmanager:us-east-1:111122223333:secret:secret-name-random-6-characters"
        }
    ]
}

Le rôle doit également être associé à une politique d'accès et d'écriture sur le récepteur que vous avez choisi. Par exemple, si vous OpenSearch le choisissez comme récepteur, la politique est similaire à la suivante :

JSON

{
    "Version": "2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "OpenSearchWritePolicy",
            "Effect": "Allow",
            "Action": "aoss:*",
            "Resource": "arn:aws:aoss:us-east-1:111122223333:collection/collection-id"
        }
    ]
}

Configuration du pipeline de connecteurs Jira

Vous pouvez utiliser un plan Atlassian Jira préconfiguré pour créer ce pipeline. Pour de plus amples informations, veuillez consulter Travailler avec des plans.

Remplacez placeholder values par vos propres informations.

version: "2"
extension:
  aws:
    secrets:
      jira-account-credentials:
        secret_id: "secret-arn"
        region: "secret-region"
        sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"
atlassian-jira-pipeline:
  source:
    jira:
      # We only support one host url for now
      hosts: ["jira-host-url"]
      acknowledgments: true
      authentication:
        # Provide one of the authentication method to use. Supported methods are 'basic' and 'oauth2'.
        # For basic authentication, password is the API key that you generate using your jira account
        basic:
          username: ${{aws_secrets:jira-account-credentials:username}}
          password: ${{aws_secrets:jira-account-credentials:password}}
        # For OAuth2 based authentication, we require the following 4 key values stored in the secret
        # Follow atlassian instructions at the below link to generate these keys.
        # https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/
        # If you are using OAuth2 authentication, we also require, write permission to your AWS secret to
        # be able to write the renewed tokens back into the secret.
        # oauth2:
          # client_id: ${{aws_secrets:jira-account-credentials:clientId}}
          # client_secret: ${{aws_secrets:jira-account-credentials:clientSecret}}
          # access_token: ${{aws_secrets:jira-account-credentials:accessToken}}
          # refresh_token: ${{aws_secrets:jira-account-credentials:refreshToken}}
      filter:
        project:
          key:
            include:
              # This is not project name.
              # It is an alphanumeric project key that you can find under project details in Jira.
              - "project-key"
              - "project-key"
            # exclude:
              # - "project-key"
              # - "project-key"
        issue_type:
          include:
            - "issue-type"
            # - "Story"
            # - "Bug"
            # - "Task"
         # exclude:
             # - "Epic"
        status:
          include:
            - "ticket-status"
            # - "To Do"
            # - "In Progress"
            # - "Done"
         # exclude:
           # - "Backlog"

  sink:
    - opensearch:
        # Provide an Amazon OpenSearch Service domain endpoint
        hosts: [ "https://search-mydomain-1a2a3a4a5a6a7a8a9a0a9a8a7a.us-east-1.es.amazonaws.com" ]
        index: "index_${getMetadata(\"project\")}"
        # Ensure adding unique document id which is the unique ticket id in this case
        document_id: '${/id}'
        aws:
          # Provide a Role ARN with access to the domain. This role should have a trust relationship with osis-pipelines.amazonaws.com
          sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"
          # Provide the region of the domain.
          region: "us-east-1"
          # Enable the 'serverless' flag if the sink is an Amazon OpenSearch Serverless collection
          serverless: false
          # serverless_options:
            # Specify a name here to create or update network policy for the serverless collection
            # network_policy_name: "network-policy-name"
        # Enable the 'distribution_version' setting if the Amazon OpenSearch Service domain is of version Elasticsearch 6.x
        # distribution_version: "es6"
        # Enable and switch the 'enable_request_compression' flag if the default compression setting is changed in the domain. 
        # See Compression des requêtes HTTP dans Amazon  OpenSearch  Service
        # enable_request_compression: true/false
        # Optional: Enable the S3 DLQ to capture any failed requests in an S3 bucket. Delete this entire block if you don't want a DLQ.
        dlq:
          s3:
            # Provide an S3 bucket
            bucket: "your-dlq-bucket-name"
            # Provide a key path prefix for the failed requests
            # key_path_prefix: "kinesis-pipeline/logs/dlq"
            # Provide the region of the bucket.
            region: "us-east-1"
            # Provide a Role ARN with access to the bucket. This role should have a trust relationship with osis-pipelines.amazonaws.com
            sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"

Clé des attributs de la source Jira :

Configuration du pipeline du connecteur Confluence

Vous pouvez utiliser un plan Atlassian Confluence préconfiguré pour créer ce pipeline. Pour de plus amples informations, veuillez consulter Travailler avec des plans.

version: "2"
extension:
  aws:
    secrets:
      confluence-account-credentials:
        secret_id: "secret-arn"
        region: "secret-region"
        sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"
atlassian-confluence-pipeline:
  source:
    confluence:
      # We currently support only one host URL.
      hosts: ["confluence-host-url"]
      acknowledgments: true
      authentication:
        # Provide one of the authentication method to use. Supported methods are 'basic' and 'oauth2'.
        # For basic authentication, password is the API key that you generate using your Confluence account
        basic:
          username: ${{aws_secrets:confluence-account-credentials:confluenceId}}
          password: ${{aws_secrets:confluence-account-credentials:confluenceCredential}}
        # For OAuth2 based authentication, we require the following 4 key values stored in the secret
        # Follow atlassian instructions at the following link to generate these keys:
        # https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/
        # If you are using OAuth2 authentication, we also require write permission to your AWS secret to
        # be able to write the renewed tokens back into the secret.
        # oauth2:
          # client_id: ${{aws_secrets:confluence-account-credentials:clientId}}
          # client_secret: ${{aws_secrets:confluence-account-credentials:clientSecret}}
          # access_token: ${{aws_secrets:confluence-account-credentials:accessToken}}
          # refresh_token: ${{aws_secrets:confluence-account-credentials:refreshToken}}
      filter:
        space:
          key:
            include:
              # This is not space name.
              # It is a space key that you can find under space details in Confluence.
              - "space key"
              - "space key"
           # exclude:
             #  - "space key"
             #  - "space key"
        page_type:
          include:
            - "content type"
            # - "page"
            # - "blogpost"
            # - "comment"
         # exclude:
            # - "attachment"

  sink:
    - opensearch:
        # Provide an Amazon OpenSearch Service domain endpoint
        hosts: [ "https://search-mydomain-1a2a3a4a5a6a7a8a9a0a9a8a7a.us-east-1.es.amazonaws.com" ]
         index: "index_${getMetadata(\"space\")}"
        # Ensure adding unique document id which is the unique ticket ID in this case.
        document_id: '${/id}'
        aws:
          # Provide the Amazon Resource Name (ARN) for a role with access to the domain. This role should have a trust relationship with osis-pipelines.amazonaws.com.
          sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"
          # Provide the Region of the domain.
          region: "us-east-1"
          # Enable the 'serverless' flag if the sink is an Amazon OpenSearch Serverless collection
          serverless: false
          # serverless_options:
            # Specify a name here to create or update network policy for the serverless collection.
            # network_policy_name: "network-policy-name"
        # Enable the 'distribution_version' setting if the Amazon OpenSearch Service domain is of version Elasticsearch 6.x
        # distribution_version: "es6"
        # Enable and switch the 'enable_request_compression' flag if the default compression setting is changed in the domain. 
        # For more information, see Compression des requêtes HTTP dans Amazon  OpenSearch  Service.
        # enable_request_compression: true/false
        # Optional: Enable the S3 DLQ to capture any failed requests in an S3 bucket. Delete this entire block if you don't want a DLQ.
        dlq:
          s3:
            # Provide an S3 bucket
            bucket: "your-dlq-bucket-name"
            # Provide a key path prefix for the failed requests
            # key_path_prefix: "kinesis-pipeline/logs/dlq"
            # Provide the Rregion of the bucket.
            region: "us-east-1"
            # Provide the Amazon Resource Name (ARN) for a role with access to the bucket. This role should have a trust relationship with osis-pipelines.amazonaws.com
            sts_role_arn: "arn:aws:iam::123456789012:role/Example-Role"

Attributs clés de la source Confluence :

Cohérence des données

Sur la base des filtres spécifiés dans le pipeline YAML, les projets (ou espaces) sélectionnés seront extraits une fois et entièrement synchronisés avec le récepteur cible. Ensuite, la surveillance continue des modifications capturera les modifications au fur et à mesure qu'elles se produisent et mettra à jour les données dans le récepteur. Une exception est que le suivi des modifications synchronise uniquement les update actions, create et non les delete actions.

Limites

Informations relatives CloudWatch aux connecteurs Atlassian

Type : métriques du connecteur Jira

Type : métriques du connecteur Confluence