Démarrer la synchronisation

Lorsque vous utilisez un répertoire Git basé sur des fichiers, les deux instances du Synchronizer, l'une pour le développement Management Console et l'autre pour la production Management Console, requièrent un accès direct au système de fichiers où se trouve le répertoire.

Nous vous recommandons d'exécuter les deux instances du Synchronizer sur le même ordinateur où le répertoire est stocké (1). Grâce à cette configuration, le responsable de la promotion peut utiliser l'une des normes du protocole Git (2) pour accéder au répertoire et pousser les changements vers la production.

Recommandation 1 : Lors de la synchronisation avec un répertoire de fichiers nu, plusieurs Synchronizers peuvent fonctionner sur le même ordinateur.

Recommandation 2 : Pour plus de commodité, le gestionnaire de promotion peut utiliser un client Git tiers tel que SourceTree au lieu des commandes Git.

Recommandation 3 : Si Docker est utilisé pour le déploiement, les conteneurs Synchronizer peuvent partager un volume.

Configurer l'accès Synchronizer à la Management Console

Pour connecter les deux Management Consoles et le répertoire Git, procédez comme suit.

  1. Pour invoquer un Synchronizer à partir de la ligne de commande, ouvrez une fenêtre d'invite de commande, accédez au dossier bin dans le dossier d'installation Kofax RPA. Spécifiez les paramètres requis à l'aide des commandes répertoriées dans le tableau ci-dessous.

    • Démarrez la ligne de commande avec la commande -c.

    • Configurer l'accès Synchronizer à la Management Console de développement.

    • Ajoutez le paramètre -s qui crée le fichier synchronizer.settings et enregistre les paramètres de configuration.

    Exemple :

    Synchronizer.exe -c --mc-url http://127.0.0.1:8080/ManagementConsole --shared-secret-file <insert-path> --interval 10 --no-host-key false --private-key $USER_HOME\.ssh\id_rsa -s

    Commande Description
    -c,--command-line

    Utilise les paramètres spécifiés dans la ligne de commande et ignore le fichier de paramètres.

    -e,--environment

    Utilise les paramètres de l'environnement et ignore le fichier de paramètres.

    -g,--generate-ssh-keys <argument>

    Génère une paire de clés pour l'authentification SSH et l'enregistre dans le dossier spécifié. Par exemple : -g C:\Work\MyKeys

    --mc-url <argument>

    Requis. À utiliser uniquement lorsque -c est spécifié. Spécifie l'URL pour se connecter à la Management Console de développement ou de production contenant le protocole et un numéro de port.

    --shared-secret <argument>

    Requis. À utiliser uniquement lorsque -c est spécifié. Contient le code secret partagé en texte brut copié à partir de la section Serveur OAuth de la Management Console pour authentifier Synchronizer sur la Management Console.

    --shared-secret-file <argument>

    Requis. Chemin vers un fichier contenant le code secret partagé copié à partir de la section Authentification du service de la Management Console pour authentifier Synchronizer sur la Management Console.

    --interval <argument>

    Requis. À utiliser uniquement lorsque -c est spécifié. Définit l'intervalle en secondes entre les cycles de synchronisation. S'il est réglé sur une valeur égale ou inférieure à 0 ou sur une valeur non numérique, le Synchronizer fonctionne une fois et sort.

    --no-host-key <argument>

    Facultatif. À utiliser uniquement lorsque -c est spécifié. Désactive le contrôle strict des clés de l'hôte en SSH. Par défaut, il est défini sur faux.

    --private-key <argument> Requis. À utiliser uniquement lorsque -c est spécifié. Fournit le chemin d'accès au fichier contenant la clé privée SSH pour se connecter à un répertoire distant. Lors de la connexion à un répertoire local, cet attribut est ignoré, mais une valeur doit être spécifiée.
    -r,--reset-hard

    Réinitialise les informations de version et purge l'ensemble du cache local.

    -s,--save

    Enregistre les paramètres de configuration dans le fichier synchronizer.settings et quitte.

    -v,--version

    Imprime les informations de version et quitte.

    -h,--help

    Imprime la description des propriétés et quitte.

  2. Répétez l'étape précédente et configurez l'accès Synchronizer à la Management Console en production en modifiant les propriétés selon les besoins.

Les Management Consoles et le répertoire Git sont maintenant synchronisés. Vous pouvez désormais promouvoir des objets en production et configurer la synchronisation entre le projet Management Console et le répertoire Git.

Configurer la synchronisation entre le projet Management Console et le répertoire GitHub

Pour configurer la synchronisation entre le projet Management Console et le répertoire GitHub, procédez comme suit.

  1. Ouvrez le site web du répertoire GitHub et créez un nouveau compte.

  2. Dans la fenêtre d'invite de commande, exécutez le fichier Synchronizer.exe avec le paramètre spécifié -g.

    Exemple

    Synchronizer.exe -c --mc-url http://127.0.0.1:8080/ManagementConsole --shared-secret <insert-secret-string> -g $USER_HOME\.ssh\

    Cela génère la paire RSA de clés publiques et privées.

  3. Connectez-vous à votre compte GitHub. Dans le menu Paramètres, recherchez la section Clés SSH et GPG et créez une nouvelle clé SSH en saisissant la clé publique à partir de la paire de clés générée.

  4. Créez un nouveau répertoire privé sur le site web GitHub et copiez l'adresse SSH de votre répertoire, tel que git@githubrepository.com/username/repository_name.git.

  5. Accédez à Management Console > Administration > Projets et sélectionnez un projet.

    Cliquez sur Modifier et dans la fenêtre Modifier projet, sélectionnez Répertoire.

    1. Cliquez sur Activer la configuration pour activer les champs de configuration d'un répertoire.

    2. Dans le champ URL, insérez l'adresse SSH que vous avez copiée.

    3. Dans le champ Branche, saisissez le nom de la branche à utiliser.

    4. Si Lecture seule est sélectionné, les fichiers du projet seront effacés et remplacés par les fichiers du répertoire GitHub.

      Si Lecture seule n'est pas sélectionné, les fichiers du répertoire GitHub seront effacés et remplacés par les fichiers du projet.

      En mode lecture seule, tous les objets contenus dans la Management Console sont extraits du répertoire. Avant de lancer la synchronisation, assurez-vous que les objets que vous souhaitez synchroniser sont vides dans la Management Console. Sinon, un message d'erreur s'affiche.

      Pour supprimer le contenu de l'objet, sélectionnez l'objet requis dans la liste Objets à synchroniser et cliquez sur Supprimer les objets sélectionnés. Soyez prudent lorsque vous supprimez les objets afin de ne pas perdre de données importantes.

    5. Pour les Objets à synchroniser, sélectionnez les objets à inclure dans la synchronisation.

    6. Cliquez sur OK pour inscrire les modifications.

  6. Dans la fenêtre d'invite de commande, exécutez le fichier Synchronizer.exe avec le paramètre spécifié --private-key.

    Exemple

    Synchronizer.exe -c --mc-url http://127.0.0.1:8080/ManagementConsole --shared-secret <insert-secret-string> --interval 10 --no-host-key true --private-key $USER_HOME\.ssh\id_rsa

Vous avez maintenant synchronisé votre répertoire GitHub avec votre projet Management Console.