Fournir des informations d'identification et des secrets dans les configurations

Lorsque vous déployez des intégrations dans App Connect vous pouvez ajouter des configurations pour fournir les données et les informations d'identification dont vos flux ont besoin pour fonctionner.

A propos de cette tâche

Pour exécuter les intégrations que vous créez dans App Connect Designer ou IBM® App Connect Enterprise Toolkit, vous devez les déployer. Lorsque vous déployez une intégration, vous pouvez lui appliquer une ou plusieurs configurations. Les fichiers de configuration peuvent définir des paramètres spécifiques à l'environnement, tels que les identifiants de compte, les secrets ou les données que vous ne pouvez pas enregistrer dans un système de contrôle du code source. Les configurations que vous App Connect ajoutez remplacent les configurations existantes qui sont appliquées aux intégrations.
Conseil : en séparant les artefacts des fichiers BAR des fichiers de configuration, vous n'avez pas besoin de modifier un fichier BAR avant de le déployer dans différents environnements. Vous pouvez créer des fichiers de configuration différents pour chaque environnement. Par exemple, vous pouvez avoir des configurations distinctes qui contiennent des informations d'identification différentes pour les systèmes de test et de production. Vous pouvez également utiliser une configuration pour fournir une politique commune ou un ensemble d'informations d'identification à plusieurs intégrations déployées. Lorsque les informations d'identification changent, vous devez les modifier à un seul endroit.
Différents types de configuration vous permettent de personnaliser une intégration avant de la déployer. Par exemple, utilisez une configuration Comptes pour spécifier les détails du compte pour les applications auxquelles vous vous connectez. Utilisez une configuration de projet de politique pour spécifier un ensemble de politiques pour les nœuds dans le flux de votre boîte à outils. Vous pouvez également utiliser une configuration d' agent de réseau privé pour vous connecter à des systèmes ou à des applications sur un réseau privé.
Remarque : Lorsque vous déployez des flux créés dans App Connect Designer, vous devez ajouter une configuration Comptes pour fournir des informations d'identification de compte pour vos connecteurs. Les comptes auxquels vous vous connectez sur la page Applications et API ou dans l'éditeur de flux sont utilisés pour développer et tester vos flux. Lorsque vous déployez votre flux, vous devez fournir les informations d'identification de ces comptes dans la configuration des comptes. Vous ne pouvez appliquer qu'une seule configuration de comptes à une exécution d'intégration, mais vous pouvez l'utiliser pour fournir des informations d'identification à plusieurs connecteurs.

Vous pouvez créer, visualiser et modifier vos configurations dans l'onglet Configurations de la page Gérer Icône représentant la page Gérer. Lorsque vous mettez à jour la configuration d'un flux déployé, ce flux est redémarré automatiquement avec la configuration mise à jour.

Création de configurations

