建立代理程式定義

1. 登入 IBM Cloud控制台。
2. 點選選單圖示> Platform Automation > Schematics > Extensions > Create Agent。
   • 在 定義代理程式詳細資料 區段中:
     • 請輸入一個唯一的代理名稱。
     • 選擇地點和資源組從下拉選項中。
     • 輸入代理程式的 標籤及 說明。
   • 在 指派給叢集 區段中:
     • 選取 IBM Cloud Kubernetes Service 或 Red Hat OpenShift 服務。
     • 選取叢集名稱。
     • 在 定義 COS 實例 中
       • 請輸入 COS 實例名稱
       • 請輸入 COS 儲存桶名稱
       • 輸入 COS 儲存區地區
3. 按一下「定義」。
4. 按一下 驗證 以驗證叢集及 IBM Cloud Object Storage 配置。
5. 按一下 部署 以部署代理程式。

透過 CLI 建立代理定義

第一步，您必須在 IBM Cloud 帳戶中建立一個代理程式定義，其中包含用於部署代理程式的組態。 如需 agent create 選項的完整清單，請參閱 ibmcloud schematics agent create 指令。

選擇IBM Cloud您想要定義和管理代理的區域。 執行 ibmcloud target -r <region>，以設定 CLI region 指令。 該區域必須與 location 指定於 agent create 命令。 IBM Cloud Object Storage 儲存區位置的格式必須是 eu-gb 或 us-south，而不是城市名稱。

範例 agent create 語法。 < > 之間的文字必須新增您的值:

ibmcloud schematics agent create --name <agent-ga-prod-cli-jan-10> --location <us-south> --agent-location <us-south> --version <1.0.0> --infra-type <ibm_kubernetes> --cluster-id <cg3fgvad0dak571xxx> --cluster-resource-group <Default> --cos-instance-name <agent-cos-instance> --cos-bucket <agent-cos-bucket> --cos-location <us-east> --resource-group <Default>

輸出

Creating agent...
OK
ID               agent-ga-prod-cli-jan-10.soA.cd1c
Name             agent-ga-prod-cli-jan-10
Status           Defined
Version          1.0.0
Location         us-south
Agent Location   us-south
Resource Group   aac37f57b20142dba1a435c70aeb12df
Metadata         [Metadata]
                 - [git]
                 - [github.com]

記錄 Agent ID 以在後續指令中使用。 若要顯示代理程式詳細資料，您可以使用 agent get 指令。

範例

ibmcloud schematics agent get --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Retrieving agent...
OK
ID               agent-ga-prod-cli-jan-10.soA.cd1c
Name             agent-ga-prod-cli-jan-10
Status           ACTIVE
Version          1.0.0
Location         us-south
Agent Location   us-south
Resource Group   Default
Metadata         [Metadata]
                 - [git]
                 - [github.com]

透過 CLI 驗證代理部署的先決條件

您可以使用代理程式驗證指令來驗證代理程式定義及叢集可用性。 驗證對目標代理基礎架構進行先決條件檢查。 此指令會採用 Agent ID 作為 agent create 指令所傳回的輸入。 代理驗證指令的輸出顯示相關列表Kubernetes和代理屬性名稱、期望值、實際值和結果：PASS 或者 FAIL。

範例

ibmcloud schematics agent validate --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Initiating agent validate...
Job ID	.ACTIVITY.600cadf9
Polling status...
Status	job_pending
Status	job_in_progress
Status	job_in_progress
Status	job_in_progress
Status	job_finished

範例

ibmcloud schematics agent get --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Retrieving agent...
OK
ID               agent-ga-prod-cli-jan-10.soA.cd1c
Name             agent-ga-prod-cli-jan-10
Status           ACTIVE
Version
Location         us-south
Agent Location   us-south
Resource Group   Default
Recent Job   Job ID                             Status                  Last modified
DEPLOY       -                                  Deploy in progress      2024-01-10T09:54:32.607Z
VALIDATE     8b168c1e0e4b35708e95c2af9a99d9d4   Successful validation   2024-01-10T09:53:48.435Z

透過 CLI 部署代理

