tridentctl

The Trident installer bundle includes a command-line utility, tridentctl, that provides simple access to Trident. It can be used to install Trident, as well as to interact with it directly by any Kubernetes users with sufficient privileges, to manage the namespace that contains the Trident pod.

For full usage information, run tridentctl --help. Here are the available commands and global options:

Usage:
  tridentctl [command]

Available Commands:
  create      Add a resource to Trident
  delete      Remove one or more resources from Trident
  get         Get one or more resources from Trident
  install     Install Trident
  logs        Print the logs from Trident
  uninstall   Uninstall Trident
  update      Modify a resource in Trident
  version     Print the version of Trident

Flags:
  -d, --debug              Debug output
  -n, --namespace string   Namespace of Trident deployment
  -o, --output string      Output format. One of json|yaml|name|wide|ps (default)
  -s, --server string      Address/port of Trident REST interface

create

Add a resource to Trident

Usage:
  tridentctl create [command]

Available Commands:
  backend     Add a backend to Trident

delete

Remove one or more resources from Trident

Usage:
  tridentctl delete [command]

Available Commands:
  backend      Delete one or more storage backends from Trident
  storageclass Delete one or more storage classes from Trident
  volume       Delete one or more storage volumes from Trident

get

Get one or more resources from Trident

Usage:
  tridentctl get [command]

Available Commands:
  backend      Get one or more storage backends from Trident
  storageclass Get one or more storage classes from Trident
  volume       Get one or more volumes from Trident

install

Install Trident

Usage:
  tridentctl install [flags]

Flags:
  --dry-run
  --generate-custom-yaml   Generate YAML files, but don't install anything
  --k8s-timeout duration   The number of seconds to wait before timing out on Kubernetes
                           operations (default 2m0s)
  --pv string              The name of the PV used by Trident (default "trident")
  --pvc string             The name of the PVC used by Trident (default "trident")
  --silent                 Disable most output during installation
  --use-custom-yaml        Use any existing YAML files that exist in setup directory
  --volume-name string     The name of the storage volume used by Trident (default "trident")
  --volume-size string     The size of the storage volume used by Trident (default "2Gi")

logs

Print the logs from Trident

Usage:
  tridentctl logs [flags]

Flags:
  -a, --archive      Create a support archive with all logs unless otherwise specified.
  -l, --log string   Trident log to display. One of trident|etcd|launcher|ephemeral|auto|all
                     (default "auto")

uninstall

Uninstall Trident

Usage:
  tridentctl uninstall [flags]

Flags:
  -a, --all      Deletes almost all artifacts of Trident, including the PVC and PV used
                 by Trident; however, it doesn't delete the volume used by Trident from
                 the storage backend. Use with caution!
      --silent   Disable most output during uninstallation.

update

Modify a resource in Trident

version

Print the version of tridentctl and the running Trident service

Usage:
  tridentctl version