501: OCICLIを利用したインスタンス操作

ここまでの章で、ADBインスタンスの作成やOCPU数の変更等、様々な操作を実施いただきましたが、これら一連の操作を自動化するにはどうしたら良いでしょうか？

ADBはOracle Cloud Infrastructure(OCI)の他のサービスと同様、REST APIを介した各種操作が可能であり、それらを呼び出すコマンド・ライン・インタフェース（OCI CLI）を利用した操作も可能です。

この章ではOCI CLIを利用してADBインスタンスの作成や起動・停止、およびスケールアップ、ダウンといった構成変更の方法について確認します。

これらコマンドを利用しスクリプトを組めば、例えば夜間はあまり使わないからOCPUをスケールダウンさせておき、朝になったらスケールアップしよう。といった自動化が可能となります。

尚、本ガイドではOCI CLIがインストールされたOCI Developer Image を利用することを前提に記載しています。

OCI CLIのインストール方法を含め、OCI CLIの詳細についてはを参照ください。

所要時間 : 約30分

前提条件 :

• ADBインスタンスが構成済みであること
  ※ADBインタンスを作成方法については、本ハンズオンガイドの 101:ADBインスタンスを作成してみよう を参照ください。

• ADBインスタンスに接続可能な仮想マシンを構成済みであること
  ※仮想マシンの作成方法については、本ハンズオンガイドの 204:マーケットプレイスからの仮想マシンのセットアップ方法 を参照ください。

目次：

• 1. OCI CLIをセットアップしよう
• 2. OCI CLIを使ってみよう
• 3. OCI CLIでインスタンスを操作しよう

1. OCI CLIをセットアップしよう

まずはOCI CLIにクラウド環境の情報を登録します。

1. Tera Termを起動し、仮想マシンにログインします。

2. oracleユーザに切り替えます。

    sudo su - oracle
   

   

3. OCI CLIがセットアップされていることを確認するために、バージョンを確認します。（ 2.18.XXが出力されればOKです。）

    oci -v
   

   

4. クラウド環境の情報（OCID）を確認します。
   後続のconfigファイルの作成で利用しますので、お手元のメモ帳に一旦保存します。
   ここでは、ユーザのOCIDとテナンシOCIDをそれぞれ確認しましょう。

   補足

   OCIDとは、Oracle Cloud識別子のことで、OCIの各リソースに付与されている一意のIDです。REST APIやOCI CLIを利用する際はこのIDを利用して、各リソースにアクセスします。 OCIDについての詳細な情報は こちら を参照ください。

   4-1. ユーザのOCIDを確認します。
   ユーザー設定をクリックします。OCID はユーザ情報の最上部に表示されています。
   コピーをクリックすると、OCIDがクリップボードに保存されますので、お手元のメモ帳にペーストしてください。

   

   4-2. 次に、テナンシのOCIDを確認します。 右上のメニューをクリックし、「ガバナンスと管理」から「テナンシ詳細」をクリックします。
   OCID はテナンシ情報の最上部に表示されています。
   コピーをクリックすると、OCIDがクリップボードに保存されますので、お手元のメモ帳にペーストしてください。

   

5. OCIに接続するユーザの情報を設定するconfigファイルを作成します。こちらの設定は２回目以降は省略が可能です。

    oci setup config
   

   設定は対話形式で生成されます。次の入力例を参考に各項目を入力ください。

   Location for your config	（そのままでENTER）
   User OCID	＜上記のステップで取得した値＞
   Tenancy OCID	＜上記のステップで取得した値＞
   region	ADBを作成したリージョンの識別子を選択します。 識別子または各識別子に割り振られた番号を入力します。（コマンドラインに表示されます） リージョン識別子の一覧は こちら
   Generate a new RSA Key Pair	Y ※新しいRSAキーペアを作成します。
   directory for your keys to be created	（そのままでENTER）
   name for your key	（そのままでENTER）
   passphrase for your private key	（そのままでENTER）

   

6. API公開キーを確認します。 後ほどユーザ設定でこちらの公開キーを登録するので、お手元のメモ帳にペーストしてください。

    cat ~/.oci/oci_api_key_public.pem
   

   

