Skip to main content
logoTetrate Service BridgeVersion: next

Shared Gateway Reference Grant

Grants Workspaces or Gateway Groups the ability to reference a shared Gateway.

SharedGatewayReferenceGrant

Shared Gateway Reference Grants allows sharing a Gateway with other Workspaces or Gateway Groups, so that the referencing Workspaces or Gateway Groups can apply their own configurations to the shared Gateway.

The following example creates a Shared Gateway Reference Grant for the Gateway shared-gw1 and allows the Workspace w2 to reference it and apply its own configurations. Any shared Gateway configurations that are applied to shared-gw1 in Workspace w2 will be applied to the Gateway shared-gw1 in Workspace w1.

apiVersion: gateway.tsb.tetrate.io/v2
kind: SharedGatewayReferenceGrant
metadata:
name: shared-gw1-grant
group: g1
workspace: w1
tenant: mycompany
organization: myorg
spec:
gatewaySelectors:
- nameSelector:
name: shared-gw1
from:
fqn:
- organizations/tetrate/tenants/mycompany/workspaces/w2
FieldDescriptionValidation Rule

updateProtectionEnabled

bool
When set, prevents the resource from being deleted or updated. In order to delete or update the resource this property needs to be set to false first.

from

tetrateio.api.tsb.gateway.v2.SharedGatewayReferenceGrant.From
REQUIRED
The fully-qualified name of the resource that is being granted access to the shared Gateway. This can be a Tenant, Workspace or a Gateway Group.

gatewaySelectors

List of tetrateio.api.tsb.gateway.v2.SharedGatewayReferenceGrant.GatewaySelector
REQUIRED
A list of Gateway Selectors that specify which Gateways are being shared.

repeated = {
  min_items: 1
}

From

From specifies the resource that is granted access to the shared Gateway.

FieldDescriptionValidation Rule

fqn

List of string
REQUIRED
The fully-qualified name of the resource that is being granted access to the shared Gateway. This can be a Tenant, Workspace or a Gateway Group.

repeated = {
  min_items: 1
  items: {string:{min_len:1}}
}

GatewaySelector

GatewaySelector specifies which Gateways are being shared.

FieldDescriptionValidation Rule

nameSelector

tetrateio.api.tsb.gateway.v2.SharedGatewayReferenceGrant.GatewaySelector.NameSelector oneof _selector_specifier
NameSelector specifies the name of the Gateway to be shared in the same Workspace or Gateway Group as the SharedGatewayReferenceGrant.

appLabelSelector

tetrateio.api.tsb.gateway.v2.SharedGatewayReferenceGrant.GatewaySelector.AppLabelSelector oneof _selector_specifier
AppLabelSelector specifies the app label and namespace of the Gateway to be shared. This is used to select Gateways with a specific app label and namespace within the same Workspace or Gateway Group as the SharedGatewayReferenceGrant.

AppLabelSelector

AppLabelSelector specifies the app label and namespace of the Gateway to be shared. This is used to select Gateways with a specific app label and namespace within the same Workspace or Gateway Group as the SharedGatewayReferenceGrant.

FieldDescriptionValidation Rule

appLabel

string
REQUIRED
The app label and namespace of the Gateway to be shared.

string = {
  min_len: 1
}

namespace

string
REQUIRED
The namespace of the Gateway to be shared.

string = {
  min_len: 1
}

NameSelector

NameSelector specifies the name of the Gateway to be shared in the same Workspace or Gateway Group as the SharedGatewayReferenceGrant.

FieldDescriptionValidation Rule

name

string
REQUIRED
The name of the Gateway to be shared. This is the name of the Gateway resource in the same Workspace or Gateway Group as the SharedGatewayReferenceGrant.

string = {
  min_len: 1
}