Utilisation de l'interface de ligne de commande avec un appareil d'infrastructure en périphérie de réseau Rover

La version minimale de l'interface de ligne de commande requise pour le service d'infrastructure en périphérie de réseau Rover est 2.12.1.

Accédez à l'URL suivante pour voir la version actuellement disponible de l'interface de ligne de commande :

https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst

Entrez la commande suivante à l'invite pour voir la version de l'interface de ligne de commande actuellement installée sur votre machine :

oci --version

Si la version installée sur votre machine est plus ancienne que la version actuellement disponible, installez la dernière version.

Ouvrez votre fichier /etc/hosts et ajoutez une entrée ip_address host_name pour votre RED.

Où ip_address est l'adresse IP du périphérique de l'infrastructure en périphérie de réseau Rover et host_name est le nom de l'hôte de l'infrastructure en périphérie de réseau Rover sur lequel vous exécutez l'interface de ligne de commande.

Par exemple :

10.0.1.8 rover.mycompany.com

Accédez au nom d'hôte en exécutant les commandes suivantes :

• Téléchargez le certificat redroot.pem :

  echo -n | openssl s_client -showcerts -connect ip_address:8015 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > redroot.pem

• Affichez ensuite les noms d'hôte DNS :

  openssl x509 -in redroot.pem -text -noout | grep DNS

Dans le retour de la commande, les éléments suivants apparaissent :

• DNS:*.certcommonname.com : Indique un certificat générique. Préfixez le certificat avec le sous-domaine de votre choix "ex : rover" et ouvrez votre fichier /etc/hosts et ajoutez une ligne avec les éléments suivants :

  10.145.140.5 rover.certcommonname.com

• DNS:rover-install-red-1, DNS:…, : Sélectionnez une des sorties DNS et ajoutez la ligne suivante au fichier /etc/hosts :

  10.145.140.5 rover-install-red-1

Ouvrez votre fichier /etc/hosts et ajoutez une ligne avec les éléments suivants :

10.145.140.5 rover.mycompany.com otec-console-local rover-install-red-1

Si la valeur de paramètre obligatoire est indiquée en tant que variable, par exemple name, vous devez fournir une valeur. Entrez la commande telle qu'elle apparaît dans la documentation.

L'inclusion de [OPTIONS] dans la syntaxe de commande indique des paramètres facultatifs. Accédez à l'aide en ligne de l'interface de ligne de commande pour obtenir une liste de paramètres facultatifs et leur syntaxe.

L'installation et la configuration d'une interface de ligne de commande sont décrites en détail dans la rubrique Interface de ligne de commande de la documentation sur Oracle Cloud Infrastructure.

Avant de configurer le fichier de configuration, vous devez collecter les informations suivantes :

• OCID de la location du service d'infrastructure en périphérie de réseau Rover. Obtenez l'OCID de la location à l'aide de la commande suivante :

  curl -k https://ip_address:12060/v1/tenants/orei

  où ip_address est l'adresse IP de l'appareil du service d'infrastructure en périphérie de réseau Rover. L'OCID de la location est contenu dans le retour, par exemple :

  {
    "id" : "ocid1.tenancy.orei..uniqueID",
    "name" : "orei"
  }

  Vous pouvez également entrer l'URL suivante dans le navigateur Web de la console de l'appareil :

  https://ip_address:12060/v1/tenants/orei

  L'OCID de la location est retourné dans votre navigateur Web.