Procédure

  1. Allez dans l'onglet Configurations de la page Gérer Icône représentant la page Gérer.
    Le tableau répertorie certaines configurations générées par le système et toutes les configurations que vous et d'autres utilisateurs de l'instance avez créées. Vous pouvez utiliser le champ de recherche pour filtrer les configurations.
    Onglet Configuration avec des configurations générées par le système et par l'utilisateur.
  2. Pour créer une configuration, cliquez sur Créer une configuration.
  3. Sélectionnez l'emplacement de déploiement où vous souhaitez créer la configuration.
  4. Cliquez sur Type et sélectionnez le type de configuration.
  5. Saisissez un nom pour la configuration afin de pouvoir l'identifier ultérieurement dans le tableau des configurations.
    Le nom doit être composé de caractères alphanumériques minuscules, de tirets (-) ou de points (.), et doit commencer et se terminer par un caractère alphanumérique.
  6. Fournir les valeurs requises.
    Les informations que vous devez fournir dépendent du type de configuration que vous sélectionnez. Selon le type de configuration, vous pouvez remplir des champs de formulaire, importer un fichier ou coller du code. Pour plus d'informations, voir Types de configuration.
    • Si vous sélectionnez le type Comptes, choisissez une application dans la liste et fournissez les détails de connexion requis. Pour plus d'informations, voir Configuration des comptes.
      Si vous déployez un flux que vous avez créé dans le concepteur d' App Connect, vous devez ajouter une configuration Comptes contenant les détails de connexion pour toutes les applications de votre intégration. Vous ne pouvez ajouter qu'une seule configuration de compte, mais vous pouvez ajouter des informations d'identification pour plusieurs applications en cliquant sur Ajouter un compte.
      Une configuration de type Comptes. Le nom de la configuration est accounts-for-test et la description est Les comptes pour l'environnement de test. L'application sélectionnée est BambooHR,, dont le nom de compte est myAccount,, le sous-domaine mycompany.bamboohr.com et la clé API obscurcie. Le lien Ajouter un montant permet d'ajouter les détails de la connexion pour une autre application.

      Les guides pratiques indiquent comment obtenir les détails de connexion pour les applications.

    • Si vous sélectionnez le type Projet de politique, vous pouvez soit télécharger des projets de politique existants dans un .zip fichier, soit créer un projet à partir de zéro dans le générateur de projets de politique (voir Création d'une configuration de projet de politique ).
    • Si vous sélectionnez le type server.conf.yaml, vous pouvez soit télécharger un fichier YAML de configuration de serveur existant (server.conf.yaml), soit créer un fichier à partir de zéro dans le générateur de configuration de serveur (voir Création d'une configuration d' server.conf.yaml ).
    • Pour les autres types de configuration, saisissez ou importez les informations requises. Pour plus d'informations, consultez Types de configuration.
  7. Après avoir saisi toutes les valeurs requises pour votre configuration, cliquez sur Créer.

Résultats

La configuration est répertoriée dans l'onglet Configurations. Vous pouvez sélectionner une ou plusieurs configurations lorsque vous déployez une intégration.

Mise à jour d'une configuration

Procédure

  1. Allez dans l'onglet Configurations de la page Gérer.
  2. Pour mettre à jour les valeurs d'une configuration existante, ouvrez le menu des options L'icône qui représente le menu d'options d'une configuration. de la configuration et cliquez sur Mettre à jour.
    Le menu d'options d'une configuration contient des options permettant de mettre à jour ou de supprimer la configuration.
  3. Modifiez les valeurs nécessaires en tenant compte des restrictions suivantes.
    • Pour une configuration de comptes contenant des secrets, tous les champs qui ne peuvent pas être mis à jour sont désactivés. Les champs contenant des données sensibles (représentés par une icône Afficher/Masquer Afficher l'icône du mot de passele mot de passe ) affichent une valeur lorsque REDACTED vous cliquez sur l'icône. Pour des raisons de sécurité, vous ne pouvez pas consulter les valeurs existantes, mais vous pouvez les remplacer. Par exemple, vous pouvez avoir besoin de modifier un mot de passe ou de spécifier un nouvel identifiant client ou un nouveau secret.
      Exemple de champs contenant des secrets et le texte EXPURGÉ

      Pour les champs contenant des données non sensibles, les données sont affichées en texte brut que vous pouvez écraser. (Les valeurs que vous ne mettez pas à jour restent inchangées)

      Remarque :

      Vous pouvez mettre à jour les champs dans la vue Formulaire, mais pas dans la vue Code.

      Vous pouvez également importer un accounts.yaml fichier contenant les valeurs mises à jour en cliquant sur Importer le fichier Importer un fichier. Les paramètres du fichier remplacent les données de votre compte existant.

      Vous pouvez également ajouter ou supprimer des comptes dans le cadre de la mise à jour.

    • Pour les configurations qui contiennent des secrets et fournissent un éditeur de texte pour le contenu (par exemple, setdbparms.txt), tous les champs qui ne peuvent pas être mis à jour sont désactivés. Pour des raisons de sécurité, l'éditeur de texte affiche une valeur de REDACTED. Vous pouvez écraser cette valeur en collant le contenu d'un fichier existant dans l'éditeur de texte.

      Vous pouvez également importer un fichier contenant du contenu mis à jour en cliquant sur Importer un fichier. Lorsque vous cliquez sur Afficher le contenu du fichier pour revenir à l'éditeur de texte, vous voyez le contenu du fichier importé.

    • Pour mettre à jour la configuration d'un projet de stratégie, vous pouvez utiliser le générateur de projet de stratégie, et pour mettre à jour une server.conf.yaml configuration, vous pouvez utiliser le générateur de configuration de serveur.
    • Pour les autres types de configuration, vous pouvez mettre à jour les paramètres dans l'éditeur de texte ou importer un fichier mis à jour pour remplacer le contenu existant. (Les champs qui ne peuvent pas être mis à jour sont désactivés) Effectuez l'une des étapes suivantes. Remplacez le contenu de l'éditeur de texte en collant le contenu d'un fichier existant ou importez un fichier contenant le contenu mis à jour en cliquant sur Importer un fichier Importer un fichier. Pour afficher le contenu dans l'éditeur de texte, cliquez sur Afficher le contenu du fichier.
  4. Pour enregistrer vos modifications, cliquez sur Mettre à jour.

Résultats

La configuration mise à jour est appliquée à tous les déploiements qui utilisent cette configuration. Pour certains types de configuration, la durée d'exécution de l'intégration est redémarrée automatiquement.

Suppression d'une configuration

Procédure

Pour supprimer une configuration qui n'est utilisée par aucune intégration déployée, procédez comme suit.

  1. Allez dans l'onglet Configurations de la page Gérer.
  2. Vérifiez si la configuration est utilisée dans un environnement d'exécution. Si la configuration est appliquée à une intégration déployée, le nom du runtime s'affiche dans la colonne Appliqué dans du tableau des configurations.
    Vous ne pouvez pas supprimer une configuration qui est utilisée par une intégration déployée. Pour supprimer une configuration, vous devez d'abord la supprimer de l'intégration.
    Par exemple, procédez comme suit.
    1. Accédez à l'onglet Durées d'exécution de la page Gérer.
    2. Ouvrez le menu du runtime contenant la configuration, puis cliquez sur Modifier.
    3. Dans la section Configurations, cliquez sur Supprimer (x) à côté de la configuration, puis cliquez sur Enregistrer les modifications. Cette action supprime la configuration du runtime, mais ne la supprime pas de votre instance.
  3. Dans l'onglet Configurations, ouvrez le menu des options L'icône qui représente le menu d'options d'une configuration. de la configuration et cliquez sur Supprimer.
  4. Pour confirmer la suppression, cliquez sur Supprimer.

Résultats

La configuration est supprimée et retirée de la table.