您可以使用代理程式定義，以 agent deploy 指令來部署代理程式。 agent deploy 指令會採用 Agent ID 作為輸入。 您可以使用以下命令升級現有部署 force deploy 選項。

代理程式部署需要數分鐘才能完成。

ibmcloud schematics agent deploy --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Initiating agent deploy...
Job ID	.ACTIVITY.465e9716

範例

ibmcloud schematics agent get --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Retrieving agent...
OK
ID               agent-ga-prod-cli-jan-10.soA.cd1c
Name             agent-ga-prod-cli-jan-10
Status           ACTIVE
Version          1.0.0
Location         us-south
Agent Location   us-south
Resource Group   Default
Recent Job   Job ID               Status                 Last modified
DEPLOY       .ACTIVITY.465e9716   Triggered deployment   2024-01-10T10:20:48.435Z
VALIDATE     8b168c1e0e4b35708e   Successful validation   2024-01-10T09:53:48.435Z

透過 CLI 驗證代理部署

您可以使用 agent health 指令來驗證最近部署代理程式的性能。 該指令會採用 Agent ID 作為輸入。 輸出會顯示相關 Kubernetes 的清單，其中包含代理程式性能內容名稱、期望值、實際值，以及結果 PASS 或 FAIL。

範例

ibmcloud schematics agent health --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Initiating agent health...
Job ID	.ACTIVITY.f6f77588

範例

ibmcloud schematics agent get --id agent-ga-prod-cli-jan-10.soA.cd1c

輸出

Retrieving agent...
OK
ID               agent-ga-prod-cli-jan-10.soA.cd1c
Name             agent-ga-prod-cli-jan-10
Status           ACTIVE
Version
Location         us-south
Agent Location   us-south
Resource Group   Default
Recent Job   Job ID                             Status                   Last modified
DEPLOY       f5c6987ce53032547b6d5d5f870dfe5f   Job Success               0001-01-01T00:00:00.000Z
HEALTH       .ACTIVITY.f6f77588                 Triggered health check   2023-03-27T12:31:15.326Z

此外，您還可以使用KubernetesCLI (kubectl) 或Kubernetes叢集的儀表板，用於查看命名空間中與代理相關的微服務、pod、部署、configmap 和叢集綁定的狀態和日誌，schematics-agent-observe,schematics-sandbox,schematics-runtime 和 schematics-job-runtime。

透過API建立代理

遵循 步驟 以建立 IAM 存取記號，並透過 API 向 Schematics 進行鑑別。 如需相關資訊，請參閱使用 API 來 建立代理程式。

範例

  POST /v2/agents HTTP/1.1
  Host: schematics.cloud.ibm.com
  Content-Type: application/json
  Authorization: Bearer
  {
    "name": "agentb1-gsmforvpc",
    "description": "Create Agent",
    "resource_group": "Default",
    "tags": [
        "env:prod",
        "mytest"
    ],
    "version": "v1.0.0",
    "schematics_location": "eu-de",
    "agent_location": "Frankfurt MZR",
    "agent_infrastructure": {
        "infra_type": "ibm_kubernetes",
        "cluster_id": "cg3fgvad0dak571op4g0",
        "cluster_resource_group": "Default",
        "cos_instance_name": "agent-cos-instance",
        "cos_bucket_name": "agent-cos-bucket"
    },
    "user_state": {
        "state": "enable"
    }
}

驗證已順利建立代理程式定義，如輸出中所示。 記錄要在後續指令中使用的代理程式 ID。 例如，agentb1-gsmforvpc.soA.115c。