7. コンソール画面より、OCIユーザーのプロファイルに作成したAPI公開キーを追加します。
   右上のユーザー設定をクリックします。
   APIキーから、公開キーの追加をクリックします。

   

   先程取得したAPI公開キーをペーストし、追加をクリックします。

   

   APIキーを追加すると、ユーザー設定の画面上に新たにフィンガープリントが表示されます。

   

   以下のファイルに記載されているfingerprintの値と一致していることを確認ください。一致していればOKです。

    cat ~/.oci/config
   

   

8. デフォルトのコンパートメントを設定します。設定することで、毎回のコマンド発行時にコンパートメントを指定しないで済みます。

   8-1. メニューからアイデンティティ、コンパートメントをクリックします。 コンパートメント（adb-hol-01）を選択し、コンパートメントのOCIDをコピーしてメモ帳に保存しておきます。

   

   8-2. 仮想マシン上にて以下を実行し、~/.oci/oci_cli_rc というファイルを作成します。

    oci setup oci-cli-rc
   

   8-3. vi で oci_cli_rc ファイル を編集し、コンパートメントIDを追記します。

    vi .oci/oci_cli_rc
   

    [DEFAULT]
   
    compartment-id = <コンパートメントのOCID>
   

   次の操作方法を参考に、上記のフレーズをファイルの最後に追加します。

   

   viの操作方法

   キー入力	動作
   上下左右キー	カーソルの場所を移動する
   i	カーソルの場所から編集する（InsertModeに入る）
   ESCキー	InsertModeを抜ける
   x	カーソルの場所を一文字消す
   :wq	ファイルを保存して閉じる
   :q	ファイルを閉じる（それまでの編集は破棄される）
   :q!	強制的に終了する

2. OCI CLIを使ってみよう

まずはOCI CLIの操作感をみてみましょう。

OCI CLIの基本的なコマンド構成は、サービスの後にリソース・タイプとアクションを指定する構成となっています。

oci <service> <type> <action> <options>

oci compute instance launch --availability-domain "EMIr:PHX-AD-1" -c ocid1.compartment.oc1..aaaaaaaal3gzijdlieqeyg35nz5zxil26astxxhqol2pgeyqdrggnx7jnhwa --shape "VM.Standard1.1"   --display-name "Instance 1 for sandbox" --image-id ocid1.image.oc1.phx.aaaaaaaaqutj4qjxihpl4mboabsa27mrpusygv6gurp47kat5z7vljmq3puq --subnet-id  ocid1.subnet.oc1.phx.aaaaaaaaypsr25bzjmjyn6xwgkcrgxd3dbhiha6lodzus3gafscirbhj5bpa

例えば、上記のようなインスタンスを起動するためのコマンドライン構文では、

• <service>：compute
• <type>：instance
• <action>：launch
• <options>：以降のコマンド文字列

という構成になります。

1. Autonomous Databaseに対してOCI CLIで操作できる内容を確認するために、一覧を表示します。

    oci db autonomous-database --help
   

   このコマンドはdbサービスのautonomous-databaseというリソース・タイプで使用できる内容を一覧表示するものです。

   インスタンスの作成から複製、削除、リストアの実行、インスタンスの停止、起動など、GUIツール（WEB画面）で出来ることは基本的にOCI CLIで実施可能です。 尚、上記のようにociコマンドは各コマンドに続けて “–help” を入力することで、その都度オプションを確認することができます。（$ oci –help 等）

   autonomous-databaseで実行可能なコマンドの一覧は こちら

   

2. 現在作成されているインスタンスの情報を確認するために、一覧を表示します。JSON形式で出力されます。

    oci db autonomous-database list
   

   次のように、作成されたADBインスタンスの情報が一覧表示されます。 さらにオプションを指定することにより、絞り込んで表示することも可能です。

   

   autonomous-databaseのlistコマンドの詳細はこちら

3. OCI CLIでインスタンスを操作しよう

では実際に操作してみましょう。

ここでは、OCPU数の変更、インスタンスの停止、起動、およびインスタンスを新規に作成します。

