Resource: PersistentResource
Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
JSON representation |
---|
{ "name": string, "displayName": string, "resourcePools": [ { object ( |
Fields | |
---|---|
name |
Immutable. Resource name of a PersistentResource. |
displayName |
Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
resourcePools[] |
Required. The spec of the pools of different resources. |
state |
Output only. The detailed state of a Study. |
error |
Output only. Only populated when persistent resource's state is |
createTime |
Output only. time when the PersistentResource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startTime |
Output only. time when the PersistentResource for the first time entered the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. time when the PersistentResource was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. The labels with user-defined metadata to organize PersistentResource. label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
network |
Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example, To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. |
encryptionSpec |
Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key. |
resourceRuntimeSpec |
Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. |
resourceRuntime |
Output only. Runtime information of the Persistent Resource. |
reservedIpRanges[] |
Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. |
ResourcePool
Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
JSON representation |
---|
{ "id": string, "machineSpec": { object ( |
Fields | |
---|---|
id |
Immutable. The unique ID in a PersistentResource for referring to this resource pool. user can specify it if necessary. Otherwise, it's generated automatically. |
machineSpec |
Required. Immutable. The specification of a single machine. |
diskSpec |
Optional. Disk spec for the machine in this node pool. |
usedReplicaCount |
Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count. |
autoscalingSpec |
Optional. Optional spec to configure GKE autoscaling |
replicaCount |
Optional. The total number of machines to use for this resource pool. |
AutoscalingSpec
The min/max number of replicas allowed if enabling autoscaling
JSON representation |
---|
{ "minReplicaCount": string, "maxReplicaCount": string } |
Fields | |
---|---|
minReplicaCount |
Optional. min replicas in the node pool, must be ≤ replicaCount and < maxReplicaCount or will throw error |
maxReplicaCount |
Optional. max replicas in the node pool, must be ≥ replicaCount and > minReplicaCount or will throw error |
State
Describes the PersistentResource state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not set. |
PROVISIONING |
The PROVISIONING state indicates the persistent resources is being created. |
RUNNING |
The RUNNING state indicates the persistent resource is healthy and fully usable. |
STOPPING |
The STOPPING state indicates the persistent resource is being deleted. |
ERROR |
The ERROR state indicates the persistent resource may be unusable. Details can be found in the error field. |
REBOOTING |
The REBOOTING state indicates the persistent resource is being rebooted (PR is not available right now but is expected to be ready again later). |
UPDATING |
The UPDATING state indicates the persistent resource is being updated. |
ResourceRuntimeSpec
Configuration for the runtime on a PersistentResource instance, including but not limited to:
- service accounts used to run the workloads.
- Whether to make it a dedicated Ray Cluster.
JSON representation |
---|
{ "serviceAccountSpec": { object ( |
Fields | |
---|---|
serviceAccountSpec |
Optional. Configure the use of workload identity on the PersistentResource |
raySpec |
Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. |
ServiceAccountSpec
Configuration for the use of custom service account to run the workloads.
JSON representation |
---|
{ "enableCustomServiceAccount": boolean, "serviceAccount": string } |
Fields | |
---|---|
enableCustomServiceAccount |
Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom code service Agent. |
serviceAccount |
Optional. Required when all below conditions are met * The users must have Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the |
RaySpec
This type has no fields.
Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.
ResourceRuntime
This type has no fields.
Persistent Cluster runtime information as output
Methods |
|
---|---|
|
Creates a PersistentResource. |
|
Deletes a PersistentResource. |
|
Gets a PersistentResource. |
|
Lists PersistentResources in a Location. |
|
Updates a PersistentResource. |
|
Reboots a PersistentResource. |