Version: 1.1.0

CLI Command Reference

This topic contains information about kubeslice-cli commands, syntax, options, resource types, and a few examples of command usage.

Syntax

Use the following syntax to run the kubeslice-cli tool:

kubeslice-cli [global-options] <command> [<command-arguments>] [command-options]

Commands

The following table describes the syntax and descriptions for all the kubeslice-cli commands.

Operations	Syntax	Description
create	`kubeslice-cli create [options]`	Creates one or more resources from a file.
delete	`kubeslice-cli delete [options]`	Delete resources from a file.
describe	`kubeslice-cli describe [options]`	Describe the KubeSlice resources.
edit	`kubeslice-cli edit [options]`	Edit and update the definition of one or more kubeSlice resources.
get	`kubeslice-cli get [options]`	List one or more kubeSlice resources.
install	`kubeslice-cli install [options]`	Install kubeSlice resources.
uninstall	`kubeslice-cli uninstall [options]`	Uninstall kubeSlice resources.
help	`kubeslice-cli help`	Get more information on any command.

Options

The following are the kubeslice-cli options.

Options	Shorthand	Description
--help	-h	It provides more information on the kubeslice-cli.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--version	-v	It is the version of the `kubeslice-cli` tool.

note

The kubeslice-cli tool must have access to the clusters you want it to manage. To grant it access, set the KUBECONFIG environment variable to a path to the kubeconfig file containing the necessary keys to access those clusters. To set the KUBECONFIG environment variable, use these commands:

On Linux/macOS: export KUBECONFIG=<path to kubeconfig file>
On Windows: $env:KUBECONFIG = "kubeslice/kubeconfig.yaml"

caution

If the global —config option is not specified, kubeslice-cli attempts to execute against the current cluster context. Run the following command to determine which context you are currently in: kubectx -c.
The currently supported operations are all controller cluster specific. You must run the kubeslice-cli commands on the controller cluster. use this command to switch the cluster context: kubectx <controller-cluster>.

create

Use this command to create one or more KubeSlice resources. For example, use the create command to create a slice, project, or service export.

Syntax

kubeslice-cli --config <path-to-the-custom-topology-file> create project <project-name> --namespace <controller-namespace>
kubeslice-cli create <sliceConfig|serviceExportConfig> --namespace <project-namespace> --filename <path-to-the-configuration-yaml>

Options

The following are the kubeslice-cli create options.

Option	Shorthand	Description
--filename	-f	It is the filename, directory, or URL of the file used to create the resource.
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--setWorker	-w	It is the list of worker clusters to be registered in the SliceConfig.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the create command.

Resource Types

The following are the resource types used with the create command:

project: It is used to create, edit, delete, describe, and get the project.
sliceConfig: It is used to create, edit, delete, describe, and get the slice.
serviceExportConfig: It is used to create, edit, delete, describe, and get the service export.

Examples

The following are the example commands:

To create a slice, use the following command:

kubeslice-cli create sliceConfig -n <project-namespace> -f <slice-configuration-yaml>

Example

kubeslice-cli create sliceConfig -n kubeslice-avesha -f slice-config.yaml

Example output

🏃 Running command: /usr/local/bin/kubectl apply -f slice-config.yaml -n kubeslice-demo
sliceconfig.controller.kubeslice.io/slice-red created

Successfully Applied Slice Configuration.

To create a project, use the following command:

Kubeslice-cli create project <project-namespace> -n <controller-namespace>

Example

kubeslice-cli create project kubeslice-avesha -n kubeslice-controller

Example Output

Creating KubeSlice Project...
✔ Generated project manifest project.yaml
🏃 Running command: /usr/local/bin/kubectl apply -f kubeslice/project.yaml -n kubeslice-controller
✔ Applied project.yaml
Created KubeSlice Project.

To create service export, use the following command:

kubeslice-cli create serviceExportConfig -f <path-to-the-service-export-yaml> -n <application-namespace>

delete

Use this command to delete the KubeSlice resources. For example, use the delete command to delete a slice, project, or service export. The delete command can also be used to unregister the registered worker cluster. You must offboard the namespaces and delete the slice before unregistering the worker cluster. For more information, see Uninstalling KubeSlice.

Syntax