1. インスタンスのスケールアップ・ダウン（OCPU数の変更）

   ここでは前の章でスケールアップしたインスタンスのOCPUを1に戻してみましょう。
   （OCI CLIであってもオンラインで実施可能です。アプリケーションの停止は不要です。）

   1-1. 対象となるADBインスタンスのOCIDを確認するため、以下のlistコマンドを実行しOCIDを取得します。

    oci db autonomous-database list
   

   id列の値がADBインスタンスのOCIDです。

   

   合わせて、現在のOCPU数 (cpu-core-count) を確認します。

   

   1-2. 下記のコマンドを実行し、OCPUを1に変更します。（＜取得したADBインスタンスのOCID＞を1-1で取得したOCIDに置き換えてください）

    oci db autonomous-database update --autonomous-database-id "＜取得したADBインスタンスのOCID＞" --cpu-core-count 1
   

   lifecycle-state 列が SCALE_IN_PROGRESS になっていればOKです。

   

   しばらく経ってから、GUIツール（WEB画面）、もしくはlistコマンドにてOCPU=1(cpu-core-count=1)にスケールダウンしたことをご確認ください。

   

2. 次にこのインスタンスを停止・起動してみましょう

   2-1. 次のコマンドを実行し、インスタンスの現在のステータスを確認します。

    oci db autonomous-database get --autonomous-database-id "＜取得したADBインスタンスのOCID＞"
   

   lifecycle-state が AVAILABLE になっていることを確認します。

   

   2-2. 以下を実行し、対象のインスタンスを停止します。（＜取得したADBインスタンスのOCID＞を1-1で取得したOCIDに置き換えてください）

    oci db autonomous-database stop --autonomous-database-id "＜取得したADBインスタンスのOCID＞"
   

   しばらく経ってから、GUIツール（WEB画面）、もしくはlistコマンドおよびgetコマンドでインスタンスが停止したかご確認ください。
   停止した場合、lifecycle-state のステータスは STOPPED になります。

   

   2-3. 以下を実行し、対象のインスタンスを起動します。（＜取得したADBインスタンスのOCID＞を1-1で取得したOCIDに置き換えてください）

    oci db autonomous-database start --autonomous-database-id "＜取得したADBインスタンスのOCID＞" 
   

   しばらく経ってから、GUIツール（WEB画面）、もしくはlistコマンドおよびgetコマンドでインスタンスが停止したかご確認ください。 コマンドで確認する場合、lifecycle-state が AVAILABLE に切り替わっていることを確認します。

3. 新たにADBインスタンスを作成してみましょう。

   3-1. 以下の記載例を参考にインスタンスを作成します。

    oci db autonomous-database create --display-name=atpXXb --db-name=atp01b --db-workload=OLTP --cpu-core-count=1 --data-storage-size-in-tbs=1 --admin-password="Welcome12345#" --license-model=LICENSE_INCLUDED
   

   どのようなインスタンスを作成するかはオプションで指定することができます。今回作成するインスタンスの詳細は次の通りです。

   指定したオプション	詳細
   --display-name=atpXXb	データベースの表示名を"atpXXb"で作成する
   --db-name=atp01b	データベース名を"atp01b"で作成する テナンシ内で一意である必要がある
   --db-workload=OLTP	ADBのワークロードタイプ（AJD/APEX/DW/OLTPの中から指定）をOLTPに指定
   --cpu-core-count=1	使用するOCPU数を1に指定
   --data-storage-size-in-tbs=1	作成されたADBに接続されるデータボリュームのサイズを1TBに指定
   --admin-password="Welcome12345#"	adminユーザのパスワードを"Welcome12345#"に指定
   --license-model=LICENSE_INCLUDED	適用するライセンスモデルを、ライセンスを含んで作成する形を指定 BRING_YOUR_OWN_LICENSEおよびLICENSE_INCLUDEDのいずれかを指定可能

   補足

   インスタンスを作成する際に、データベース名と配置するコンパートメントの指定は必須のパラメータです。今回はデフォルトのコンパートメントを指定済みなので必要ありません。

   コマンドが問題なく通ると、インスタンス作成時に指定した情報がJSON形式で出力されます。

   次のようにlifecycle-stateの値が PROVISIONING と表示されていればOKです。

   

   その他、インスタンス作成時のオプションについてはマニュアルを参照ください。 コマンドリファレンスはこちら
   もしくは次のコマンドでも確認できます。

    oci db autonomous-database create --help
   

   しばらく経ってから、インスタンスが問題なく構成されたかをご確認ください。

   GUIツール（WEB画面）にてatp01bという名前のインスタンスが使用可能と表示されているか、もしくは上記2のlistコマンドを実行し、atp01bという名前のインスタンスのlifecycle-state の値がAVAILABLEになっていればOKです。

   以上で、この章の作業は終了です。