将现有 Google Cloud 资源注册为 App Hub 应用中的服务和工作负载,您可以根据业务用途整理资源,从而简化管理。这种方法可提供统一的可见性、监控、治理和运营控制。
本指南介绍了如何对尚未正式定义为应用的现有 Google Cloud 资源进行分组。
准备工作
您必须先完成应用管理的初始设置,然后才能将资源整理到应用中。此过程通常涉及以下角色和步骤:
对于管理员:
对于开发者和运维人员:
- 请与您的管理员确认初始设置已完成。
- 确保您拥有执行所需任务所需的 IAM 角色。
- 在 Google Cloud 控制台中打开您的管理项目,或查找管理项目的项目 ID,以便与 Terraform 或 Google Cloud CLI 进行交互。
创建应用
在 App Hub 中创建一个应用,作为现有 Google Cloud 资源的逻辑容器:
控制台
在 Google Cloud 控制台中,使用项目选择器选择管理项目。
从 App Hub 进入应用页面:
点击 创建应用。
在应用详情标签页中,根据您的地理分布要求为应用选择最佳位置:
- 选择全球以创建全球应用。
- 选择多区域以创建多区域应用。然后,为您的应用选择受支持的多区域(
us或eu)。 - 选择区域级以创建区域级应用。然后,根据 App Hub 支持的区域为您的应用选择特定区域。
如需详细了解适合您应用的最佳位置,请参阅全球、多区域和区域应用。
输入应用的名称。
此名称是唯一标识符,只能包含小写字母、数字或连字符。创建应用后,您将无法更改此名称。
(可选)为应用添加显示名称和说明。
这些不是唯一标识符,您可以在创建应用后更改它们。
点击继续。
在应用资源标签页中,浏览基础架构资源,然后选中要注册为应用的服务和工作负载的资源对应的复选框。
您一次最多可以选择 10 项资源。
点击继续。
在属性和所有者标签页中,您可以为应用添加属性,例如重要性、环境和应用所有者。
您可以选择为要注册到应用的资源使用相同的属性和所有者,也可以稍后定义这些属性和所有者。
点击创建。
创建应用后,应用页面会显示其详细信息,包括您注册为服务和工作负载的资源。创建应用后,您可以向其注册更多服务和工作负载。
gcloud
使用 Google Cloud CLI 从终端或 Cloud Shell 创建应用:
gcloud apphub applications create APPLICATION_NAME \ --project=PROJECT_ID \ --scope-type=SCOPE_TYPE \ --location=LOCATION \ --display-name=DISPLAY_NAME \ --criticality-type=CRITICALITY \ --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将
APPLICATION_NAME替换为应用的名称。此名称是唯一标识符,只能包含小写字母、数字或连字符。使用可选标志(例如
--criticality-type)定义应用的顶级属性,并支持可检测性和治理。对于必需和可选标志,请替换以下内容:
- 必需:
PROJECT_ID:管理项目的 ID。 必需:
SCOPE_TYPE:根据您的地理分布要求,为您的应用选择位置。使用以下任一值:REGIONAL(对于区域级应用)。MULTI_REGIONAL(适用于多区域应用)。GLOBAL,适用于全球应用。
如需详细了解适合您应用的最佳位置,请参阅全球、多区域和区域应用。
必需:
LOCATION:应用的特定位置。请使用以下某个值:- 如果应用的
--scope-type位置设置为REGIONAL,请指定 App Hub 支持的区域名称。 - 如果应用的
--scope-type位置设置为MULTI_REGIONAL,请指定us或eu。 - 如果应用的
--scope-type位置设置为GLOBAL,请使用global。
- 如果应用的
可选:
DISPLAY_NAME:应用的显示名称。显示名称不是唯一标识符,您可以在创建应用后更改它。可选:
CRITICALITY:应用对您的运营的重要性级别。请使用以下某个值:MISSION_CRITICALHIGHMEDIUMLOW
可选:
ENVIRONMENT:软件生命周期的阶段。请使用以下某个值:PRODUCTIONSTAGINGDEVELOPMENTTEST
可选:
DEV_NAME和DEV_EMAIL:分别为开发者所有者的显示名称和电子邮件地址。可选:
OPERATOR_NAME和OPERATOR_EMAIL:分别是运营商所有者的显示名称和电子邮件地址。可选:
BUSINESS_NAME和BUSINESS_EMAIL:分别为企业主的显示名称和电子邮件地址。
- 必需:
列出项目中的应用:
gcloud apphub applications list \ --project=PROJECT_ID \ --location=LOCATION您应该会看到类似如下所示的输出:
ID DISPLAY_NAME CREATE_TIME APPLICATION_NAME DISPLAY_NAME 2023-10-31T18:33:48
Terraform
如需使用 Terraform 创建应用,请使用 google_apphub_application 资源。此资源可让您定义应用的属性,包括其名称、位置和属性。
以下示例在 us-central1 中创建了一个区域级应用,并定义了重要性、环境和所有者属性:
resource "google_apphub_application" "example" {
project = "my-project-id"
location = "us-central1"
application_id = "my-application"
display_name = "My Application"
description = "This application represents our platform."
scope {
type = "REGIONAL"
}
attributes {
criticality {
type = "MISSION_CRITICAL"
}
environment {
type = "PRODUCTION"
}
business_owners {
display_name = "Alice"
email = "alice@example.com"
}
developer_owners {
display_name = "Bob"
email = "bob@example.com"
}
operator_owners {
display_name = "Charlie"
email = "charlie@example.com"
}
}
}
注册服务和工作负载
借助 App Hub,您可以选择位于应用管理边界内的受支持资源,将其注册为服务和工作负载。创建应用后,您可以在其中将 Google Cloud资源注册为服务和工作负载。
您只能将专属服务注册到一个应用。不过,共享服务可以注册到多个应用。当您将共享服务注册到某个应用时,即使这些服务已注册到其他应用,App Hub 也会发现这些服务,但您可能无法修改其属性。
控制台
创建应用后,您可以向其注册多个资源:
在 Google Cloud 控制台中,使用项目选择器选择管理项目。
从 App Hub 进入应用页面:
点击要为其注册Google Cloud 资源的应用的名称。
在应用的页面中,选择服务和工作负载标签页。
点击 注册服务或工作负载。
在服务和工作负载标签页中,浏览基础架构资源,然后选中要注册为应用的服务或工作负载的资源的复选框。
您一次最多可以选择 10 项资源。
点击继续。
在属性和所有者标签页中,您可以为这些资源添加属性,例如重要性、环境和资源所有者。
您可以选择使用应用中的相同属性和所有者,也可以稍后定义不同的属性。
点击注册。
服务和工作负载标签页会显示应用的所有已注册服务和工作负载。
gcloud
借助 App Hub,您可以选择位于应用管理边界内的受支持资源作为服务或工作负载。使用 Google Cloud CLI 列出您可以从终端或 Cloud Shell 注册到应用的服务或工作负载。服务和工作负载的命令略有不同:
注册服务
列出您可以注册到应用的可用服务:
gcloud apphub discovered-services list \ --project=PROJECT_ID \ --location=REGION \ --filter=FILTER_EXPRESSION对于必需和可选标志,请替换以下内容:
- 必需:
PROJECT_ID:管理项目的 ID。 必需:
REGION:服务的具体位置,具体取决于您的地理位置分布。请使用以下某个值:- 如果服务是区域级服务,请指定 App Hub 支持的区域名称。
- 如果服务是多区域服务,请指定
us或eu。 - 如果服务是全球性的,请使用
global。
可选:
FILTER_EXPRESSION:--filter标志的过滤表达式,用于仅显示应用管理边界内指定项目中的服务或具有特定属性的服务,例如:service_properties.gcp_project=projects/PROJECT_IDservice_properties.gcp_project=projects/PROJECT_ID AND service_reference.uri~"forwardingRules"
输出类似于以下示例:
ID SERVICE_REFERENCE SERVICE_PROPERTIES SERVICE_ID {'uri': '//compute.googleapis.com/projects/PROJECT_NUMBER/regions/REGION/forwardingRules/forwarding-rule'} {'gcpProject': 'projects/PROJECT_ID', 'location': 'REGION'}- 必需:
从输出中复制服务 ID
SERVICE_ID。向您的应用注册该服务:
gcloud apphub applications services create SERVICE_NAME \ --project=PROJECT_ID \ --location=APPLICATION_LOCATION \ --application=APPLICATION_NAME \ --discovered-service=projects/PROJECT_ID/locations/REGION/discoveredServices/SERVICE_ID \ --display-name=SERVICE_DISPLAY_NAME \ --criticality-type=CRITICALITY \ --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替换为您要用于向应用注册服务的名称。使用可选标志(例如
--criticality-type)定义服务的顶级属性,并支持可检测性和治理。对于必需和可选标志,请替换以下内容:
- 必需:
PROJECT_ID:管理项目的 ID。 必需:
APPLICATION_LOCATION:应用的位置。请使用以下某个值:- 如果应用是区域级应用,请指定 App Hub 支持的区域名称。
- 如果应用是多区域应用,请指定
us或eu。 - 如果应用是全球性的,请使用
global。
必需:
APPLICATION_NAME:要为其注册服务的应用的名称。必需:
REGION:上一个输出中发现的服务的位置。必需:
SERVICE_ID:您从上一个输出中复制的服务 ID。可选:
SERVICE_DISPLAY_NAME:服务的显示名称。可选:
CRITICALITY:服务对您的运营的重要性级别。请使用以下某个值:MISSION_CRITICALHIGHMEDIUMLOW
可选:
ENVIRONMENT:软件生命周期的阶段。请使用以下某个值:PRODUCTIONSTAGINGDEVELOPMENTTEST
可选:
DEV_NAME和DEV_EMAIL:分别为开发者所有者的显示名称和电子邮件地址。可选:
OPERATOR_NAME和OPERATOR_EMAIL:分别是运营商所有者的显示名称和电子邮件地址。可选:
BUSINESS_NAME和BUSINESS_EMAIL:分别为企业主的显示名称和电子邮件地址。
- 必需:
列出应用中已注册的服务:
gcloud apphub applications services list \ --application=APPLICATION_NAME \ --project=PROJECT_ID \ --location=APPLICATION_LOCATION对于每个已注册的服务,您必须获得类似于以下内容的输出:
ID DISPLAY_NAME SERVICE_REFERENCE CREATE_TIME SERVICE_NAME SERVICE_DISPLAY_NAME {'uri': '//compute.googleapis.com/projects/PROJECT_NUMBER/regions/REGION/forwardingRules/forwarding-rule'} 2023-11-01T21:38:08
注册工作负载
列出您可以注册到应用的可用工作负载:
gcloud apphub discovered-workloads list \ --project=PROJECT_ID \ --location=REGION \ --filter=FILTER_EXPRESSION对于必需和可选标志,请替换以下内容:
- 必需:
PROJECT_ID:管理项目的 ID。 必需:
REGION:工作负载的具体位置,具体取决于您的地理分布。请使用以下某个值:- 如果工作负载是区域级工作负载,请指定 App Hub 支持的区域名称。
- 如果工作负载是多区域的,请指定
us或eu。 - 如果工作负载是全球性的,请使用
global。
可选:
FILTER_EXPRESSION:--filter标志的过滤表达式,用于仅显示应用管理边界内指定项目中的工作负载或具有特定属性的工作负载,例如workload_properties.gcp_project=projects/PROJECT_ID。
输出类似于以下示例:
ID WORKLOAD_REFERENCE WORKLOAD_PROPERTIES WORKLOAD_ID {'uri': '//compute.googleapis.com/projects/PROJECT_NUMBER/regions/REGION/instanceGroups/mig-name'} {'gcpProject': 'projects/PROJECT_ID', 'location': 'REGION'}- 必需:
从输出中复制工作负载 ID
WORKLOAD_ID。将工作负载注册到您的应用:
gcloud apphub applications workloads create WORKLOAD_NAME \ --project=PROJECT_ID \ --location=APPLICATION_LOCATION \ --application=APPLICATION_NAME \ --discovered-workload=projects/PROJECT_ID/locations/REGION/discoveredWorkloads/WORKLOAD_ID \ --display-name=WORKLOAD_DISPLAY_NAME \ --criticality-type=CRITICALITY \ --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替换为您要用于向应用注册工作负载的名称。使用可选标志(例如
--criticality-type)定义工作负载的顶级属性,并支持可检测性和治理。对于必需和可选标志,请替换以下内容:
- 必需:
PROJECT_ID:管理项目的 ID。 必需:
APPLICATION_LOCATION:应用的位置。请使用以下某个值:- 如果应用是区域级应用,请指定 App Hub 支持的区域名称。
- 如果应用是多区域应用,请指定
us或eu。 - 如果应用是全球性的,请使用
global。
必需:
APPLICATION_NAME:您要向其注册工作负载的应用的名称。必需:
REGION:上一个输出中发现的工作负载的位置。必需:
WORKLOAD_ID:您从上一个输出中复制的工作负载 ID。可选:
WORKLOAD_DISPLAY_NAME:工作负载的显示名称。可选:
CRITICALITY:工作负载对运营的重要性级别。请使用以下某个值:MISSION_CRITICALHIGHMEDIUMLOW
可选:
ENVIRONMENT:软件生命周期的阶段。请使用以下某个值:PRODUCTIONSTAGINGDEVELOPMENTTEST
可选:
DEV_NAME和DEV_EMAIL:分别为开发者所有者的显示名称和电子邮件地址。可选:
OPERATOR_NAME和OPERATOR_EMAIL:分别是运营商所有者的显示名称和电子邮件地址。可选:
BUSINESS_NAME和BUSINESS_EMAIL:分别为企业主的显示名称和电子邮件地址。
- 必需:
列出应用中已注册的工作负载:
gcloud apphub applications workloads list \ --application=APPLICATION_NAME \ --project=PROJECT_ID \ --location=APPLICATION_LOCATION对于每个已注册的工作负载,您应该会获得类似于以下内容的输出:
ID DISPLAY_NAME WORKLOAD_REFERENCE CREATE_TIME WORKLOAD_NAME WORKLOAD_DISPLAY_NAME {'uri': '//compute.googleapis.com/projects/PROJECT_NUMBER/regions/REGION/instanceGroups/mig-name'} 2023-11-01T21:38:08
Terraform
如需使用 Terraform 将应用管理边界内的 Google Cloud 资源注册为应用中的服务或工作负载,请使用 google_apphub_discovered_service 和 google_apphub_discovered_workload 数据源动态检索要注册的资源的相关信息。
然后,分别使用 google_apphub_service 或 google_apphub_workload 资源注册服务或工作负载。
注册服务
使用服务的 URI 获取有关服务的信息:
data "google_apphub_discovered_service" "my-service" { location = "LOCATION" service_uri = "SERVICE_URI" }将发现的服务注册到您的应用,例如:
resource "google_apphub_service" "example" { project = "my-project-id" location = "us-central1" application_id = google_apphub_application.example.application_id service_id = "frontend-load-balancer" discovered_service = data.google_apphub_discovered_service.my-forwarding-rule.name display_name = "Frontend Load Balancer" description = "The primary load balancer for the frontend." }
注册工作负载
使用工作负载的 URI 获取其相关信息:
data "google_apphub_discovered_workload" "my-workload" { location = "LOCATION" workload_uri = "WORKLOAD_URI" }将发现的工作负载注册到您的应用,例如:
resource "google_apphub_workload" "example" { project = "my-project-id" location = "us-central1" application_id = google_apphub_application.example.application_id workload_id = "frontend-instance-group" discovered_workload = data.google_apphub_discovered_workload.my-mig.name display_name = "Frontend Instance Group" description = "The managed instance group for the frontend." }
如果您将项目或文件夹移出应用管理边界或删除底层资源,则注册到应用的服务的注册状态可能会更改为已分离。分离的服务和工作负载会保留在应用中,直到您取消注册它们,但 App Hub 无法再管理或监控它们。如需了解详情,请参阅服务和工作负载的注册状态。
如需将服务或工作负载重新附加到应用,您必须重新注册它们。
授予权限并开始操作
在 App Hub 中创建应用并注册服务和工作负载后,您必须根据生命周期职责授予用户访问权限,以便将此逻辑分组作为一个单元进行管理:
- 您可以根据访问需求,向单个应用或所有应用授予权限。如需查看推荐的角色列表,请参阅向用户授予以应用为中心的角色。
- (可选)前往 Cloud Hub,查看所定义应用的统一运营信息中心,包括其健康状况、性能和费用数据。