Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

AM-11418: Fixed the hyperlinks in the kubeslice-cli tutorials #126

Merged
merged 4 commits into from
Sep 6, 2023
Merged

AM-11418: Fixed the hyperlinks in the kubeslice-cli tutorials #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfa9924
fixed the hyperlinks
uma-kt Sep 6, 2023
7e50841
fixed the hyperlinks
uma-kt Sep 6, 2023
1df770c
fixed the typos
uma-kt Sep 6, 2023
c3cc9fd
fixed the typos
uma-kt Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions ...0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,6 @@ YAML file.
## Slice Creation
Create the slice configuration `.yaml` file using the following template.

:::info
To understand more about the parameters, see [Slice Configuration Parameters](#slice-configuration-parameters).
:::

```
apiVersion: controller.kubeslice.io/v1alpha1
kind: SliceConfig
Expand Down
14 changes: 7 additions & 7 deletions ....0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ your existing clusters, use the `kubeslice-cli install` command.
## Prerequisites
Before you begin, ensure the following prerequisites are met:
- You have set up the environment to install the KubeSlice Controller on the cluster. For more information,
see [Prerequisites](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx).
see [Prerequisites](/versioned_docs/version-1.0.0/get-started/prerequisites/prerequisites-kubeslice-controller-requirements.mdx).
- You have set up the environment for the worker clusters. For more information,
see [Prerequisites](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx).
see [Prerequisites](/versioned_docs/version-1.0.0/get-started/prerequisites/prerequisites-worker-cluster-requirements.mdx).
- You have authenticated the worker clusters with the cloud providers. For more information,
see [Prepare Clusters](/versioned_docs/version-1.0.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx).
see [Prepare Clusters](/versioned_docs/version-1.0.0/get-started/prerequisites/prerequisites-cluster-authentication.mdx).

## Install KubeSlice

Expand All @@ -19,8 +19,8 @@ In this demonstration, let us install KubeSlice on cloud clusters using the cust
## Install the KubeSlice Controller and Worker Clusters

You must create a topology configuration file that includes the names of the clusters and the cluster contexts that host the
KubeSlice Controller, the worker clusters, and a project name. For more information, see the sample
[topology configuration](/versioned_docs/version-1.0.0/reference/sample-configuration-file.mdx#create-a-topology-configuration-file-for-cloud-clusters) file.
KubeSlice Controller, the worker clusters, and a project name. For more information, see the
[sample configuration](/versioned_docs/version-1.0.0/install-kubeslice/kubeslice-cli/install-kubeslice.mdx#sample-topology-configuration-file) file.

The following is an example custom topology file for installing KubeSlice in an existing setup.
```
Expand Down Expand Up @@ -113,7 +113,7 @@ To onboard your existing namespaces (and their applications) onto a slice:
Use the following template to create a slice configuration YAML file.
:::info
To understand more about the configuration parameters, see
[Slice Configuration Parameters](/versioned_docs/version-1.0.0/reference/configuration-parameters.mdx#slice-configuration-parameters).
[Slice Configuration Parameters](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
:::

```
Expand Down Expand Up @@ -258,4 +258,4 @@ kubeslice-cli uninstall --config=<file-path-of-topology> --all
```


To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.0.0/kubeslice-cli/uninstalling-kubeslice.mdx).
To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.0.0/kubeslice-cli/uninstall-kubeslice.mdx).
6 changes: 3 additions & 3 deletions ...ned_docs/version-1.0.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. To validate the demo slice, see [Validate the Slice](#validate-the-slice).

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).
[Deploy the iPerf Application](#deploy-the-iperf-application).

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.
Expand All @@ -102,7 +102,7 @@ Create a slice configuration YAML file using the following template and apply it

### Create the Slice Configuration YAML File
:::info
To understand more about the configuration parameters, see [Slice Configuration Parameters](/versioned_docs/version-1.0.0/reference/configuration-parameters.mdx#slice-configuration-parameters).
To understand more about the configuration parameters, see [Slice Configuration Parameters](/versioned_docs/version-1.0.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
:::

Use the following template to create a slice.
Expand Down
5 changes: 0 additions & 5 deletions ...1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ This parameter is related to the open VPN certificate generation and is configur
| cipher | Alphanumeric | This is the type of cipher used to generate the open VPN certificates. The value can be set to `AES_128_CBC`. The default value is `AES_256_CBC`.This parameter is provided as part of the slice configuration during creation. This configuration is immutable during the lifetime of the slice.| Optional |



#### QOS Profile Parameters

These parameters are related to the QoS profile for the slice inter-cluster traffic configured in the
Expand Down Expand Up @@ -163,10 +162,6 @@ the creation of slice.

Create the slice configuration YAML file using the following template.

:::info
To understand more about the parameters, see [Slice Configuration Parameters](#slice-configuration-parameters).
:::

```
apiVersion: controller.kubeslice.io/v1alpha1
kind: SliceConfig
Expand Down
14 changes: 7 additions & 7 deletions ....1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo-on-cloud-clusters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ your existing clusters, use the `kubeslice-cli install` command.
## Prerequisites
Before you begin, ensure the following prerequisites are met:
- You have set up the environment to install the KubeSlice Controller on the cluster. For more information,
see [Prerequisites](/versioned_docs/version-1.1.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx).
see [Prerequisites](/versioned_docs/version-1.1.0/get-started/prerequisites/prerequisites-kubeslice-controller-requirements.mdx).
- You have set up the environment for the worker clusters. For more information,
see [Prerequisites](/versioned_docs/version-1.1.0/getting-started-with-cloud-clusters/prerequisites/prerequisites.mdx).
see [Prerequisites](/versioned_docs/version-1.1.0/get-started/prerequisites/prerequisites-worker-cluster-requirements.mdx).
- You have authenticated the worker clusters with the cloud providers. For more information,
see [Prepare Clusters](/versioned_docs/version-1.1.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx).
see [Prepare Clusters](/versioned_docs/version-1.1.0/get-started/prerequisites/prerequisites-cluster-authentication.mdx).

## Install KubeSlice

Expand All @@ -19,8 +19,8 @@ In this demonstration, let us install KubeSlice on cloud clusters using the cust
## Install the KubeSlice Controller and Worker Clusters

You must create a topology configuration file that includes the names of the clusters and the cluster contexts that host the
KubeSlice Controller, the worker clusters, and a project name. For more information, see the sample
[topology configuration](/versioned_docs/version-1.1.0/reference/sample-configuration-file.mdx#create-a-topology-configuration-file-for-cloud-clusters) file.
KubeSlice Controller, the worker clusters, and a project name. For more information, see the [sample
configuration](/versioned_docs/version-1.1.0//install-kubeslice/kubeslice-cli/install-kubeslice.mdx#sample-topology-configuration-file) file.

The following is an example custom topology file for installing KubeSlice in an existing setup.
```
Expand Down Expand Up @@ -113,7 +113,7 @@ To onboard your existing namespaces (and their applications) onto a slice:
Use the following template to create a slice configuration YAML file.
:::info
To understand more about the configuration parameters, see
[Slice Configuration Parameters](/versioned_docs/version-1.1.0/reference/configuration-parameters.mdx#slice-configuration-parameters).
[Slice Configuration Parameters](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
:::

```
Expand Down Expand Up @@ -258,4 +258,4 @@ kubeslice-cli uninstall --config=<file-path-of-topology> --all
```


To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.1.0/kubeslice-cli/uninstalling-kubeslice.mdx).
To uninstall KubeSlice from your cloud clusters step-by-step, follow the instructions in [Uninstall KubeSlice](/versioned_docs/version-1.1.0/uninstall-kubeslice.mdx).
6 changes: 3 additions & 3 deletions ...ned_docs/version-1.1.0/tutorials/kubeslice-cli-tutorials/kubeslice-cli-demo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. To validate the demo slice, see [Validate the Slice](#validate-the-slice).

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).
[Deploy the iPerf Application](#deploy-the-iperf-application).

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.
Expand All @@ -102,7 +102,7 @@ Create a slice configuration YAML file using the following template and apply it

### Create the Slice Configuration YAML File
:::info
To understand more about the configuration parameters, see [Slice Configuration Parameters](/versioned_docs/version-1.1.0/reference/configuration-parameters.mdx#slice-configuration-parameters).
To understand more about the configuration parameters, see [Slice Configuration Parameters](/versioned_docs/version-1.1.0/install-kubeslice/yaml/slice-operations/slice-operations-slice-creation.mdx).
:::

Use the following template to create a slice.
Expand Down
Loading