Tâches d'administration de la passerelle de gestion

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

Port de la passerelle de gestion

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 de la passerelle de gestion, modifiez le fichier gateway.properties et remplacez la valeur courante de la propriété GatewayPort par le numéro de port souhaité.

Après la modification du fichier gateway.properties, le service de passerelle de gestion doit être redémarré.
  • Pour Oracle Linux 6, utilisez : /sbin/initctl restart mgmt_gateway

  • Pour Oracle Linux 7, utilisez : systemctl restart mgmt_gateway

  • Pour Windows :
    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, voir Mettre à jour les agents de gestion après les modifications apportées à la configuration de la passerelle de gestion

Données d'identification de la passerelle de gestion

La passerelle est généralement configurée pour utiliser les données d'identification : le nom d'utilisateur et le mot de passe sont requis pour s'y connecter.

Ces informations d'identification sont stockées dans les portefeuilles Oracle. Pour plus d'informations sur l'ajout, la mise à jour ou la suppression de données d'identification, voir Configurer les données d'identification de la passerelle de gestion.

Si les données 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 données d'identification. Pour plus d'informations, voir Mettre à jour les agents de gestion après les modifications apportées à la configuration de la passerelle de gestion.

Configurer les données d'identification de la passerelle de gestion

Cette section décrit comment gérer les données d'identification qui peuvent être nécessaires pour la passerelle de gestion.

La passerelle de gestion stocke les informations sensibles, telles que les données d'identification, dans des portefeuilles Oracle.

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

Note

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

Ajouter ou mettre à jour des données d'identification

Pour ajouter des données d'identification ou mettre à jour des données d'identification existantes, 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 d'utilisateur et le mot de passe pour la passerelle :

    GatewayUsername=<USER_NAME>
    GatewayPassword=<USER_PASSWORD>

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

  2. Ajoutez des données d'identification à l'aide d'un fichier texte.

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

      Par exemple, vous pouvez exécuter la commande suivante sous 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
    • Pour Windows :
      gateway_credentials.bat -o upsertCredentials
      Par exemple, vous pouvez exécuter ceci 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 sensibles. Les clients sont responsables de la suppression du fichier texte de données d'identification une fois l'opération d'ajout ou de mise à jour des données d'identification terminée.

Supprimer des données d'identification

Pour supprimer des données 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
Note

La suppression des données 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 la passerelle de gestion

