beibootctl - How to use

Get in contact

Below you find the documentation of the beibootctl CLI. If you struggle to set it up or need any other support, please find us on Discord or use this link to book a call.

Syntax

Use the following syntax to run beibootctl commands from your terminal:

beibootctl [OPTIONS] [ACTION] [ARGUMENTS]

Where OPTIONS can be:

• -d, --debug: add debug output for each action
• --help: show help message and exit
• --kubeconfig TEXT: path to the kubeconfig file to use instead of loading the default
• --context TEXT: context of the kubeconfig file to use instead of 'default'

Where ACTION is one of:

• cluster: manage clusters
• connect: connect to a cluster
• disconnect: disconnect from a cluster
• install: generate K8s resources to install beiboot into the host cluster
• shelf: manage shelves
• uninstall: uninstall beiboot from the host cluster

Where ARGUMENTS specify the required and optional arguments for a specific action. Use the action with --help, to see the available arguments.

Global flags are:

• -d, --debug: add debug output for each action
• -h, --help: show help message and exit

Actions

beibootctl allows running the following available actions. If an action doesn't list OPTIONS or optional arguments, only the global flags are available.

beibootctl cluster

Manage Beiboot clusters.

Syntax: beibootctl cluster [OPTIONS] COMMAND [ARGUMENTS]

ARGUMENTS: please use beibootctl cluster COMMAND --help for a full list of arguments

Example: beibootctl cluster create test-cluster

COMMANDs

Command	Description
create	Create a new Beiboot cluster
delete (rm, remove)	Mark a Beiboot cluster for deletion
inspect	Display detailed information of one Beiboot cluster
list (ls)	List all Beiboot clusters

beibootctl connect

Set up the tunnel connection to a Beiboot cluster.

Syntax: beibootctl connect [OPTIONS] NAME

Example: beibootctl connect test-cluster

Positional Arguments

NAME, the name of the Beiboot cluster for which the connection should be established.

Optional Arguments

Option	Description
--connector	ghostunnel_docker or dummy_no_connect
--host	Override the connection endpoint

beibootctl disconnect

Remove the tunnel connection and files from this host (i.e. the machine from which you're running beibootctl).

Syntax: beibootctl disconnect [OPTIONS] NAME

Example: beibootctl disconnect test-cluster

Positional Arguments

NAME, the name of the Beiboot cluster for which the connection should be established.

beibootctl install

Create and print the Kubernetes configs for Beiboot; use it so beibootctl install [OPTIONS] | kubectl apply -f -

Syntax: beibootctl install [OPTIONS]

OPTIONS: please use beibootctl install --help for a full list of install options

Example: beibootctl install | kubectl apply -f -

beibootctl shelf

Manage shelves of Beiboot clusters.

Syntax: beibootctl shelf [OPTIONS] COMMAND [ARGUMENTS]

ARGUMENTS: please use beibootctl shelf COMMAND --help for a full list of arguments

Example: beibootctl shelf create test-cluster

COMMANDs

Command	Description
create	Create a new Shelf
delete (rm, remove)	Mark a Shelf for deletion
inspect	Display detailed information of one Shelf
list (ls)	List shelved Beiboot clusters

beibootctl uninstall

Removes the Beiboot installation from the host cluster.

Syntax: beibootctl uninstall [OPTIONS]

Example: beibootctl uninstall

Optional Arguments

Argument	Description
-f, --force	Delete without prompt
-ns TEXT, --namespace TEXT	The namespace Beiboot was installed to (TEXT, default: getdeck)

beibootctl version

Print the version of beibootctl.