Vertex AI Workbench KRM API リファレンス

パッケージ

aiplatform.gdc.goog/v1

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

リソースタイプ

ノートブック

Notebook は、Notebooks API のスキーマです。

表示場所: - NotebookList

フィールド 説明
apiVersion 文字列 aiplatform.gdc.goog/v1
kind 文字列 Notebook
metadata ObjectMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
spec NotebookSpec
status NotebookStatus

NotebookCondition

表示場所: - NotebookStatus

フィールド 説明
type 文字列 条件のタイプ。取りうる値は RunningWaitingTerminated の 3 つです。
lastProbeTime 時間 ノートブックが最後にプローブされた時刻。
reason 文字列 コンテナが現在の状態になっている理由を含む文字列。
message 文字列 コンテナが現在の状態にあることを示す詳細なメッセージを含む文字列。

NotebookError

NotebookError は、ノートブック リソースの更新中に発生したエラーを表します。

表示場所: - NotebookStatus

フィールド 説明
errorMessage 文字列 Pod の状態を説明する詳細なメッセージを含む文字列。
code 文字列 現在の状態の Pod のエラーコード(VTXWB-E0000 など)を含む文字列。

NotebookList

NotebookList には、Notebook インスタンスのリストが含まれます。

フィールド 説明
apiVersion 文字列 aiplatform.gdc.goog/v1
kind 文字列 NotebookList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items ノートブックの配列

NotebookSpec

NotebookSpec は、ノートブックの望ましい状態を定義します。

表示場所: - ノートブック

フィールド 説明
template NotebookTemplateSpec クラスタ内の Notebook のワークロードの望ましい状態を記述する Notebook インスタンスの仕様。

NotebookStatus

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

表示場所: - ノートブック

フィールド 説明
conditions NotebookCondition 配列 非推奨。Notebook CR Events を使用します。NotebookCondition オブジェクトの配列。
readyReplicas 整数 StatefulSet コントローラによって作成され、ConditionReady に設定されている Pods の数。
containerState ContainerState 非推奨: NotebookStatus.Phase を使用します。基盤となるコンテナの状態。詳細については、https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#containerstate-v1-core をご覧ください。
phase 文字列 現在の Pod フェーズを含む文字列。
reason 文字列 Pod が現在の状態になっている理由を含む文字列。
podUnavailableTime 時間 ノートブックが現在実行されていない場合、またはコントローラが Pod のステータスのクエリに失敗した場合、ノートブック Pod が実行されていないことが最初に確認された時刻。
error NotebookError ノートブック リソースの更新中に発生した最後のエラー。成功した場合、このフィールドは空になります。

NotebookTemplateSpec

NotebookTemplateSpec は、クラスタの望ましい状態を定義します。

表示場所: - NotebookSpec

フィールド 説明
spec PodSpec コンテナ、コンテナの環境変数、スケジューラ名やセキュリティ コンテキストなどのその他のプロパティを定義します。詳細については、https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podspec-v1-core をご覧ください。
userCluster 文字列 UserCluster は、Notebook ワークロードが作成されるユーザー クラスタの名前です。クラスタには、PodSpec で指定されたワークロードを実行するのに十分なリソースが必要です。