Package intrinsic_proto.vmpoolleaseapi.v1
Services
service VMPoolLeaseService intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
Ping can be used for latency and health checks. Do not rely on the response content.
rpc Lease
Request: intrinsic_proto.vmpoolleaseapi.v1.LeaseRequest
Response:
intrinsic_proto.vmpoolleaseapi.v1.LeaseResponse
Lease a VM from a pool. The lease time might be less than what you requested.
rpc Return
Request: intrinsic_proto.vmpoolleaseapi.v1.ReturnRequest
Response:
intrinsic_proto.vmpoolleaseapi.v1.ReturnResponse
Return a VM back to the pool and end the lease. The VM will be destroyed and all data on the VM will be lost.
rpc ExtendTo
Request: intrinsic_proto.vmpoolleaseapi.v1.ExtendToRequest
Response:
intrinsic_proto.vmpoolleaseapi.v1.ExtendToResponse
Extend the lease of a VM to a specific time. The lease extension might be less than what you requested.
rpc Pools
Request: intrinsic_proto.vmpoolleaseapi.v1.PoolsRequest
Response:
intrinsic_proto.vmpoolleaseapi.v1.PoolsResponse
List all available pools.
rpc GetLease
Request: intrinsic_proto.vmpoolleaseapi.v1.GetLeaseRequest
Response:
intrinsic_proto.vmpoolleaseapi.v1.GetLeaseResponse
Get the lease information of a VM.
Messages
message ExtendToRequest intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
string
|
The instance to extend the lease for. |
| 2 | to |
google.protobuf.Timestamp
|
The point in time to extend to. |
| 3 | service_tag |
string
|
The service requesting the lease extension. Must match the service tag of the lease. |
| 4 | extend_only |
bool
|
If true, the lease will only be extended, but not shortened. If the requested extension is shorter than the current lease, the lease will not be updated. |
message ExtendToResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | lease |
intrinsic_proto.vmpoolleaseapi.v1.Lease
|
The new lease |
message GetLeaseRequest intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
string
|
The instance to get the lease for. |
message GetLeaseResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | lease |
intrinsic_proto.vmpoolleaseapi.v1.Lease
|
message Label intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | key |
string
|
|
| 2 | value |
string
|
message Lease intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
string
|
The instance / lease identifier |
| 2 | pool |
string
|
From which pool the instance was taken. |
| 3 | expires |
google.protobuf.Timestamp
|
The time when the lease expires. |
| 4 | zone |
string
|
The zone of the instance |
message LeaseRequest intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | pool |
string
|
The pool to lease from. Optional. If empty, the server selects one for you. |
| 2 | expires |
google.protobuf.Timestamp
|
The time when the lease should expire. The lease time might be different than what you requested. Optional. If empty, the server defines it for you. |
| 3 | service_tag |
string
|
The service requesting the lease. Only the service which created it can modify it. |
| 4 | reservation_id |
optional
string
|
By specifying a UUID, you can reserve a lease. If an instance is available, the reservation will be ignored. If no instance is available, your reservation will be enqueued. The reservation will be saved server-sided and available instances's will be leased to reservation in a FIFO order. A reservation expires after a time (specified in the pool configuration) of its creation. The expiration time will be deferred on every lease request using the same reservation_id. |
message LeaseResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | lease |
intrinsic_proto.vmpoolleaseapi.v1.Lease
|
message PingResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | msg |
string
|
message Pool intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name / identifier of the pool. |
| 2 | labels |
repeated
intrinsic_proto.vmpoolleaseapi.v1.Label
|
Pool labels. |
message PoolsRequest intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description |
|---|
message PoolsResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | pools |
repeated
intrinsic_proto.vmpoolleaseapi.v1.Pool
|
message ReturnRequest intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | instance |
string
|
The instance to return. |
| 3 | service_tag |
string
|
The service requesting the return. Must match the service tag of the lease. |
message ReturnResponse intrinsic/kubernetes/vmpool/manager/api/v1/lease_api.proto
| Field | Type | Description |
|---|