CLI のセットアップ

IBM Key Protect CLI プラグインを使用して、暗号鍵の作成、インポート、および管理に役立てることができます。

Key Protect CLI プラグインの使用について詳しくは、 Key Protect CLI リファレンス資料を参照してください。

Key Protect CLI プラグインのインストール

Key Protect CLI プラグインをセットアップする前に、以下をインストールします。 IBM Cloud CLI

CLI をインストールするには、以下の手順を実行します。

  1. のインストール IBM Cloud CLI

    CLI のインストール後、ibmcloud コマンドを実行して、クラウド・サービスと対話できます。

  2. IBM Cloud にログインします。

    ibmcloud login
    

    ログインに失敗した場合は、ibmcloud login --ssoコマンドを実行して再試行してください。 この --sso パラメータは、連携 ID でログインする場合に必要です。 このオプションを使用する場合、CLI 出力にリストされているリンクに移動して、ワンタイム・パスコードを生成します。

  3. 暗号鍵の管理を開始するには、Key Protect CLI プラグインをインストールします。

    ibmcloud plugin install key-protect -r "IBM Cloud"
    
  4. 特定の Key Protect エンドポイントをターゲットにするために、リージョンを設定します。

    ibmcloud kp region-set -i <INSTANCE_ID>
    

    <INSTANCE_ID>を Key Protect を表すインスタンス ID に置き換えます。 リージョンの選択方法など、インスタンスについて詳しくは、Key Protect サービスのプロビジョニングを参照してください。

    結果として表示されたリストから選択するように求められます。

    Select a Region:
        1. au-syd
        2. eu-de
        3. eu-gb
        4. jp-osa
        5. jp-tok
        6. us-east
        7. us-south
        8. staging (us-south)
        Enter a number:
    
  5. インスタンスのエンドポイントを設定する:

    export KP_TARGET_ADDR=<KEY_PROTECT_INSTANCE_ENDPOINT>   
    

    <KEY_PROTECT_INSTANCE_ENDPOINT> 、インスタンスIDのエンドポイントに置き換えてください。 以下に例を示します。

    export KP_TARGET_ADDR=https://fadedbee-0000-0000-0000-1234567890ab.api.us-south.kms.appdomain.cloud   
    

Key Protect のインスタンスエンドポイントは、特定のインスタンスの IBM Cloud UI コンソールで見つけることができます。

  1. オプション: プラグインが正常にインストールされたことを確認します。

    ibmcloud plugin list
    

Key Protect CLI プラグインの更新

ベスト・プラクティスとして、新機能を使用できるように定期的に CLI を更新してください。

CLI を更新するには、以下のようにします。

  1. 以下を使用して IBM Cloud にログインします。 IBM Cloud CLI

    ibmcloud login
    

    ログインに失敗した場合は、ibmcloud login --ssoコマンドを実行して再試行してください。 この --sso パラメータは、連携 ID でログインする場合に必要です。 このオプションを使用する場合、CLI 出力にリストされているリンクに移動して、ワンタイム・パスコードを生成します。

  2. プラグイン・リポジトリーから更新をインストールします。

    ibmcloud plugin update key-protect
    
  3. オプション: プラグインが正常に更新されたことを確認します。

    ibmcloud plugin list
    

    結果には、プラグインのバージョンと状況、およびプラグインに関するプロパティー (「プライベート・エンドポイント」がサポートされているかどうかなど) が表示されます。

    
    Plugin Name                             Version   Status             Private endpoints supported   
    cloud-functions[wsk/functions/fn]       1.0.49    Update Available   false   
    cloud-object-storage                    1.2.4     Update Available   false   
    container-registry                      0.1.541   Update Available   true   
    container-service[kubernetes-service]   1.0.233   Update Available   false   
    key-protect                             0.6.8                        true   
    sdk-gen                                 0.1.12                       false   
    

Key Protect CLI プラグインのアンインストール

  1. 以下を使用して IBM Cloud にログインします。 IBM Cloud CLI

    ibmcloud login
    

    ログインに失敗した場合は、ibmcloud login --ssoコマンドを実行して再試行してください。 この --sso パラメータは、連携 ID でログインする場合に必要です。 このオプションを使用する場合、CLI 出力にリストされているリンクに移動して、ワンタイム・パスコードを生成します。

  2. プラグイン・リポジトリーから更新をインストールします。

    ibmcloud plugin uninstall key-protect
    
  3. オプション: プラグインが正常にアンインストールされたことを確認します。

    ibmcloud plugin list