kubeslice-cli <delete|remove|d> project <project-name> --namespace <controller-namespace>
kubeslice-cli <delete|remove|d> <sliceConfig|serviceExportConfig> <resource-name> --namespace <project-namespace>

Options

The following are the kubeslice-cli delete command options.

Name	Shorthand	Usage
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the delete command.

Resource Types

The following are the resource types used with the create command:

project: It is used to create, edit, delete, describe, and get the project.
sliceConfig: It is used to create, edit, delete, describe, and get the slice.
serviceExportConfig: It is used to create, edit, delete, describe, and get the service export.

Examples

The following are the example commands:

To delete the slice configuration, use the following command:

kubeslice-cli delete sliceConfig <sliceConfig-name> -n <project namespace>

Example

kubeslice-cli delete sliceConfig blue -n kubeslice-demo

Example Output

Deleting KubeSlice SliceConfig...
🏃 Running command: /usr/local/bin/kubectl delete sliceconfigs.controller.kubeslice.io blue -n kubeslice-demo
sliceconfig.controller.kubeslice.io "blue" deleted

To delete a project, use the following command:

kubeslice-cli delete project <project-name> -n <controller-namespace>

Example

kubeslice-cli delete project rainbow -n kubeslice-controller

Example Output

Deleting KubeSlice Project...
🏃 Running command: /usr/local/bin/kubectl delete projects.controller.kubeslice.io uma -n kubeslice-controller
project.controller.kubeslice.io "rainbow" deleted

To delete a registered worker cluster, use the following command:

kubeslice-cli delete worker <worker-name> -n <project-namespace>

Example:

kubeslice-cli delete worker kind-ks-w-4 -n kubeslice-demo

Example Output

Deleting KubeSlice Worker...
🏃 Running command: /usr/local/bin/kubectl delete clusters.controller.kubeslice.io kind-ks-w-4 -n kubeslice-demo
cluster.controller.kubeslice.io "kind-ks-w-4" deleted

describe

Use this command to describe KubeSlice resources. This shows the details of a specific KubeSlice resource.

Syntax

kubeslice-cli describe project <project-name> --namespace <controller-namespace>
kubeslice-cli describe <sliceConfig|serviceExportConfig> --namespace <project-namespace>

Options

The following are the kubeslice-cli describe command options.

Option	Shorthand	Description
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the describe command.

Resource Types

The following are the resource types used with the describe command:

project: It is used to create, edit, delete, describe, and get the project.
sliceConfig: It is used to create, edit, delete, describe, and get the slice.
serviceExportConfig: It is used to create, edit, delete, describe, and get the service export.

Examples

The following are the example commands:

To describe the slice configuration, use the following command:

kubeslice-cli describe sliceConfig <slice-name> -n <project-namespace>

Example

kubeslice-cli describe sliceConfig slice-red -n kubeslice-demo

Example Output

Describing KubeSlice SliceConfig...
🏃 Running command: /usr/local/bin/kubectl describe sliceconfigs.controller.kubeslice.io slice-red -n kubeslice-demo
Name:         slice-red
Namespace:    kubeslice-demo
Labels:       <none>
Annotations:  <none>
API Version:  controller.kubeslice.io/v1alpha1
Kind:         SliceConfig
Metadata:
  Creation Timestamp:  2022-10-04T12:35:54Z
  Finalizers:
    controller.kubeslice.io/slice-configuration-finalizer
  Generation:  1
  Managed Fields:
    API Version:  controller.kubeslice.io/v1alpha1
    Fields Type:  FieldsV1
    fieldsV1:
      f:metadata:
        f:annotations:
           .:
          f:kubectl.kubernetes.io/last-applied-configuration:
      f:spec:
         .:
         f:clusters:
         f:qosProfileDetails:
           .:
          f:bandwidthCeilingKbps:
          f:bandwidthGuaranteedKbps:
          f:dscpClass:
          f:priority:
          f:queueType:
          f:tcType:
        f:sliceGatewayProvider:
           .:
           f:sliceCaType:
           f:sliceGatewayType:
         f:sliceIpamType:
        f:sliceSubnet:
        f:sliceType:
    Manager:      kubectl-client-side-apply
    Operation:    Update
    Time:         2022-10-04T12:35:54Z
    API Version:  controller.kubeslice.io/v1alpha1
    Fields Type:  FieldsV1
    fieldsV1:
      f:metadata:
        f:finalizers:
          .:
          v:"controller.kubeslice.io/slice-configuration-finalizer":
    Manager:         manager
    Operation:       Update
    Time:            2022-10-04T12:35:54Z
  Resource Version:  60976
  UID:               d7fa839e-9b05-4264-adc6-a061850d54d5
