設定 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 的 endopoint。 例如:

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

您可以在 IBM Cloud UI 主控台中找到特定實例的 Key Protect 的實例端點。

  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