Workspace Configuration Parameters
This topic describes the configuration parameters for the Workspace (Slice) resources in EGS.
Workspace (Slice) Configuration Parameters
The following table describes the configuration parameters for the SliceNSGateway resource. These parameters are required to create the Workspace NS gateway YAML file.
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| apiVersion | The API version of the SliceNSGateway resource. | String | Required |
| kind | The kind of resource, which is SliceNSGateway. | String | Required |
| metadata | Metadata about the SliceNSGateway resource, including name and namespace. | Object Required | |
| spec | The specification of the SliceNSGateway resource, including sliceName, fqdn, gatewayRef, and ports. | Object | Required |
Metadata Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| name | The name of the SliceNSGateway resource. | String | Required |
| namespace | The namespace where the SliceNSGateway resource is deployed. | String | Required |
Spec Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| sliceName | The name of the workspace (slice) where the gateway is deployed. | String | Required |
| fqdn | List of fully qualified domain names for accessing the gateway. | List of Strings | Optional |
| gatewayRef | Reference to the gateway resource, including name, autoCreate flag, and gatewayClassName. | Object | Required |
| ports | List of ports and protocols for the gateway. | List of Objects | Optional |
| backends | List of backend services, including name, type, cluster (for remote), service/serviceImport, weight. | List of Objects | Required |
| routingRules | List of routing rules for traffic management, including priority, match criteria, and backends. | List of Objects | Optional |
Gateway Reference Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| name | The name of the gateway resource. | String | Required |
| autoCreate | Flag to indicate whether to auto-create the gateway if it doesn't exist. | Boolean | Optional |
| gatewayClassName | The class name of the gateway (for example, istio, envoy). | String | Required |
Ports Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| port | The port number for the gateway. | Integer | Required |
| protocol | The protocol for the gateway (for example, HTTP, HTTPS, TCP). | String | Required |
| name | The name of the port. | String | Optional |
| containerPort | The container port number. | Integer | Optional |
| ServicePort | The service port number. | Integer | Optional |
| ServiceProtocol | The service protocol. | String | Optional |
Backends Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| name | The name of the backend service. | String | Required |
| type | The type of backend service (local or remote). | String | Required |
| cluster | The name of the remote cluster where the service is located. | String | Required for remote |
| service | The local service details, including name and port. | Object | Required for local |
| serviceImport | The service import details, including name and port. | Object | Required for remote |
| weight | The weight for traffic distribution among backends. | Integer | Optional |
Routing Rules Parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| priority | The priority of the routing rule. | Integer | Required |
| match | The match criteria for the routing rule, including path type and value. | Object | Required |
| backends | List of backend services for the routing rule, including name, type, cluster (for remote), service/serviceImport, weight. | List of Objects | Required |