Utilitaires OCI

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

Installation des utilitaires OCI

Pour les instances lancées avec Oracle Linux 7 ou une versions ultérieure, le package d'utilitaires Oracle Cloud Infrastructure (OCI) (oci-utils) est automatiquement installé. Les utilitaires ne sont pas disponibles sur d'autres distributions.

Pour utiliser les utilitaires OCI, vous devez satisfaire aux prérequis 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. Il contient toutes les dépendances d'un package, y compris les packages OCI SDK et Python requis. Tous les packages requis sont installés avec le package oci-utils.
  • Assurez-vous que les utilitaires OCI disposent de droits d'accès suffisants pour accéder à Oracle Cloud Infrastructure en effectuant l'une des opérations suivantes :
    • Créez le fichier de configuration du kit SDK pour l'hôte. Pour plus d'informations, reportez-vous à Fichier de configuration du kit SDK et de l'interface de ligne de commande.
      Remarque

      Vous devrez peut-être installer l'interface de ligne de commande pour votre environnement avant d'exécuter la commande oci setup config pour créer le fichier de configuration du kit SDK. Pour plus d'informations, reportez-vous à Installation de la CLI.
    • Utilisez des principaux d'instance en ajoutant l'instance à un groupe dynamique disposant d'un accès aux services Oracle Cloud Infrastructure. Pour plus d'informations, reportez-vous à Gestion des groupes dynamiques.
    • Configurez oci-utils de sorte à permettre à l'utilisateur root de se servir des fichiers de configuration Oracle Cloud Infrastructure d'un utilisateur sans privilège. Pour plus d'informations, consultez 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 effectuez les procédures de configuration nécessaires pour cette méthode :
    • Interface de ligne de commande OCI à partir d'une instance ou d'un hôte distant : terminal d'interface de ligne de commande connecté à une instance ou à un hôte distant sur lequel vous pouvez exécuter les utilitaires OCI. Pour plus d'informations sur l'interface de ligne de commande et sur la prise en main, reportez-vous aux sections Command Line Interface (CLI) et CLI Quickstart.
    • Kit de développement logiciel OCI : ensemble d'outils de développement qui vous permettent d'écrire du code et de gérer les ressources OCI. Pour plus d'informations, reportez-vous à Kits SDK et interface de ligne de commande.

Pour voir une vidéo portant sur l'installation et la configuration des utilitaires OCI, reportez-vous à Activation des utilitaires OCI dans Oracle Linux sur les instances Oracle Cloud Infrastructure dans le centre de formation Oracle Linux.

Mise à jour des utilitaires OCI

Pour effectuer la mise à jour vers la dernière version de oci-utils, utilisez la commande suivante :

sudo yum update oci-utils

Utilisation du démon ocid

Le démon ocid est le composant de service de oci-utils. Il surveille les modifications apportées à la configuration iSCSI et d'interface réseau virtuelle de l'instance, et essaye d'attacher ou de détacher automatiquement les périphériques lorsqu'ils apparaissent ou disparaissent. Par exemple, lorsqu'ils sont créés ou supprimés à l'aide de la console Oracle Cloud Infrastructure, de la CLI ou de l'API.

Pour démarrer le démon ocid à l'aide de systemd et définir le service ocid de sorte qu'il démarre automatiquement lors de l'initialisation du système, utilisez la commande suivante :

sudo systemctl enable --now ocid.service

Pour vérifier que le service est actif (en cours d'exécution), utilisez la commande suivante :

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.
        

Récapitulatif des utilitaires OCI

Récapitulatif 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 recherche les modifications apportées aux configurations de périphérique iSCSI et de carte d'interface réseau virtuelle, et met en 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 fichier racine de l'instance jusqu'à sa taille configurée.
oci-image-expand Convertit l'instance Oracle Linux Minimal pour ajouter des services et des packages d'une image de plate-forme Oracle Linux standard.
oci-instanceid Affiche l'OCID de l'instance.
oci-iscsi-config Répertorie ou configure les périphériques iSCSI attachés à une instance de calcul. Si aucune option de ligne de commande n'est indiquée, répertorie les périphériques nécessitant une attention particulière.
oci-metadata Affiche les métadonnées de l'instance de calcul. Si aucune option de ligne de commande n'est indiquée, répertorie toutes les métadonnées disponibles. Les métadonnées comprennent l'OCID, le nom d'affichage, le compartiment, la forme, la région, le domaine de disponibilité, la date de création, l'état et l'image de l'instance, ainsi que toutes les métadonnées personnalisées que vous fournissez, telles qu'une clé publique SSH.
oci-network-config Répertorie ou configure les cartes d'interface réseau virtuelles attachées à l'instance de calcul. Lorsqu'une carte d'interface réseau virtuelle secondaire est provisionnée dans le cloud, elle doit être explicitement configurée sur l'instance à l'aide de ce script ou de commandes similaires.
oci-network-inspector Affiche un rapport détaillé pour un compartiment ou un réseau indiqué.
oci-notify Envoie un message à un sujet du service Notifications.
oci-public-ip Affiche l'adresse IP publique du système en cours dans un format lisible par l'utilisateur ou au format JSON.
oci-volume-data Affiche les données relatives à un volume iSCSI spécifique attaché à l'instance.

Options courantes 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 façon dont une tâche de l'utilitaire est exécutée.

Le tableau suivant répertorie les options et 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 afficher l'aide de l'utilitaire oci-metadata, procédez comme suit :
$ 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 le mode d'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 au format analysable.
  • table : affiche la sortie dans une table.
  • text : affiche la sortie textuelle.

--no-truncate

Ne raccourcit pas les valeurs de 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.

Remarque

Vous pouvez également afficher les pages de manuel de chaque utilitaire OCI en saisissant man oci-utility sur la ligne de commande. Par exemple, pour afficher les pages manuelles intégrées pour l'utilitaire oci-metadata, procédez comme suit :
man oci-metadata