Si la configuration de la passerelle de gestion est modifiée, il est possible que l'agent de gestion doive également être modifié.

  • Hôte de passerelle : Si la passerelle est déplacée vers un autre hôte ou si l'hôte de la passerelle est renommé, tous les agents qui utilisent la passerelle doivent être modifiés pour utiliser le nouveau nom d'hôte.

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

  • Port de la passerelle : Si la valeur du port de la passerelle est modifiée, tous les agents qui l'utilisent doivent être modifiés pour utiliser la nouvelle valeur de port.

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

  • Données d'identification de la passerelle : Si les données d'identification requises pour se connecter à la passerelle de gestion (telles que le nom d'utilisateur et le mot de passe) sont modifiées, tout agent utilisant la passerelle doit être modifié pour utiliser les nouvelles données d'identification. Pour plus d'informations, voir Type de données d'identification pour les passerelles et mandataires de gestion et Ajouter ou mettre à jour des données d'identification.

Mettre à jour les données d'identification du mandataire pour la passerelle de gestion

Vous pouvez mettre à jour les données d'identification de mandataire externe existantes pour la passerelle de gestion.

Préalables :

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

Étape 1 : Créer le corps de la demande pour mettre à jour les données d'identification du mandataire

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

  • ProxyUser : Nom d'utilisateur pour l'authentification auprès du mandataire.
  • ProxyPassword : Mot de passe de l'utilisateur pour l'authentification auprès du mandataire.
Note

Les propriétés de données d'identification ci-dessus sont sensibles à la casse.

Voir ci-dessous l'exemple de fichier de données d'identification sample-proxycreds.json :

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

Étape 2 : Exécuter la commande pour mettre à jour les données d'identification de mandataire

Exécutez la commande ci-dessous pour mettre à jour les données d'identification de mandataire à 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
  • Pour Windows :
    type sample-proxycreds.json | C:\oracle\mgmt_agent\agent_inst\bin\credential_mgmt.bat -o upsertCredentials -s Agent

Étape 3 : Redémarrer la passerelle de gestion

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

Les données 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 peuvent empêcher la passerelle de gestion de communiquer de nouveau 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 pour assurer une meilleure gestion des chargements de journalisation dans 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, exécutez les opérations suivantes :

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

Mettre à niveau la passerelle de gestion

Mettre à niveau la passerelle de gestion sous Linux

Pour mettre à niveau une passerelle sous Linux, procédez de la façon suivante :
  • Téléchargez la dernière version du fichier RPM contenant le fichier de téléchargement du logiciel. Pour plus de détails, voir Télécharger le logiciel de la 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>

Mettre à niveau 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 de la façon suivante :

  • Télécharger la dernière version du fichier ZIP contenant le fichier de téléchargement du logiciel de la passerelle. Pour plus de détails, voir Télécharger le logiciel de la passerelle de gestion
  • Accédez au répertoire dans lequel vous avez téléchargé le fichier ZIP du logiciel de la passerelle de gestion et décompressez celui-ci dans l'emplacement privilégié de votre choix.
  • Pour mettre à niveau la passerelle, exécutez le script installer.sh avec l'option :-u
    installer.sh -u
  • La sortie ressemble à la suivante :
    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

Mettre à niveau la passerelle de gestion sous Windows

Pour mettre à niveau une passerelle Windows :
  • Connectez-vous en tant qu'administrateur et ouvrez une fenêtre d'invite de commande.
  • Téléchargez la dernière version du fichier zip contenant le fichier de téléchargement du logiciel de l'agent. Pour plus de détails, voir Télécharger le logiciel de la passerelle de gestion.
  • Accédez au répertoire dans lequel vous avez téléchargé le fichier zip du logiciel de l'agent de gestion et décompressez celui-ci dans l'emplacement privilégié 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

    La sortie ressemble à la suivante :
    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.

Supprimer la passerelle de gestion

Lors de la suppression d'une passerelle de gestion d'un hôte, celle-ci n'est pas enregistrée dans le service Cloud Service des agents de gestion avant d'être supprimée de l'hôte.

Pour supprimer ou désinstaller la passerelle de gestion des systèmes d'exploitation suivants, vous pouvez suivre les étapes suivantes :

Supprimer 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>

Supprimer 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.

La sortie ressemble à la suivante :

$ 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.
Note

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 supprime toutes les données du répertoire /opt/oracle/mgmt_agent et, sur certains systèmes d'exploitation, supprime également le répertoire cible vers lequel pointe le lien symbolique.

Supprimer la passerelle de gestion sous Windows

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

La sortie ressemble à la suivante :
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 dans le service de certificats OCI dans la console Oracle Cloud. Pour plus d'informations, voir Importation d'un certificat.
  1. Dans la console Oracle Cloud, ouvrez le menu de navigation et sélectionnez Identité et sécurité.
  2. Allez à Certificats et sélectionnez Certificats.
  3. Cliquez sur Créer un certificat.
  4. Sélectionnez le compartiment dans lequel vous voulez importer le certificat. Il doit s'agir du 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. Évitez d'entrer des informations confidentielles.
  7. Facultativement, vous pouvez 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 son statut est Actif dans la console Oracle Cloud.

  9. Ensuite, vous devez copier l'OCID du 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 à l'aide du format suivant, voir Configurer un fichier de réponses pour la passerelle de gestion.
    GatewayCertOcid=ocid1.certificate.oc1.iad.<unique-id>
  10. Effectuez les étapes suivantes pour importer les mêmes certificats dans l'agent de gestion afin que l'interaction de bout en bout fonctionne.

Utiliser un utilisateur de système d'exploitation non 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 décrit 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éalables

Note

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

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

    L'utilisateur de système d'exploitation mgmt_agent par défaut est un utilisateur de système d'exploitation à privilèges minimaux sans interpréteur de commandes de connexion. Si vous décidez de sélectionner un autre utilisateur du système d'exploitation, assurez-vous que l'utilisateur sélectionné dispose de privilèges limités.

  • La passerelle de gestion est une application multifil et chaque unité d'exécution compte pour la limite d'utilisateurs du système d'exploitation. Assurez-vous que la limite d'utilisateur (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 s'exécutant en tant qu'utilisateur de 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-la comme valeur pour la variable RUN_AGENT_AS_USER.
    Oracle recommande à l'utilisateur du système d'exploitation sélectionné d'avoir le moins de privilèges et aucun interpréteur de commandes de connexion.
    id -un <username>

    Exemple 1 :

    id -un myexistinguser
    L'utilisateur de système d'exploitation myexistinguser existe. La sortie retourne la valeur de l'utilisateur sélectionné et ressemble à ce qui suit :
    myexistinguser
    Exemple 2 :
    id -un mytestuser2
    L'utilisateur de système d'exploitation mytestuser2 n'existe pas et n'est pas un utilisateur valide. La sortie ne retourne 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é.
    Note

    L'utilisation d'un groupe secondaire n'est pas prise en charge et peut entraîner une corruption de la passerelle de gestion.
    id -gn <username>
    Exemple :
    id -gn myexistinguser
    La sortie ressemble à la suivante :
    staff

Définir les variables d'environnement et installer la passerelle de gestion

  1. Définissez 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 définies correctement en exécutant les opérations suivantes :
    sudo su
    echo $RUN_AGENT_AS_USER
    echo $AGENT_USER_GROUP
    Par exemple, la sortie ressemble à ce qui suit :
    myexistinguser
    staff
    Si root ne peut 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, réglez de 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.

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

    Par exemple, suivez les instructions sous Installer la passerelle de gestion sur le fichier RPM Linux. Dans ce cas, ignorez l'étape 1 car vous êtes déjà root et vous n'avez pas besoin de privilèges sudo. Commencez à l'étape 2 : rpm -ivh <rpm_file_name.rpm>