Reference For: developers

gRPC: tenants

Services, methods, messages and enums of tenants.proto.

Multi-tenant self-service (docs/cloud/SELF_SERVICE.md §2, §3, §5): tenants, their quotas, users, servers and monthly usage. Bodies travel as JSON in the schemas of the REST API (/v1/tenants, docs/api/openapi.yaml); the rules are the REST rules.

TenantService

Tenants of a self-service portal and their servers. Bodies are JSON in the shape of the REST API.

MethodRequestResponseDescription
ListTenantsEmptyJsonBody

TenantView[] (Kyvernon.Tenant.Read on the root).

GetTenantTenantRequestJsonBody

TenantView.

CreateTenantJsonBodyJsonBody

CreateTenantRequest -> TenantView.

SetQuotaTenantJsonRequestJsonBody

QuotaView -> TenantView.

SuspendTenantTenantRequestTaskRef

Suspends a tenant: its virtual machines shut down and its users become read-only.

ResumeTenantTenantRequestTaskRef

Resumes a suspended tenant and starts the virtual machines that ran.

CloseTenantTenantJsonRequestTaskRef

CloseTenantRequest.

GetUsageUsageRequestJsonBody

TenantUsageView of month (YYYY-MM, empty: current).

ListServersTenantRequestJsonBody

ServerView[].

GetServerServerRequestJsonBody

ServerView.

CreateServerTenantJsonRequestJsonBody

CreateServerRequest -> ServerTaskView (with the generated password, once).

ServerActionServerActionRequestJsonBody

One server operation -> ServerTaskView (console: ConsoleTicketView).

Messages

JsonBody

A JSON document.

FieldNumberTypeDescription
json1string

The body as JSON, in the shape of the REST API.

TenantRequest

Names a tenant.

FieldNumberTypeDescription
tenant1string

Id of the tenant.

TenantJsonRequest

A tenant and a JSON body.

FieldNumberTypeDescription
tenant1string

Id of the tenant.

json2string

The body as JSON, in the shape of the REST API.

UsageRequest

Usage of a tenant in a month.

FieldNumberTypeDescription
tenant1string

Id of the tenant.

month2string

YYYY-MM; empty for the current month.

ServerRequest

Names a server of a tenant.

FieldNumberTypeDescription
tenant1string

Id of the tenant.

server2string

Id of the server.

ServerActionRequest

One operation on a server.

FieldNumberTypeDescription
tenant1string

Id of the tenant.

server2string

Id of the server.

action3string

delete, power (json: ServerPowerRequest), reinstall (ReinstallServerRequest), resize (ResizeServerRequest), rescue (RescueServerRequest), unrescue, reset-password, snapshot (ServerSnapshotRequest), remove-snapshot, revert-snapshot, console.

json4string

The operation as JSON, in the shape of the REST API.

snapshot5uint32

Snapshot key of remove-snapshot and revert-snapshot.

Version 0.1.