Utilitaires OCI

Les instances qui utilisent des images de plate-forme Oracle Linux incluent un jeu d'utilitaires (oci-utils) qui permettent à l'instance d'accéder aux informations sur les ressources d'infrastructure. Ces utilitaires comportent un composant de service et des outils de ligne de commande qui permettent de détecter ou de provisionner automatiquement des ressources.

Installation des utilitaires OCI

Les instances lancées avec Oracle Linux 7 ou une autre version comprennent automatiquement l'ensemble d'utilitaires Oracle Cloud Infrastructure (OCI) (oci-utils). Les utilitaires ne sont pas disponibles sur d'autres distributions.

Pour utiliser les utilitaires OCI, vous devez respecter les préalables suivants :

  • Assurez-vous que le référentiel oci_included est activé. Ce référentiel est activé par défaut dans les images de plate-forme Oracle Linux. Ce référentiel contient toutes les dépendances d'ensemble, y compris les ensembles SDK pour OCI et Python requis. Tous les ensembles requis sont installés avec l'ensemble oci-utils.
  • Assurez-vous que les utilitaires OCI disposent des autorisations suffisantes pour accéder à Oracle Cloud Infrastructure en effectuant l'une des opérations suivantes :
    • Créez le fichier de configuration de la trousse SDK pour l'hôte. Pour plus d'informations, voir Fichier de configuration des trousses SDK et de l'interface de ligne de commande.
      Note

      Vous devrez peut-être installer l'interface de ligne de commande de votre environnement avant d'exécuter la commande oci setup config pour créer le fichier de configuration de la trousse SDK. Pour plus d'informations, voir Installation de l'interface de ligne de commande.
    • Utilisez les principaux d'instance en ajoutant l'instance à un groupe dynamique autorisé à accéder aux services Oracle Cloud Infrastructure. Pour plus d'informations, voir Gestion des groupes dynamiques.
    • Configurez oci-utils pour permettre à l'utilisateur racine d'utiliser les fichiers de configuration Oracle Cloud Infrastructure d'un utilisateur sans privilèges. Pour plus d'informations, voir le fichier de configuration situé dans le répertoire /etc/oci-utils.conf.d de l'instance.
  • Choisissez la méthode d'accès aux utilitaires et exécutez les procédures de configuration nécessaires pour cette méthode :

Pour une vidéo expliquant comment installer et configurer les utilitaires OCI, voir Activation des utilitaires OCI dans Oracle Linux sur des instances Oracle Cloud Infrastructure dans le parcours d'apprentissage pour Oracle Linux.

Mise à jour des utilitaires OCI

Pour effectuer la mise à jour vers la dernière version d'oci-utils :

sudo yum update oci-utils

Utilisation du démon ocid

Le démon ocid est le composant de service d'oci-utils. Il surveille les modifications apportées à la carte VNIC et à la configuration iSCSI de l'instance et tente d'attacher ou de détacher automatiquement les appareils à mesure qu'ils apparaissent ou disparaissent; par exemple, lorsqu'ils sont créés ou supprimés à l'aide de la console Oracle Cloud Infrastructure, de l'interface de ligne de commande ou de l'API.

Pour démarrer le démon ocid à l'aide de systemd et définir le service ocid pour qu'il démarre automatiquement lors du démarrage du système :

sudo systemctl enable --now ocid.service

