管理服務和工作負載

App Hub 可讓您管理直接註冊和探索到的服務與工作負載,確保應用程式中繼資料正確無誤。基礎架構變更時,您可以查看元件詳細資料、更新屬性,或從應用程式取消註冊元件。

如果是從範本部署的應用程式,請在 Application Design Center 更新元件。

總覽

選擇應用程式設定模型時,您會在管理專案中,為 App Hub 應用程式定義應用程式管理邊界。接著,您可以在這個邊界內的應用程式中註冊服務和工作負載。如需導入應用程式管理做法的建議用途,請參閱「準備應用程式生命週期管理」。

為避免設定偏移並維持明確的可靠資料來源,建議您在最初定義應用程式元件的環境中管理這些元件:

事前準備

本文假設您已建立應用程式,並註冊支援的資源。

必要的角色

如要取得在 App Hub 管理服務和工作負載所需的權限,請要求管理員在定義應用程式管理邊界的管理專案中,授予您下列 IAM 角色:

  • 更新及取消註冊服務和工作負載:App Hub 編輯者 (roles/apphub.editor)
  • 查看服務、工作負載和詳細資料:App Hub 檢視者 (roles/apphub.viewer)

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

如要進一步瞭解 App Hub 角色,請參閱「App Hub IAM 角色和權限」。

查看服務和工作負載的詳細資料

請按照下列步驟,查看應用程式管理邊界內的服務和工作負載詳細資料,包括:

如要進一步瞭解這些詳細資料,請參閱「App Hub 概念和資料模型」。

控制台

查看註冊狀態值為 registered 或 detached 的應用程式服務和工作負載詳細資料:

  1. 在 Google Cloud 控制台,使用專案挑選器選取管理專案。

  2. 從 App Hub 前往「Applications」(應用程式) 頁面:

    前往「Applications」(應用程式)

    頁面會顯示應用程式清單。

  3. 按一下要查看 Service 或工作負載詳細資料的應用程式名稱。

  4. 在「Services and workloads」(服務和工作負載) 分頁中,按一下要查看的服務或工作負載名稱。

  5. 在元件的「Details」(詳細資料) 頁面中,您可以查看顯示名稱、位置、註冊狀態、屬性和特徵等資訊。

或者,您也可以查看註冊狀態值為「discovered」(已發現) 或「registered」(已註冊) 的所有服務和工作負載清單:

  1. 從 App Hub 前往「Services and workloads」(服務和工作負載) 頁面:

    前往「Services and workloads」(服務和工作負載)

    頁面會顯示所有已探索和註冊的服務和工作負載清單。

  2. 使用「Filter」(篩選器) 欄位,依屬性、屬性或狀態縮小結果範圍,並使用「Environment」(環境)、「Owners」(擁有者) 或「Registration status」(註冊狀態) 等值。

gcloud

查看註冊狀態值為 registered 或 detached 的應用程式服務和工作負載詳細資料:

  1. 找出管理專案的專案 ID。

  2. 說明應用程式中的服務或工作負載,查看其詳細資料,包括屬性和特徵:

    • 說明服務:

      gcloud apphub applications services describe SERVICE \
          --project=PROJECT_ID \
          --application=APPLICATION \
          --location=LOCATION
      

      更改下列內容:

      • SERVICE:服務的 ID。
      • PROJECT_ID:管理專案的 ID。
      • APPLICATION:服務註冊的應用程式 ID。
      • LOCATION:應用程式的位置。如果是全球性應用程式,請使用 global;如果是多區域應用程式,請使用多區域 (us 或 eu);如果是區域性應用程式,請使用特定區域,例如 us-east1。
    • 說明工作負載:

      gcloud apphub applications workloads describe WORKLOAD \
          --project=PROJECT_ID \
          --application=APPLICATION \
          --location=LOCATION
      

      更改下列內容:

      • WORKLOAD:工作負載的 ID。
      • PROJECT_ID:管理專案的 ID。
      • APPLICATION:工作負載註冊的應用程式 ID。
      • LOCATION:應用程式的位置。如果是全球性應用程式,請使用 global;如果是多區域應用程式,請使用多區域 (us 或 eu);如果是區域性應用程式,請使用特定區域,例如 us-east1。

