Sveltosctl

Introduction to sveltosctl

The Sveltosctl is the command-line interface (CLI) for Sveltos. It is an available option to query Sveltos resources but not a mandatory option.

Option 1: Binaries

It offers a convenient CLI experience. The Binaries for each release are available on the releases page.

The Binaries are sufficient to register worker clusters with Sveltos, query resources etc. However, if you want more capabilities like the Techsupport and the Snapshot, use "Option 2: Run sveltosctl as a pod".

Option 2: Run sveltosctl as Pod

If you choose to run sveltosctl as a pod in the management cluster, the YAML configuration can be found here.

Remember that sveltosctl necessitates a PersistentVolume. Before posting the YAML, make the necessary adjustments to the below section.

  volumeClaimTemplates:
  - metadata:
      name: snapshot
    spec:
      accessModes: [ "ReadWriteOnce" ]
      storageClassName: "standard"
      resources:
        requests:
          storage: 1Gi

Once the pod is running,

$ sveltosctl --help

You might also want to change the timezone of sveltosctl pod by using specific timezone config and hostPath volume to set specific timezone. Currently:

  volumes:
  - hostPath:
      path: /usr/share/zoneinfo/America/Los_Angeles
      type: File
    name: tz-config

Tip

The Sveltos CLI pod cannot be used as a way to register a worker Kubernetes cluster. For that, use the Sveltos Binaries.