Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AM-11500: Fixed the typos in v1.0.0 and v1.1.0 register cluster docs #127

Merged
merged 4 commits into from
Sep 15, 2023
Merged

AM-11500: Fixed the typos in v1.0.0 and v1.1.0 register cluster docs #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5524407
fixed the typos in v-1.1.0
uma-kt Sep 14, 2023
450771b
fixed the typos in v-1.1.0 and v1.0.0
uma-kt Sep 14, 2023
2812331
fixed the typos
uma-kt Sep 15, 2023
2c6cd2e
fixed the review comments
uma-kt Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 24 additions & 26 deletions ...ned_docs/version-1.0.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Register Worker Clusters
Before creating a slice across your Kubernetes clusters, you must
register your worker clusters with the KubeSlice Controller. This topic describes the steps to register
your worker cluster with the KubeSlice Controller.
To create a slice across your Kubernetes clusters, register worker clusters with the KubeSlice Controller.
This topic describes how to register a worker cluster with the KubeSlice Controller.

## Cluster Registration Configuration Parameters
The following tables describe the configuration parameters used to register the worker cluster with the controller cluster.
Expand Down Expand Up @@ -53,10 +52,6 @@ You can list multiple clusters in a single registration YAML file and register t

Create your cluster `registration.yaml` file using the following template:

:::info
To understand more about the parameters, see [Cluster Registration Configuration Parameters](#cluster-registration-configuration-parameters).
:::

```
apiVersion: controller.kubeslice.io/v1alpha1
kind: Cluster
Expand Down Expand Up @@ -88,12 +83,12 @@ spec:
```

:::info
The IP addresses used for inter-cluster tunnel creation. (Supports IPv4 and IPv6 IP address). If a node IP is not provided, Kubeslice will
auto detect it from the gateway nodes.
The IP addresses are used for inter-cluster tunnel creation (supports IPv4 and IPv6 IP address). If a node IP is not
provided, Kubeslice will auto detect it from the gateway nodes.
:::


Example YAML file
The following is the example YAML file:
```
apiVersion: controller.kubeslice.io/v1alpha1
kind: Cluster
Expand Down Expand Up @@ -124,7 +119,7 @@ spec:
- <IP address -2>
```

Example YAML File Only with Mandatory Parameters
The following is the example YAML file only with the mandatory parameters:

```
apiVersion: controller.kubeslice.io/v1alpha1
Expand Down Expand Up @@ -200,7 +195,7 @@ file to install the Slice Operator. By completing these steps, the worker cluste
integrate with the KubeSlice Controller and utilize its features.

:::info
** THIS STEP NEEDS TO BE PERFORMED ON ALL WORKER CLUSTERS IN THE CONFIGURATION. **
THIS STEP NEEDS TO BE PERFORMED ON ALL WORKER CLUSTERS IN THE CONFIGURATION.
:::

## Automated Retrieval of Registered Cluster Secrets
Expand All @@ -217,18 +212,19 @@ integrate with the KubeSlice Controller and utilize its features.

### Getting the Worker Network Interface

To install the Slice Operator, you will require the interface name of the gateway nodes which were either labeled at the time of installation or were created as node pools during the installation process.
To install the Slice Operator, you will require the interface name of the gateway nodes which were either labeled at the time
of installation or were created as node pools during the installation process.

Use the following command on the gateway node:
:::warning
The below command does not work for OpenShift clusters.
:::

Use the following command on the gateway node:
```
ip route get <external node IP> | awk '{ print $5 }'
```

Example
**Example**
```
ip route get 8.8.8.8 | awk '{ print $5 }'
```
Expand All @@ -237,7 +233,7 @@ ip route get 8.8.8.8 | awk '{ print $5 }'
eth0
```

### Create Script: `secrets.sh`.
### Create the secrets.sh File

Copy and save the below script as `secrets.sh`

Expand Down Expand Up @@ -286,7 +282,7 @@ netop:
networkInterface: ${networkInterface}
```

### Execute `secrets.sh` script
### Execute the secrets.sh File

The output of the script is **Required** for the Slice YAML file creation:

Expand Down Expand Up @@ -354,9 +350,8 @@ to communicate with the KubeSlice Controller.
```

The name of the secret is in this format:` kubeslice-rbac-<registered cluster secret name>-token`.
For example, `kubeslice-rbac-worker-aks-worker-1-token-hml58` - this
secret is meant for a worker cluster that was registered using the
name aks-worker-1.
For example, the `kubeslice-rbac-worker-aks-worker-1-token-hml58` secret is meant for a worker cluster that
is registered using the name `aks-worker-1`.

3. Retrieve the details of the secret using the following command:
```
Expand Down Expand Up @@ -415,10 +410,12 @@ to communicate with the KubeSlice Controller.
### Get the Worker Network Interface
Get the name of the network interface on the gateway nodes that is the egress interface for external traffic.


Use the following command on the gateway node:
:::warning
The below command does not work for OpenShift clusters.
:::
Use the following command on the gateway node:

```
ip route get <External IP Address> | awk '{ print $5 }'
```
Expand Down Expand Up @@ -488,11 +485,12 @@ This parameter is related to network operations such as enforcing the QoS profil
## Create the Slice Operator YAML

Use base64 encoded values of the `namespace`, `endpoint`, `ca.crt`, and
the `token` from the above secrets retrieved by using the `secret.sh` script or the output following the manual secret retrieval steps to create your `sliceoperator.yaml` file.
the `token` from the above secrets retrieved by using the `secret.sh` script or the output following the manual secret retrieval
steps to create the `sliceoperator.yaml` file.

### Create YAML template
### Create the YAML File

Copy and pase the below template into a file called `sliceoperator.yaml`
Copy and paste the below template into a file called `sliceoperator.yaml`.

```
## Base64 encoded secret values for the namespace, endpoint, ca.crt and token from the controller cluster
Expand All @@ -511,7 +509,7 @@ netop:
```


### Worker Cluster Control Plane Endpoint
### Get the Worker Cluster Control Plane Endpoint
Get the control plane's `kube-apiserver` endpoint of the **worker cluster** by using the following command:
```
kubectl cluster-info
Expand Down Expand Up @@ -586,7 +584,7 @@ spire-install-clusterid-cr-klqzj 0/1 Completed 0 112s
spire-install-crds-pl2m2 0/1 Completed 0 2m1s
```

You can also validate the spire installation using the following command:
Validate the spire installation using the following command:
```
k get pods -n spire
```
Expand Down
Loading
Loading