輸出內容會顯示元件的詳細資料,例如顯示名稱、位置和註冊狀態。如果資源有屬性和特性,也會一併包含。

或者,您也可以查看註冊狀態值為「discovered」(已發現) 或「registered」(已註冊) 的所有服務和工作負載清單:

發現時間

在應用程式管理邊界內探索到的 Google Cloud 資源,可註冊為應用程式中的服務或工作負載。請按照下列步驟列出探索到的資源:

  1. 列出找到的服務:

    gcloud apphub discovered-services list \
        --project=PROJECT_ID \
        --location=LOCATION
    

    更改下列內容:

    • PROJECT_ID:管理專案的 ID。
    • LOCATION:要探索資源的位置。全域資源請使用 global,多區域資源請使用多區域 (us 或 eu),區域資源則請使用特定區域,例如 us-east1。
  2. 列出找到的工作負載:

    gcloud apphub discovered-workloads list \
        --project=PROJECT_ID \
        --location=LOCATION
    

註冊

已註冊的服務和工作負載是應用程式的一部分。請按照下列步驟,列出特定應用程式的註冊元件。您可以使用 --filter 旗標,根據屬性篩選清單:

  1. 列出應用程式中已註冊的服務:

    gcloud apphub applications services list \
        --application=APPLICATION_NAME \
        --project=PROJECT_ID \
        --location=LOCATION \
        --filter=FILTER_EXPRESSION
    

    更改下列內容:

    • APPLICATION_NAME:應用程式名稱。您可以在建立應用程式時指定這個值。
    • PROJECT_ID:管理專案的 ID。
    • LOCATION:應用程式位置。如果是全球性應用程式,請使用 global;如果是多區域應用程式,請使用多區域 (us 或 eu);如果是區域性應用程式,請使用特定區域,例如 us-east1。
    • 選用:FILTER_EXPRESSION:指定屬性的篩選運算式。例如,如要列出環境類型為 PRODUCTION 的元件,請使用 attributes.environment.type=PRODUCTION。
  2. 列出應用程式中已註冊的工作負載:

    gcloud apphub applications workloads list \
        --application=APPLICATION_NAME \
        --project=PROJECT_ID \
        --location=LOCATION \
        --filter=FILTER_EXPRESSION
    

如果將專案或資料夾移出應用程式管理邊界,或刪除基礎資源,應用程式中服務和工作負載的註冊狀態可能會變更為「detached」。卸載的服務和工作負載會保留在應用程式中,直到您取消註冊為止,但 App Hub 無法再管理或監控這些服務和工作負載。詳情請參閱「服務和工作負載的註冊狀態」。

如要將服務或工作負載重新附加至應用程式,您必須再次註冊。

查看擴充中繼資料結構定義

App Hub 會為服務和工作負載加入中繼資料,提升可搜尋性、管理能力,以及與其他系統的整合程度。您可以使用 App Hub API 搜尋可用的中繼資料結構定義,並查看其定義。

請按照下列步驟查看擴充中繼資料屬性的結構定義定義、列出所有可用的結構定義,或取得特定結構定義的詳細資料 (如有)。

如要進一步瞭解擴充中繼資料屬性,請參閱「屬性和屬性」。如需支援的中繼資料類型和結構定義清單,請參閱「擴充中繼資料結構定義」。