• OCID du service de gestion des identités et des accès de l'utilisateur du service d'infrastructure en périphérie de réseau Rover (IAM). Obtenez l'OCID de la location à l'aide des étapes suivantes :

  1. Accédez à la console de l'appareil pour le noeud de l'appareil.

  2. Ouvrez le menu de navigation et sélectionnez Gestion des identités > Utilisateurs.

     La page Utilisateurs s'affiche. Tous les utilisateurs sont présentés sous forme de tableau.

  3. Sélectionnez l'utilisateur dont vous voulez obtenir les détails. La page Détails de l'utilisateur s'affiche.

  4. Recherchez la ligne OCID sous Informations sur l'utilisateur dans la page Détails et copiez le lien et enregistrez ces informations.

     Gardez la page Web de l'utilisateur IAM ouverte selon vos besoins pour charger la clé publique au format PEM.

  5. Créez un répertoire .oci dans le répertoire de base de l'hôte sur lequel l'interface de ligne de commande OCI est installée. Par exemple :

     • Linux et Macintosh :

       cd $HOME
       mkdir .oci
       cd .oci

     • Windows PowerShell :

       mkdir %HOMEDRIVE%%HOMEPATH%\.oci
       cd ~
       cd .oci

• Paire de clés RSA au format PEM : Dans un terminal Linux ou Macintosh ou une fenêtre Windows PowerShell, passez au répertoire .oci et exécutez :

  oci setup keys

  La commande crée les fichiers suivants dans le répertoire .oci :

  • oci_api_key_public.pem

  • oci_api_key.pem

  Retournez à la console de l'appareil et allez à la page Détails de l'utilisateur IAM. Sélectionnez Clés d'API sur le côté gauche de la fenêtre, puis sélectionnez Ajouter une clé publique et sélectionnez le fichier oci_api_key_public.pem à charger.

  Après avoir chargé la clé, enregistrez la valeur de l'empreinte numérique, car vous en aurez besoin plus tard pour mettre à jour le fichier de configuration.

  Dans le répertoire .oci, créez le fichier config et alimentez-le avec les éléments suivants :

  [DEFAULT]
  user=user_ocid_from_RED_console
  fingerprint=your_fingerprint_generated_after_uploading_the_public_key
  key_file=path_to_home_directory/.oci/oci_api_key.pem
  tenancy=tenancy_ocid_from_curl_command_or_web_browser
  region=region_name
   
  Example:
  [DEFAULT]
  user=ocid1.user.orei..uniqueID
  fingerprint=10:00:00:db:dd:c4:de:71:a1:01:10:88:f9:95:1e:23
  tenancy=ocid1.tenancy.orei..uniqueID
  region=us-ashburn-1
  key_file=/Users/username/.oci/oci_api_key.pem

Si vous avez inclus une phrase secrète lors de la création de la clé PEM, ajoutez une ligne avec :

pass_phrase=your_passphrase 

Si vous avez déjà un fichier config avec un profil DEFAULT, vous pouvez créer d'autres entrées avec un profil portant le nom de votre choix.

Chaque location (appareil) du service d'infrastructure en périphérie de réseau Rover a besoin de son propre profil. Vous pouvez utiliser un nom de base et incrémenter le numéro de chaque périphérique. L'exemple suivant utilise le nom de profil ROVINGEDGE1 du nom de base ROVINGEDGE :

L'exemple suivant utilise le profil ROVINGEDGE1 :

[DEFAULT]
user=user_ocid
fingerprint=your_fingerprint
key_file=path_to_home_directory/.oci/oci_api_key.pem
tenancy=tenancy_ocid
region=region_name
[ROVINGEDGE1]
user=user_ocid_from_RED_console_UI
fingerprint=your_fingerprint_generated_after_uploading_the_public_key
key_file=path_to_home_directory/.oci/oci_api_key.pem
tenancy=tenancy_ocid_from_curl_command_or_web_browser
region=region_name
 
Example:
[DEFAULT]
user=ocid1.user.oc1..uniqueID
fingerprint=10:00:00:db:dd:c4:de:71:a1:01:10:88:f9:95:1e:23
tenancy=ocid1.tenancy.oc1..uniqueID
region=us-ashburn-1
key_file=/Users/username/.oci/oci_api_key.pem
[ROVINGEDGE1]
user=ocid1.user.orei..uniqueID
fingerprint=10:00:00:db:dd:c4:de:71:a1:01:10:88:f9:95:1e:23
tenancy=ocid1.tenancy.orei..uniqueID
region=us-ashburn-1
key_file=/Users/username/.oci/oci_api_key.pem