輸出

  {
      "name": "agentb1-gsmforvpc",
      "description": "Create Agent",
      "resource_group": "aac37f57b20142dba1a435c70aeb12df",
      "tags": [
          "env:prod",
          "mytest"
      ],
      "version": "v1.0.0",
      "schematics_location": "eu-de",
      "agent_location": "Frankfurt MZR",
      "user_state": {
          "state": "enable",
          "set_by": "xxxx@in.ibm.com",
          "set_at": "2023-03-16T18:08:18.399224788Z"
      },
      "agent_crn": "crn:v1:bluemix:public:schematics:eu-de:a/1f7277194bb748cdxxxxxxxxxxx42-0d59-415c-a6ce-0b662f520a4d:agent:agentb1-gsmforvpc.soA.115c",
      "id": "agentb1-gsmforvpc.soA.115c",
      "created_at": "2023-03-16T18:08:18.39924616Z",
      "creation_by": "xxxxx@in.ibm.com",
      "updated_at": "0001-01-01T00:00:00Z",
      "system_state": {
          "status_code": "draft"
      },
      "agent_kpi": {}
  }

現在，使用 agent ID 執行 agent deploy API，以建立用於部署代理程式的 Schematics 工作區。 agent deploy 作業會同時啟動 agent validate 及 agent deploy 作業，以設定代理程式。

語法

  PUT /v2/agents/<enter your agentID>/deploy HTTP/1.1
  Host: schematics.cloud.ibm.com
  Content-Type: application/json
  Authorization: Bearer

範例

  PUT /v2/agents/agentb1-gsmforvpc.soA.115c/deploy HTTP/1.1
  Host: schematics.cloud.ibm.com
  Content-Type: application/json
  Authorization: Bearer

輸出

{
    "workspace_id": "eu-de.workspace.agentb1-gsmforvpc-deploy.1xxxxdf",
    "job_id": ".ACTIVITY.7f40fdc0",
    "updated_at": "2023-03-16T18:13:27.217864196Z",
    "updated_by": "xxxx@in.ibm.com",
    "status_code": "PENDING",
    "status_message": "Triggered deployment"
}

透過 Terraform 建立代理

若要使用 Terraform 建立 Schematics Agent 部署，請在 Terraform 配置檔案中定義 ibm_schematics_agent_deploy 資源。 請依照以下步驟建立「Schematics」代理程式。 您可以選擇參閱 terraform-ibm-schematics-agent 模組，以取得相關的基礎架構程式碼和使用範例。

1. 安裝 Terrafrom CLI。

2. 設定 IBM Cloud Provider Plug-in for Terraform 外掛程式。

3. 測試您的設定。

4. 在 main.tf 檔案中定義 ibm_schematics_agent 資源。

   resource "ibm_schematics_agent" "schematics_agent_instance" {
   agent_infrastructure {
           infra_type = "ibm_kubernetes"
           cluster_id = "cluster_id"
           cluster_resource_group = "cluster_resource_group"
           cos_instance_name = "cos_instance_name"
           cos_bucket_name = "cos_bucket_name"
           cos_bucket_region = "cos_bucket_region"
   }
   agent_location = "us-south"
   agent_metadata {
           name = "purpose"
           value = ["git", "terraform", "ansible"]
   }
   description = "Create Agent"
   name = "MyDevAgent"
   resource_group = "Default"
   schematics_location = "us-south"
   tags = ["agent-MyDevAgent"]
   version = "1.0.0"
   }
   

   或使用 Terraform IBM 模組進行示意圖代理，如圖所示：

   module "schematics_agent" {
       source                      = "terraform-ibm-modules/schematics-agent/ibm"
       version                     = "1.4.0"
       infra_type                  = "ibm_openshift"
       cluster_id                  = "cluster-id"
       cluster_resource_group_name = "Default"
       cos_instance_name           = "cos-instance-name"
       cos_bucket_name             = "cos-bucket-name"
       cos_bucket_region           = "cos-bucket-region"
       agent_location              = "us-south"
       agent_description           = "schematics agent description"
       agent_name                  = "k8s-schematics-agent"
       agent_resource_group_name   = "Default"
       schematics_location         = "us-south"
       agent_version               = "1.5.0"
   }
   

5. 起始設定

   terraform init
   

6. 套用

   terraform apply
   

7. 使用 ibm_schematics_agent_deploy 資源部署代理。

   resource "ibm_schematics_agent_deploy" "schematics_agent_deploy_instance" {
   agent_id = "agent_id"
   }
   

您可以查看 IBM Cloud Provider Plug-in for Terraform 說明文件，以取得更多資源的特定參數。