gcloud

  • 列出專案和位置中所有可用的擴充中繼資料結構定義:

    gcloud alpha apphub extended-metadata-schemas list \
        --project=PROJECT_ID \
        --location=LOCATION \
    

    更改下列內容:

    • PROJECT_ID:管理專案的 ID。
    • LOCATION:元件位置。全域元件請使用 global,多區域元件請使用多區域 (us 或 eu),區域元件則請使用特定區域,例如 us-east1。
  • 查看特定結構定義的詳細資料:

    gcloud alpha apphub extended-metadata-schemas describe SCHEMA_NAME \
        --project=PROJECT_ID \
        --location=LOCATION \
    

    將 SCHEMA_NAME 替換為結構定義的全名,例如 apphub.googleapis.com/AgentProperties。

Terraform

您可以在 Terraform 中使用資料來源,擷取特定結構定義的詳細資料。以下範例可讓您查看 my-project-id 專案中 us-central1 位置,功能類型為 AGENT 的工作負載 apphub.googleapis.com/AgentProperties 結構定義詳細資料。

data "google_apphub_extended_metadata_schema" "agent_properties" {
  project  = "my-project-id"
  location = "us-central1"
  name     = "apphub.googleapis.com/AgentProperties"
}

更新服務和工作負載屬性

如要修改應用程式中註冊的服務和工作負載屬性,請按照下列步驟操作:

控制台

  1. 在 Google Cloud 控制台,使用專案挑選器選取管理專案。

  2. 從 App Hub 前往「Applications」(應用程式) 頁面:

    前往「Applications」(應用程式)

    頁面會顯示應用程式清單。

  3. 按一下要更新服務或工作負載屬性的應用程式名稱。

  4. 在「Services and workloads」(服務和工作負載) 分頁中,找出要更新的服務或工作負載名稱。

  5. 依序點選「more_vert」more_vert「More」(更多),然後點選「 Edit service」(編輯服務) 或「 Edit workload」(編輯工作負載)。

  6. 在開啟的窗格中,視需要編輯欄位,然後按一下「儲存」。

gcloud

  1. 找出管理專案的專案 ID。

  2. 更新服務或工作負載屬性:

    • 更新服務屬性:

      gcloud apphub applications services update SERVICE_NAME \
          --application=APPLICATION_NAME \
          --project=PROJECT_ID \
          --location=LOCATION \
          --display-name=DISPLAY_NAME \
          --criticality-type=CRITICALITY_LEVEL \
          --environment-type=ENVIRONMENT \
          --developer-owners=display-name=DEV_NAME,email=DEV_EMAIL \
          --operator-owners=display-name=OPERATOR_NAME,email=OPERATOR_EMAIL \
          --business-owners=display-name=BUSINESS_NAME,email=BUSINESS_EMAIL
      

      將 SERVICE_NAME 替換為要更新的服務名稱。

    • 更新工作負載屬性:

      gcloud apphub applications workloads update WORKLOAD_NAME \
          --application=APPLICATION_NAME \
          --project=PROJECT_ID \
          --location=LOCATION \
          --display-name=DISPLAY_NAME \
          --criticality-type=CRITICALITY_LEVEL \
          --environment-type=ENVIRONMENT \
          --developer-owners=display-name=DEV_NAME,email=DEV_EMAIL \
          --operator-owners=display-name=OPERATOR_NAME,email=OPERATOR_EMAIL \
          --business-owners=display-name=BUSINESS_NAME,email=BUSINESS_EMAIL
      

      將 WORKLOAD_NAME 替換為要更新的工作負載名稱。

      替換下列必要和選用旗標:

      • 必要:APPLICATION_NAME:應用程式名稱。您可以在建立應用程式時指定這個值。
      • 必要:PROJECT_ID:管理專案的 ID。
      • 必要:LOCATION:應用程式位置。如果是全球性應用程式,請使用 global;如果是多區域應用程式,請使用多區域 (us 或 eu);如果是區域性應用程式,請使用特定區域,例如 us-east1。
      • 選用:DISPLAY_NAME:元件的顯示名稱。
      • 選用:CRITICALITY_LEVEL:元件的重要性等級。請使用下列其中一個值:

        • MISSION_CRITICAL
        • HIGH
        • MEDIUM
        • LOW
      • 選用:ENVIRONMENT:軟體生命週期的階段。請使用下列其中一個值:

        • PRODUCTION
        • STAGING
        • DEVELOPMENT
        • TEST
      • 選用:DEV_NAME 和 DEV_EMAIL:分別是開發人員擁有者的顯示名稱和電子郵件地址。

      • 選用:OPERATOR_NAME 和 OPERATOR_EMAIL:分別是運算子擁有者的顯示名稱和電子郵件地址。

      • 選用:BUSINESS_NAME 和 BUSINESS_EMAIL:分別是業主的顯示名稱和電子郵件地址。