Pour vérifier que le service est actif (en cours d'exécution) :

sudo service ocid status

Par exemple :

$ sudo service ocid status
Redirecting to /bin/systemctl status ocid.service
  ocid.service - Oracle Cloud Infrastructure utilities daemon
   Loaded: loaded (/etc/systemd/system/ocid.service; enabled; vendor preset: enabled)
   Active: active (running) since Thu 2021-02-04 18:01:25 GMT; 1min 42s ago
 Main PID: 16630 (python3)
   CGroup: /system.slice/ocid.service
           └─16630 /usr/bin/python3 /usr/lib/python3.6/site-packages/oci_util...

Feb 04 18:01:23 mor-demoinst-10 systemd[1]: Starting Oracle Cloud Infrastruc....
Feb 04 18:01:24 mor-demoinst-10 sudo[16705]:     root : TTY=unknown ; PWD=/ ...w
Feb 04 18:01:25 mor-demoinst-10 systemd[1]: Started Oracle Cloud Infrastruct....
Hint: Some lines were ellipsized, use -l to show in full.
        

Sommaire des utilitaires OCI

Sommaire des composants des utilitaires OCI.

Nom Description
ocid Composant de service de oci-utils, exécuté en tant que démon démarré par systemd. Ce service effectue un balayage pour rechercher les modifications apportées aux configurations des périphériques iSCSI et vNIC et met en mémoire cache les métadonnées OCI et l'adresse IP publique de l'instance.
oci-compartmentid Affiche l'identificateur Oracle Cloud (OCID) du compartiment dans lequel l'instance est exécutée.
oci-growfs Développe le système de fichiers racine de l'instance à sa taille configurée.
oci-image-expand Convertit l'instance Oracle Linux Minimal en services et ensembles d'une image de plate-forme Oracle Linux standard.
oci-instanceid Affiche l'OCID de l'instance.
oci-iscsi-config Liste ou configure les périphériques iSCSI attachés à une instance de calcul. Si aucune option de ligne de commande n'est spécifiée, indique les périphériques qui nécessitent votre attention.
oci-metadata Affiche les métadonnées pour l'instance de calcul. Si aucune option de ligne de commande n'est spécifiée, indique toutes les métadonnées disponibles. Les métadonnées incluent l'OCID de l'instance, le nom d'affichage, le compartiment, la forme, la région, le domaine de disponibilité, la date de création, l'état, l'image et toutes les métadonnées personnalisées que vous fournissez, par exemple une clé publique SSH.
oci-network-config Liste ou configure les cartes d'interface réseau virtuelles (vNIC) attachées à l'instance de calcul. Lorsqu'une carte vNIC secondaire est provisionnée dans le nuage, elle doit être configurée explicitement dans l'instance à l'aide de ce script ou de commandes similaires.
oci-network-inspector Affiche un rapport détaillé sur un compartiment ou un réseau indiqué.
oci-notify Envoie un message à un sujet du service d'avis.
oci-public-ip Affiche l'adresse IP publique du système courant dans un format lisible par l'utilisateur ou au format JSON.
oci-volume-data Affiche les données sur un volume iSCSI spécifique attaché à l'instance.

Options communes de l'utilitaire OCI

De nombreux utilitaires Oracle Cloud Infrastructure (OCI) ont les mêmes options ou arguments disponibles lorsque les utilitaires sont exécutés à partir de la ligne de commande. Ces options et arguments permettent de définir plus précisément le type d'informations produites par l'utilitaire ou la manière dont une tâche d'utilitaire est exécutée.

Le tableau suivant répertorie les options, ainsi que leurs valeurs prises en charge, communes aux utilitaires OCI.

Option Description
--help Affiche des informations d'aide sur l'utilitaire, telles que l'utilisation de l'utilitaire, les options disponibles et les valeurs prises en charge pour chaque option. Par exemple, pour voir l'aide de l'utilitaire oci-metadata :
$ sudo oci-metadata --help

usage: oci-metadata [-h] [-j] [-g KEY] [--value-only] [--export] [--trim]
                    [-u KEY=VALUE  [KEY=VALUE  ...]] [-i OCID] [--help]

Utility for displaying metadata for an instance running in the Oracle Cloud
Infrastructure.

optional arguments:
  -h, --human-readable  Display human readable output (default)
  -j, --json            Display json output
  ...
  --help                Display this help

--all

Affiche tous les éléments, ou valeurs, dans la sortie.

--details

Affiche des informations détaillées dans la sortie.

--output-mode

Permet de définir l'affichage de la sortie de l'utilitaire. Les modes d'utilitaire OCI disponibles sont les suivants :

  • json : Affiche la sortie au format JSON.
  • human-readable : Affiche la sortie dans un format lisible par l'utilisateur.
  • parsable : Affiche la sortie dans un format analysable.
  • table : Affiche la sortie dans une table.
  • text : Affiche la sortie textuelle.

--no-truncate

Ne raccourcit pas les valeurs dans la sortie affichée.

--truncate

Raccourcit les valeurs dans la sortie affichée.

-y| --yes

Réponses "Oui" à toutes les invites.

-n | --no

Réponses "non" à toutes les invites.

-q | --quiet

Supprime les messages d'information.

Note

Vous pouvez également voir les pages de manuel de chaque utilitaire OCI en entrant man oci-utility à la ligne de commande. Par exemple, pour afficher les pages manuelles intégrées pour l'utilitaire oci-metadata :
man oci-metadata