Si vous utilisez un nom de profil non par défaut, incluez l'option --profile profile_name dans toutes les commandes de l'interface de ligne de commande. Pour cet exemple, à l'aide du profil ROVINGEDGE1, vous devez inclure --profile ROVINGEDGE1 dans la syntaxe de votre interface de ligne de commande. La section suivante "Configuration du fichier RC de l'interface de ligne de commande OCI" décrit une méthode facultative pour éliminer cette exigence.

Chaque appareil d'infrastructure en périphérie de réseau Rover nécessite son propre profil. Sélectionnez un nom de base tel que ROVINGEDGE et incrémentez le numéro de chaque appareil. Par exemple : ROVINGEDGE1.

Oracle recommande vivement de configurer un fichier RC d'interface de ligne de commande OCI facultatif lors de l'utilisation des appareils du service d'infrastructure en périphérie de réseau Rover. La configuration d'un fichier RC d'interface de ligne de commande OCI facilite l'exécution des commandes d'interface de ligne de commande en éliminant le besoin d'inclure l'option --profile profile_name dans toutes les commandes d'interface de ligne de commande.

Le fichier RC de l'interface de ligne de commande OCI doit correspondre au jeu de profils dans le fichier config. Si vous utilisez un profil DEFAULT dans le fichier config, le fichier RC de l'interface de ligne de commande OCI utilise également DEFAULT. Si vous avez créé un profil avec un autre nom, par exemple ROVINGEDGE1, utilisez le profil ROVINGEDGE1 pour le fichier RC de l'interface de ligne de commande OCI.

Avant de configurer le fichier RC de l'interface de ligne de commande OCI, effectuez les tâches suivantes pour obtenir les informations suivantes :

• Créez un lot de certificats :

  Retournez à l'endroit où vous avez généré vos clés PEM et exécutez la commande suivante :

  echo -n | openssl s_client -showcerts -connect ip_address:8015|sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > bundle.pem

  Un fichier comportant trois certificats est créé dans le répertoire .oci. Enregistrez le chemin pour une utilisation future.

• Créez un fichier nommé oci_cli_rc dans le répertoire .oci avec le contenu suivant :

  [DEFAULT]
  # Specifies cert bundle to use
  cert-bundle = path_to_bundle/.oci/bundle.pem
  # Specifies default compartment id so it doesn't have to be set as env variable or on CLI
  compartment-id = tenancy_ocid_used_in_config_file
  # Defines endpoint to use for compute
  compute.endpoint = https://otec-console-local:19060
  # Defines endpoint to use for object storage
  os.endpoint = https://otec-console-local:8019
  # Defines namespace
  os.namespace = rover-namespace
  # Defines endpoint to use for IAM
  iam.endpoint = https://otec-console-local:12050
  # Defined endpoint for block
  bv.endpoint = https://otec-console-local:5012
  # Defined endpoint for VCN 18336
  network.endpoint = https://otec-console-local:18336

Si un fichier oci_cli_rc est déjà configuré avec une entrée DEFAULT, mettez en correspondance le nom utilisé dans le fichier config. Si vous utilisez un autre nom de profil (par exemple, ROVINGEDGE1), le fichier oci_cli_rc inclut ce nom. Par exemple :

[DEFAULT]
# Defines OCI Tenancy object namespace
os.namespace = idbcq3arv1py
[ROVINGEDGE1]
# Specifies cert bundle to use
cert-bundle = /Users/username/.oci/bundle.pem
# Specifies default compartment id so it doesn't have to be set as env variable or on CLI
compartment-id = ocid1.tenancy.orei..uniqueID
# Defines Roving Edge endpoint to use for compute
compute.endpoint = https://otec-console-local:19060
# Defines Roving Edge endpoint to use for object storage
os.endpoint = https://otec-console-local:8019
# Defines Roving Edge object namespace
os.namespace = rover-namespace
# Defines Roving Edge endpoint to use for IAM
iam.endpoint = https://otec-console-local:12050
# Defined Roving Edge endpoint for block
bv.endpoint = https://otec-console-local:5012
# Defined Roving Edge endpoint for VCN 18336
network.endpoint = https://otec-console-local:18336