Spec:
  Clusters:
    ks-w-1
    ks-w-2
  Namespace Isolation Profile:
    Isolation Enabled:  false
  Qos Profile Details:
    Bandwidth Ceiling Kbps:     30000
    Bandwidth Guaranteed Kbps:  20000
    Dscp Class:                 AF11
    Priority:                   0
    Queue Type:                 HTB
    Tc Type:                    BANDWIDTH_CONTROL
  Slice Gateway Provider:
    Slice Ca Type:       Local
    Slice Gateway Type:  OpenVPN
  Slice Ipam Type:       Local
  Slice Subnet:          10.190.0.0/16
  Slice Type:            Application
Events:                  <none>

edit

Use this command to directly edit any KubeSlice resource you can retrieve through the command line tools. It opens the editor defined by your KUBE_EDITOR, or EDITOR environment variables, or falls back to vi for Linux or notepad for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. The default format is YAML. In the event of an error while updating, a temporary file is created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

Syntax

kubeslice-cli <edit|e> project <project-name> --namespace <controller-namespace>
kubeslice-cli <edit|e> <sliceConfig|serviceExportConfig> <resource-name> --namespace <project-namespace>

Options

The following are the kubeslice-cli edit command options.

Option	Shorthand	Description
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--filename	-f	It is the filename, directory, or URL of the file used to create the resource.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the edit command.

Resource Types

The following are the resource types used with create command:

project: It is used to create, edit, delete, describe, and get the project.
sliceConfig: It is used to create, edit, delete, describe, and get the slice.
serviceExportConfig: It is used to create, edit, delete, describe, and get the service export.

Examples

The following are the example commands:

To edit the slice configuration, use the following command:

kubeslice-cli edit sliceConfig <slice-name> -n <project-namespace>

Example

kubeslice-cli edit sliceConfig blue -n kubeslice-demo

To edit the project details, use the following command:

kubeslice-cli edit project <project name> -n <controller-namespace>

Examples

kubeslice-cli edit project demo -n kubeslice-controller
kubeslice-cli edit project kubeslice-avesha -n kubeslice-controller

To edit the service export, use the following command:

kubeslice-cli edit serviceExportConfig <resource-name> --namespace <project namespace>

The <resource-name> is obtained using this command:

kubeslice-cli get serviceExportConfig -n <project namespace>

Example

kubeslice-cli get serviceExportConfig -n kubeslice-demo

Example Output

Fetching KubeSlice serviceExportConfig...
🏃 Running command: /home/eric/bin/kubectl get serviceexportconfigs.controller.kubeslice.io -n kubeslice-demo
NAME                          AGE
iperf-server-iperf-worker-2   4d19h

Example

kubeslice-cli edit serviceExportConfig iperf-server-iperf-worker-2 -n kubeslice-demo

get

Use this command to get one or more KubeSlice resources. For example, use the get command to get a slice, project, or service export.

Syntax

kubeslice-cli <get|g> project <project-name> --namespace <controller-namespace>
kubeslice-cli <get|g> <sliceConfig|serviceExportConfig> --namespace <project-namespace>

Options

The following are the kubeslice-cli get command options.

Option	Shorthand	Description
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--output	-o	It supports json and yaml values.
--worker	-w	It is the worker cluster name.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the get command.

Resource Types

The following are the resource types used with the get command:

project: It is used to create, edit, delete, describe, and get the project.
sliceConfig: It is used to create, edit, delete, describe, and get the slice.
serviceExportConfig: It is used to create, edit, delete, describe, and get the service export.
secrets: It is used to get the secrets of the registered worker clusters from the controller cluster.
ui-endpoint: It is used to get the KubeSlice Manager URL.

Examples

The following are the example commands:

To get the worker details, use the following command:

kubeslice-cli get worker -n <project-namespace>

Example

kubeslice-cli get worker -n kubeslice-demo

Example Output

