Skip to content

Commit

Permalink
Fixed the broken and incorrect links in version 1.0.0 and 1.1.0 (#139)
Browse files Browse the repository at this point in the history
* Fixed the broken and incorrect links in version 1.0.0 and 1.1.0

* Fixed broken links
  • Loading branch information
veenamj-avesha authored Oct 11, 2023
1 parent 6a8e893 commit e857960
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 105 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ order of operations provided under this topic.

## Offboard Namespaces
To offboard the namespaces from slice, you must first delete the serviceexport for each application. For more information, see
[offboard Namespaces](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx).
[offboard Namespaces](/versioned_docs/version-1.0.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).


## Delete a Slice
Expand All @@ -32,7 +32,7 @@ Before deregistering the worker cluster, ensure you have offboarded all namespac
:::

You must first uninstall the Slice Operator from the worker cluster before deregistering it from the KubeSlice Controller. To uninstall
the Slice Operator, follow the instructions in the [uninstall the Slice Operator](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/deregistering-the-worker-cluster.mdx#uninstall-the-slice-operator)
the Slice Operator, follow the instructions in the [uninstall the Slice Operator](/versioned_docs/version-1.0.0/uninstall-kubeslice/uninstall-kubeslice.mdx#uninstall-the-slice-operator)
section.

Use the following command to delete a registered worker cluster:
Expand All @@ -59,4 +59,4 @@ Before deleting a project, ensure all namespaces have been offboarded, the slice
:::

After deleting all the projects, uninstall the KubeSlice Controller. To uninstall the KubeSlice Controller, see
[uninstall the KubeSlice Controller](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/uninstalling-the-kubeslice-controller.mdx).
[uninstall the KubeSlice Controller](/versioned_docs/version-1.0.0/uninstall-kubeslice/uninstall-kubeslice.mdx#uninstall-the-kubeslice-controller).
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ applications do not work as expected.

To avoid this breaking change, you must add the corresponding namespace of the existing
onboarded application in the slice configuration file. To know more, see
[namespace isolation profile parameters](/versioned_docs/version-1.0.0//reference/configuration-parameters.mdx#namespace-isolation-profile-parameters).
[namespace isolation profile parameters](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#namespace-isolation-profile-parameters).
:::

To onboard namespaces:

1. Edit the [slice configuration](/versioned_docs/version-1.0.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-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ KubeSlice supports a standard QoS profile configuration in a separate YAML file.
This QoS profile must be applied and called out as a standard QoS profile in
a slice configuration. This is useful when you want to configure the same
QoS profile on multiple slices. For more information, see
[creating a standard QoS profile](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
[creating a standard QoS profile](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#create-a-standard-qos-profile).

## Bug Fixes
* The issue where the QoS traffic on a worker cluster did not work due to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
For more information, see the [slice configuration](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation).
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ of cluster registration by 120 seconds. The worker cluster can only be added to

Workaround: In the following topics, you must skip the steps related to Istio:

* [Prerequisites](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx)
* [Register the worker cluster](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx)
* [Create a slice](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx)
* [Deploy the BookInfo application](/versioned_docs/version-1.0.0//tutorials/deploying-the-bookinfo-application.mdx)
* [Prerequisites](/versioned_docs/version-1.0.0/get-started/prerequisites/prerequisites-install-istio.mdx)
* [Register the worker cluster](/versioned_docs/version-1.0.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx)
* [Create a slice](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx)
* [Deploy the BookInfo application](/versioned_docs/version-1.0.0/tutorials/yaml-tutorials/deploy-the-bookinfo-application.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To establish the connectivity between two worker clusters:
```

2. Onboard the existing `iperf` namespace to the slice. To know more, see
[onboarding namespaces](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx).
[onboarding namespaces](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#manage-namespaces).

:::caution
Ensure that you have onboarded the iperf namespace. If you create a namespace after
Expand Down Expand Up @@ -108,7 +108,7 @@ the following command:
```

7. Onboard the existing `iperf` namespace on the slice. To know more, see
[onboarding namespaces](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/installing-kubeslice/managing-namespaces.mdx).
[onboarding namespaces](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#manage-namespaces).

:::caution
Ensure that you have onboarded the iperf namespace. If you create a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Uninstall KubeSlice
This topic describes how to uninstall KubeSlice. Follow these steps to uninstall the KubeSlice Controller:

- Delete namespace and slice quotas
- Delete the ServiceExport for each application
- Offboard all namespaces from the slice
- Delete a slice
Expand All @@ -10,29 +9,6 @@ This topic describes how to uninstall KubeSlice. Follow these steps to uninstall
- Delete a project
- Uninstall the KubeSlice Controller

## Delete Namespace Quotas
### Namespace Level

To delete namespace quotas from your configuration, follow these steps:

1. Open the `slice-resource-configuration.yaml` file.
2. Locate the namespace quotas you wish to delete.
3. Delete the relevant section of the YAML file related to the quotas.
4. Save the changes to the file.
5. Apply the updated YAML file to refresh the configuration.

### Slice Level
To remove slice level quotas from the configuration, follow these steps:

1. Open the `slice-resource-configuration.yaml` file.
2. Locate the metadata section of the quotas you want to delete.
3. Note the value of the `name` field.
4. Use the following command to delete the slice quotas for limits and requests, replacing `<metadata name field value>` and `<project namespace>` with the appropriate values:

```
kubectl delete SliceResourceQuotaConfig <metadata name field value> -n <project namespace>
```

## Delete ServiceExports
If a ServiceExport was created in the application namespace, it must be deleted first.

Expand Down Expand Up @@ -220,13 +196,6 @@ kubeslice-cli delete project <project-name> -n <controller-namespace>
```
## Uninstall the KubeSlice Controller
### Uninstall the KubeSlice Manager
Uninstall the KubeSlice Manager using the following command:
```
helm uninstall kubeslice-ui -n kubeslice-controller
```
### Uninstall the KubeSlice Controller
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ order of operations provided under this topic.

## Offboard Namespaces
To offboard the namespaces from slice, you must first delete the serviceexport for each application. For more information, see
[offboard Namespaces](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx).
[offboard Namespaces](/versioned_docs/version-1.1.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).


## Delete a Slice
Expand All @@ -32,7 +32,7 @@ Before deregistering the worker cluster, ensure you have offboarded all namespac
:::

You must first uninstall the Slice Operator from the worker cluster before deregistering it from the KubeSlice Controller. To uninstall
the Slice Operator, follow the instructions in the [uninstall the Slice Operator](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/deregistering-the-worker-cluster.mdx#uninstall-the-slice-operator)
the Slice Operator, follow the instructions in the [uninstall the Slice Operator](/versioned_docs/version-1.1.0/uninstall-kubeslice/uninstall-kubeslice.mdx#uninstall-the-slice-operator)
section.

Use the following command to delete a registered worker cluster:
Expand All @@ -59,4 +59,4 @@ Before deleting a project, ensure all namespaces have been offboarded, the slice
:::

After deleting all the projects, uninstall the KubeSlice Controller. To uninstall the KubeSlice Controller, see
[uninstall the KubeSlice Controller](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/uninstalling-the-kubeslice-controller.mdx).
[uninstall the KubeSlice Controller](/versioned_docs/version-1.1.0/uninstall-kubeslice/uninstall-kubeslice.mdx#uninstall-the-kubeslice-controller).
4 changes: 2 additions & 2 deletions versioned_docs/version-1.1.0/playground/sandbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Now with the access to your sandbox virtual machine (VM), a few tasks that you c

* Run `kubeslice-cli install --profile=full-demo` to get a full environment setup for you. This setup
provides you three kind clusters. You can use this setup to explore and learn about KubeSlice without installing anything.
To know more, see [kubeslice-cli](/versioned_docs/version-1.0.0/install-kubeslice/kubeslice-cli/install-kubeslice-cli.mdx)
To know more, see [kubeslice-cli](/versioned_docs/version-1.1.0/install-kubeslice/kubeslice-cli/install-kubeslice-cli.mdx)
* If you want to practice installing Kubeslice, you can do the
[minimal-demo](/versioned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo.mdx).
[minimal-demo](/versioned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo.mdx).
* If you are a contributor, you can install a topology, clone your repo to the sandbox VM, and
try out your modifications.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ applications do not work as expected.

To avoid this breaking change, you must add the corresponding namespace of the existing
onboarded application in the slice configuration file. To know more, see
[namespace isolation profile parameters](/versioned_docs/version-1.0.0//reference/configuration-parameters.mdx#namespace-isolation-profile-parameters).
[namespace isolation profile parameters](/versioned_docs/version-1.1.0/reference/configuration-parameters.mdx#namespace-isolation-profile-parameters).
:::

To onboard namespaces:

1. Edit the [slice configuration](/versioned_docs/version-1.0.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-1.1.0/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation) 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ KubeSlice supports a standard QoS profile configuration in a separate YAML file.
This QoS profile must be applied and called out as a standard QoS profile in
a slice configuration. This is useful when you want to configure the same
QoS profile on multiple slices. For more information, see
[creating a standard QoS profile](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-a-standard-qos-profile).
[creating a standard QoS profile](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#create-a-standard-qos-profile).

## Bug Fixes
* The issue where the QoS traffic on a worker cluster did not work due to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#create-the-slice-yaml-file).
For more information, see the [slice configuration](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx#slice-creation).
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ of cluster registration by 120 seconds. The worker cluster can only be added to

Workaround: In the following topics, you must skip the steps related to Istio:

* [Prerequisites](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx)
* [Register the worker cluster](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx)
* [Create a slice](/versioned_docs/version-1.0.0//getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx)
* [Deploy the BookInfo application](/versioned_docs/version-1.0.0//tutorials/deploying-the-bookinfo-application.mdx)
* [Prerequisites](/versioned_docs/version-1.1.0/get-started/prerequisites/prerequisites-install-istio.mdx)
* [Register the worker cluster](versioned_docs/version-1.1.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx)
* [Create a slice](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx)
* [Deploy the BookInfo application](/versioned_docs/version-1.1.0/tutorials/yaml-tutorials/deploy-the-bookinfo-application.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ BookInfo application to demonstrate inter-slice communication.
Before you begin, ensure the following prerequisites are met:

- You have the KubeSlice Controller components and worker cluster components on the same cluster. For more information,
see [Installing KubeSlice](/versioned_docs/version-1.0.0/install-kubeslice/yaml/yaml-controller-install.mdx)
and [Registering the Worker Cluster](/versioned_docs/version-1.0.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx).
see [Installing KubeSlice](/versioned_docs/version-1.1.0/install-kubeslice/yaml/yaml-controller-install.mdx)
and [Registering the Worker Cluster](/versioned_docs/version-1.1.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx).
- Before creating a slice, create the `bookinfo` namespace in all the participating worker clusters.
Use the following command to create the `bookinfo` namespace:
```
kubectl create ns bookinfo
```
## Creating the Slice
To install the BookInfo application on a single cluster, you must create a slice without Istio enabled. For more information,
see [Creating a Slice](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
see [Creating a Slice](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).

## Creating the BookInfo Deployment YAML Files
Using the templates below, create the necessary .yaml files to deploy the BookInfo application. All fields in the
Expand Down Expand Up @@ -582,4 +582,4 @@ You have successfully deployed the BookInfo application on a KubeSlice configura

## Uninstall Istio BookInfo
To uninstall Istio BookInfo from your KubeSlice configuration, follow the instructions
in [offboarding namespaces](/versioned_docs/version-1.0.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).
in [offboarding namespaces](/versioned_docs/version-1.1.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ BookInfo application to demonstrate inter-slice communication.
Before you begin, ensure the following prerequisites are met:

- You have a KubeSlice configuration with two or more clusters registered. For more information,
see [Installing KubeSlice](/versioned_docs/version-1.0.0/install-kubeslice/yaml/yaml-controller-install.mdx)
and [Registering the Worker Cluster](/versioned_docs/version-1.0.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx).
see [Installing KubeSlice](/versioned_docs/version-1.1.0/install-kubeslice/yaml/yaml-controller-install.mdx)
and [Registering the Worker Cluster](/versioned_docs/version-1.1.0/install-kubeslice/yaml/yaml-register-worker-clusters.mdx).
- You have Istio installed in all registered worker clusters.
- Before creating a slice, create the `bookinfo` namespace in all the participating worker clusters.
Use the following command to create the `bookinfo` namespace:
Expand All @@ -22,7 +22,7 @@ and [Registering the Worker Cluster](/versioned_docs/version-1.0.0/install-kubes
kubectl label namespace bookinfo istio-injection=enabled
```
- You have the slice created across the worker clusters. For more information,
see [Creating a Slice](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
see [Creating a Slice](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).

## Create the BookInfo Deployment YAML Files
Using the templates below, create the necessary .yaml files to deploy the BookInfo application.
Expand Down Expand Up @@ -592,4 +592,4 @@ You have successfully deployed BookInfo application on a KubeSlice configuration

## Uninstall Istio BookInfo
To uninstall BookInfo application from your KubeSlice configuration, follow the
instructions in [offboarding namespaces](/versioned_docs/version-1.0.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).
instructions in [offboarding namespaces](/versioned_docs/version-1.1.0/uninstall-kubeslice/uninstall-kubeslice.mdx#offboard-application-namespaces).
Loading

0 comments on commit e857960

Please sign in to comment.