インスタンスでのコマンドの実行

コマンド実行機能は、次のプラットフォーム・イメージを使用するコンピュート・インスタンスでサポートされています:

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

サポートされているプラットフォーム・イメージに基づくカスタム・イメージも、コマンド実行機能をサポートしています。

コマンド実行機能は、Oracle Cloud Infrastructure商用レルムのすべてのリージョンでサポートされています。

• Linuxインスタンスでは、スクリプトはデフォルトでBashシェルで実行されます。別のプログラムでスクリプトを実行するには、スクリプトの1行目として#!/<path_to_program>を使用します。

• Windowsインスタンスでは、スクリプトはデフォルトでバッチ・シェルで実行されます。PowerShellでスクリプトを実行するには、スクリプトの1行目として#ps1を使用します。

  PowerShellスクリプトの例を参照してください

  次の例では、PowerShellを使用してインスタンス・メタデータ・サービスを問い合せ、インスタンスOCIDを出力します:

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

• プレーン・テキストでインスタンスに直接アップロードするスクリプト・ファイルの最大サイズは4KBです。より大きなファイルを指定するには、ファイルをオブジェクト・ストレージの場所に保存します。
• プレーン・テキストとして返されるスクリプトの出力は、最後の1KBに制限されます。より大きなレスポンスを保存するには、出力をオブジェクト・ストレージの場所に保存します。
• オブジェクト・ストレージの場所を使用してスクリプト・ファイルまたはレスポンスを保存する場合、インスタンスにNetwork Access Translation (NAT)ゲートウェイ、サービス・ゲートウェイ、インターネット・ゲートウェイなどのアウトバウンド接続が必要です。インスタンスでは、Oracle Cloud Agentソフトウェア、オブジェクト・ストレージおよびIAMのポート443でのエグレス・トラフィックも許可する必要があります。

• デフォルトでは、一度に2つのスクリプトを実行できます。デフォルトを変更するには、コマンド実行の構成ファイルを更新します:

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

  次のパラメータを設定します:

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

• 一度に実行できるスクリプトは最大5つです。スクリプトは、コンピュート・インスタンスのコマンド実行プラグインによって受信されたが、まだキューから削除されていない場合、実行中とみなされます。
• 長時間実行タスクを実行するには、コマンド実行機能を使用して、インスタンスでcronジョブをスケジュールします。コマンドのオーケストレーションはサポートされていません。
• 各スクリプトは1回実行されます。スクリプトを複数回実行する場合は、cronを使用して、スクリプトのスケジュールを構成します。
• 情報の入力を求めるスクリプトは、サポートされていません。ただし、インスタンス・メタデータ・サービス(IMDS)を使用して、スクリプトが実行されるインスタンスに関する情報をプログラムで取得できます。
• コンピュート・インスタンス実行コマンド・プラグインの権限がすでに構成されているカスタム・イメージからインスタンスを作成する場合は、構成ファイルで101-oracle-cloud-agent-run-commandを100-oracle-cloud-agent-run-commandに置き換えます。
• 返される終了コードは、標準のLinuxエラー・コードです。終了コード0は成功を示します。
• スクリプトにオプションのタイムアウトを適用する場合、デフォルトは1時間です。最大値は24時間です。
• スクリプトを実行できる最大時間は1日です。
• スクリプトが消費するリソース(CPU使用率など)をモニターするには、メトリックを使用します。
• スクリプトの取消しは、ベストエフォート試行です。コマンドの実行が終了した後、またはコマンドの有効期限が切れた場合は、コマンドを取り消すことはできません。
• プレーン・テキストで保存されたスクリプト・ファイルおよびレスポンスは、7日間保持されます。オブジェクト・ストレージの場所に保存されたスクリプト・ファイルおよびレスポンスは、削除するまで保持されます。
• Oracle Cloud Agentソフトウェアまたはコンピュート・インスタンスのコマンド実行プラグインを停止させるスクリプトを実行しないでください。

コマンドに管理者権限が必要な場合は、コマンドを実行できるように、コンピュート・インスタンスのコマンド実行プラグインに管理者権限を付与する必要があります。プラグインは、ocarunユーザーとして実行されます。

cloud-init (Windowsの場合はcloudbase-init)を使用して、インスタンスの起動時に権限を構成することも、インスタンスの起動後にインスタンスに接続し、権限を手動で構成することもできます。管理者権限を付与するステップは、オペレーティング・システムによって異なります。

• コンピュート・インスタンスのコマンド実行プラグインをインスタンスで有効にし、プラグインを実行する必要があります。プラグインを有効化および実行する方法の詳細は、「Oracle Cloud Agent」を参照してください。
• 実行するスクリプトの準備が完了しました。コマンドは、本番ワークフローを実行するインスタンスにデプロイする前に、本番以外の環境でテストすることをお薦めします。
• オブジェクト・ストレージの場所からスクリプト・ファイルを提供するには、ターゲット・インスタンスと同じリージョンのオブジェクト・ストレージ・バケットにイメージ・ファイルをアップロードします。バケットとファイル名、またはファイルのオブジェクト・ストレージURLを書き留めます。テナンシ間で同じコマンドを使用するには、ファイルをポイントする事前認証済リクエストURLを作成します。
• コマンド出力をオブジェクト・ストレージの場所に保存するには、ターゲット・インスタンスと同じリージョンに、保存先のバケットを作成します。バケット名またはバケットのオブジェクト・ストレージURLを書き留めます。オプションで、オブジェクト・ストレージの場所を指す事前認証済リクエストを使用して、コマンド出力を保存できます。
• 2020年10月より前にリリースされたプラットフォーム・イメージの場合、コンピュート・インスタンスのコマンド実行プラグイン(バージョン1.5.1以降)をサポートするバージョンに、Oracle Cloud Agentソフトウェアを更新する必要があります。

APIの使用およびリクエストの署名の詳細は、REST APIのドキュメントおよびセキュリティ資格証明を参照してください。SDKの詳細は、SDKおよびCLIを参照してください。

次のAPI操作を使用して、コマンド実行機能を使用します:

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

コンピュート・インスタンスのコマンド実行プラグインのトラブルシューティングを行うには、プラグインが生成するログを表示します。インスタンスに接続し、次を使用します:

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

インスタンスに接続せずにプラグインの操作を簡単に表示できるように、Oracle Cloud Infrastructure Loggingサービスを使用してカスタム・ログを作成できます。