Fetching KubeSlice Worker...
🏃 Running command: /usr/local/bin/kubectl get clusters.controller.kubeslice.io -n kubeslice-demo
NAME     AGE
ks-w-1   8m13s
ks-w-2   8m13s

To get a slice, use the following command:

kubeslice-cli get sliceConfig -n <project-namespace>

Example

kubeslice-cli get sliceConfig -n kubeslice-demo

Example Output:

Fetching KubeSlice sliceConfig...
🏃 Running command: /usr/local/bin/kubectl get sliceconfigs.controller.kubeslice.io -n kubeslice-demo
NAME   AGE
blue   27s

To get the project details, use the following command:

kubeslice-cli get project -n <controller-namespace>

Example

kubeslice-cli get project -n kubeslice-controller

Example Output

Fetching KubeSlice Project...
🏃 Running command: /usr/local/bin/kubectl get projects.controller.kubeslice.io -n kubeslice-controller
NAME   AGE
demo   7m6s

To get the list of secrets that belong to project namespace, use the following command:

kubeslice-cli get secrets <worker-cluster-name> -n kubeslice-demo

Example 1

kubeslice-cli get secrets -n kubeslice-demo

Example Output

Fetching KubeSlice secret...
🏃 Running command: /usr/local/bin/kubectl get secrets -n kubeslice-demo
NAME                                       TYPE                                  DATA   AGE
default-token-6qz9w                        kubernetes.io/service-account-token   3      73m
demo-ks-w-1-ks-w-2                         Opaque                                7      69m
demo-ks-w-2-ks-w-1                         Opaque                                1      69m
kubeslice-rbac-rw-john-token-smmfj         kubernetes.io/service-account-token   3      73m
kubeslice-rbac-worker-ks-w-1-token-rn7dl   kubernetes.io/service-account-token   5      73m
kubeslice-rbac-worker-ks-w-2-token-qld6t   kubernetes.io/service-account-token   5      73m

Example 2

Use the following command to get the details of secrets in the yaml file.

kubeslice-cli get secrets -n kubeslice-demo -o yaml

To get the service export, use the following command:

kubeslice-cli get serviceExportConfig -n <project-namespace>

Example

kubeslice-cli get serviceExportConfig -n kubeslice-demo

Example Output

Fetching KubeSlice serviceExportConfig...
🏃 Running command: /usr/local/bin/kubectl get serviceexportconfigs.controller.kubeslice.io -n kubeslice-demo
NAME                          AGE
iperf-server-iperf-worker-2   4d19h

install

Use this command to install the required workloads to run KubeSlice Controller and worker clusters.

Syntax

kubeslice-cli --config <path-to-the-custom-topology-file> <install|i>
kubeslice-cli install <command-options>
kubeslice-cli install --profile=<minimal-demo|full-demo|enterprise-demo >

Options

The following are the kubeslice-cli install command options.

Option	Shorthand	Description	Supported Values
--profile	-p	It is the profile to install or uninstall KubeSlice.	full-demo: showcases the KubeSlice inter-cluster connectivity by spawning 3 kind clusters, including 1 KubeSlice Controller and 2 worker clusters, and installing iPerf application to generate network traffic. minimal-demo: sets up 3 kind clusters, including 1 KubeSlice Controller and 2 worker clusters. Generates the Kubernetes manifests for user to manually apply, and verify the functionality. enterprise-demo: showcases the KubeSlice Enterprise functionality by spawning 3 kind clusters, including 1 KubeSlice Controller and 2 KubeSlice Workers. Installs the Enterprise charts for the controller, the worker(s), the KubeSlice Manager (UI), and iPerf application to generate network traffic. The imagePullSecrets (username and password) listed must be set as environment variables: KUBESLICE_IMAGE_PULL_USERNAME: `optional`, the default value is `aveshaenterprise`. KUBESLICE_IMAGE_PULL_PASSWORD: `required`.
--skip	-s	It skips the installation steps (comma-separated) with `minimal-demo`, `full-demo`, and `enterprise-demo` options.	kind: skips the creation of kind clusters. calico: skips the installation of Calico. controller: skips the installation of KubeSlice Controller. worker-registration: skips the registration of worker clusters with the KubeSlice Controller. worker: skips the installation of worker clusters. demo: skips the installation of additional example applications. prometheus: skips the installation of the Prometheus.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--with-cert-manager		It installs the cert-manager charts. This is required for the KubeSlice Controller v0.7.0 and below versions.
--help	-h	It provides information on the install command.

