總覽
預先訓練的 API 是一系列 AI 服務，包括光學字元辨識 (OCR)、語音轉文字和翻譯。服務是透過 Kubernetes 資源模型 (KRM) API 啟用和停用。KRM API 是管理 API，AI Platform 管理員可選擇是否使用。
本頁面僅提供資訊。
aiplatform.private.gdc.goog/v1
套件 v1 包含 aiplatform.private.gdc.goog v1 API 群組的 API 結構定義
警告
「Alerting」包含要處理並轉換為 Observability Platform 警報 CR 的 ConfigMap 名稱：MonitoringRule 和 LoggingRule。
顯示位置： - 可觀測性
| 欄位 | 說明 |
|---|---|
monitoringAlertsConfigMap 字串 |
內嵌 MonitoringRule CR 的 Configmap，可從遠端 K8s 叢集擷取資料，並轉換成 Observability Platform MonitoringRule CR，然後部署至管理員叢集。 |
loggingAlertsConfigMap 字串 |
ConfigMap 內嵌 LoggingRule CR，可從遠端 K8s 叢集擷取資料，並轉換成 Observability Platform 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 boolean |
「就緒」表示資源是否處於就緒狀態。 |
primaryCondition ResourceCondition |
PrimaryCondition 代表資源的主要條件。如果資源已準備就緒，條件就會指出資源已準備就緒。否則，該條件就是資源尚未準備就緒的主要原因。 |
resourceConditions ResourceCondition 陣列 |
ResourceConditions 是資源及其子資源的條件集合。可用於判斷資源及其子資源的整體健康狀態。 |
conditions Condition 陣列 |
條件代表從 Kubernetes 資源填入的原始資源條件，用於偵錯。 |
database DatabaseInfo |
顯示資料庫子資源資訊。 |
資訊主頁
資訊主頁包含要處理的 Observability Platform 資訊主頁相容 configmap 名稱清單。
顯示位置： - 可觀測性
| 欄位 | 說明 |
|---|---|
configMaps 字串陣列 |
要處理的 ConfigMap (內含 Grafana 資訊主頁 JSON 定義)；這些 ConfigMap 應位於 AI 工作負載部署的使用者叢集和命名空間中。所需資訊主頁數量與資訊主頁 ConfigMap 之間應為 1:1 對應。我們假設 configmap 中會有單一鍵：「data」，其中會包含資訊主頁定義 JSON 字串。 |
資料庫
資料庫會為目標微服務設定關聯式資料庫需求。
顯示位置： - AppConfigSpec
| 欄位 | 說明 |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo 會定義資料庫資訊的觀察狀態。
出現位置： - AppConfigStatus
| 欄位 | 說明 |
|---|---|
endpoint 字串 |
|
port 字串 |
HPAStatus
HPAStatus 說明 HorizontalPodAutoscaler 的狀態條件。
顯示於： - MicroserviceStatus
| 欄位 | 說明 |
|---|---|
statusConditions HorizontalPodAutoscalerCondition 陣列 |
狀態條件 |
currentReplicas 整數 |
HPA 管理的目前副本數 |
desiredReplicas 整數 |
HPA 管理的所需備用資源數量 |
記錄
記錄會為 GDC 氣隙環境中的可觀測性平台設定記錄收集功能 (在 GKE 上測試時請勿啟用，因為這項功能不適用於 GKE)。
顯示位置： - 可觀測性
| 欄位 | 說明 |
|---|---|
enableLogCollection boolean |
EnableLogCollection 會指出是否要透過可觀測性平台啟用記錄檔收集功能。 |
staticLabels 物件 (鍵：字串，值：字串) |
對應至 OP LoggingTargetCR 的「additionalLabels」屬性。要新增至所有擷取記錄項目的靜態標籤。標籤名稱不得包含破折號「-」，但標籤值可以包含破折號。 |
指標
指標會設定如何收集 Pod 的指標。
顯示位置： - 可觀測性
| 欄位 | 說明 |
|---|---|
prometheus PrometheusMetrics |
微服務
微服務是服務 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 定義了微服務的所需狀態。
顯示位置： - 微服務
| 欄位 | 說明 |
|---|---|
public boolean |
這個微服務是否公開。如為 true，則會同時擁有公開端點和公開 DNS 記錄。系統也會根據 DNS 名稱，在閘道上自動設定 TLS。DNS 前置字串會是中繼資料中的微服務名稱。 |
enableBucketAccess boolean |
是否要將儲存空間 bucket 相關設定提供給容器 |
dnsname 字串 |
DNS 主機名稱。如果微服務是公開的，系統會在 GDC 環境中建構微服務的 DNS 主機名稱時使用這個值 |
autoscaling |
自動調度資源設定。 |
observability 觀測能力 |
可觀測性 (記錄、指標、監控和資訊主頁) 設定 (部分設定僅適用於 GDC 氣隙設定)。 |
prerequisites 必要條件 |
設定必要條件。 |
template PodTemplateSpec |
在微服務中建立 Pod 的範本。微服務會包含這些 Pod 的無狀態部署作業。 |
PodSpec
PodSpec 是核心 PodSpec 的簡化版本。
顯示位置： - PodTemplateSpec
| 欄位 | 說明 |
|---|---|
containers Container 陣列 |
指定容器。系統僅支援部分屬性。系統會公開所有容器指定的通訊埠。第一個容器 (containers[0]) 會視為主要容器，並標記自動佈建節點的資源要求。其餘容器則視為輔助容器 (例如 Sidecar)。 |
nodeSelector 物件 (鍵：字串，值：字串) |
NodeSelector 是一種選取器，Pod 必須符合這個選取器，才能放在節點上。選取器，必須與節點的標籤相符，Pod 才能排程到該節點。 |
volumes Volume 陣列 |
要掛接到 Pod 的磁碟區清單 |
initContainers Container 陣列 |
屬於 Pod 的初始化容器清單。Init 容器會在容器啟動前依序執行。如果任何 init 容器失敗，系統會將該 pod 視為失敗，並根據其 restartPolicy 處理。初始容器或一般容器的名稱不得與其他容器重複。設定完成後即無法更新。詳情請參閱：https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
tolerations 容許條件陣列 |
如果指定，則為 Pod 的容許度。 |
serviceAccount 字串 |
Pod 將使用的預先建立 Kubernetes 服務帳戶。 |
PodTemplateSpec
PodTemplateSpec 是 PodSpec 的容器物件，也可能是中繼資料規格。
顯示位置： - 微服務
| 欄位 | 說明 |
|---|---|
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec PodSpec |
MicroserviceStatus
MicroserviceStatus 定義了 Microservice 的觀察狀態。
顯示位置： - 微服務
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
部署控制器觀察到的世代。 |
endpoint 字串 |
可存取這項微服務的端點。只有公開服務會填入這項資料。 |
deploymentStatus DeploymentStatus |
這項微服務的部署狀態。 |
hpaStatus HPAStatus |
HorizontalPodAutoscaler 的狀態。 |
ready boolean |
微服務的整體就緒狀態 |
conditions Condition 陣列 |
代表微服務目前狀態的最新可用觀測結果。 |
觀測能力
可觀測性會設定可觀測性平台 (在 GDC 氣隙環境中) 或指標曝光 (在 GKE 中) 所需的各種元件和參數。
出現位置： - MicroserviceSpec
| 欄位 | 說明 |
|---|---|
metrics 指標 |
指標設定。在 GKE 上，這些資料只會收集第一個容器的資料。在 GDC 氣隙環境中，這項設定會與「可觀測性」部分搭配使用，以設定可觀測性平台的行為。 |
logging 記錄 |
|
alerting「快訊」 |
|
dashboards 資訊主頁 |
PostgresConfig
PostgresConfig 會定義 Postgres 資料庫的相關目標設定。
顯示位置： - 資料庫
| 欄位 | 說明 |
|---|---|
version 字串 |
必要條件
Prerequisites 會設定微服務的任何必要條件。
出現位置： - MicroserviceSpec
| 欄位 | 說明 |
|---|---|
sql boolean |
SQL 設定 (目標工作負載需要時) |
PrometheusMetrics
PrometheusMetrics 會設定 Pod 公開的 Prometheus 指標。
| 欄位 | 說明 |
|---|---|
path 字串 |
要從中抓取指標的指標 URI 路徑。預設為 /metrics。 |
port 整數 |
要從中抓取指標的通訊埠。預設值為 80。 |