Terraform

如要使用 Terraform 更新服務或工作負載屬性,請修改設定檔中對應 google_apphub_service 或 google_apphub_workload 資源區塊內的引數。套用變更後,Terraform 會更新資源,使其符合新設定。

下列範例會更新區域性應用程式服務和工作負載的重要性和環境屬性:

  • 更新服務屬性:

    resource "google_apphub_service" "example" {
        # ... other arguments
        attributes {
            criticality {
                type = "HIGH" # Updated criticality
            }
            environment {
                type = "PRODUCTION"
            }
            # ... other attributes
        }
    }
    
  • 更新工作負載屬性:

    resource "google_apphub_workload" "example" {
        # ... other arguments
        attributes {
            criticality {
                type = "HIGH" # Updated criticality
            }
            environment {
                type = "PRODUCTION"
            }
            # ... other attributes
        }
    }
    

取消註冊服務和工作負載

取消註冊服務或工作負載,會將其從應用程式中移除。基礎資源不會遭到刪除。如果該資源仍在應用程式管理邊界內,註冊狀態值會變成「discovered」,可註冊至其他應用程式。

請按照下列步驟,取消註冊服務和工作負載:

控制台

  1. 在 Google Cloud 控制台,使用專案挑選器選取管理專案。

  2. 從 App Hub 前往「Applications」(應用程式) 頁面:

    前往「Applications」(應用程式)

    頁面會顯示應用程式清單。

  3. 按一下要取消註冊服務或工作負載的應用程式名稱。

  4. 在「Services and workloads」(服務和工作負載) 分頁中,按一下要取消註冊的服務或工作負載名稱。

  5. 在元件的詳細資料頁面中,按一下「取消註冊」。

gcloud

  1. 找出管理專案的專案 ID。

  2. 取消註冊服務或工作負載:

    • 取消註冊服務:

      gcloud apphub applications services delete SERVICE_NAME \
          --application=APPLICATION_NAME \
          --project=PROJECT_ID \
          --location=LOCATION
      

      更改下列內容:

      • SERVICE_NAME:要取消註冊的服務名稱。
      • APPLICATION_NAME:應用程式名稱。您可以在建立應用程式時指定這個值。
      • PROJECT_ID:管理專案的 ID。
      • LOCATION:應用程式位置。如果是全球應用程式,請使用 global;如果是多區域應用程式,請使用多區域 (us 或 eu);如果是區域應用程式,請使用特定區域,例如 us-east1。
    • 取消註冊工作負載:

      gcloud apphub applications workloads delete WORKLOAD_NAME \
          --application=APPLICATION_NAME \
          --project=PROJECT_ID \
          --location=LOCATION
      

      將 WORKLOAD_NAME 替換為要取消註冊的工作負載名稱。

Terraform

如要取消註冊由 Terraform 管理的服務或工作負載,請從設定檔中移除對應的 google_apphub_service 或 google_apphub_workload 資源區塊,然後執行 terraform apply。套用變更後,Terraform 會從 App Hub 移除註冊。

取消註冊所有服務和工作負載後,即可刪除應用程式。

後續步驟