Worker Cluster Registration Parameters
This topic describes the parameters required to register worker clusters and to install the Slice Operator on the
them.
Cluster Registration Configuration Parameters
The following tables describe the configuration parameters used to register the worker cluster with the controller cluster.
The parameters are required to create the worker cluster registration YAML file.
| Parameter | Parameter Type | Required | Description |
|---|
| apiVersion | String | The KubeSlice Controller API version. The value must be controller.kubeslice.io/v1alpha1. | Mandatory |
| kind | String | The name of a particular object schema. The value must be Cluster. | Mandatory |
| metadata | Object | The metadata parameters (names and types) and attributes that have been applied. | Mandatory |
| spec | Object | The specification of the desired state of an object. | Mandatory |
The parameters are related to metadata configured in the
worker cluster registration YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| name | String | The given name of the cluster. | Mandatory |
| namespace | String | The project namespace on which you apply the project configuration file. | Mandatory |
Cluster Registration Spec Parameters
The parameters are related to the specification configured in the
worker cluster registration YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| networkInterface | String | The name of the network interface for egress traffic on a gateway node. The QoS profile for a slice will be applied to this interface.Default Interface: eth0 | Mandatory |
| clusterProperty | Object | It contains the worker cluster details. | Mandatory |
Cluster Property Parameters
The parameters are related to the cluster property configured in the
worker cluster registration YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| geoLocation | Object | It contains information on the geological location of the worker cluster. | Optional |
| telemetry | Object | It contains the telemetry configuration of the worker cluster. | Optional |
Geolocation Parameters
| Parameter | Parameter Type | Description | Required |
|---|
| cloudProvider | String | The name of your cloud provider | Optional |
| cloudRegion | String | The cloud provider region where your cluster is located. | Optional |
Telemetry Parameters
| Parameter | Parameter Type | Description | Required |
|---|
| enabled | Boolean | It is a setting to indicate whether or not the telemetry is enabled on the worker cluster. It must be set to true. | Optional |
| telemetryProvider | String | The name of the telemetry provider. Currently, only Prometheus is the supported telemetry provider. | Optional |
| endpoint | String | The value is the Prometheus URL (Server Domain Name/ IP). | Optional |
Script Parameters for Automated Retrieval of Registered Cluster Secrets
The following parameters are required for automated retrieval of secrets during cluster registration.
| Parameter | Description |
|---|
<worker-secret-name> | The worker secret name that you get by running this command on the KubeSlice Controller: kubectl get secrets -n kubeslice-<projectname>. For example, kubeslice-rbac-worker-kind-worker-1-token-s9d96. |
<worker-cluster-name> | The given name of the worker cluster. |
kubeslice-<projectname> | The given name of your project. For example, add kubeslice-avesha as the project namespace. |
<network-interface> | The worker network interface you get in the above output by doing route lookup on the EXTERNAL IP address. For example, add eth0 as the parameter value. |
<worker-api-endpoint | The endpoint of the worker cluster you get by running this command: kubectl cluster-info. For example, add https://34.105.95.217 as the endpoint. |
<kubesliceRegistrationUsername> | The username you received in the KubeSlice Registration email. |
<kubesliceRegistrationPassword> | The password you received in the KubeSlice Registration email. |
<kubesliceRegistrationEmail> | The email address you used in the KubeSlice Registration process. |
Slice Operator Configuration Parameters
The following tables describe the configuration parameters required to install the Slice Operator
on the worker cluster.
| Parameter | Parameter Type | Description | Required |
|---|
| operator | Object | This contains the Slice Operator information. | Optional |
| controllerSecret | Object | This contains the secrets to connect to controller cluster. | Optional |
| cluster | Object | This contains the information about the worker cluster. | Optional |
| KubesliceNetworking | Object | This contains the parameter related to slice overlay network. | Optional |
| imagePullSecrets | Object | This contains the secrets to access the repository that contains the image. | Mandatory |
Slice Operator Parameters
These parameters are related to the installation of the Slice Operator and they are configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| logLevel | String | The log level can be set to INFO or DEBUG. The default value is set to INFO. | Optional |
Controller Secret Parameters
These parameters are related to the KubeSlice Controller that are required to install the Slice Operator and they are configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| namespace | String | The namespace that you get from the secret. | Mandatory |
| endpoint | String | The controllerEndpoint that you get from the secret. | Mandatory |
| ca.crt | String | The ca.crt that you get from the secret. | Mandatory |
| token | String | The token that you get from the secret. | Mandatory |
Cluster Parameters
These parameters are related to the worker cluster that are configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| name | String | The name of the cluster that is registered with the KubeSlice controller. The cluster name must be unique in the project. | Mandatory |
| endpoint | String | The control plane's kube-apiserver endpoint of the worker cluster that you get in the output after running the kubectl cluster-info command. | Mandatory |
KubeSlice Networking Parameters
These parameters are related to the slice that are configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| enabled | Boolean | This is the Boolean expression required to enable or disable overlay network for a slice. This field specifies if the kubeslice networking components should be installed on a worker cluster during helm install or helm upgrade. The default value is true. The value must be true(i.e network dependencies must be present) on all participating clusters, in order to create (or update to) any slice with network capabilities(i.e single or multi network). | Optional |
Network Operator Parameter
This parameter is related to network operations such as enforcing the QoS profile configured for a slice and is configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| networkInterface | AlphaNumeric | The name of the network interface on the gateway nodes that is the egress interface for external traffic. It may be obtained by doing a route lookup on a well-known public IP address like the Google public DNS IP address 8.8.8.8. | Mandatory |
Slice Operator Image Pull Secret Parameters
These parameters are required to pull the image and they are configured in the
Slice Operator YAML file.
| Parameter | Parameter Type | Description | Required |
|---|
| repository | String | This is the repository URL to pull the image from.Its value must always be https://index.docker.io/v1/. | Mandatory |
| username | String | This is your username to log in to the repository from your KubeSlice Registration email. | Mandatory |
| password | String | This is your user access token/password to log in to the repository for your KubeSlice Registration email. | Mandatory |
| email | String | This is your email address to log into the repository use in your KubeSlice Registration. | Mandatory |