Vous pouvez spécifier des options pour l'interface de ligne de commande à l'aide des commandes suivantes :

• --option value

  ou

• --option=value

N'utilise pas le fichier RC de l'interface de ligne de commande OCI

Si vous n'utilisez pas de fichier oci_cli_rc, la syntaxe de base de l'interface de ligne de commande pour l'infrastructure en périphérie de réseau Rover est la suivante :

oci resource action options --endpoint resource_endpoint --compartment-id Roving_Edge_tenancy_ocid_used_in_config_file --cert-bundle path_to_cert bundle

Cette syntaxe comprend les éléments suivants :

• oci est le nom de commande abrégé de l'interface de ligne de commande

• os bucket est un exemple d'élément resource

• create est un exemple d'élément action

• Les autres chaînes sont des éléments options

Les points d'extrémité de ressource sont les suivants :

• Stockage d'objets : https://otec-console-local:8019

  Les commandes de stockage d'objets doivent également inclure l'option --namespace rover-namespace.

• Calcul : https://otec-console-local:19060

• Stockage par blocs : https://otec-console-local:5012

• IAM : https://otec-console-local:12050

• Réseau : https://otec-console-local:18336

• Synchronisation de données : https://otec-console-local:21060

• Mise à niveau du système : https://otec-console-local:23060

• Événements : https://otec-console-local:18000
• Surveillance : https://otec-console-local:22060
• Outils de diagnostic : https://otec-console-local:31060

Incluez la valeur otec-console-local pour l'entrée de ligne IP address dans le fichier /etc/hosts pour utiliser la fonctionnalité de fichier oci_cli_rc.

Si vous utilisez un certificat Oracle Cloud Infrastructure, les points d'extrémité de ressource sont les suivants :

Ex: DNS:*.commonname.com

• Stockage d'objets : https://rover.commonname.com:8019

  Les commandes de stockage d'objets doivent également inclure l'option --namespace rover-namespace.

• Calcul : https://rover.commonname.com:19060

• Stockage par blocs : https://rover.commonname.com:5012

• IAM : https://rover.commonname.com:12050

• Réseau : https://rover.commonname.com:18336

• Synchronisation de données : https://rover.commonname.com:21060

• Mise à niveau du système : https://rover.commonname.com:23060

• Événements : https://rover.commonname.com:18000

• Surveillance : https://rover.commonname.com:22060

• Outils de diagnostic : https://rover.commonname.com:31060

Voici un exemple de commande d'interface de ligne de commande :

oci os bucket list --compartment-id ocid1.tenancy.orei..uniqueID --endpoint https://otec-console-local:8019 --cert-bundle /Users/username/.oci/bundle.pem

Si l'entrée de fichier config pour l'environnement du service d'infrastructure en périphérie de réseau Rover n'est pas DEFAULT, incluez l'option --profile profile_name dans la syntaxe de votre interface de ligne de commande. Par exemple :

oci os bucket list --compartment-id ocid1.tenancy.orei..uniqueID --endpoint https://otec-console-local:8019 --cert-bundle /Users/username/.oci/bundle.pem --profile ROVINGEDGE1

Utilisation du fichier RC de l'interface de ligne de commande OCI

Si vous utilisez le fichier the oci_cli_rc, la syntaxe de base de l'interface de ligne de commande pour le service d'infrastructure en périphérie de réseau Rover est la suivante :

oci resource action options

Cette syntaxe comprend les éléments suivants :

• oci est le nom de commande abrégé de l'interface de ligne de commande

