概览
预训练 API 是一系列 AI 服务,包括光学字符识别 (OCR)、Speech-to-Text 和 Translation。这些服务使用 Kubernetes 资源模型 (KRM) API 启用和停用。KRM API 是一个管理 API,可由 Vertex AI Platform Admin 选择性使用。
本页面仅供参考。
aiplatform.private.gdc.goog/v1
软件包 v1 包含 aiplatform.private.gdc.goog v1 API 组的 API 架构定义
提醒
Alerting 包含要处理并转换为可观测性平台提醒 CR(MonitoringRule 和 LoggingRule)的 ConfigMap 的名称。
来源: - Observability
| 字段 | 说明 |
|---|---|
monitoringAlertsConfigMap 字符串 |
包含嵌入式 MonitoringRule CR 的 Configmap,用于从远程 K8s 集群提取数据,并通过转换为可观测性平台 MonitoringRule CR 进行处理,然后部署到管理员集群。 |
loggingAlertsConfigMap 字符串 |
包含嵌入式 LoggingRule CR 的 ConfigMap,用于从远程 K8s 集群提取数据,并通过转换为可观测性平台 LoggingRule CR 进行处理,然后部署到管理员集群。 |
AppConfig
AppConfig 是 AppConfig API 的架构。每个命名空间应有一个
来源: - AppConfigList
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
aiplatform.private.gdc.goog/v1 |
kind 字符串 |
AppConfig |
metadata ObjectMeta |
如需了解 metadata 的字段,请参阅 Kubernetes API 文档。 |
spec AppConfigSpec |
|
status AppConfigStatus |
AppConfigList
AppConfigList 包含 AppConfig 列表
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
aiplatform.private.gdc.goog/v1 |
kind 字符串 |
AppConfigList |
metadata ListMeta |
如需了解 metadata 的字段,请参阅 Kubernetes API 文档。 |
items AppConfig 数组 |
AppConfigSpec
来源: - AppConfig
| 字段 | 说明 |
|---|---|
sql 数据库 |
AppConfigStatus
AppConfigStatus 定义捕捉到的 AppConfig 状态。
来源: - AppConfig
| 字段 | 说明 |
|---|---|
ready 布尔值 |
“就绪”表示资源是否处于就绪状态。 |
primaryCondition ResourceCondition |
PrimaryCondition 表示资源的主要条件。如果资源已准备就绪,则条件会指示资源已准备就绪。否则,该条件将是资源未就绪的主要原因。 |
resourceConditions ResourceCondition 数组 |
ResourceConditions 是资源及其子资源的条件集合。它可用于确定资源及其子资源的整体健康状况。 |
conditions 条件数组 |
Conditions 表示从 Kubernetes 资源填充的原始资源条件,用于调试目的。 |
database DatabaseInfo |
显示数据库子资源信息。 |
信息中心
Dashboards 包含要处理的与可观测性平台信息中心兼容的 ConfigMap 的名称列表。
来源: - Observability
| 字段 | 说明 |
|---|---|
configMaps 字符串数组 |
要处理的 ConfigMap(带有嵌入式 Grafana 信息中心 JSON 定义);这些 ConfigMap 应存在于部署了 AI 工作负载的用户集群和命名空间中。所需信息中心的数量与信息中心 ConfigMap 的数量之间应存在 1:1 的映射关系。我们假设 configmap 中只有一个键:“data”,其中将包含信息中心定义 JSON 字符串。 |
数据库
Database 用于配置目标微服务的关系型数据库要求。
来源: - AppConfigSpec
| 字段 | 说明 |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo 定义观察到的数据库信息状态。
来源: - AppConfigStatus
| 字段 | 说明 |
|---|---|
endpoint 字符串 |
|
port 字符串 |
HPAStatus
HPAStatus 描述 HorizontalPodAutoscaler 的状态条件。
来源: - MicroserviceStatus
| 字段 | 说明 |
|---|---|
statusConditions HorizontalPodAutoscalerCondition 数组 |
状态条件 |
currentReplicas 整数 |
由 HPA 管理的当前副本数 |
desiredReplicas 整数 |
HPA 管理的所需副本数量 |
日志记录
Logging 为 GDC 网闸隔离配置上的可观测性平台配置日志收集功能(如果在 GKE 上测试,请勿启用,因为此功能不适用于 GKE)。
来源: - Observability
| 字段 | 说明 |
|---|---|
enableLogCollection 布尔值 |
EnableLogCollection 指示是否通过可观测性平台启用日志收集。 |
staticLabels对象(键:字符串,值:字符串) |
映射到 OP LoggingTargetCR 的“additionalLabels”属性。要添加到所有捕获的日志条目的静态标签。标签名称不得包含短划线(“-”);标签值可以包含短划线。 |
指标
Metrics 用于配置 Pod 指标的收集方式。
来源: - Observability
| 字段 | 说明 |
|---|---|
prometheus PrometheusMetrics |
微服务
Microservice 是服务 API 的架构
来源: - MicroserviceList
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
aiplatform.private.gdc.goog/v1 |
kind 字符串 |
Microservice |
metadata ObjectMeta |
如需了解 metadata 的字段,请参阅 Kubernetes API 文档。 |
spec MicroserviceSpec |
|
status MicroserviceStatus |
MicroserviceList
MicroserviceList 包含 Microservice 列表
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
aiplatform.private.gdc.goog/v1 |
kind 字符串 |
MicroserviceList |
metadata ListMeta |
如需了解 metadata 的字段,请参阅 Kubernetes API 文档。 |
items Microservice 数组 |
MicroserviceSpec
MicroserviceSpec 定义 Microservice 的期望状态。
来源: - Microservice
| 字段 | 说明 |
|---|---|
public 布尔值 |
此微服务是否公开。如果为 true,则它将具有公开 DNS 记录以及公共端点。系统还会根据 DNS 名称在网关上自动设置 TLS。DNS 前缀将是元数据中的微服务名称。 |
enableBucketAccess 布尔值 |
是否将与存储桶相关的配置预配到容器 |
dnsname 字符串 |
DNS 主机名。当微服务公开时,此名称将用于在 GDC 环境中为微服务构建 DNS 主机名 |
autoscaling |
自动扩缩配置。 |
observability 可观测性 |
可观测性(日志记录、指标、监控和信息中心)配置(其中一些仅适用于 GDC 网闸隔离配置)。 |
prerequisites 前提条件 |
前提条件配置。 |
template PodTemplateSpec |
用于在微服务中创建 Pod 的模板。微服务将包含这些 Pod 的无状态部署。 |
PodSpec
PodSpec 是核心 PodSpec 的极简版本。
来源: - PodTemplateSpec
| 字段 | 说明 |
|---|---|
containers 容器数组 |
指定容器。并非所有属性都受支持。所有容器中指定的端口都将公开。第一个容器 (containers[0]) 被视为主容器,并将成为使用资源请求进行标记以进行节点自动预配的容器。其余容器则被视为辅助容器(例如边车容器)。 |
nodeSelector对象(键:字符串,值:字符串) |
NodeSelector 是一个选择器,其值必须为 true,Pod 才能在节点上运行。选择器,必须与节点的标签匹配,才能将 Pod 调度到该节点上。 |
volumes 卷数组 |
将装载到 Pod 的卷的列表 |
initContainers 容器数组 |
属于 Pod 的初始化容器的列表。Init 容器在容器启动之前按顺序执行。如果任何 init 容器失败,则 Pod 会被视为失败,并根据其 restartPolicy 进行处理。初始化容器或普通容器的名称在所有容器中必须是唯一的。无法更新。 详细信息:https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
tolerations Toleration 数组 |
如果指定,则为 Pod 的容忍设置。 |
serviceAccount 字符串 |
Pod 将使用的预创建 Kubernetes 服务账号。 |
PodTemplateSpec
PodTemplateSpec 是 PodSpec 和潜在元数据规范的容器对象。
来源: - Microservice
| 字段 | 说明 |
|---|---|
metadata ObjectMeta |
如需了解 metadata 的字段,请参阅 Kubernetes API 文档。 |
spec PodSpec |
MicroserviceStatus
MicroserviceStatus 定义观察到的 Microservice 状态。
来源: - Microservice
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
Deployment 控制器观察到的世代。 |
endpoint 字符串 |
可用于访问此微服务的端点。仅针对公共服务填充。 |
deploymentStatus DeploymentStatus |
此微服务的部署状态。 |
hpaStatus HPAStatus |
HorizontalPodAutoscaler 的状态。 |
ready 布尔值 |
微服务的整体就绪状态 |
conditions 条件数组 |
表示微服务当前状态的最新可用观察结果。 |
可观测性
可观测性会配置可观测性平台(在 GDC 网闸隔离配置上)或指标公开(在 GKE 上)所需的各种组件和参数。
来源: - MicroserviceSpec
| 字段 | 说明 |
|---|---|
metrics 指标 |
指标配置。在 GKE 上,系统仅在第一个容器上收集这些指标。在 GDC 网闸隔离配置中,此部分与“可观测性”部分结合使用,用于配置可观测性平台的行为。 |
logging Logging |
|
alerting 提醒 |
|
dashboards 信息中心 |
PostgresConfig
PostgresConfig 定义 Postgres 数据库的相关目标配置设置。
来源: - 数据库
| 字段 | 说明 |
|---|---|
version 字符串 |
前提条件
“前提条件”用于配置微服务的任何前提条件。
来源: - MicroserviceSpec
| 字段 | 说明 |
|---|---|
sql 布尔值 |
SQL 配置(如果目标工作负载需要) |
PrometheusMetrics
PrometheusMetrics 用于配置 Pod 公开的 Prometheus 指标。
来源: - 指标
| 字段 | 说明 |
|---|---|
path 字符串 |
要从中爬取指标的指标 URI 路径。默认值为 /metrics。 |
port 整数 |
要从中爬取指标的端口。默认值为 80。 |