Tâches d'administration relatives à la passerelle de gestion

Mettre à jour les propriétés de la passerelle de gestion

Port Management Gateway

La passerelle de gestion est configurée pour accepter le trafic sur un port spécifique spécifié à l'aide de la propriété GatewayPort du fichier gateway.properties.
  • Sur les plates-formes Linux, le fichier gateway.properties se trouve sous : /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/config.
  • Sur les plates-formes Windows, le fichier gateway.properties se trouve sous : C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config.

Pour modifier la valeur du port Management Gateway, modifiez le fichier gateway.properties et remplacez la valeur en cours de la propriété GatewayPort par le numéro de port souhaité.

Après avoir modifié le fichier gateway.properties, le service Management Gateway doit être redémarré.
  • Pour Oracle Linux 6, utilisez : /sbin/initctl restart mgmt_gateway

  • Pour Oracle Linux 7, utilisez : systemctl restart mgmt_gateway

  • Sous Windows, utilisez :
    net stop mgmt_gateway
    net start mgmt_gateway

Si la valeur de la propriété GatewayPort change, tout agent de gestion utilisant cette passerelle de gestion doit être modifié pour utiliser la nouvelle valeur de port. Pour plus de détails, reportez-vous à Mise à jour des agents de gestion après les modifications apportées à la configuration de Management Gateway.

Informations d'identification Management Gateway

La passerelle est généralement configurée pour utiliser les informations d'identification : le nom utilisateur et le mot de passe sont requis pour la connexion.

Ces informations d'identification sont stockées dans les portefeuilles Oracle. Pour plus d'informations sur l'ajout, la mise à jour ou la suppression d'informations d'identification, reportez-vous à Configuration des informations d'identification Management Gateway.

Si les informations d'identification de la passerelle de gestion changent, tous les agents de gestion qui utilisent la passerelle de gestion doivent être modifiés pour utiliser les nouvelles informations d'identification. Pour plus d'informations, reportez-vous à Mise à jour des agents de gestion après les modifications de la configuration de Management Gateway.

Configurer les informations d'identification Management Gateway

Cette section explique comment gérer les informations d'identification qui peuvent être nécessaires pour une passerelle de gestion.

Une passerelle de gestion stocke des informations confidentielles, telles que des informations d'identification, dans des portefeuilles Oracle.

Après avoir installé une passerelle de gestion, vous devrez peut-être configurer des informations d'identification.

Remarque

Si des modifications ont été apportées à l'aide de commandes d'interface de ligne de commande, la passerelle doit être redémarrée. Pour plus d'informations sur les commandes d'interface de ligne de commande, reportez-vous à Référence de commande d'interface de ligne de commande d'Oracle Cloud Infrastructure.

Ajout ou mise à jour d'informations d'identification

Pour ajouter des informations d'identification ou en mettre à jour, utilisez le script gateway_credentials avec l'opération upsertCredentials.

  • Linux : le script gateway_credentials.sh se trouve dans le répertoire /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin.
  • Windows : le script gateway_credentials.bat se trouve dans le répertoire C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin.
  1. Créez un fichier texte avec le nom utilisateur et le mot de passe pour la passerelle :

    GatewayUsername=<USER_NAME>
    GatewayPassword=<USER_PASSWORD>

    Par exemple, vous pouvez enregistrer le fichier texte sous cred.properties.

  2. Ajoutez les informations d'identification à l'aide du fichier texte.

    • Pour Linux, utilisez :
      gateway_credentials.sh -o upsertCredentials

      Par exemple, vous pouvez exécuter la commande suivante sur Linux à l'aide du fichier cred.properties :

      cat cred.properties | sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o upsertCredentials
    • Sous Windows, utilisez :
      gateway_credentials.bat -o upsertCredentials
      Par exemple, vous pouvez exécuter la commande suivante sur Windows à l'aide du fichier cred.properties :
      type cred.properties | C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin\gateway_credentials.bat -o upsertCredentials
  3. Supprimez le fichier texte créé à l'étape 1.

    Le fichier texte contient des informations confidentielles. Les clients sont responsables de la suppression du fichier texte d'informations d'identification une fois l'ajout ou la mise à jour des informations d'identification terminé.

Suppression d'informations d'identification

