Executando Comandos em uma Instância

O recurso do comando de execução é suportado nas instâncias de computação que usam as seguintes imagens da plataforma:

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

Imagens personalizadas baseadas em uma imagem de plataforma suportada também suportam o recurso de comando de execução.

O recurso de comando de execução é suportado em todas as regiões do realm comercial do Oracle Cloud Infrastructure.

• Nas instâncias do Linux, o script é executado em um shell Bash por padrão. Para executar o script com um programa diferente, use #!/<path_to_program> como primeira linha do script.

• Nas instâncias do Windows, o script é executado em um shell batch por padrão. Para executar o script com o PowerShell, use #ps1 como primeira linha do script.

  Consulte um script de exemplo do PowerShell

  O exemplo a seguir usa o PowerShell para consultar o serviço de metadados da instância e imprimir o OCID da instância:

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

• O tamanho máximo de um arquivo de script que você carrega diretamente para uma instância em texto sem formatação é 4 KB. Para fornecer um arquivo maior, salve o arquivo em um local do serviço Object Storage.
• A saída de um script quando retornado como texto sem formatação é limitada ao último 1 KB. Para salvar uma resposta maior, salve a saída em um local do serviço Object Storage.
• Quando você usa um local do serviço Object Storage para salvar o arquivo de script ou a resposta, a instância deve ter conectividade de saída, como um gateway NAT (Network Access Translation), um gateway de serviço ou um gateway de internet. A instância também deve permitir tráfego de saída na porta 443 para o software Oracle Cloud Agent, Object Storage e IAM.

• Por padrão, é possível executar dois scripts por vez. Para alterar o padrão, atualize o arquivo de configuração do comando de execução:

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

  Defina os parâmetros a seguir:

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

• No máximo, cinco scripts por vez podem estar em andamento. Um script será considerado em execução se tiver sido recebido pelo plug-in Compute Instance Run Command, mas ainda não tiver sido excluído da fila.
• Para executar tarefas de longa duração, use o recurso de comando de execução para programar um job cron na instância. A orquestração de comando não é suportada.
• Cada script é executado uma vez. Se quiser que um script seja executado várias vezes, use o cron para configurar uma programação para o script.
• Scripts que solicitam informações não são suportados. Você pode usar o serviço de metadados de instância (IMDS), no entanto, para recuperar de forma programática informações sobre a instância em que o script é executado.
• Quando você criar uma instância com base em uma imagem personalizada que já tenha permissões para o plug-in Compute Instance Run Command configurado, substitua 101-oracle-cloud-agent-run-command por 100-oracle-cloud-agent-run-command no arquivo de configuração.
• Os códigos de saída retornados são códigos de erro padrão do Linux. Um código de saída 0 indica sucesso.
• Se você aplicar um timeout opcional a um script, o padrão será uma hora. O máximo é 24 horas.
• O tempo máximo durante o qual um script pode ser executado é de um dia.
• Para monitorar os recursos que os scripts consomem, como a utilização de CPU, use métricas.
• O cancelamento de um script é a melhor tentativa. Os comandos não poderão ser cancelados depois de finalizada a execução ou se tiverem expirado.
• Os arquivos de script e as respostas salvos em texto sem formatação são mantidos por sete dias. Arquivos de script e respostas salvos em um local do serviço Object Storage são retidos até você excluí-los.
• Não execute um script que faça com que o software Oracle Cloud Agent ou o plug-in Compute Instance Run Command seja interrompido.

Se um comando exigir permissões de administrador, conceda-as ao plug-in Compute Instance Run Command para poder executar o comando. O plug-in é executado como usuário ocarun.

Você pode usar cloud-init (cloudbase-init no Windows) para configurar permissões na ativação da instância ou estabelecer conexão com uma instância depois que ela for iniciada e configurar as permissões manualmente. As etapas para conceder permissões de administrador dependem do sistema operacional.

• O plug-in Compute Instance Run Command deve estar ativado na instância e os plug-ins devem estar em execução. Para obter mais informações sobre como ativar e executar plug-ins, consulte Oracle Cloud Agent.
• Você preparou o script que deseja executar. Recomendamos que você teste o comando em um ambiente não de produção antes de implantá-lo em instâncias que executam workflows de produção.
• Para fornecer o arquivo de script de um local do Object Storage, Faça upload do arquivo de imagem para um bucket do Object Storage na mesma região da instância de destino. Observe o bucket e o nome do arquivo, ou o URL do serviço Object Storage para o arquivo. Para usar o mesmo comando entre tenancies, crie um URL de solicitação pré-autenticada que aponta para o arquivo.
• Para salvar a saída do comando em um local do serviço Object Storage, crie um bucket para salvá-lo na mesma região da instância de destino. Observe o nome do bucket ou o URL do serviço Object Storage para o bucket. Você tem a opção de salvar a saída do comando usando uma solicitação pré-autenticada que aponte para um local do serviço Object Storage.
• Para imagens de plataforma que foram liberadas antes de outubro de 2020, o software Oracle Cloud Agent deve ser atualizado para uma versão que suporte o plug-in Compute Instance Run Command (versão 1.5.1 ou posterior).

Para obter informações sobre como usar a API e assinar solicitações, consulte a documentação da API REST e Credenciais de Segurança. Para obter informações sobre SDKs, consulte SDKs e a CLI.

Use estas operações de API para trabalhar com o recurso de comando de execução:

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

Para diagnosticar e solucionar problemas do plug-in Compute Instance Run Command, você pode exibir os logs que o plug-in gera. Estabeleça conexão com a instância e use o seguinte:

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

Para facilitar a visibilidade das operações do plug-in sem precisar estabelecer conexão com a instância, você pode criar logs personalizados usando o serviço Oracle Cloud Infrastructure Logging.