Exécution de commandes sur une instance

La fonction 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 fonction d'exécution de commande.

La fonction 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 est exécuté par défaut dans un interpréteur de commandes Bash. 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 est exécuté par défaut dans un interpréteur de commandes par lots. 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 de l'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 que vous chargez directement dans une instance en texte brut est de 4 Ko. Pour un fichier plus grand, enregistrez le fichier dans un emplacement du service Stockage d'objets.
• La sortie d'un script retourné en texte brut est limitée au dernier Ko. Pour enregistrer une réponse plus importante, enregistrez la sortie dans un emplacement du service Stockage d'objets.
• Lorsque vous utilisez un emplacement du service Stockage d'objets pour enregistrer le fichier ou la réponse de script, l'instance doit avoir une connectivité sortante telle qu'une passerelle de traduction d'adresses de réseau (NAT), une passerelle de service ou une passerelle Internet. L'instance doit également autoriser le trafic sortant sur le port 443 pour le logiciel Oracle Cloud Agent, le service Stockage d'objets et le service Gestion des identités et des accès.

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

  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 cours à la fois. Un script est considéré en cour s'il a été reçu par le plugiciel d'exécution de commande pour les instances de calcul, mais pas encore supprimé de la file d'attente.
• Pour exécuter des tâches de longue durée, utilisez la fonction d'exécution de commande pour planifier une tâche cron sur l'instance. L'orchestration des commandes n'est pas prise en charge.
• Chaque script est exécuté une seule fois. Pour qu'un script s'exécute plusieurs fois, utilisez cron pour configurer une programmation du script.
• Les scripts qui demandent des informations ne sont pas pris en charge. Vous pouvez cependant utiliser le service de métadonnées d'instance (IMDS), pour extraire par programmation des informations sur l'instance sur laquelle le script s'exécute.
• Lorsque vous créez une instance à partir d'une image personnalisée qui dispose déjà des autorisations pour le plugiciel Exécution de commandes dans l'instance de calcul, remplacez 101-oracle-cloud-agent-run-command par 100-oracle-cloud-agent-run-command dans le fichier de configuration.
• Les codes de sortie retournés sont des codes d'erreur Linux standard. Le code de sortie 0 indique le succès.
• Si vous appliquez une temporisation facultative 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 d'UC, utilisez des mesures.
• L'annulation d'un script est une tentative au mieux. Les commandes ne peuvent pas être annulées après leur exécution ou si elles ont expiré.
• Les fichiers et les réponses de script enregistrés en texte brut sont conservés pendant sept jours. Les fichiers et les réponses de script enregistrés dans un emplacement du service Stockage d'objets sont conservés jusqu'à ce que vous les supprimiez.
• N'exécutez pas de script qui provoque l'arrêt du logiciel Oracle Cloud Agent ou du plugiciel d'exécution de commande pour les instances de calcul.

Si une commande nécessite des autorisations d'administrateur, vous devez les accorder au plugiciel d'exécution de commande dans une instance de calcul pour qu'il puisse exécuter la commande. Le plugiciel est exécuté en tant qu'utilisateur ocarun.

Vous pouvez utiliser cloud-init (cloudbase-init sur Windows) pour configurer les autorisations lors du lancement de l'instance ou vous connecter à une instance après son lancement et configurer manuellement les autorisations. Les étapes visant à accorder les autorisations d'administrateur dépendent du système d'exploitation.

• Le plugiciel d'exécution de commandes dans une instance de calcul doit être activé sur l'instance, et les plugiciels doivent être en cours d'exécution. Pour plus d'informations sur l'activation et l'exécution des plugiciels, voir Oracle Cloud Agent.
• Vous avez préparé le script que vous souhaitez exécuter. Nous vous recommandons de tester la commande dans un environnement hors production avant de la déployer sur les instances qui exécutent des flux de travail de production.
• Pour fournir le fichier de script à partir d'un emplacement du service de stockage d'objets, chargez le fichier d'image dans un seau du service de stockage d'objets dans la même région que l'instance cible. Notez le nom du seau et du fichier ou l'URL du service Stockage d'objets pour le fichier. Pour utiliser la même commande pour toutes les locations, créez une URL de demande préauthentifiée qui pointe vers le fichier.
• Pour enregistrer la sortie de commande dans un emplacement du service Stockage d'objets, créez un seau dans lequel l'enregistrer, dans la même région que l'instance cible. Notez le nom du seau ou l'URL du service Stockage d'objets pour le seau. Vous pouvez éventuellement enregistrer la sortie de commande à l'aide d'une demande préauthentifiée qui pointe vers un emplacement du service Stockage d'objets.
• Pour les images de plate-forme qui ont été lancées avant octobre 2020, le logiciel Oracle Cloud Agent doit être mis à jour à une version prenant en charge le plugiciel d'exécution de commandes dans une instance de calcul (version 1.5.1 ou version ultérieure).

Pour plus d'informations sur l'utilisation de l'API et sur les demandes de signature, voir la documentation de l'API REST et Données d'identification de sécurité. Pour plus d'informations sur les trousses SDK, voir Trousses SDK et interface de ligne de commande.

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

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

Pour dépanner le plugiciel d'exécution de commandes dans une instance de calcul, vous pouvez voir les journaux que le plugiciel génère. Connectez-vous à l'instance, puis utilisez la commande suivante :

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

Pour faciliter la visibilité des opérations du plugiciel sans avoir à vous connecter à l'instance, vous pouvez créer des journaux personnalisés à l'aide du service Journalisation pour Oracle Cloud Infrastructure.