Pour supprimer des informations d'identification, utilisez le script gateway_credentials avec l'opération deleteCredentials.

  • Linux :

    Le script gateway_credentials.sh se trouve dans le répertoire /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin.

    Syntaxe :
    gateway_credentials.sh -o deleteCredentials
    Exemple :
    sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o deleteCredentials
  • Windows :

    Le script gateway_credentials.bat se trouve dans le répertoire C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin.

    Syntaxe :
    gateway_credentials.bat -o deleteCredentials
    Exemple :
    C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config\bin\gateway_credentials.bat -o deleteCredentials
Remarque

La suppression des informations d'identification ne supprime pas le portefeuille qui les contient.

Mettre à jour les agents de gestion après les modifications apportées à la configuration de Management Gateway

Si la configuration d'une passerelle de gestion est modifiée, vous devez peut-être également modifier l'agent de gestion.

  • Hôte de passerelle : si vous déplacez la passerelle vers un autre hôte ou si vous renommez l'hôte de passerelle, vous devez modifier tous les agents employant la passerelle pour qu'ils utilisent le nouveau nom d'hôte.

    Dans ce cas, le paramètre d'agent de gestion GatewayServerHost doit être mis à jour pour utiliser la nouvelle passerelle.

  • Port de passerelle : si la valeur du port de passerelle change, tous les agents utilisant la passerelle doivent être modifiés pour utiliser la nouvelle valeur de port.

    Dans ce cas, le paramètre d'agent de gestion GatewayServerPort doit être mis à jour pour utiliser le nouveau port de passerelle.

  • Informations d'identification de passerelle : si les informations d'identification requises pour la connexion à la passerelle de gestion (par exemple, le nom utilisateur et le mot de passe) sont modifiées, tous les agents utilisant la passerelle doivent être modifiés pour utiliser les nouvelles informations d'identification. Pour plus d'informations, reportez-vous aux sections Credential Type for Management Gateways and Proxies et Add or Update Credentials.

Mettre à jour les informations d'identification de proxy pour Management Gateway

Vous pouvez mettre à jour les informations d'identification de proxy externes existantes pour la passerelle de gestion.

Prérequis :

La passerelle de gestion doit être configurée avec un proxy à l'aide des deux propriétés suivantes :
  • ProxyHost
  • ProxyPort
Par exemple :
ProxyHost=myproxy.example.com
ProxyPort=80

Etape 1 : Créer un corps de demande pour la mise à jour des informations d'identification de proxy

Indiquez le nouveau nom utilisateur et le nouveau mot de passe dans le fichier d'informations d'identification à l'aide des propriétés suivantes :

  • ProxyUser : nom utilisateur pour l'authentification auprès du proxy.
  • ProxyPassword : mot de passe de l'utilisateur pour l'authentification auprès du proxy.
Remarque

Les propriétés d'informations d'identification ci-dessus respectent la casse.

Consultez l'exemple de fichier d'informations d'identification sample-proxycreds.json ci-dessous :

{"source":"agent.%%agentId%%",
"name":"ManagementAgent-Proxy",
"type":"ProxyCreds",
"description":"Proxy Credentials",
"properties":[
{"name":"ProxyUser","value":"<UserName>"},
{"name":"ProxyPassword","value":"<Password>"}]}

Etape 2 : exécution de la commande pour mettre à jour les informations d'identification de proxy

Exécutez la commande ci-dessous pour mettre à jour les informations d'identification du proxy à l'aide de l'exemple de fichier ci-dessus :
  • Pour Linux :
    cat sample-proxycreds.json | sudo -u mgmt_agent /opt/oracle/mgmt_agent/agent_inst/bin/credential_mgmt.sh -o upsertCredentials -s Agent
  • Sous Windows :
    type sample-proxycreds.json | C:\oracle\mgmt_agent\agent_inst\bin\credential_mgmt.bat -o upsertCredentials -s Agent

Etape 3 : Redémarrage de la passerelle de gestion

  • Pour Linux :
    sudo systemctl restart mgmt_gateway
  • Sous Windows :
    net stop mgmt_gateway
    net start mgmt_gateway
Remarque

Les informations d'identification sont utilisées par la passerelle de gestion pour communiquer avec les services Oracle Cloud Infrastructure. La modification de leur format ou leur suppression peut avoir un effet indésirable sur la capacité de la passerelle de gestion à communiquer avec les services Oracle Cloud Infrastructure.

Activer le traitement par lots pour la passerelle de gestion

