← Back to packages

Package intrinsic_proto.vmpoolapi.v1

Service VMPoolService

Message CreatePoolRequest

Message DeletePoolRequest

Message HardwareTemplate

Message Lease

Message ListHardwareTemplatesRequest

Message ListHardwareTemplatesResponse

Message ListLeasesRequest

Message ListLeasesResponse

Message ListPoolsRequest

Message ListPoolsResponse

Message ListTiersRequest

Message ListTiersResponse

Message PausePoolRequest

Message Pool

Message ResumePoolRequest

Message Spec

Message StopLeaseRequest

Message StopPoolRequest

Message Tier

Message UpdatePoolRequest

Services

service VMPoolService intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

VMPoolService manages pools of virtual machines.

rpc CreatePool
Request: intrinsic_proto.vmpoolapi.v1.CreatePoolRequest
Response: intrinsic_proto.vmpoolapi.v1.Pool

Creates a new Pool with the provided name and specification.

rpc ListPools
Request: intrinsic_proto.vmpoolapi.v1.ListPoolsRequest
Response: intrinsic_proto.vmpoolapi.v1.ListPoolsResponse

Lists all current Pools.

rpc UpdatePool
Request: intrinsic_proto.vmpoolapi.v1.UpdatePoolRequest
Response: intrinsic_proto.vmpoolapi.v1.Pool

Updates an existing Pool by providing a new specification.

rpc ListHardwareTemplates
Request: intrinsic_proto.vmpoolapi.v1.ListHardwareTemplatesRequest
Response: intrinsic_proto.vmpoolapi.v1.ListHardwareTemplatesResponse

Lists available hardware templates for VM configurations.

rpc ListTiers
Request: intrinsic_proto.vmpoolapi.v1.ListTiersRequest
Response: intrinsic_proto.vmpoolapi.v1.ListTiersResponse

Lists available pool configuration tiers.

rpc DeletePool
Request: intrinsic_proto.vmpoolapi.v1.DeletePoolRequest
Response: google.protobuf.Empty

Deletes a Pool. The Pool will converge to being deleted.

rpc StopPool
Request: intrinsic_proto.vmpoolapi.v1.StopPoolRequest
Response: google.protobuf.Empty

Stops a Pool. The Pool will converge to having no ready and no leased Instances. Existing leases are not terminated. Leasing is not possible in this state.

rpc ResumePool
Request: intrinsic_proto.vmpoolapi.v1.ResumePoolRequest
Response: google.protobuf.Empty

Resumes a Pool. The Pool will converge to provisioning ready Instances and allow new Leases to be acquired.

rpc PausePool
Request: intrinsic_proto.vmpoolapi.v1.PausePoolRequest
Response: google.protobuf.Empty

Pauses a Pool. The Pool will converge to having no ready Instances. New leases are not possible in this state.

rpc ListLeases
Request: intrinsic_proto.vmpoolapi.v1.ListLeasesRequest
Response: intrinsic_proto.vmpoolapi.v1.ListLeasesResponse

Lists active leases for a given pool.

rpc StopLease
Request: intrinsic_proto.vmpoolapi.v1.StopLeaseRequest
Response: google.protobuf.Empty

Stops (terminates) an active lease, releasing the VM instance.

Messages

message CreatePoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 name string
2 spec intrinsic_proto.vmpoolapi.v1.Spec

message DeletePoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Request to delete a pool.

Field Type Description
1 name string

message HardwareTemplate intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

HardwareTemplate is a predefined hardware configuration of a VM.

Field Type Description
1 name string
2 description string
3 has_gpu bool

message Lease intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Lease represents a VM instance leased from a pool.

Field Type Description
1 name string
2 pool_name string
3 expiration_time google.protobuf.Timestamp

message ListHardwareTemplatesRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description

message ListHardwareTemplatesResponse intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 hw_templates repeated intrinsic_proto.vmpoolapi.v1.HardwareTemplate

message ListLeasesRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 pool_name string

message ListLeasesResponse intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 leases repeated intrinsic_proto.vmpoolapi.v1.Lease

message ListPoolsRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description

message ListPoolsResponse intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 pools repeated intrinsic_proto.vmpoolapi.v1.Pool

message ListTiersRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description

message ListTiersResponse intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 tiers repeated intrinsic_proto.vmpoolapi.v1.Tier

message PausePoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 name string

message Pool intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Pool represents a pool of VM instances.

Field Type Description
1 name string

The name of the Pool you will call lease on. Format: organizations/{organization}/pools/{pool}
3 current_status string

The current operational status of this pool. This is a read-only field reflecting the system's state. Possible values: "INITIALIZING", "RUNNING", "PAUSING", "PAUSED", "STOPPING", "STOPPED", "DELETING", "DELETED"
4 desired_status string

The desired operational status of this pool, as set by user actions (e.g., via StopPool, ResumePool, PausePool). Possible values: "RUNNING", "PAUSED", "STOPPED", "DELETED"
6 spec intrinsic_proto.vmpoolapi.v1.Spec

The specification that defines this pool.

message ResumePoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 name string

message Spec intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Spec consists of a set of parameters that define a specific Pool configuration.

Field Type Description
1 runtime string

Pin the intrinsic platform runtime version for the VMs in the pool. If empty, the pool will be set to the current runtime. The runtime version should be in the form of 'intrinsic.platform.YYYYMMDD.RCXX'.
2 intrinsic_os string

The IntrinsicOS version to be used for the VMs. If empty, the pool will be set to the current IntrinsicOS version. The intrinsic_os version should be in the form of 'YYYYMMDD.RCXX'.
3 hardware_template string

The name of the hardware template to use for the VMs. This should correspond to a HardwareTemplate.name.
4 pool_tier string

The name of the tier to apply to the pool. This should correspond to a Tier.name.

message StopLeaseRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Force stop a lease.

Field Type Description
1 lease_name string

message StopPoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Field Type Description
1 name string

message Tier intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Tier defines a pool configuration with e.g. a certain number of standby VMs.

Field Type Description
1 name string
2 description string

message UpdatePoolRequest intrinsic/kubernetes/vmpool/service/api/v1/vmpool_api.proto

Request to update an existing pool by providing a new specification.

Field Type Description
1 name string
2 spec intrinsic_proto.vmpoolapi.v1.Spec