Tenant Service

import { PanelContent, PanelContentCode, } from “@theme/Panel”;

Service to manage TSB tenants.

Tenants

The Tenant service can be used to manage the tenants in TSB. Tenants can be seen as organization units and line of business that have a set of resources. Every resource in TSB belongs to a tenant, and users can be assigned to tenants to get access to those resources (such as workspaces, traffic settings, etc). This service provides methods to manage the tenants that are available in the platform.

CreateTenant

rpc CreateTenant (tetrateio.api.tsb.v2.CreateTenantRequest) returns (tetrateio.api.tsb.v2.Tenant)

Requires CREATE

Create a new tenant in the platform that will be the home for a set of resources.

GetTenant

rpc GetTenant (tetrateio.api.tsb.v2.GetTenantRequest) returns (tetrateio.api.tsb.v2.Tenant)

Requires READ

Get the details of an existing tenant.

UpdateTenant

rpc UpdateTenant (tetrateio.api.tsb.v2.Tenant) returns (tetrateio.api.tsb.v2.Tenant)

Requires WRITE

Modify the details of the given tenant.

ListTenants

rpc ListTenants (tetrateio.api.tsb.v2.ListTenantsRequest) returns (tetrateio.api.tsb.v2.ListTenantsResponse)

List all tenants that are available.

DeleteTenant

rpc DeleteTenant (tetrateio.api.tsb.v2.DeleteTenantRequest) returns (google.protobuf.Empty)

Requires DELETE

Delete a tenant from the platform. Deleting a tenant will recursively delete all resources attached to the tenant, so use with caution. It will delete all workspaces and all settings that have been created in that tenant, so this operation should be done carefully, when it’s safe to do so.

CreateSetting

rpc CreateSetting (tetrateio.api.tsb.v2.CreateTenantSettingRequest) returns (tetrateio.api.tsb.v2.TenantSetting)

Requires CreateTenantSetting

Create a settings object for the given tenant.

GetSetting

rpc GetSetting (tetrateio.api.tsb.v2.GetTenantSettingRequest) returns (tetrateio.api.tsb.v2.TenantSetting)

Requires ReadTenantSetting

Get the details for the given settings object.

UpdateSetting

rpc UpdateSetting (tetrateio.api.tsb.v2.TenantSetting) returns (tetrateio.api.tsb.v2.TenantSetting)

Requires WriteTenantSetting

Modify the given settings in the given tenant.

ListSettings

rpc ListSettings (tetrateio.api.tsb.v2.ListTenantSettingsRequest) returns (tetrateio.api.tsb.v2.ListTenantSettingsResponse)

List all the settings objects that have made available to the given tenant.

ListWasmExtensions

rpc ListWasmExtensions (tetrateio.api.tsb.v2.ListTenantExtensionsRequest) returns (tetrateio.api.tsb.v2.ListTenantExtensionsResponse)

Requires ReadWasmExtension

List all the WASM extensions that have been attached to the given tenant.

DeleteSetting

rpc DeleteSetting (tetrateio.api.tsb.v2.DeleteTenantSettingRequest) returns (google.protobuf.Empty)

Requires DeleteTenantSetting

Delete the given settings object from the tenant.

CreateTenantRequest

Request to create a tenant.

Field Description Validation Rule

parent

string
Parent resource where the Tenant will be created. $only_beta

–

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

tenant

tetrateio.api.tsb.v2.Tenant
REQUIRED
Details of the tenant to be created.

message = {
  required: true
}

CreateTenantSettingRequest

Request to create a Tenant Setting.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource where the Tenant Setting will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

setting

tetrateio.api.tsb.v2.TenantSetting
REQUIRED
Details of the Tenant Setting to be created.

message = {
  required: true
}

DeleteTenantRequest

Request to delete a tenant.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the tenant.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

–

DeleteTenantSettingRequest

Request to delete a Tenant Setting.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tenant Setting.

string = {
  min_len: 1
}

GetTenantRequest

Request to retrieve a tenant.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the tenant.

string = {
  min_len: 1
}

GetTenantSettingRequest

Request to retrieve a Tenant Settings.

Field Description Validation Rule

fqn

string
REQUIRED
Fully-qualified name of the Tenant Setting.

string = {
  min_len: 1
}

ListTenantExtensionsRequest

Request to list Tenant extensions.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list Tenant Extensions from.

string = {
  min_len: 1
}

ListTenantExtensionsResponse

List of all existing WasmExtensions objects assigned to the Tenant.

Field Description Validation Rule

extensions

List of tetrateio.api.tsb.extension.v2.WasmExtension

–

ListTenantSettingsRequest

Request to list Tenant Settings.

Field Description Validation Rule

parent

string
REQUIRED
Parent resource to list Tenant Settings from.

string = {
  min_len: 1
}

ListTenantSettingsResponse

List of all existing Tenant settings objects in the Tenant.

Field Description Validation Rule

settings

List of tetrateio.api.tsb.v2.TenantSetting

–

ListTenantsRequest

Request to list tenants.

Field Description Validation Rule

parent

string
Parent resource to list Tenants from. $only_beta

–

ListTenantsResponse

List of available tenants.

Field Description Validation Rule

tenants

List of tetrateio.api.tsb.v2.Tenant
The list of available tenants.

–
TSB

最近更新于 2023-09-19