Après l'installation de la passerelle de gestion, vous pouvez activer le traitement par lots afin d'améliorer et d'accélérer la gestion des téléchargements de journalisation vers le service Log Analytics.

Pour activer le traitement par lots, ajoutez la propriété suivante dans le fichier gateway.properties :
BatchingEnabled=true

Après la mise à jour du fichier gateway.properties, le service de passerelle de gestion doit être redémarré. Pour le redémarrer, procédez comme suit :

  • Pour Oracle Linux 6, utilisez : /sbin/initctl restart mgmt_gateway
  • Pour Oracle Linux 7, utilisez : systemctl restart mgmt_gateway

Mise à niveau d'une passerelle de gestion

Mise à niveau d'une passerelle de gestion sous Linux

Pour mettre à niveau une passerelle sous Linux, procédez comme suit :
  • Téléchargez la dernière version du fichier RPM contenant le fichier de téléchargement du logiciel. Pour plus de détails, reportez-vous à Téléchargement du logiciel de passerelle de gestion.
  • Pour mettre à niveau la passerelle, exécutez la commande rpm avec l'option de mise à niveau rpm -U.
    sudo rpm -U <rpm_file_name.rpm>

Mise à niveau de la passerelle de gestion sous Linux à l'aide d'un fichier ZIP

Pour mettre à niveau une passerelle sous Linux à l'aide d'un fichier ZIP, procédez comme suit :

  • Pour plus de détails, reportez-vous à Téléchargement du logiciel de passerelle de gestion.
  • Accédez au répertoire dans lequel vous avez téléchargé le fichier ZIP du logiciel de passerelle de gestion et décompressez-le à l'emplacement de votre choix.
  • Pour mettre à niveau la passerelle, exécutez le script installer.sh avec l'option :-u
    installer.sh -u
  • Le résultat ressemble à ce qui suit :
    sudo ./installer.sh -u
    Checking pre-requisites
            Checking available disk space for gateway upgrade
            Checking agent version 
    
    Executing install
            Unpacking software zip
            Copying files to destination dir (/opt/oracle/mgmt_agent)
            Updating communication wallet 
            Creating 'mgmt_gateway' daemon
            Starting mgmt_gateway
            Gateway Install Logs: /opt/oracle/mgmt_agent/installer-logs/installer.log
    
    Gateway upgrade successful

Mise à niveau d'une passerelle de gestion sous Windows

Pour mettre à niveau une passerelle sous Windows, procédez comme suit :
  • Connectez-vous en tant qu'administrateur et ouvrez une invite de commande.
  • Téléchargez la dernière version du fichier ZIP contenant le fichier de téléchargement du logiciel d'agent. Pour plus de détails, reportez-vous à Téléchargement du logiciel de passerelle de gestion.
  • Accédez au répertoire dans lequel vous avez téléchargé le fichier ZIP du logiciel d'agent de gestion et décompressez-le à l'emplacement de votre choix.
  • Pour mettre à niveau la passerelle, exécutez le script installer.bat avec l'option -u :
    installer.bat -u

    Par exemple : C:\Users\test_agent>installer.bat -u

    Le résultat se présente comme suit :
    JAVA_HOME found at: C:\Program Files\Java\jdk1.8.0_321
    Executing upgrade
            Unpacking software zip
            Copying files to destination dir (C:\Oracle\mgmt_agent)
            Updating communication wallet       
            Creating mgmt_gateway service
    
    Management Gateway upgrade successful
    The Oracle Management Gateway service is starting....
    The Oracle Management Gateway service was started successfully.

Suppression d'une passerelle de gestion

Lors de la suppression d'une passerelle de gestion d'un hôte, celle-ci n'est pas inscrite auprès des agents de gestion Cloud Service avant d'être enlevée de l'hôte.

Pour supprimer ou désinstaller la passerelle de gestion des systèmes d'exploitation suivants, procédez comme suit :

Suppression de la passerelle de gestion sous Linux à l'aide de la commande RPM

Exécutez la commande rpm suivante avec l'option -e :
sudo rpm -e <rpm_name>

Suppression de la passerelle de gestion sous Linux à l'aide d'un script de désinstallation

Exécutez le script uninstaller.sh si vous avez installé la passerelle de gestion à l'aide des fichiers ZIP.

Le résultat se présente comme suit :

