Exécution de commandes sur une instance

La fonctionnalité d'exécution de commande est prise en charge sur les instances de calcul qui utilisent les images de plate-forme suivantes:

• Oracle Autonomous Linux
• Oracle Linux
• CentOS
• Windows Server

Les images personnalisées basées sur une image de plate-forme prise en charge prennent également en charge la fonctionnalité d'exécution de commande.

La fonctionnalité d'exécution de commande est prise en charge dans toutes les régions du domaine commercial Oracle Cloud Infrastructure.

• Sur les instances Linux, le script s'exécute dans un shell de type bash par défaut. Pour exécuter le script avec un autre programme, utilisez #!/<path_to_program> comme première ligne du script.

• Sur les instances Windows, le script s'exécute dans un shell en batch par défaut. Pour exécuter le script avec PowerShell, utilisez #ps1 comme première ligne du script.

  Voir un exemple de script PowerShell

  L'exemple suivant utilise PowerShell pour interroger le service de métadonnées d'instance et imprimer l'OCID d'instance :

  #ps1
  $instance = Invoke-RestMethod -Headers @{'Authorization' = 'Bearer Oracle'} -Uri http://169.254.169.254/opc/v2/instance/
  Write-Host ('Instance OCID is ' + $($instance.id))

• La taille maximale d'un fichier de script téléchargé directement vers une instance en texte brut est de 4 ko. Pour fournir un fichier plus volumineux, enregistrez ce dernier dans un emplacement Object Storage.
• La sortie d'un script renvoyée en texte brut est limitée au dernier kilo-octet. Pour enregistrer une réponse plus volumineuse, enregistrez la sortie dans un emplacement Object Storage.
• Lorsque vous utilisez un emplacement Object Storage pour enregistrer le fichier de script ou la réponse, l'instance doit disposer d'une connectivité sortante, telle qu'une passerelle NAT (Network Access Translation), une passerelle de service ou une passerelle Internet. L'instance doit également autoriser le trafic sortant sur le port 443 pour le logiciel d'agent Oracle Cloud, Object Storage et IAM.

• Par défaut, deux scripts à la fois peuvent être exécutés. Pour modifier la valeur par défaut, mettez à jour le fichier de configuration de commande d'exécution :

  cat /etc/oracle-cloud-agent/plugins/runcommand/config.yml

  Définissez les paramètres suivants :

  logDir: /var/log/oracle-cloud-agent/plugins/runcommand
  commandExecutionMaxWorkers: <number-of-parallel-scripts>

• Un maximum de cinq scripts peuvent être en attente de traitement à la fois. Un script est considéré comme en attente de traitement s'il a été reçu par le module d'extension d'exécution de commandes sur les instances de calcul, mais pas encore supprimé de la file d'attente.
• Pour effectuer des tâches longues, utilisez la fonctionnalité d'exécution de commande afin de programmer un travail CRON sur l'instance. L'orchestration des commandes n'est pas prise en charge.
• Chaque script s'exécute une fois. Pour qu'un script soit exécuté plusieurs fois, utilisez CRON afin de configurer une programmation pour ce script.
• Les scripts qui demandent des informations ne sont pas pris en charge. Toutefois, vous pouvez utiliser le service de métadonnées d'instance (IMDS) pour extraire par programmation des informations concernant l'instance sur laquelle le script est exécuté.
• Lorsque vous créez une instance à partir d'une image personnalisée qui dispose déjà de droits d'accès pour le module d'extension d'exécution de commandes sur les instances de calcul configuré, remplacez 101-oracle-cloud-agent-run-command par 100-oracle-cloud-agent-run-command dans le fichier de configuration.
• Les codes de sortie renvoyés sont des codes d'erreur Linux standard. Le code de sortie 0 indique un succès.
• Si vous appliquez un délai d'expiration facultatif pour un script, la valeur par défaut est d'une heure. Le maximum est de 24 heures.
• La durée maximale d'exécution d'un script est d'un jour.
• Pour surveiller les ressources consommées par les scripts, telles que l'utilisation de l'UC, employez des mesures.
• Les tentatives d'annulation de script n'aboutissent pas forcément. Les commandes ne peuvent pas être annulées si elles ont déjà été exécutées ou si elles ont expiré.
• Les fichiers de script et les réponses enregistrés en texte brut sont conservés pendant sept jours. Les fichiers de script et les réponses enregistrés dans un emplacement Object Storage sont conservés jusqu'à ce que vous les supprimiez.
• N'exécutez pas de script qui entraîne l'arrêt du logiciel d'agent Oracle Cloud ou du module d'extension d'exécution de commandes sur les instances de calcul.

Si une commande requiert des droits d'accès administrateur, vous devez les accorder au module d'extension Exécution de commandes sur les instances de calcul pour pouvoir exécuter la commande. Le module d'extension s'exécute en tant qu'utilisateur ocarun.

Vous pouvez utiliser cloud-init (cloudbase-init sous Windows) pour configurer les droits d'accès lors du lancement de l'instance, ou vous connecter à une instance après son lancement et configurer les droits d'accès manuellement. Les étapes permettant d'octroyer des droits d'accès d'administrateur dépendent du système d'exploitation.

• Le module d'extension d'exécution de commandes sur les instances de calcul doit être activé sur l'instance et les modules d'extension doivent être en cours d'exécution. Pour plus d'informations sur l'activation et l'exécution des modules d'extension, reportez-vous à Agent Oracle Cloud.
• Vous avez préparé le script à exécuter. Nous vous recommandons de tester la commande dans un environnement de non-production avant de la déployer sur des instances exécutant des workflows de production.
• Pour fournir le fichier de script à partir d'un emplacement Object Storage, télez-le vers un bucket Object Storage de la région de l'instance cible. Notez le nom du bucket et du fichier, ou l'URL Object Storage du fichier. Pour utiliser la même commande dans toutes les locations, créez une URL de demande pré-authentifiée pointant vers le fichier.
• Pour enregistrer la sortie de commande dans un emplacement Object Storage, créez un bucket dans lequel l'enregistrer, dans la région de l'instance cible. Notez le nom ou l'URL Object Storage du bucket. Vous pouvez éventuellement enregistrer la sortie de commande à l'aide d'une demande pré-authentifiée pointant vers un emplacement Object Storage.
• Pour les images de plate-forme publiées avant octobre 2020, le logiciel d'agent Oracle Cloud doit être mis à jour vers une version prenant en charge le module d'extension d'exécution de commandes sur les instances de calcul (version 1.5.1 ou ultérieure).

Pour plus d'informations sur l'utilisation de l'API et la signature des demandes, reportez-vous à la documentation relative à l'API REST et à Informations d'identification de sécurité. Pour plus d'informations sur les kits SDK, reportez-vous à Kits SDK et interface de ligne de commande.

Utilisez ces opérations d'API pour utiliser la fonctionnalité d'exécution de commande :

• CreateInstanceAgentCommand
• GetInstanceAgentCommand
• GetInstanceAgentCommandExecution
• ListInstanceAgentCommands
• ListInstanceAgentCommandExecutions
• CancelInstanceAgentCommand

Pour dépanner le module d'extension d'exécution de commandes sur les instances de calcul, vous pouvez visualiser les journaux générés par le module d'extension. Connectez-vous à l'instance, puis utilisez la commande suivante :

tail -f /var/log/oracle-cloud-agent/plugins/runcommand/runcommand.log

Pour bénéficier d'une meilleure visibilité des opérations du module d'extension sans devoir vous connecter à l'instance, vous pouvez créer des journaux personnalisés à l'aide du service Oracle Cloud Infrastructure Logging.