• os bucket est un exemple d'élément resource

• list est un exemple de action

• Les autres chaînes sont des éléments options

L'exemple de ligne de commande suivant présente une construction de commande d'interface de ligne de commande standard pour lister les seaux d'un compartiment spécifié :

oci os bucket list --compartment-id ocid1.tenancy.orei..uniqueID

Si votre entrée de fichier config pour l'environnement du service d'infrastructure en périphérie de réseau Rover n'est pas DEFAULT, vous devez également inclure l'option --profile profile_name dans la syntaxe de votre interface de ligne de commande. Par exemple :

oci os bucket list --compartment-id ocid1.tenancy.orei..uniqueID --endpoint https://otec-console-local:8019 --cert-bundle /Users/username/.oci/bundle.pem --profile ROVINGEDGE1

oci os bucket create --name name [OPTIONS]

Si la valeur de paramètre obligatoire est indiquée en tant que variable, par exemple name, vous devez fournir une valeur. Entrez la commande telle qu'elle apparaît dans la documentation.

L'inclusion de [OPTIONS] dans la syntaxe de commande indique des paramètres facultatifs. Accédez à l'aide en ligne de l'interface de ligne de commande pour obtenir une liste de paramètres facultatifs et leur syntaxe.

Suivez ces directives pour exécuter des commandes d'interface de ligne de commande sur des instances de calcul hébergées par des appareils en périphérie de réseau Rover.

• Demandez à l'instance de passer par l'adresse IP locale suivante :

  169.254.169.254

  Demandez à l'instance de se référer à l'appareil en périphérie de réseau Rover en tant que otec-console-local.

• Utilisez les règles suivantes relatives aux tables IP :

  { for i in 19060 8019 12050 21060 22060 23060 22060 12060;do iptables -I 
  BareMetalInstanceServices -d 169.254.169.254/32 -p tcp -m tcp --dport $i -m 
  comment --comment "Rover service access port" -j ACCEPT;done }

  Voir Ports de service pour obtenir la liste des ports disponibles.

  Note
  
  

  Sur certains systèmes d'exploitation, la chaîne BareMetalInstanceServices peut être InstanceServices. Utilisez la commande iptables -L pour voir ce qui s'applique à votre système d'exploitation.

  Enregistrez la valeur iptable afin que les règles persistent après un redémarrage :

  iptables save

Les commandes d'interface de ligne de commande suivantes ne sont actuellement pas prises en charge. Des solutions de rechange sont fournies lorsqu'elles sont disponibles.

• Interfaces de ligne de commande du service de stockage d'objets : oci os list

  Vous ne pouvez utiliser la commande oci os list que lorsque vous incluez l'option --fields. Par exemple :

  # oci os object list --bucket-name generic-image --fields name,size,timeCreated,md5,etag
  {
  "data": [
  {
  "archival-state": null,
  "etag": "b2c123ff0f1231c4c7f41ff92294e4a0-32",
  "md5": "ssYx/w8SUcTH9B/5IpTkoA==-32",
  "name": "exported-image",
  "size": 2132357120,
  "storage-tier": null,
  "time-created": "2022-03-01T19:50:03.076000+00:00",
  "time-modified": null
  },    {
        "archival-state": null,
        "etag": "fe5e3c12e12e31de65b86722a6fe29e7-32",
        "md5": "/l48AOleMd5luGcipv4p5w==-32",
        "name": "imported-image-20210830-1542_ocid1.image.oc1.iad..uniqueID.oci",
        "size": 2132224000,
        "storage-tier": null,
        "time-created": "2022-03-01T19:50:59.968000+00:00",
        "time-modified": null
      }
    ],
    "prefixes": []
  }