$ sudo bash /opt/oracle/mgmt_agent/agent_inst/bin/uninstaller.sh
Executing pre-remove step from uninstall
Attempting to remove the Gateway from Management Agent Cloud service, please do not interrupt...
Attempting to remove the Gateway from Management Agent Cloud service,please do not interrupt...
Gateway was removed from Management Agent Cloud service successfully.
Detected Oracle Linux Server (Red Hat family):
Stopping mgmt_gateway...
Removing mgmt_gateway daemon from systemd...
Removed symlink /etc/systemd/system/multi-user.target.wants/mgmt_gateway.service.
Gateway was removed from the host successfully.
Executing post-remove step from uninstall
Gateway state directory was removed from the host successfully.
Remarque

Si vous avez installé la passerelle de gestion à l'aide d'un volume externe sous Linux, le script de désinstallation de la passerelle de gestion enlève toutes les données du répertoire /opt/oracle/mgmt_agent et, sur certains systèmes d'exploitation, enlève également le répertoire cible vers lequel pointe le lien symbolique.

Enlever la passerelle de gestion sous Windows

Ouvrez une fenêtre d'invite de commande, accédez au répertoire de base de l'installation de la passerelle de gestion et exécutez le script uninstaller.bat.

Le résultat se présente comme suit :
C:\Oracle>mgmt_agent\uninstaller.bat
Removing Management Gateway from the OCI service console.
Attempting to remove the agent from Management Agent Cloud service, do not interrupt...
Gateway was removed from the Management Agent Cloud service successfully.
Removing Management Gateway service from the host 
Management Gateway service was removed from the host successfully
Removing Management Gateway directories

Assurez-vous que toutes les autres fenêtres d'invite de commande sont fermées ou qu'elles ne pointent pas vers le répertoire de base de la passerelle de gestion avant d'exécuter le script uninstaller.bat.

Configurer la passerelle de gestion à l'aide de certificats personnalisés

Pour configurer la passerelle de gestion, vous pouvez importer des certificats personnalisés vers OCI Certificate Service dans la console Oracle Cloud. Pour plus d'informations, reportez-vous à Importing a Certificate.
  1. Dans la console Oracle Cloud, ouvrez le menu de navigation et sélectionnez Identité et sécurité.
  2. Accédez à Certificats et sélectionnez Certificats.
  3. Cliquez sur Créer un certificat.
  4. Sélectionnez le compartiment dans lequel importer le certificat, qui doit correspondre au compartiment dans lequel la passerelle de gestion est installée.
  5. Pour importer un certificat que vous prévoyez de gérer à l'aide d'une autorité de certification, cliquez sur Importé en tant que type de certificat.
  6. Entrez un nom d'affichage unique pour le certificat. Evitez de saisir des informations confidentielles.
  7. Vous pouvez éventuellement entrer une description pour le certificat.
  8. Vous devez entrer une clé privée et le certificat de chaîne.

    Le certificat est prêt à être utilisé lorsque le statut du certificat est Actif dans la console Oracle Cloud.

  9. Ensuite, vous devez copier l'OCID de certificat, puis entrer l'OCID en tant que paramètre dans le fichier de réponses de la passerelle de gestion lors de l'installation de la passerelle de gestion au format suivant. Reportez-vous à Configuration d'un fichier de réponses pour la passerelle de gestion.
    GatewayCertOcid=ocid1.certificate.oc1.iad.<unique-id>
  10. Pour importer les mêmes certificats dans l'agent de gestion, procédez comme suit afin que l'interaction de bout en bout fonctionne.

Utilisation d'un utilisateur de système d'exploitation autre que celui par défaut pour installer la passerelle de gestion

Oracle recommande d'effectuer l'installation de la passerelle de gestion à l'aide de l'utilisateur de système d'exploitation par défaut : mgmt_agent, mais selon vos besoins, vous devrez peut-être effectuer l'installation à l'aide d'un autre utilisateur de système d'exploitation.

Cette section explique comment installer la passerelle de gestion à l'aide d'un utilisateur différent de mgmt_agent, l'utilisateur de système d'exploitation par défaut.

Prérequis

Remarque

