Gateway Service

Gateway

The Gateway service provides methods to manage gateway settings in TSB.

It provides methods to create and manage gateway groups within a workspace, allowing to create fine-grained groupings to configure a subset of the workspace namespaces. Access policies can be assigned at group level, providing a fine-grained access control to the gateway configuration features.

The Gateway service also provides methods to configure the different gateway settings that are allowed within each group.

CreateGroup

rpc CreateGroup (tetrateio.api.tsb.gateway.v2.CreateGatewayGroupRequest) returns (tetrateio.api.tsb.gateway.v2.Group)

Requires CreateGroup

Create a new gateway group in the given workspace.

Groups will by default configure all the namespaces owned by their workspace, unless explicitly configured. If a specific set of namespaces is set for the group, it must be a subset of the namespaces defined by its workspace.

GetGroup

rpc GetGroup (tetrateio.api.tsb.gateway.v2.GetGatewayGroupRequest) returns (tetrateio.api.tsb.gateway.v2.Group)

Requires ReadGroup

Get the details of the given gateway group.

UpdateGroup

rpc UpdateGroup (tetrateio.api.tsb.gateway.v2.Group) returns (tetrateio.api.tsb.gateway.v2.Group)

Requires WriteGroup

update the given gateway group.

ListGroups

rpc ListGroups (tetrateio.api.tsb.gateway.v2.ListGatewayGroupsRequest) returns (tetrateio.api.tsb.gateway.v2.ListGatewayGroupsResponse)

List all gateway groups that exist in the workspace.

DeleteGroup

rpc DeleteGroup (tetrateio.api.tsb.gateway.v2.DeleteGatewayGroupRequest) returns (google.protobuf.Empty)

Requires DeleteGroup

Delete the given gateway group. Note that deleting resources in TSB is a recursive operation. Deleting a gateway group will delete all configuration objects that exist in it.

CreateIngressGateway

rpc CreateIngressGateway (tetrateio.api.tsb.gateway.v2.CreateIngressGatewayRequest) returns (tetrateio.api.tsb.gateway.v2.IngressGateway)

Requires CreateIngressGateway

Create an Ingress Gateway object in the gateway group.

GetIngressGateway

rpc GetIngressGateway (tetrateio.api.tsb.gateway.v2.GetIngressGatewayRequest) returns (tetrateio.api.tsb.gateway.v2.IngressGateway)

Requires ReadIngressGateway

Get the details of the given Ingress Gateway object.

UpdateIngressGateway

rpc UpdateIngressGateway (tetrateio.api.tsb.gateway.v2.IngressGateway) returns (tetrateio.api.tsb.gateway.v2.IngressGateway)

Requires WriteIngressGateway

Modify the given Ingress Gateway object.

ListIngressGateways

rpc ListIngressGateways (tetrateio.api.tsb.gateway.v2.ListIngressGatewaysRequest) returns (tetrateio.api.tsb.gateway.v2.ListIngressGatewaysResponse)

List all Ingress Gateway objects in the gateway group.

DeleteIngressGateway

rpc DeleteIngressGateway (tetrateio.api.tsb.gateway.v2.DeleteIngressGatewayRequest) returns (google.protobuf.Empty)

Requires DeleteIngressGateway

Delete the given Ingress Gateway object.

CreateTier1Gateway

rpc CreateTier1Gateway (tetrateio.api.tsb.gateway.v2.CreateTier1GatewayRequest) returns (tetrateio.api.tsb.gateway.v2.Tier1Gateway)

Requires CreateTier1Gateway

Create a Tier1 Gateway object in the gateway group.

GetTier1Gateway

rpc GetTier1Gateway (tetrateio.api.tsb.gateway.v2.GetTier1GatewayRequest) returns (tetrateio.api.tsb.gateway.v2.Tier1Gateway)

Requires READ

get the details of the given Tier1 Gateway object.

UpdateTier1Gateway

rpc UpdateTier1Gateway (tetrateio.api.tsb.gateway.v2.Tier1Gateway) returns (tetrateio.api.tsb.gateway.v2.Tier1Gateway)

Requires WRITE

ListTier1Gateways

rpc ListTier1Gateways (tetrateio.api.tsb.gateway.v2.ListTier1GatewaysRequest) returns (tetrateio.api.tsb.gateway.v2.ListTier1GatewaysResponse)

List all Tier1 Gateway objects that have been created in the gateway group.

DeleteTier1Gateway

rpc DeleteTier1Gateway (tetrateio.api.tsb.gateway.v2.DeleteTier1GatewayRequest) returns (google.protobuf.Empty)

Requires DELETE

Delete the given Tier1 Gateway object.

CreateGatewayGroupRequest

Request to create a Gateway Group.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource where the Group will be created.	string = {   min_len: 1 }
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1 }
group	tetrateio.api.tsb.gateway.v2.Group REQUIRED Details of the Group to be created.	message = {   required: true }

CreateIngressGatewayRequest

Request to create a IngressGateway.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource where the IngressGateway will be created.	string = {   min_len: 1 }
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1 }
ingressGateway	tetrateio.api.tsb.gateway.v2.IngressGateway REQUIRED Details of the IngressGateway to be created.	message = {   required: true }

CreateTier1GatewayRequest

Request to create a Tier1Gateway.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource where the Tier1Gateway will be created.	string = {   min_len: 1 }
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1 }
tier1Gateway	tetrateio.api.tsb.gateway.v2.Tier1Gateway REQUIRED Details of the Tier1Gateway to be created.	message = {   required: true }

DeleteGatewayGroupRequest

Request to delete a Gateway Group.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Group.	string = {   min_len: 1 }

DeleteIngressGatewayRequest

Request to delete a IngressGateway.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the IngressGateway.	string = {   min_len: 1 }

DeleteTier1GatewayRequest

Request to delete a Tier1Gateway.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Tier1Gateway.	string = {   min_len: 1 }

GetGatewayGroupRequest

Request to retrieve a Gateway Group.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Group.	string = {   min_len: 1 }

GetIngressGatewayRequest

Request to retrieve a IngressGateway.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the IngressGateway.	string = {   min_len: 1 }

GetTier1GatewayRequest

Request to retrieve a Tier1Gateway.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Tier1Gateway.	string = {   min_len: 1 }

ListGatewayGroupsRequest

Request to list Gateway Groups.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource to list Groups from.	string = {   min_len: 1 }

ListGatewayGroupsResponse

List of all gateway groups in the workspace.

Field	Description	Validation Rule
groups	List of tetrateio.api.tsb.gateway.v2.Group	–

ListIngressGatewaysRequest

Request to list IngressGateways.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource to list IngressGateways from.	string = {   min_len: 1 }

ListIngressGatewaysResponse

Lost of all Ingress Gateway objects in the gateway group.

Field	Description	Validation Rule
ingressGateways	List of tetrateio.api.tsb.gateway.v2.IngressGateway	–

ListTier1GatewaysRequest

Request to list Tier1Gateways.

Field	Description	Validation Rule
parent	string REQUIRED Parent resource to list Tier1Gateways from.	string = {   min_len: 1 }

ListTier1GatewaysResponse

List of all Tier1 Gateway objects in the gateway group.

Field	Description	Validation Rule
tier1Gateways	List of tetrateio.api.tsb.gateway.v2.Tier1Gateway	–