設定 CLI

使用 IBM Cloud Schematics 指令行外掛程式來自動化基礎架構佈建程序、資源配置及應用程式工作負載部署。 IBM Cloud® Schematics 指令行支援下列平台架構:

  • Mac OS X 64 位元
  • Mac OS arm64
  • Windows™ 64 位元
  • Windows™ 32 位元
  • Linux™ 64 位元
  • Linux™ arm64
  • Linux™ 32 位元
  • PowerLinux™ 64 位元
  • System/390 Linux™ 64 位元

安裝 IBM Cloud 指令行

安裝必要的指令行以開始使用 IBM Cloud Schematics。

  1. 安裝 IBM Cloud CLI

    打算經常使用命令列? 嘗試 為IBM Cloud命令列啟用 shell 自動完成(僅限Linux/MacOS )

  2. 登入 IBM Cloud CLI。 系統提示時,請輸入您的 IBM Cloud 認證。

    ibmcloud login
    

    如果您具有聯合 ID,請使用 ibmcloud login --sso 來登入 IBM Cloud CLI。 輸入您的使用者名稱,並在命令列輸出中使用所提供的 URL 擷取您的一次性密碼。 若沒有 --sso 時登入失敗,而有 --sso 選項時登入順利,即表示您有聯合 ID。

安裝 IBM Cloud Schematics 指令行外掛程式