Lorsque vous choisissez un utilisateur de système d'exploitation autre que mgmt_agent pour effectuer l'installation de la passerelle de gestion sur des systèmes Linux ou Unix, les considérations suivantes doivent être prises en compte :

  • Sélectionnez un utilisateur du système d'exploitation disposant de privilèges limités.

    L'utilisateur par défaut de l'O/S mgmt_agent est un utilisateur de l'O/S disposant du moindre privilège sans shell de connexion. Si vous décidez plutôt de sélectionner un autre utilisateur du système d'exploitation, assurez-vous que l'utilisateur choisi dispose de privilèges limités.

  • La passerelle de gestion est une application multithread et chaque thread (LWP) compte pour la limite d'utilisateurs du système d'exploitation. Assurez-vous que la limite d'utilisateurs (ulimit) pour max user processes est définie en conséquence en vérifiant :
    ulimit -u

    Le choix d'une limite inadéquate peut entraîner l'instabilité de la passerelle de gestion et des applications exécutées en tant qu'utilisateur du système d'exploitation sélectionné.

  1. Identifiez un utilisateur de système d'exploitation valide pour effectuer l'installation de la passerelle de gestion et utilisez-le comme valeur pour la variable RUN_AGENT_AS_USER.
    Oracle recommande que l'utilisateur du système d'exploitation sélectionné dispose des privilèges les plus faibles et ne dispose d'aucun shell de connexion.
    id -un <username>

    Exemple 1 :

    id -un myexistinguser
    L'utilisateur du système d'exploitation myexistinguser existe. La sortie renvoie la valeur de l'utilisateur sélectionné et ressemble à ce qui suit :
    myexistinguser
    Exemple 2 :
    id -un mytestuser2
    L'utilisateur du système d'exploitation mytestuser2 n'existe pas et n'est pas valide. La sortie ne renvoie aucune valeur utilisateur et ressemble à ce qui suit :
    id: mytestuser2: no such user
  2. Identifiez le groupe principal de l'utilisateur à utiliser comme valeur pour la variable AGENT_USER_GROUP.
    Assurez-vous que la valeur de AGENT_USER_GROUP est le groupe d'utilisateurs principal de l'utilisateur de système d'exploitation sélectionné.
    Remarque

    L'utilisation d'un groupe secondaire n'est pas prise en charge et peut entraîner une altération de la passerelle de gestion.
    id -gn <username>
    Exemple :
    id -gn myexistinguser
    Le résultat se présente comme suit :
    staff

Définition des variables d'environnement et installation de la passerelle de gestion

  1. Configurez les variables d'environnement suivantes :
    RUN_AGENT_AS_USER=<selected_OS_user_for_ManagementGateway_installation>
    AGENT_USER_GROUP=<OS_primary_group_of_selected_OS_user>
    Exemple :
    RUN_AGENT_AS_USER=myexistinguser
    AGENT_USER_GROUP=staff
  2. Assurez-vous que la variable d'environnement ci-dessus est accessible par l'utilisateur du système d'exploitation root.

    Par défaut, les variables d'environnement ne sont pas partagées avec l'utilisateur root.

  3. Vérifiez que les variables d'environnement sont correctement définies en exécutant la commande suivante :
    sudo su
    echo $RUN_AGENT_AS_USER
    echo $AGENT_USER_GROUP
    Par exemple, la sortie ressemble à ce qui suit :
    myexistinguser
    staff
    Si root ne parvient pas à accéder aux variables d'environnement, modifiez le fichier /etc/sudoers et ajoutez les éléments suivants :
    Defaults env_keep+=RUN_AGENT_AS_USER
    Defaults env_keep+=AGENT_USER_GROUP

    Ce qui précède garantit que les variables d'environnement RUN_AGENT_AS_USER et AGENT_USER_GROUP sont conservées et accessibles par l'utilisateur root.

    Après avoir mis à jour le fichier /etc/sudoers, définissez à nouveau les variables d'environnement et vérifiez que root peut accéder aux variables d'environnement.

  4. Une fois la vérification terminée, vous pouvez démarrer l'installation de la passerelle de gestion : connectez-vous en tant que root, définissez les variables d'environnement, puis démarrez l'installation de la passerelle de gestion.

    En fonction de votre méthode préférée, vous pouvez suivre les instructions de Installation de la passerelle de gestion sur le fichier RPM Linux ou de Installation de la passerelle de gestion sur le fichier ZIP Linux.

    Par exemple, suivez les instructions de la section Install Management Gateway on Linux RPM file. Dans ce cas, ignorez l'étape 1 car vous êtes déjà root et vous n'avez pas besoin des privilèges sudo. Commencez à l'étape 2 : rpm -ivh <rpm_file_name.rpm>