• Interfaces de ligne de commande du service de calcul : oci compute instance list-vnics

  La commande oci compute instance list-vnics liste les cartes vNIC attachées à l'instance spécifiée et est souvent utilisée pour obtenir l'adresse IP publique d'un noeud de calcul. Cette interface de ligne de commande n'est pas prise en charge actuellement dans le service d'infrastructure en périphérie de réseau Rover. Vous pouvez obtenir des informations sur la carte VNIC, notamment l'adresse IP associée à une carte VNIC associée à un noeud de calcul, au moyen de l'une des méthodes suivantes :

  • Console d'appareil : Allez à l'emplacement suivant :

    Compute > Instances > Détails de l'instance > Cartes vNIC attachées

    Les adresses IP des cartes vNIC sont listées dans la boîte de dialogue qui s'affiche.

  • Interface de ligne de commande : oci compute instance list-vnics

    Commencez par exécuter la commande suivante pour lister tous les attachements de la carte vNIC :

    oci compute vnic-attachment list --instance-id <> --all

    Ensuite, exécutez la commande suivante pour la carte VNIC spécifique pour laquelle vous voulez obtenir des détails :

    oci network vnic get --vnic-id <>

    L'exemple suivant montre ces deux commandes exécutées avec leurs retours respectifs :

    # oci compute vnic-attachment list --instance-id ocid1.instance.orei.orei-1..uniqueID --all
    {
      "data": [
        {
          "availability-domain": "orei-1-ad-1",
          "compartment-id": "ocid1.tenancy.orei..uniqueID",
          "display-name": null,
          "id": "ocid1.vnicattachment.orei.orei-1..uniqueID",
          "instance-id": "ocid1.instance.orei.orei-1..uniqueID",
          "lifecycle-state": "ATTACHED",
          "nic-index": 0,
          "subnet-id": "ocid1.subnet.orei.orei-1..uniqueID",
          "time-created": "2022-03-01T21:07:00.937000+00:00",
          "vlan-id": null,
          "vlan-tag": 1,
          "vnic-id": "ocid1.vnic.orei.orei-1..uniqueID"
        }
      ]
    }
    
    # oci network vnic get --vnic-id ocid1.vnic.orei.orei-1..uniqueID
    {
      "data": {
        "availability-domain": "orei-1-ad-1",
        "compartment-id": "ocid1.tenancy.orei..uniqueID",
        "defined-tags": {},
        "display-name": "test-instance",
        "freeform-tags": {},
        "hostname-label": "test-instance",
        "id": "ocid1.vnic.orei.orei-1..uniqueID",
        "is-primary": true,
        "lifecycle-state": "AVAILABLE",
        "mac-address": "02:00:17:00:04:00",
        "nsg-ids": [],
        "private-ip": "10.0.0.2",
        "public-ip": "10.145.142.128",
        "skip-source-dest-check": false,
        "subnet-id": "ocid1.subnet.orei.orei-1..",
        "time-created": "2022-03-01T21:07:00.155000+00:00",
        "vlan-id": null
      },
      "etag": "2c082d1c"
    }

    Si une seule carte VNIC est attachée, vous pouvez combiner ces commandes d'interface de ligne de commande avec d'autres outils Linux pour limiter la sortie à l'adresse IP publique à l'aide de la commande suivante :

    oci compute vnic-attachment list --instance-id <> --all|grep -m 1 vnic-id|awk -F'"' '{print $4}'|xargs -I{} oci network vnic get --vnic-id {}|grep public-ip|awk -F'"' '{print $4}'
    

    Par exemple :

    # oci compute vnic-attachment list --instance-id ocid1.instance.orei.orei-1..uniqueID --all|grep -m 1 vnic-id|awk -F'"' '{print $4}'|xargs -I{} oci network vnic get --vnic-id {}|grep public-ip|awk -F'"' '{print $4}'
    10.145.142.128

Toutes les commandes d'aide sur l'interface de ligne de commande sont associées à un composant d'aide auquel vous pouvez accéder depuis la ligne de commande. Pour voir l'aide, entrez une commande suivie de l'option --help ou -h. Par exemple :

oci os bucket --help