事前トレーニング済み API のプライベート システム Kubernetes リソースモデル API

概要

事前トレーニング済み API は、光学式文字認識(OCR)、音声文字変換、翻訳などの AI サービスを含むコレクションです。サービスは、Kubernetes Resource Model(KRM)API を使用して有効または無効にします。KRM API は、AI Platform 管理者が任意で使用する管理 API です。

このページは情報提供のみを目的としています。

aiplatform.private.gdc.goog/v1

パッケージ v1 には、aiplatform.private.gdc.goog v1 API グループの API スキーマ定義が含まれています。

アラート

アラートには、処理されてオブザーバビリティ プラットフォームのアラート CR(MonitoringRule と LoggingRule)に変換される ConfigMap の名前が含まれています。

表示場所: - オブザーバビリティ

フィールド 説明
monitoringAlertsConfigMap 文字列 MonitoringRule CR が埋め込まれた Configmap。リモート K8s クラスタから取得し、オブザーバビリティ プラットフォームの MonitoringRule CR に変換して処理し、管理クラスタにデプロイします。
loggingAlertsConfigMap 文字列 リモート K8s クラスタから取得し、Observability Platform LoggingRule CR に変換して処理し、管理クラスタにデプロイする LoggingRule CR が埋め込まれた ConfigMap。

AppConfig

AppConfig は、AppConfig API のスキーマです。名前空間ごとに 1 つ必要

表示場所: - 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 ブール値 Ready は、リソースが準備完了状態かどうかを示します。
primaryCondition ResourceCondition PrimaryCondition は、リソースのプライマリ条件を表します。リソースの準備が整うと、条件はリソースの準備が整ったことを示します。それ以外の場合、この条件はリソースが準備できていない主な理由になります。
resourceConditions ResourceCondition 配列 ResourceConditions は、リソースとそのサブリソースの条件のコレクションです。リソースとそのサブリソースの全体的な健全性を判断するために使用できます。
conditions 条件の配列 Conditions は、デバッグ目的で Kubernetes リソースから入力された未加工のリソース条件を表します。
database DatabaseInfo Database サブリソースの情報を表示します。

ダッシュボード

Dashboards には、処理する Observability Platform ダッシュボード互換の ConfigMap の名前のリストが含まれています。

表示場所: - オブザーバビリティ

フィールド 説明
configMaps 文字列配列 処理される ConfigMap(Grafana ダッシュボードの JSON 定義が埋め込まれています)。これらは、AI ワークロードがデプロイされるユーザー クラスタと Namespace に存在することが想定されています。必要なダッシュボードの数とダッシュボードの ConfigMap の間には 1 対 1 のマッピングが必要です。configmap には、ダッシュボード定義の JSON 文字列を格納する単一のキー「data」があると想定しています。

データベース

データベースは、ターゲット マイクロサービスの関連データベース要件を構成します。

表示場所: - AppConfigSpec

フィールド 説明
postgres PostgresConfig

DatabaseInfo

DatabaseInfo は、データベース情報の観測された状態を定義します。

表示場所: - AppConfigStatus

フィールド 説明
endpoint 文字列
port 文字列

HPAStatus

HPAStatus は、HorizontalPodAutoscaler のステータス条件を表します。

表示場所: - MicroserviceStatus

フィールド 説明
statusConditions HorizontalPodAutoscalerCondition 配列 ステータスの条件
currentReplicas 整数 HPA によって管理されている現在のレプリカの数
desiredReplicas 整数 HPA によって管理される目的のレプリカの数

ロギング

ロギングは、GDC エアギャップ上のオブザーバビリティ プラットフォームのログ収集機能を構成します(GKE でテストする場合は有効にしないでください。この機能は適用されません)。

表示場所: - オブザーバビリティ

フィールド 説明
enableLogCollection ブール値 EnableLogCollection は、オブザーバビリティ プラットフォームを介してログ収集を有効にするかどうかを示します。
staticLabels オブジェクト(キー:文字列、値:文字列) OP LoggingTargetCR の additionalLabels プロパティにマッピングされます。キャプチャされたすべてのログエントリに追加する静的ラベル。ラベル名にダッシュ(「-」)を含めることはできません。ラベル値にはダッシュを含めることができます。

指標

Metrics は、Pod の指標を収集する方法を構成します。

表示場所: - オブザーバビリティ

フィールド 説明
prometheus PrometheusMetrics

マイクロサービス

Microservice は、services 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 は、Pod がノードに適合するために true にする必要があるセレクタです。Pod をそのノードにスケジュールするために、ノードのラベルと一致する必要があるセレクタ。
volumes ボリュームの配列 Pod にマウントされるボリュームのリスト
initContainers コンテナの配列 Pod に属する初期化コンテナのリスト。初期コンテナは、コンテナが起動される前に順番に実行されます。いずれかの init コンテナが失敗すると、Pod は失敗したと見なされ、restartPolicy に従って処理されます。init コンテナまたは通常のコンテナの名前は、すべてのコンテナ間で一意である必要があります。この設定は変更できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
tolerations Toleration の配列 指定されている場合、Pod の toleration。
serviceAccount 文字列 Pod で使用される事前作成済みの Kubernetes サービス アカウント。

PodTemplateSpec

PodTemplateSpec は、PodSpec とメタデータ仕様(場合によっては)のコンテナ オブジェクトです。

表示場所: - Microservice

フィールド 説明
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec PodSpec

MicroserviceStatus

MicroserviceStatus は、Microservice の観測された状態を定義します。

表示場所: - Microservice

フィールド 説明
observedGeneration 整数 デプロイ コントローラによって観測された世代。
endpoint 文字列 このマイクロサービスにアクセスできるエンドポイント。一般公開サービスに対してのみデータが入力されます。
deploymentStatus DeploymentStatus このマイクロサービスのデプロイ ステータス。
hpaStatus HPAStatus HorizontalPodAutoscaler のステータス。
ready ブール値 マイクロサービスの全体的な準備状況
conditions 条件の配列 マイクロサービスの現在の状態に関する取得可能な最新の観測値を表します。

オブザーバビリティ

オブザーバビリティは、オブザーバビリティ プラットフォーム(GDC エアギャップ上)または指標の公開(GKE 上)に必要なさまざまなコンポーネントとパラメータを構成します。

表示場所: - MicroserviceSpec

フィールド 説明
metrics 指標 指標の構成。GKE では、これらは最初のコンテナでのみ収集されます。GDC エアギャップでは、このセクションはモニタリング セクションと組み合わせて使用され、モニタリング プラットフォームの動作を構成します。
logging ロギング
alerting アラート
dashboards ダッシュボード

PostgresConfig

PostgresConfig は、Postgres DB の関連するターゲット構成設定を定義します。

表示場所: - データベース

フィールド 説明
version 文字列

前提条件

Prerequisites は、マイクロサービスの前提条件を構成します。

表示場所: - MicroserviceSpec

フィールド 説明
sql ブール値 移行先のワークロードで必要な場合は、SQL 構成

PrometheusMetrics

PrometheusMetrics は、Pod によって公開される Prometheus 指標を構成します。

表示場所: - 指標

フィールド 説明
path 文字列 指標を収集する指標 URI パス。デフォルトは /metrics です。
port 整数 指標をスクレイピングするポート。デフォルトは 80 です。