info

The global option --config and install command option --profile are mutually exclusive and cannot be used together.

Examples

The following are the example commands:

Use the following command to create the kind clusters, install the KubeSlice Controller and worker clusters.
```
kubectl-cli install --profile=minimal-demo
```
To install the KubeSlice using custom topology file, use the following command:
```
kubeslice-cli --config <path-to-the-custom-topology-file> install
```

register

Use this command to register a new worker cluster with the KubeSlice Controller in an existing multi-cluster setup.

Syntax

kubeslice-cli register worker <worker-cluster-name> --namespace <project-namespace>
kubeslice-cli --config <path-to-the-custom-topology-file> <install|i> [options]

Options

The following are the kubeslice-cli register command options.

Option	Shorthand	Description
--filename	-f	It is the filename, directory, or URL of the file used to create the resource.
--namespace	-n	It is the name of the project namespace on the KubeSlice Controller.
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the register command.

Resource Type

The worker is the resource type used with the register command.

Examples

The following are the example commands:

info

You must switch the context to the controller cluster to register the worker cluster.

To register a new worker cluster with the KubeSlice Controller in demo setup, use the following command:

kubeslice-cli register worker <worker-cluster-name> -n kubeslice-demo

Example

kubeslice-cli register worker kind-ks-w-4 -n kubeslice-demo

Example Output

Registering Worker Clusters with Project...
✔ Generated cluster registration manifest kubeslice/custom-cluster-registration.yaml
🏃 Running command: /usr/local/bin/kubectl apply -f kubeslice/custom-cluster-registration.yaml -n kubeslice-demo
✔ Applied kubeslice/custom-cluster-registration.yaml
Registered Worker Clusters with Project.

To register a new worker cluster with the KubeSlice Controller in an existing multi-cluster setup, use the following command:

info
Add a new worker information in the same custom topology file that you used to install KubeSlice. The -s controller option skips the installation of KubeSlice Controller.
```
kubeslice-cli --config=<path-to-the-custom-topology-file> install -s controller
```

uninstall

Use this command to uninstall all the KubeSlice components on kind and cloud clusters.

Syntax

kubeslice-cli <uninstall|cleanup>

Options

The following are the kubeslice-cli uninstall options

Option	Shorthand	Description
--config	-c	It is a global option. The path to the topology configuration YAML file.
--help	-h	It provides information on the delete command.
--all	-a	Uninstalls all the KubeSlice components (worker, controller, and Kubeslice Manager).
--ui	-u	Uninstalls the enterprise user interface component (Kubeslice Manager).
--cert-manager		It uninstalls the cert-manager charts.

Examples

The following is an example command:

To uninstall the KubeSlice components on kind clusters and delete the kind clusters created using full-demo|minimal-demo option, use the following command:
```
kubeslice-cli uninstall
```
To uninstall the KubeSlice components that were installed using a custom topology file on cloud clusters, use the following command:

info
KubeSlice must be uninstalled using the topology file that was used to install it on cloud clusters.
```
kubeslice-cli uninstall --config=<path-to-the-custom-topology-file> --all
```

CLI Command Reference

Syntax​

Commands​

Options​

create​

Syntax​

Options​

Resource Types​

Examples​

delete​

Syntax​

Options​

Resource Types​

Examples​

describe​

Syntax​

Options​

Resource Types​

Examples​

edit​

Syntax​

Options​

Resource Types​

Examples​

get​

Syntax​

Options​

Resource Types​

Examples​

install​

Syntax​

Options​

Examples​

register​

Syntax​

Options​

Resource Type​

Examples​

uninstall​

Syntax​

Options​

Examples​

Syntax

Commands

Options

create

Syntax

Options

Resource Types

Examples

delete

Syntax

Options

Resource Types

Examples

describe

Syntax

Options

Resource Types

Examples

edit

Syntax

Options

Resource Types

Examples

get

Syntax

Options

Resource Types

Examples

install

Syntax

Options

Examples

register

Syntax

Options

Resource Type

Examples

uninstall

Syntax

Options

Examples