-
- We could not find what you were looking for.
-
-
-
-
- Not Found
-
-
-
-
-
-
- >
- );
-}
diff --git a/src/theme/NotFound/Content/index.js b/src/theme/NotFound/Content/index.js
new file mode 100644
index 00000000..9fdac5af
--- /dev/null
+++ b/src/theme/NotFound/Content/index.js
@@ -0,0 +1,36 @@
+import React from 'react';
+import clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import Heading from '@theme/Heading';
+export default function NotFoundContent({className}) {
+ return (
+
+
+
+
+
+ Page Not Found
+
+
+
+
+ We could not find what you were looking for.
+
+
+
+
+ Please contact the owner of the site that linked you to the
+ original URL and let them know their link is broken.
+
+
+
+
+
+ );
+}
diff --git a/utils.js b/utils.js
new file mode 100644
index 00000000..e6d4ea3d
--- /dev/null
+++ b/utils.js
@@ -0,0 +1,31 @@
+function uniquePath(path) {
+ const segments = path?.split("/").filter(Boolean);
+ for (let i = 0; i < segments.length; i++) {
+ if (segments.length === 2 && segments[i] === segments[i + 1]) {
+ return segments[0] + "/";
+ }
+ }
+ return path;
+}
+
+
+export function getValidPaths(items) {
+ return items?.flatMap((item) => {
+ const paths = [];
+
+ if (item?.label) {
+ if (item.label !== "Overview") {
+ const formattedTitle = `category/${item?.label.toLowerCase().replace(/\s+/g, "-")}`;
+ paths.push(formattedTitle);
+ }
+ }
+
+ if (item?.items) {
+ paths.push(...getValidPaths(item?.items));
+ } else if (typeof item === "string") {
+ paths.push(uniquePath(item));
+ }
+
+ return paths;
+ });
+}
diff --git a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index ccd448b3..8f3781cc 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -12,8 +12,7 @@ Before you begin, ensure the following prerequisites are met:
see [Installing the KubeSlice Controller](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#installing-istio).
+- You have installed Istio in the worker clusters to configure the external gateways.
## Creating the Slice YAML File
@@ -255,9 +254,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
diff --git a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index d935d3d7..267d70d9 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -116,8 +116,8 @@ The following information is required.
|Parameter|Description|
|----|----|
-||The name of the cluster.|
-||The name of the values file.|
+|``|The name of the cluster.|
+|``|The name of the values file.|
Use the following command to apply the YAML:
```
@@ -196,7 +196,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+||The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index c7cfe3e7..1eea19f9 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -155,9 +155,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
@@ -373,8 +373,8 @@ The following information is required to apply the YAML file.
|Parameter|Description|
|----|----|
-||The name of the cluster.|
-||The file name with the values.|
+|``|The name of the cluster.|
+|``|The file name with the values.|
Perform these steps:
diff --git a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index ea81c770..d1f626b2 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -25,8 +25,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -43,8 +43,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The AWS region the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The AWS region the cluster belongs to.|
The following command retrieves your EKS cluster `kubeconfig` and adds
it to your default `kubeconfig` path. Complete this step for each EKS
@@ -62,9 +62,9 @@ Engine (GKE) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The region the cluster belongs to.|
-| | The project ID that the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The region the cluster belongs to.|
+| `` | The project ID that the cluster belongs to.|
The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -116,10 +116,10 @@ The following information is required to label the GKE cluster nodepools.
|**Variable** | **Description** |
|-----|----|
-|| The name of the nodepool being labeled.|
-| | The name of the cluster the nodepool being labeled belongs to.|
-| | The Compute Engine region for the cluster the nodepool belongs to.|
-| | The Compute Engine zone for the cluster the nodepool belongs to.|
+|``| The name of the nodepool being labeled.|
+|`` | The name of the cluster the nodepool being labeled belongs to.|
+| `` | The Compute Engine region for the cluster the nodepool belongs to.|
+| `` | The Compute Engine zone for the cluster the nodepool belongs to.|
The following command labels the GKE cluster nodepool:
diff --git a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
index 616b8329..5cef5218 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
| Variables | Description |
|-------------------------|---------------------------------------------------------
-| | The name of the cluster the application is deployed on.|
-| | The name of the service export that you want to delete.|
-| | The namespace the application is deployed on.|
+| `` | The name of the cluster the application is deployed on.|
+|`` | The name of the service export that you want to delete.|
+| `` | The namespace the application is deployed on.|
Switch the contexts to the cluster you deployed the application on:
diff --git a/versioned_docs/version-0.2.0/getting-started-with-kind-clusters.mdx b/versioned_docs/version-0.2.0/getting-started-with-kind-clusters.mdx
index 0e710aab..d6120e26 100644
--- a/versioned_docs/version-0.2.0/getting-started-with-kind-clusters.mdx
+++ b/versioned_docs/version-0.2.0/getting-started-with-kind-clusters.mdx
@@ -11,11 +11,10 @@ free to join our [community](/versioned_docs/version-0.2.0/community.mdx).
The following sections help you to:
- Install the KubeSlice Controller on the controller cluster
-- Register the worker clusters on the controller cluster and install
- the Slice Operator (Worker Operator) on the worker clusters
+- Register worker clusters on the controller cluster and install
+ the Slice Operator (Worker Operator) on worker clusters
- Create a slice
-- Test the connectivity between the worker clusters using the iPerf
- tool
+- Test the connectivity between the worker clusters using the iPerf tool
The following diagram shows the topology of KubeSlice installed on
kind clusters.
@@ -861,8 +860,7 @@ Before you begin, ensure the following prerequisites are met:
- You have the KubeSlice Controller installed on a separate cluster. For more information,
see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
### Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/configuration-parameters.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/configuration-parameters.mdx
index 1dc6ed8a..d9043510 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/configuration-parameters.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/configuration-parameters.mdx
@@ -192,7 +192,7 @@ These parameters are related to the spec configured in the
| sliceIpamType | String | It is the type of the IP address management for the slice subnet. The value must be always set to `Local`. | Mandatory |
| clusters | List of Strings | The names of the worker clusters that would be part of the slice. You can provide the list of worker clusters. | Mandatory |
| [qosProfileDetails](#qos-profile-parameters) | Object | QoS profile for the slice inter cluster traffic. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
-| [standardQosProfileName](#standard-qos-profile-parameters) | String | This [name](#slice-qos-profile-metadata-parameter) of the [external QoS profile](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
+| [standardQosProfileName](#qos-profile-parameters) | String | This name of the external QoS profile that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
| [namespaceIsolationProfile](#namespace-isolation-profile-parameters) | Object | It is the configuration to onboard namespaces and/or isolate namespaces with the network policy. | Mandatory |
| [externalGatewayConfig](#external-gateway-configuration-parameters) | Object | It is the slice ingress/egress gateway configuration. It is an optional configuration. | Mandatory |
@@ -267,7 +267,7 @@ Parameter|Parameter Type|Description|Required|
|----|----|----|----|
| apiVersion | String | The KubeSlice Controller API version. A set of resources that are exposed together, along with the version. The value must be `networking.kubeslice.io/v1beta1`. | Mandatory |
| kind | String | The name of a particular object schema. The value must be `SliceQoSConfig`. | Mandatory |
-| [metadata](#standard-qos-profile-metadata-parameters) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
+| [metadata](#standard-qos-profile-metadata-parameter) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
| [spec](#standard-qos-profile-specification-parameters) | Object | The specification of the desired state of an object. | Mandatory |
### Standard QoS Profile Metadata Parameter
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index f4edc10f..80d24311 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -12,8 +12,7 @@ Before you begin, ensure the following prerequisites are met:
see [Installing the KubeSlice Controller](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#installing-istio).
+- You have installed Istio in the worker clusters to configure the external gateways.
## Creating the Slice YAML File
@@ -292,9 +291,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index acd12033..bb2c50bb 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -116,8 +116,8 @@ The following information is required.
|Parameter|Description|
|----|----|
-||The name of the cluster.|
-||The name of the values file.|
+|``|The name of the cluster.|
+|``|The name of the values file.|
Use the following command to apply the YAML:
```
@@ -196,7 +196,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+|``|The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index 6a111d56..14189a3f 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -155,9 +155,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
@@ -372,8 +372,8 @@ The following information is required to apply the YAML file.
|Parameter|Description|
|----|----|
-||The name of the cluster.|
-||The file name with the values.|
+|``|The name of the cluster.|
+|``|The file name with the values.|
Perform these steps:
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index ee44978f..0f51a590 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -25,8 +25,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -43,8 +43,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The AWS region the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The AWS region the cluster belongs to.|
The following command retrieves your EKS cluster `kubeconfig` and adds
it to your default `kubeconfig` path. Complete this step for each EKS
@@ -62,9 +62,9 @@ Engine (GKE) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The region the cluster belongs to.|
-| | The project ID that the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The region the cluster belongs to.|
+| `` | The project ID that the cluster belongs to.|
The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -116,10 +116,10 @@ The following information is required to label the GKE cluster nodepools.
|**Variable** | **Description** |
|-----|----|
-|| The name of the nodepool being labeled.|
-| | The name of the cluster the nodepool being labeled belongs to.|
-| | The Compute Engine region for the cluster the nodepool belongs to.|
-| | The Compute Engine zone for the cluster the nodepool belongs to.|
+|``| The name of the nodepool being labeled.|
+|`` | The name of the cluster the nodepool being labeled belongs to.|
+| `` | The Compute Engine region for the cluster the nodepool belongs to.|
+| `` | The Compute Engine zone for the cluster the nodepool belongs to.|
The following command labels the GKE cluster nodepool:
diff --git a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
index 616b8329..5cef5218 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
| Variables | Description |
|-------------------------|---------------------------------------------------------
-| | The name of the cluster the application is deployed on.|
-| | The name of the service export that you want to delete.|
-| | The namespace the application is deployed on.|
+| `` | The name of the cluster the application is deployed on.|
+|`` | The name of the service export that you want to delete.|
+| `` | The namespace the application is deployed on.|
Switch the contexts to the cluster you deployed the application on:
diff --git a/versioned_docs/version-0.3.0/getting-started-with-kind-clusters.mdx b/versioned_docs/version-0.3.0/getting-started-with-kind-clusters.mdx
index 8eb41169..b8477362 100644
--- a/versioned_docs/version-0.3.0/getting-started-with-kind-clusters.mdx
+++ b/versioned_docs/version-0.3.0/getting-started-with-kind-clusters.mdx
@@ -860,8 +860,7 @@ Before you begin, ensure the following prerequisites are met:
- You have the KubeSlice Controller installed on a separate cluster. For more information,
see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
### Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create
@@ -873,7 +872,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-standard-qos-profile).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index 47e9cfaa..54204c17 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -12,9 +12,7 @@ Before you begin, ensure the following prerequisites are met:
see [Installing the KubeSlice Controller](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#install-istio).
-
+- You have installed Istio in the worker clusters to configure the external gateways.
## Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create a slice to onboard your application namespaces. You can create a slice across the multiple clusters or intra-cluster.
@@ -36,7 +34,7 @@ For example YAML files on kind clusters, see [kind YAML examples](/versioned_doc
Create the slice configuration `.yaml` file using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -102,7 +100,7 @@ are the scenarios to configure a slice with/without egress and ingress gateways.
Create the slice configuration file with Istio egress gateway using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -169,7 +167,7 @@ Create the slice configuration file with Istio ingress gateways using the follow
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -236,7 +234,7 @@ Create the slice configuration file with Istio ingress and egress gateways using
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -300,9 +298,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index 1c13bcb0..bed745ae 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -199,7 +199,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+|``|The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
index a91bacca..a334d75f 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
@@ -14,7 +14,7 @@ Namespaces are isolated with respect to sending and receiving data traffic to ot
## Enable Namespace Isolation
Namespace isolation is enabled by setting the isolationEnabled parameter to true and disabled by setting the
same parameter to false in the slice configuration file. To know more, see [namespace isolation profile parameters](/versioned_docs/version-0.4.0/reference/configuration-parameters.mdx#namespace-isolation-profile-parameters)
-and the [slice configuration YAML](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) file.
+and the [slice configuration YAML](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) file.
When the namespace isolation feature is enabled, the namespace isolation policy is
applied to isolate the application namespaces. Verify the namespace isolation policy by
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
index 91941550..9d242a9b 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
@@ -11,7 +11,7 @@ form a micro-network segment. After a namespace is bound to a slice, all the pod
scheduled in the namespace would get connected to the slice.
## Onboard Namespaces
-To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file.
+To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file.
You can add namespaces in the following ways in the slice configuration YAML file:
- Add namespaces for each worker cluster.
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index a499241d..b3d2c656 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -162,9 +162,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
@@ -383,8 +383,8 @@ The following information is required to apply the YAML file.
|Parameter|Description|
|----|----|
-|``|The name of the cluster.|
-|``|The file name with the values.|
+|``|The name of the cluster.|
+|``|The file name with the values.|
Perform these steps:
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index 12d7f964..7c9446b0 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -297,8 +297,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -315,8 +315,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The AWS region the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The AWS region the cluster belongs to.|
The following command retrieves your EKS cluster `kubeconfig` and adds
it to your default `kubeconfig` path. Complete this step for each EKS
@@ -334,9 +334,9 @@ Engine (GKE) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The region the cluster belongs to.|
-| | The project ID that the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The region the cluster belongs to.|
+| `` | The project ID that the cluster belongs to.|
The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -388,10 +388,10 @@ The following information is required to label the GKE cluster nodepools.
|**Variable** | **Description** |
|-----|----|
-|| The name of the nodepool being labeled.|
-| | The name of the cluster the nodepool being labeled belongs to.|
-| | The Compute Engine region for the cluster the nodepool belongs to.|
-| | The Compute Engine zone for the cluster the nodepool belongs to.|
+|``| The name of the nodepool being labeled.|
+|`` | The name of the cluster the nodepool being labeled belongs to.|
+| `` | The Compute Engine region for the cluster the nodepool belongs to.|
+| `` | The Compute Engine zone for the cluster the nodepool belongs to.|
The following command labels the GKE cluster nodepool:
diff --git a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
index f6a69241..d2c8e1cb 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
| Variables | Description |
|-------------------------|---------------------------------------------------------
-| | The name of the cluster the application is deployed on.|
-| | The name of the service export that you want to delete.|
-| | The namespace the application is deployed on.|
+| `` | The name of the cluster the application is deployed on.|
+|`` | The name of the service export that you want to delete.|
+| `` | The namespace the application is deployed on.|
Switch the contexts to the cluster you deployed the application on:
diff --git a/versioned_docs/version-0.4.0/getting-started-with-kind-clusters.mdx b/versioned_docs/version-0.4.0/getting-started-with-kind-clusters.mdx
index 16a17a1e..51eb98e1 100644
--- a/versioned_docs/version-0.4.0/getting-started-with-kind-clusters.mdx
+++ b/versioned_docs/version-0.4.0/getting-started-with-kind-clusters.mdx
@@ -861,8 +861,7 @@ Before you begin, ensure the following prerequisites are met:
- You have the KubeSlice Controller installed on a separate cluster. For more information,
see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
### Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create
@@ -874,7 +873,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.4.0/kubeslice-cli/installing-kubeslice.mdx b/versioned_docs/version-0.4.0/kubeslice-cli/installing-kubeslice.mdx
index 7d7ed6d8..df220486 100644
--- a/versioned_docs/version-0.4.0/kubeslice-cli/installing-kubeslice.mdx
+++ b/versioned_docs/version-0.4.0/kubeslice-cli/installing-kubeslice.mdx
@@ -18,7 +18,7 @@ Depending on the requirements, the KubeSlice Controller and/or worker components
or across all the clusters in your topology.
For demonstration purposes, to set up a three-cluster topology of kind clusters in your local environment, use the
-**—profile ** option instead of the **—config** option.
+**—profile ``** option instead of the **—config** option.
## Install the KubeSlice Controller and Worker Clusters
diff --git a/versioned_docs/version-0.4.0/reference/configuration-parameters.mdx b/versioned_docs/version-0.4.0/reference/configuration-parameters.mdx
index f769e749..11b52093 100644
--- a/versioned_docs/version-0.4.0/reference/configuration-parameters.mdx
+++ b/versioned_docs/version-0.4.0/reference/configuration-parameters.mdx
@@ -173,7 +173,7 @@ The following tables describe the configuration parameters used to create the Sl
### Slice Metadata Parameters
These parameters are related to the metadata configured in the
-[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -182,7 +182,7 @@ These parameters are related to the metadata configured in the
### Slice Spec Parameters
These parameters are related to the spec configured in the
-[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -193,14 +193,14 @@ These parameters are related to the spec configured in the
| sliceIpamType | String | It is the type of the IP address management for the slice subnet. The value must be always set to `Local`. | Mandatory |
| clusters | List of Strings | The names of the worker clusters that would be part of the slice. You can provide the list of worker clusters. | Mandatory |
| [qosProfileDetails](#qos-profile-parameters) | Object | QoS profile for the slice inter cluster traffic. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
-| [standardQosProfileName](#standard-qos-profile-parameters) | String | This [name](#slice-qos-profile-metadata-parameter) of the [external QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
+| [standardQosProfileName](#standard-qos-profile-parameters) | String | This name of the [external QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
| [namespaceIsolationProfile](#namespace-isolation-profile-parameters) | Object | It is the configuration to onboard namespaces and/or isolate namespaces with the network policy. | Mandatory |
| [externalGatewayConfig](#external-gateway-configuration-parameters) | Object | It is the slice ingress/egress gateway configuration. It is an optional configuration. | Mandatory |
#### Slice Gateway Provider Parameters
These parameters are related to the slice gateway created for the inter-cluster
communication and they are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -209,7 +209,7 @@ communication and they are configured in the
#### QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+configured in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -223,7 +223,7 @@ configured in the [slice configuration YAML file](/versioned_docs/version-0.4.0/
#### Namespace Isolation Profile Parameters
These parameters are related to onboarding namespaces, isolating the slice, and allowing
external namespaces to communicate with the slice. They are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -233,7 +233,7 @@ external namespaces to communicate with the slice. They are configured in the
#### Application Namespaces Parameters
These parameters are related to onboarding namespaces onto a slice, which are configured
-in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -242,7 +242,7 @@ in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-sta
#### Allowed Namespaces Parameters
These parameters are related to allowing external namespaces to communicated with the slice,
-which are configured in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+which are configured in the [slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -251,7 +251,7 @@ which are configured in the [slice configuration YAML file](/versioned_docs/vers
#### External Gateway Configuration Parameters
These parameters are related to external gateways, which are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -262,13 +262,13 @@ These parameters are related to external gateways, which are configured in the
## Standard QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
+configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx).
Parameter|Parameter Type|Description|Required|
|----|----|----|----|
| apiVersion | String | The KubeSlice Controller API version. A set of resources that are exposed together, along with the version. The value must be `networking.kubeslice.io/v1beta1`. | Mandatory |
| kind | String | The name of a particular object schema. The value must be `SliceQoSConfig`. | Mandatory |
-| [metadata](#standard-qos-profile-metadata-parameters) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
+| [metadata](#standard-qos-profile-metadata-parameter) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
| [spec](#standard-qos-profile-specification-parameters) | Object | The specification of the desired state of an object. | Mandatory |
### Standard QoS Profile Metadata Parameter
diff --git a/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx b/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
index 74076512..b92cae62 100644
--- a/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
+++ b/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
@@ -32,7 +32,7 @@ onboarded application in the slice configuration file. To know more, see
To onboard namespaces:
-1. Edit the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
+1. Edit the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
* Add namespaces for each worker cluster.
* Add a wildcard ***** (asterisk) to add all namespaces in the worker clusters.
diff --git a/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx b/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
index 601d4bf4..faf24caf 100644
--- a/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
+++ b/versioned_docs/version-0.4.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
@@ -14,4 +14,4 @@ For managing and monitoring IP addresses on a slice, a new parameter has been in
to configure the maximum number of clusters that can be connected to a slice. This parameter
is configurable only during slice creation. The value is immutable after the slice creation.
-For more information, see the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
\ No newline at end of file
+For more information, see the [slice configuration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
\ No newline at end of file
diff --git a/versioned_docs/version-0.4.0/tutorials/kind-create-slice.mdx b/versioned_docs/version-0.4.0/tutorials/kind-create-slice.mdx
index 336623e2..7763fddd 100644
--- a/versioned_docs/version-0.4.0/tutorials/kind-create-slice.mdx
+++ b/versioned_docs/version-0.4.0/tutorials/kind-create-slice.mdx
@@ -11,7 +11,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx b/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx
index 74f5e783..d5c11dac 100644
--- a/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx
+++ b/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx
@@ -11,8 +11,7 @@ see [Prerequisites](/versioned_docs/version-0.4.0/getting-started-with-cloud-clu
see [Prerequisites](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx).
- You have authenticated the worker clusters with the cloud providers. For more information,
see [Preparing the clusters for registration](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx).
-- You have installed Istio on the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.4.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#install-istio).
+- You have installed Istio on the worker clusters to configure the external gateways.
- You have cluster administrator privileges to install the KubeSlice Controller on controller cluster and the Slice Operator on worker clusters.
## Install KubeSlice
diff --git a/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo.mdx b/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo.mdx
index 3f4c9535..9ae5d38b 100644
--- a/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo.mdx
+++ b/versioned_docs/version-0.4.0/tutorials/kubeslice-cli-demo.mdx
@@ -85,10 +85,10 @@ You have successfully installed the KubeSlice Controller on the controller clust
The `kubeslice-cli install —profile=minimal-demo` command creates a slice called `demo` after successfully installing KubeSlice Controller
-and the Slice Operator on the worker clusters. To validate the demo slice, see [Validating the Slice](#validating-the-slice).
+and the Slice Operator on the worker clusters.
You can now onboard the iperf application on the `demo` slice. To onboard the application on the slice, see
-[Deploying the iPerf Application](#deploying-the-iperf-application).
+[Deploying the iPerf Application](/versioned_docs/version-0.4.0/tutorials/deploying-the-iperf-application.mdx).
You can also use the kubeslice-cli command to create a new slice for application onboarding. To create a slice on your demo setup,
follow these steps.
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index 42b0adb5..153153f2 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -12,9 +12,7 @@ Before you begin, ensure the following prerequisites are met:
see [Installing the KubeSlice Controller](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#install-istio).
-
+- You have installed Istio in the worker clusters to configure the external gateways.
## Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create a slice to onboard your application namespaces. You can create a slice across the multiple clusters or intra-cluster.
@@ -36,7 +34,7 @@ For example YAML files on kind clusters, see [kind YAML examples](/versioned_doc
Create the slice configuration `.yaml` file using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -102,7 +100,7 @@ are the scenarios to configure a slice with/without egress and ingress gateways.
Create the slice configuration file with Istio egress gateway using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -169,7 +167,7 @@ Create the slice configuration file with Istio ingress gateways using the follow
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -236,7 +234,7 @@ Create the slice configuration file with Istio ingress and egress gateways using
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -300,9 +298,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index 93674c35..c99ae8ce 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -199,7 +199,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+|``|The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
index 05fe5cea..9ea91994 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
@@ -14,7 +14,7 @@ Namespaces are isolated with respect to sending and receiving data traffic to ot
## Enable Namespace Isolation
Namespace isolation is enabled by setting the isolationEnabled parameter to true and disabled by setting the
same parameter to false in the slice configuration file. To know more, see [namespace isolation profile parameters](/versioned_docs/version-0.5.0/reference/configuration-parameters.mdx#namespace-isolation-profile-parameters)
-and the [slice configuration YAML](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) file.
+and the [slice configuration YAML](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) file.
When the namespace isolation feature is enabled, the namespace isolation policy is
applied to isolate the application namespaces. Verify the namespace isolation policy by
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
index 22beb251..68e27e52 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
@@ -11,7 +11,7 @@ form a micro-network segment. After a namespace is bound to a slice, all the pod
scheduled in the namespace would get connected to the slice.
## Onboard Namespaces
-To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file.
+To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file.
You can add namespaces in the following ways in the slice configuration YAML file:
- Add namespaces for each worker cluster.
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index 760d99a8..a17c487f 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -162,9 +162,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index 5e3dcbb6..8eb81a76 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -297,8 +297,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -315,8 +315,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The AWS region the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The AWS region the cluster belongs to.|
The following command retrieves your EKS cluster `kubeconfig` and adds
it to your default `kubeconfig` path. Complete this step for each EKS
@@ -334,9 +334,9 @@ Engine (GKE) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The region the cluster belongs to.|
-| | The project ID that the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The region the cluster belongs to.|
+| `` | The project ID that the cluster belongs to.|
The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -388,10 +388,10 @@ The following information is required to label the GKE cluster nodepools.
|**Variable** | **Description** |
|-----|----|
-|| The name of the nodepool being labeled.|
-| | The name of the cluster the nodepool being labeled belongs to.|
-| | The Compute Engine region for the cluster the nodepool belongs to.|
-| | The Compute Engine zone for the cluster the nodepool belongs to.|
+|``| The name of the nodepool being labeled.|
+|`` | The name of the cluster the nodepool being labeled belongs to.|
+| `` | The Compute Engine region for the cluster the nodepool belongs to.|
+| `` | The Compute Engine zone for the cluster the nodepool belongs to.|
The following command labels the GKE cluster nodepool:
diff --git a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
index f6a69241..763c93bb 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
| Variables | Description |
|-------------------------|---------------------------------------------------------
-| | The name of the cluster the application is deployed on.|
-| | The name of the service export that you want to delete.|
-| | The namespace the application is deployed on.|
+| `` | The name of the cluster the application is deployed on.|
+|`` | The name of the service export that you want to delete.|
+| ``| The namespace the application is deployed on.|
Switch the contexts to the cluster you deployed the application on:
diff --git a/versioned_docs/version-0.5.0/getting-started-with-kind-clusters.mdx b/versioned_docs/version-0.5.0/getting-started-with-kind-clusters.mdx
index d028c771..a71efbeb 100644
--- a/versioned_docs/version-0.5.0/getting-started-with-kind-clusters.mdx
+++ b/versioned_docs/version-0.5.0/getting-started-with-kind-clusters.mdx
@@ -861,8 +861,7 @@ Before you begin, ensure the following prerequisites are met:
- You have the KubeSlice Controller installed on a separate cluster. For more information,
see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
### Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create
@@ -874,7 +873,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.5.0/kubeslice-cli/installing-kubeslice.mdx b/versioned_docs/version-0.5.0/kubeslice-cli/installing-kubeslice.mdx
index b26cc4bc..129f8fb1 100644
--- a/versioned_docs/version-0.5.0/kubeslice-cli/installing-kubeslice.mdx
+++ b/versioned_docs/version-0.5.0/kubeslice-cli/installing-kubeslice.mdx
@@ -18,7 +18,7 @@ Depending on the requirements, the KubeSlice Controller and/or worker components
or across all the clusters in your topology.
For demonstration purposes, to set up a three-cluster topology of kind clusters in your local environment, use the
-**—profile ** option instead of the **—config** option.
+**—profile ``** option instead of the **—config** option.
## Install the KubeSlice Controller and Worker Clusters
diff --git a/versioned_docs/version-0.5.0/reference/configuration-parameters.mdx b/versioned_docs/version-0.5.0/reference/configuration-parameters.mdx
index 792587fd..9d3d16ed 100644
--- a/versioned_docs/version-0.5.0/reference/configuration-parameters.mdx
+++ b/versioned_docs/version-0.5.0/reference/configuration-parameters.mdx
@@ -173,7 +173,7 @@ The following tables describe the configuration parameters used to create the Sl
### Slice Metadata Parameters
These parameters are related to the metadata configured in the
-[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -182,7 +182,7 @@ These parameters are related to the metadata configured in the
### Slice Spec Parameters
These parameters are related to the spec configured in the
-[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -193,14 +193,14 @@ These parameters are related to the spec configured in the
| sliceIpamType | String | It is the type of the IP address management for the slice subnet. The value must be always set to `Local`. | Mandatory |
| clusters | List of Strings | The names of the worker clusters that would be part of the slice. You can provide the list of worker clusters. | Mandatory |
| [qosProfileDetails](#qos-profile-parameters) | Object | QoS profile for the slice inter cluster traffic. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
-| [standardQosProfileName](#standard-qos-profile-parameters) | String | This [name](#slice-qos-profile-metadata-parameter) of the [external QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
+| [standardQosProfileName](#standard-qos-profile-parameters) | String | This name of the [external QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
| [namespaceIsolationProfile](#namespace-isolation-profile-parameters) | Object | It is the configuration to onboard namespaces and/or isolate namespaces with the network policy. | Mandatory |
| [externalGatewayConfig](#external-gateway-configuration-parameters) | Object | It is the slice ingress/egress gateway configuration. It is an optional configuration. | Mandatory |
#### Slice Gateway Provider Parameters
These parameters are related to the slice gateway created for the inter-cluster
communication and they are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -209,7 +209,7 @@ communication and they are configured in the
#### QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+configured in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -223,7 +223,7 @@ configured in the [slice configuration YAML file](/versioned_docs/version-0.5.0/
#### Namespace Isolation Profile Parameters
These parameters are related to onboarding namespaces, isolating the slice, and allowing
external namespaces to communicate with the slice. They are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -233,7 +233,7 @@ external namespaces to communicate with the slice. They are configured in the
#### Application Namespaces Parameters
These parameters are related to onboarding namespaces onto a slice, which are configured
-in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -242,7 +242,7 @@ in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-sta
#### Allowed Namespaces Parameters
These parameters are related to allowing external namespaces to communicated with the slice,
-which are configured in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+which are configured in the [slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -251,7 +251,7 @@ which are configured in the [slice configuration YAML file](/versioned_docs/vers
#### External Gateway Configuration Parameters
These parameters are related to external gateways, which are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -262,13 +262,13 @@ These parameters are related to external gateways, which are configured in the
## Standard QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
+configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx).
Parameter|Parameter Type|Description|Required|
|----|----|----|----|
| apiVersion | String | The KubeSlice Controller API version. A set of resources that are exposed together, along with the version. The value must be `networking.kubeslice.io/v1beta1`. | Mandatory |
| kind | String | The name of a particular object schema. The value must be `SliceQoSConfig`. | Mandatory |
-| [metadata](#standard-qos-profile-metadata-parameters) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
+| [metadata](#standard-qos-profile-metadata-parameter) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
| [spec](#standard-qos-profile-specification-parameters) | Object | The specification of the desired state of an object. | Mandatory |
### Standard QoS Profile Metadata Parameter
diff --git a/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx b/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
index 2924da6f..f95d921d 100644
--- a/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
+++ b/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
@@ -32,7 +32,7 @@ onboarded application in the slice configuration file. To know more, see
To onboard namespaces:
-1. Edit the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
+1. Edit the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
* Add namespaces for each worker cluster.
* Add a wildcard ***** (asterisk) to add all namespaces in the worker clusters.
diff --git a/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx b/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
index 14f88f9e..2158cd67 100644
--- a/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
+++ b/versioned_docs/version-0.5.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
@@ -14,4 +14,4 @@ For managing and monitoring IP addresses on a slice, a new parameter has been in
to configure the maximum number of clusters that can be connected to a slice. This parameter
is configurable only during slice creation. The value is immutable after the slice creation.
-For more information, see the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
\ No newline at end of file
+For more information, see the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
\ No newline at end of file
diff --git a/versioned_docs/version-0.5.0/tutorials/kind-create-slice.mdx b/versioned_docs/version-0.5.0/tutorials/kind-create-slice.mdx
index 8ce3d2ac..992674b8 100644
--- a/versioned_docs/version-0.5.0/tutorials/kind-create-slice.mdx
+++ b/versioned_docs/version-0.5.0/tutorials/kind-create-slice.mdx
@@ -11,7 +11,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo.mdx b/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo.mdx
index 3f4c9535..9ae5d38b 100644
--- a/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo.mdx
+++ b/versioned_docs/version-0.5.0/tutorials/kubeslice-cli-demo.mdx
@@ -85,10 +85,10 @@ You have successfully installed the KubeSlice Controller on the controller clust
The `kubeslice-cli install —profile=minimal-demo` command creates a slice called `demo` after successfully installing KubeSlice Controller
-and the Slice Operator on the worker clusters. To validate the demo slice, see [Validating the Slice](#validating-the-slice).
+and the Slice Operator on the worker clusters.
You can now onboard the iperf application on the `demo` slice. To onboard the application on the slice, see
-[Deploying the iPerf Application](#deploying-the-iperf-application).
+[Deploying the iPerf Application](/versioned_docs/version-0.4.0/tutorials/deploying-the-iperf-application.mdx).
You can also use the kubeslice-cli command to create a new slice for application onboarding. To create a slice on your demo setup,
follow these steps.
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index e908d235..90ab58f4 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -12,8 +12,7 @@ Before you begin, ensure the following prerequisites are met:
see [Installing the KubeSlice Controller](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#install-istio).
+- You have installed Istio in the worker clusters to configure the external gateways.
## Creating the Slice YAML File
@@ -36,7 +35,7 @@ For example YAML files on kind clusters, see [kind YAML examples](/versioned_doc
Create the slice configuration `.yaml` file using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -102,7 +101,7 @@ are the scenarios to configure a slice with/without egress and ingress gateways.
Create the slice configuration file with Istio egress gateway using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -169,7 +168,7 @@ Create the slice configuration file with Istio ingress gateways using the follow
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -236,7 +235,7 @@ Create the slice configuration file with Istio ingress and egress gateways using
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -300,9 +299,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index 86368290..b7ca4ea1 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -199,7 +199,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+|``|The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
index 7319187f..a154c150 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/isolating-namespaces.mdx
@@ -14,7 +14,7 @@ Namespaces are isolated with respect to sending and receiving data traffic to ot
## Enable Namespace Isolation
Namespace isolation is enabled by setting the isolationEnabled parameter to true and disabled by setting the
same parameter to false in the slice configuration file. To know more, see [namespace isolation profile parameters](/versioned_docs/version-0.6.0/reference/configuration-parameters.mdx#namespace-isolation-profile-parameters)
-and the [slice configuration YAML](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) file.
+and the [slice configuration YAML](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) file.
When the namespace isolation feature is enabled, the namespace isolation policy is
applied to isolate the application namespaces. Verify the namespace isolation policy by
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
index 7be25bdc..55403158 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx
@@ -11,7 +11,7 @@ form a micro-network segment. After a namespace is bound to a slice, all the pod
scheduled in the namespace would get connected to the slice.
## Onboard Namespaces
-To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file.
+To onboard namespaces, you must add them as part of applicationNamespaces in the [slice configuration](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file.
You can add namespaces in the following ways in the slice configuration YAML file:
- Add namespaces for each worker cluster.
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index ec64c1be..49dabcca 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -162,9 +162,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index f013aabc..1399956f 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -297,8 +297,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -315,8 +315,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The AWS region the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The AWS region the cluster belongs to.|
The following command retrieves your EKS cluster `kubeconfig` and adds
it to your default `kubeconfig` path. Complete this step for each EKS
@@ -334,9 +334,9 @@ Engine (GKE) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-| | The region the cluster belongs to.|
-| | The project ID that the cluster belongs to.|
+|`` | The name of the cluster you want to get credentials for.|
+| `` | The region the cluster belongs to.|
+| `` | The project ID that the cluster belongs to.|
The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -388,10 +388,10 @@ The following information is required to label the GKE cluster nodepools.
|**Variable** | **Description** |
|-----|----|
-|| The name of the nodepool being labeled.|
-| | The name of the cluster the nodepool being labeled belongs to.|
-| | The Compute Engine region for the cluster the nodepool belongs to.|
-| | The Compute Engine zone for the cluster the nodepool belongs to.|
+|``| The name of the nodepool being labeled.|
+|`` | The name of the cluster the nodepool being labeled belongs to.|
+| `` | The Compute Engine region for the cluster the nodepool belongs to.|
+| `` | The Compute Engine zone for the cluster the nodepool belongs to.|
The following command labels the GKE cluster nodepool:
diff --git a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
index f6a69241..d2c8e1cb 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx
@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
| Variables | Description |
|-------------------------|---------------------------------------------------------
-| | The name of the cluster the application is deployed on.|
-| | The name of the service export that you want to delete.|
-| | The namespace the application is deployed on.|
+| `` | The name of the cluster the application is deployed on.|
+|`` | The name of the service export that you want to delete.|
+| `` | The namespace the application is deployed on.|
Switch the contexts to the cluster you deployed the application on:
diff --git a/versioned_docs/version-0.6.0/getting-started-with-kind-clusters.mdx b/versioned_docs/version-0.6.0/getting-started-with-kind-clusters.mdx
index 0ed53e25..a05a9020 100644
--- a/versioned_docs/version-0.6.0/getting-started-with-kind-clusters.mdx
+++ b/versioned_docs/version-0.6.0/getting-started-with-kind-clusters.mdx
@@ -861,8 +861,7 @@ Before you begin, ensure the following prerequisites are met:
- You have the KubeSlice Controller installed on a separate cluster. For more information,
see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
### Creating the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create
@@ -874,7 +873,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.6.0/kubeslice-cli/installing-kubeslice.mdx b/versioned_docs/version-0.6.0/kubeslice-cli/installing-kubeslice.mdx
index a5f82ac5..03c8f95b 100644
--- a/versioned_docs/version-0.6.0/kubeslice-cli/installing-kubeslice.mdx
+++ b/versioned_docs/version-0.6.0/kubeslice-cli/installing-kubeslice.mdx
@@ -9,7 +9,7 @@ Install KubeSlice using the cluster descriptions that you provide in a custom to
components can be installed incrementally (one cluster at a time) or across all clusters in your topology, depending on your needs.
For demonstration purposes, to set up a three-cluster topology of kind clusters in your local environment, use the
-**—profile ** option instead of the **—config** option.
+**—profile ``** option instead of the **—config** option.
## Install the KubeSlice Controller and Register Worker Clusters
diff --git a/versioned_docs/version-0.6.0/reference/configuration-parameters.mdx b/versioned_docs/version-0.6.0/reference/configuration-parameters.mdx
index c1c40a03..820e4966 100644
--- a/versioned_docs/version-0.6.0/reference/configuration-parameters.mdx
+++ b/versioned_docs/version-0.6.0/reference/configuration-parameters.mdx
@@ -172,7 +172,7 @@ The following tables describe the configuration parameters used to create the Sl
### Slice Metadata Parameters
These parameters are related to the metadata configured in the
-[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -181,7 +181,7 @@ These parameters are related to the metadata configured in the
### Slice Spec Parameters
These parameters are related to the spec configured in the
-[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -192,14 +192,14 @@ These parameters are related to the spec configured in the
| sliceIpamType | String | It is the type of the IP address management for the slice subnet. The value must be always set to `Local`. | Mandatory |
| clusters | List of Strings | The names of the worker clusters that would be part of the slice. You can provide the list of worker clusters. | Mandatory |
| [qosProfileDetails](#qos-profile-parameters) | Object | QoS profile for the slice inter cluster traffic. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
-| [standardQosProfileName](#standard-qos-profile-parameters) | String | This [name](#slice-qos-profile-metadata-parameter) of the [external QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
+| [standardQosProfileName](#standard-qos-profile-parameters) | String | This name of the [external QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
| [namespaceIsolationProfile](#namespace-isolation-profile-parameters) | Object | It is the configuration to onboard namespaces and/or isolate namespaces with the network policy. | Mandatory |
| [externalGatewayConfig](#external-gateway-configuration-parameters) | Object | It is the slice ingress/egress gateway configuration. It is an optional configuration. | Mandatory |
#### Slice Gateway Provider Parameters
These parameters are related to the slice gateway created for the inter-cluster
communication and they are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -208,7 +208,7 @@ communication and they are configured in the
#### QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+configured in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -222,7 +222,7 @@ configured in the [slice configuration YAML file](/versioned_docs/version-0.6.0/
#### Namespace Isolation Profile Parameters
These parameters are related to onboarding namespaces, isolating the slice, and allowing
external namespaces to communicate with the slice. They are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -232,7 +232,7 @@ external namespaces to communicate with the slice. They are configured in the
#### Application Namespaces Parameters
These parameters are related to onboarding namespaces onto a slice, which are configured
-in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -241,7 +241,7 @@ in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-sta
#### Allowed Namespaces Parameters
These parameters are related to allowing external namespaces to communicated with the slice,
-which are configured in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+which are configured in the [slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -250,7 +250,7 @@ which are configured in the [slice configuration YAML file](/versioned_docs/vers
#### External Gateway Configuration Parameters
These parameters are related to external gateways, which are configured in the
-[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
+[slice configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
|Parameter|Parameter Type|Description|Required|
|----|----|----|----|
@@ -261,13 +261,13 @@ These parameters are related to external gateways, which are configured in the
## Standard QOS Profile Parameters
These parameters are related to the QoS profile for the slice inter-cluster traffic
-configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
+configured in the [standard QoS profile configuration YAML file](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx).
Parameter|Parameter Type|Description|Required|
|----|----|----|----|
| apiVersion | String | The KubeSlice Controller API version. A set of resources that are exposed together, along with the version. The value must be `networking.kubeslice.io/v1beta1`. | Mandatory |
| kind | String | The name of a particular object schema. The value must be `SliceQoSConfig`. | Mandatory |
-| [metadata](#standard-qos-profile-metadata-parameters) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
+| [metadata](#standard-qos-profile-metadata-parameter) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
| [spec](#standard-qos-profile-specification-parameters) | Object | The specification of the desired state of an object. | Mandatory |
### Standard QoS Profile Metadata Parameter
diff --git a/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx b/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
index 2924da6f..f95d921d 100644
--- a/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
+++ b/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.2.0.mdx
@@ -32,7 +32,7 @@ onboarded application in the slice configuration file. To know more, see
To onboard namespaces:
-1. Edit the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
+1. Edit the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file) YAML file to add namespaces as part of applicationNamespaces . You can add namespaces in the following ways in the slice configuration YAML file:
* Add namespaces for each worker cluster.
* Add a wildcard ***** (asterisk) to add all namespaces in the worker clusters.
diff --git a/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx b/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
index 14f88f9e..2158cd67 100644
--- a/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
+++ b/versioned_docs/version-0.6.0/release-notes/release-notes-for-kubeslice-oss-0.4.0.mdx
@@ -14,4 +14,4 @@ For managing and monitoring IP addresses on a slice, a new parameter has been in
to configure the maximum number of clusters that can be connected to a slice. This parameter
is configurable only during slice creation. The value is immutable after the slice creation.
-For more information, see the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
\ No newline at end of file
+For more information, see the [slice configuration](/versioned_docs/version-0.5.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-the-slice-yaml-file).
\ No newline at end of file
diff --git a/versioned_docs/version-0.6.0/tutorials/kind-create-slice.mdx b/versioned_docs/version-0.6.0/tutorials/kind-create-slice.mdx
index 39f7e257..d4b4126c 100644
--- a/versioned_docs/version-0.6.0/tutorials/kind-create-slice.mdx
+++ b/versioned_docs/version-0.6.0/tutorials/kind-create-slice.mdx
@@ -11,7 +11,7 @@ Create the slice configuration .yaml file using the following template.
:::info
If you want to add a standard QoS profile configuration for multiple slices,
-[create a standard QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile).
+[create a standard QoS profile](/versioned_docs/version-0.6.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
Add the name of the external QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
diff --git a/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo.mdx b/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo.mdx
index 66540a49..2a31c9aa 100644
--- a/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo.mdx
+++ b/versioned_docs/version-0.6.0/tutorials/kubeslice-cli-demo.mdx
@@ -85,10 +85,10 @@ You have successfully installed the KubeSlice Controller on the controller clust
The `kubeslice-cli install —profile=minimal-demo` command creates a slice called `demo` after successfully installing KubeSlice Controller
-and the Slice Operator on the worker clusters. To validate the demo slice, see [Validating the Slice](#validating-the-slice).
+and the Slice Operator on the worker clusters.
You can now onboard the iperf application on the `demo` slice. To onboard the application on the slice, see
-[Deploying the iPerf Application](#deploying-the-iperf-application).
+[Deploying the iPerf Application](/versioned_docs/version-0.4.0/tutorials/deploying-the-iperf-application.mdx).
You can also use the kubeslice-cli command to create a new slice for application onboarding. To create a slice on your demo setup,
follow these steps.
diff --git a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
index ee19b81b..ebccbca9 100644
--- a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
+++ b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx
@@ -13,9 +13,9 @@ see [Installing the KubeSlice Controller](/versioned_docs/version-0.7.0/getting-
- You have registered two or more worker clusters with the KubeSlice Controller. For more information,
see [Registering the Worker Cluster](/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
- You have installed Istio in the worker clusters to configure the external gateways. For more information,
-see [Installing Istio](/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#install-istio).
+see [Installing Istio](/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx#install-istio).
-## Creating the Slice YAML File
+## Create the Slice YAML File
After successfully registering the worker clusters with the KubeSlice Controller, create a slice to onboard your application namespaces. You can create a slice across the multiple clusters or intra-cluster.
@@ -36,7 +36,7 @@ For example YAML files on kind clusters, see [kind YAML examples](/versioned_doc
Create the slice configuration `.yaml` file using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -102,7 +102,7 @@ are the scenarios to configure a slice with/without egress and ingress gateways.
Create the slice configuration file with Istio egress gateway using the following template.
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -169,7 +169,7 @@ Create the slice configuration file with Istio ingress gateways using the follow
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -236,7 +236,7 @@ Create the slice configuration file with Istio ingress and egress gateways using
:::info
If you want to add a QoS profile configuration for multiple slices,
-[create a standard QoS profile](#creating-a-standard-qos-profile). Add the name of the external
+[create a standard QoS profile](#create-a-standard-qos-profile). Add the name of the external
QoS profile as the value of `standardQosProfileName` in the slice configuration YAML file.
In a slice configuration YAML file, the `standardQosProfileName` parameter and the `qosProfileDetails`
@@ -300,9 +300,9 @@ The following information is required.
|Variable|Description|
|----|----|
-||The name of the cluster.|
-||The name of the slice configuration file.|
-||The project namespace on which you apply the slice configuration file.|
+|``|The name of the cluster.|
+|``|The name of the slice configuration file.|
+|``|The project namespace on which you apply the slice configuration file.|
Perform these steps:
@@ -346,7 +346,7 @@ spec:
bandwidthGuaranteedKbps: 2562
dscpClass: AF11
```
-#### Apply the Standard QOS Profile YAML File
+#### Apply the Standard QoS Profile YAML File
Apply the `slice-qos-config` file using the following command.
```
diff --git a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
index 9427806b..711480d4 100644
--- a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
+++ b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx
@@ -8,7 +8,7 @@ cluster running the KubeSlice controller can also be used as a worker cluster.
**We recommend that you run the KubeSlice Controller on a separate cluster**.
Installing the KubeSlice Controller installs the following:
-- KubeSlice Controller specific ClusterResourceDefinitions(CRDs)
+- KubeSlice Controller specific ClusterResourceDefinitions (CRDs)
- ClusterRole, ServiceAccount and ClusterRoleBinding for KubeSlice Controller
- A Role and RoleBinding for KubeSlice Controller Leader Election
- KubeSlice Controller workload
@@ -171,7 +171,7 @@ The following information is required.
|Parameter|Description|
|-----|-----|
-||The given name of the project YAML file.|
+|``|The given name of the project YAML file.|
Use the following command to apply the YAML file:
```
diff --git a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
index 990337c7..9460e95f 100644
--- a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
+++ b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx
@@ -174,9 +174,9 @@ The following information is required.
|Values|Description|
|----|----|
-||The name of the cluster.|
-||The name of the registration file.|
-||The namespace of your project.|
+|``|The name of the cluster.|
+|``|The name of the registration file.|
+|``|The namespace of your project.|
Perform these steps:
diff --git a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
index 4e4465a8..ca017f8c 100644
--- a/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
+++ b/versioned_docs/version-0.7.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx
@@ -297,8 +297,8 @@ Kubernetes Service (AKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|-----|
-| | The name of the resource group the cluster belongs to.
- | The name of the cluster you would like to get credentials for.|
+| `` | The name of the resource group the cluster belongs to.
+ `` | The name of the cluster you would like to get credentials for.|
The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
AKS cluster that you want to work with.
@@ -315,8 +315,8 @@ Service (EKS) `kubeconfig`.
| **Variable** | **Description** |
|-----|----|
-| | The name of the cluster you want to get credentials for.|
-|