安裝 IBM Cloud Schematics 外掛程式以自動化雲端作業、配置管理及基礎架構部署。 您也可以在 Cloud Shell中安裝 Schematics 外掛程式。

  1. 安裝 Schematics的 IBM Cloud 指令行外掛程式。

    ibmcloud plugin install schematics
    
  2. 確認 IBM Cloud Schematics 指令列外掛程式已成功安裝。 外掛程式列出為 schematics

    ibmcloud plugin list
    

    輸出範例

    Listing installed plug-ins...
    
    Plugin Name                             Version      Status             Private endpoints supported
    schematics[sch]                           1.12.28   Update Available                     true
    
  3. 列出所有支援的指令,確認您可以使用 Schematics 指令列外掛程式。 使用 Schematics 命令列外掛程式的命令前綴是 ibmcloud schematics

    ibmcloud schematics help
    

    輸出範例

    NAME:
    ibmcloud schematics - Automate the deployment and management of IBM Cloud resources using Infrastructure as Code
    
    USAGE:
    ibmcloud schematics command [arguments...] [command options]
    
    COMMANDS:
    action, ac           Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables.
    agent, ag            Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents.
    apply                Apply a plan to an workspace to deploy the latest version of your configuration.
    destroy              Destroy resources in an existing workspace. This action cannot be reversed.
    inventory, iv        Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's
    job, j               Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving.
    kms                  listing and enabling IBM Cloud Schematics kms instances and root keys.
    logs                 Show details about actions that ran against an workspace.
    output               Get all the output values from your workspace; (ex. result of terraform output command
    plan                 Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration.
    policy, plcy         Create and manage policies. Policies tell Schematics which agent it should use to execute Terraform and Ansible jobs in a specific network zone.
    refresh              Refresh the workspace with latest version of your workspace configuration.
    resource-query, rq   Create and manage Schematics Resource Query. Resource query let you define conditions to fetch host group that can be used to perform actions
    state                Advanced state management
    version              Report version information about the IBM Cloud Schematics CLI.
    workspace, ws        Create and manage workspaces. Workspaces let you define the source control repository that contains your Terraform configuration and pass workspace-specific variables.
    help, h              Show help
    
    Enter 'ibmcloud schematics help [command]' for more information about a command.
    

更新 CLI

定期更新 IBM Cloud 指令列和 Schematics 指令列外掛程式,以存取新功能。

  1. 更新 IBM Cloud CLI

  2. 登入 IBM Cloud CLI。 系統提示時,請輸入您的 IBM Cloud 認證。

    ibmcloud login
    

    如果您具有聯合 ID,請使用 ibmcloud login --sso 來登入 IBM Cloud CLI。 輸入您的使用者名稱,並在命令列輸出中使用所提供的 URL 擷取您的一次性密碼。 若沒有 --sso 時登入失敗,而有 --sso 選項時登入成功,即表示您有聯合 ID。

  3. 檢查 Schematics 指令列外掛程式是否有更新。 如果更新可用,您會在命令列輸出中找到「更新可用」通知。

    ibmcloud plugin list | grep schematics
    

    輸出範例

    schematics                      1.12.28        Update Available           false
    
  4. 更新 Schematics 指令行外掛程式。

    對於 Schematics 代理程式,Schematics 外掛程式版本必須大於 1.12.12 版本。

    ibmcloud plugin update schematics
    
    ibmcloud plugin list | grep schematics
    

    輸出範例

    schematics[sch]                      1.12.29        true
    
  5. 顯示 Schematics 外掛程式。

    ibmcloud plugin show schematics
    

    輸出範例

    Plugin Name              Version   Status   Private endpoints supported
    schematics[sch]          1.12.29            true
    
    Commands:
    schematics,sch                                 Automate the deployment and management of IBM Cloud resources using Infrastructure as Code
    schematics,sch plan                            Create a plan for an workspace. Plans show how resources would change if you applied the latest version of your workspace configuration.
    schematics,sch version                         Report version information about the IBM Cloud Schematics CLI.
    schematics,sch logs                            Show details about actions that ran against an workspace.
    schematics,sch output                          Get all the output values from your workspace; (ex. result of terraform output command
    schematics,sch destroy                         Destroy resources in an existing workspace. This action cannot be reversed.
    schematics,sch refresh                         Refresh the workspace with latest version of your workspace configuration.
    schematics,sch apply                           Apply a plan to an workspace to deploy the latest version of your configuration.
    schematics,sch job,j                           Create and manage Schematics jobs. Job let you manage all the jobs like creating/deleting/updating/retrieving.
    schematics,sch job,j run                       Run a job in IBM Cloud Schematics to work with your Schematics entities like workspaces/actions.
    schematics,sch job,j get                       Get information about a job.
    ....
    schematics,sch workspace,ws upload             Upload a tar file to a workspace from the IBM Cloud Schematics service.
    schematics,sch workspace,ws commands           Run one or more terraform commands
    schematics,sch workspace,ws taint              Marks a Terraform-managed resource as tainted, forcing it to be destroyed and recreated on the next apply
    schematics,sch workspace,ws untaint            Unmarks a Terraform-managed resource as tainted, restoring it as the primary instance in the state
    schematics,sch workspace,ws state              Advanced state management
    schematics,sch workspace,ws import             Run a job to import existing resources into workspace
    schematics,sch inventory,iv                    Create and manage Schematics Inventories. Inventory let you define host group that can contain INI or Resource Query id's
    schematics,sch inventory,iv create             Create an Inventory in IBM Cloud Schematics to pass to Schematics action for target host groups
    schematics,sch inventory,iv update             Update an Inventory in IBM Cloud Schematics with all new detail
    schematics,sch inventory,iv get                Get information about an inventory
    schematics,sch inventory,iv list               List all existing inventories in targeted account
    schematics,sch inventory,iv delete             Delete an inventory from the IBM Cloud Schematics service
    schematics,sch agent,ag                        Create and manage agents. Visit 'https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro' to know more about agents.
    schematics,sch agent,ag create                 Create an agent in IBM Cloud Schematics.
    schematics,sch agent,ag validate,plan          Run validate to create a prerequisite scan that analyses agent and cluster configuration before deploying your agent.
    schematics,sch agent,ag deploy,apply           Run deploy to deploy your agent on the configured cluster.
    schematics,sch agent,ag get                    View the details of an agent.
    schematics,sch agent,ag list                   List all agents in your IBM Cloud account.
    schematics,sch agent,ag update                 Update your agent details. Updating agent does not re-validate or re-deploy your agent.
    schematics,sch agent,ag health                 Run health to perform a health check on your deployed agent.
    schematics,sch agent,ag delete                 Delete an agent.
    schematics,sch agent,ag destroy                Destroy the resources associated with agent deployment
    schematics,sch action,ac                       Create and manage Schematics actions. Action let you define the source control repository that contains your playbook yamls etc. and pass environment-specific variables.
    schematics,sch action,ac create                Create an action in IBM Cloud Schematics to work with your Ansible configuration in source control.
    schematics,sch action,ac get                   Get information about an action.
    schematics,sch action,ac list                  List all existing actions in this account.
    schematics,sch action,ac delete                Delete an action from the IBM Cloud Schematics service.
    schematics,sch action,ac update                Update the details of an existing action.
    schematics,sch action,ac upload                Upload TAR file to an action from the IBM Cloud Schematics service
    

解除安裝 IBM Cloud Schematics 指令行外掛程式

解除安裝 IBM Cloud Schematics 外掛程式,以從本端系統移除 Schematics 外掛程式。

  1. 解除安裝 Schematics的 IBM Cloud 指令行外掛程式。

    ibmcloud plugin uninstall schematics
    

    輸出範例

    Uninstalling plug-in 'schematics'...
    OK
    Plug-in 'schematics' was successfully uninstalled.
    
  2. 驗證已順利解除安裝 IBM Cloud Schematics 指令行外掛程式。

    ibmcloud plugin list | grep schematics