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
  help        Help about any command
  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
  -h, --help               help for tridentctl
  -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
  snapshot     Delete one or more volume snapshots 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
  snapshot     Get one or more snapshots from Trident
  storageclass Get one or more storage classes from Trident
  volume       Get one or more volumes from Trident

import volume

Import an existing volume to Trident

Usage:
  tridentctl import volume <backendName> <volumeName> [flags]

Aliases:
  volume, v

Flags:
  -f, --filename string   Path to YAML or JSON PVC file
  -h, --help              help for volume
      --no-manage         Create PV/PVC only, don't assume volume lifecycle management

install

Install Trident

Usage:
  tridentctl install [flags]

Flags:
      --csi                       Install CSI Trident (override for Kubernetes 1.13 only, requires feature gates).
      --dry-run                   Run all the pre-checks, but don't install anything.
      --etcd-image string         The etcd image to install.
      --generate-custom-yaml      Generate YAML files, but don't install anything.
  -h, --help                      help for install
      --k8s-timeout duration      The number of seconds to wait before timing out on Kubernetes operations. (default 3m0s)
      --pv string                 The name of the PV used by Trident.
      --pvc string                The name of the PVC used by Trident.
      --silent                    Disable most output during installation.
      --trident-image string      The Trident image to install.
      --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.
      --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.
  -h, --help         help for logs
  -l, --log string   Trident log to display. One of trident|etcd|auto|all (default "auto")
  -p, --previous     Get the logs for the previous container instance if it exists.

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!
  -h, --help                      help for uninstall
      --silent                    Disable most output during uninstallation.

update

Modify a resource in Trident

Usage:
  tridentctl update [command]

Available Commands:
  backend     Update a backend in Trident

upgrade

Upgrade a resource in Trident

 Usage:
tridentctl upgrade [command]

 Available Commands:
   volume      Upgrade one or more persistent volumes from NFS/iSCSI to CSI

version

Print the version of tridentctl and the running Trident service

Usage:
  tridentctl version