Skip to main content

spirlctl cli utility

spirlctl (pronounced like spai·ruhl cuddle) is a command line utility (CLI) to interact and manage Defakto cloud, and Defakto components installed in the customer's environment.

Getting Started​

  1. Install spirlctl - Download and install the CLI
  2. Login - Authenticate with Defakto
  3. Create a Trust Domain - Set up your first trust domain
  4. Add a Cluster - Connect your Kubernetes cluster

Common Tasks​

Authentication​

# Log in to Defakto (using Google)
spirlctl login

# Log in to a specific organization (e.g. enterprise SSO,
# or when using multiple organizations)
spirlctl login --org my-org

# Check your identity
spirlctl whoami

# Log out
spirlctl logout

See Login & Logout guide for more details.

Trust Domains​

# Create a trust domain
spirlctl trust-domain create example.com

# List all trust domains
spirlctl trust-domain list

# Get trust domain information
spirlctl trust-domain info example.com

See Trust Domain Operations guide for more details.

Clusters​

# Add a Kubernetes cluster
spirlctl cluster add production --trust-domain example.com --platform k8s

# List all clusters
spirlctl cluster list

# Get cluster information
spirlctl cluster info production --trust-domain example.com

# List cluster configurations
spirlctl cluster config list production --trust-domain example.com

See Cluster Management guide for more details.

In more detail​

For detailed documentation on using spirlctl, see:

Help at the command line​

spirlctl comes with built-in help:

$ spirlctl help

Command-specific help​

For detailed help on any command, use the --help flag:

spirlctl --help
spirlctl [command] --help
spirlctl [command] [subcommand] --help

Example:

$ spirlctl cluster --help

Commands for working with clusters

Usage:
  spirlctl cluster [command]

Available Commands:
  add         Adds NAME cluster to the SPIFFE trust domain TD_NAME
  config      Commands for working with cluster configs
  delete      Deletes a cluster from a trust domain
  disable     Disable a cluster
  info        Gets detailed information about a cluster
  list        Lists all clusters
  register    Register CLUSTER_NAME cluster to the SPIFFE trust domain TD_NAME
  workloads   Commands for working with cluster workloads