Launchpad CLI reference

Launchpad CLI reference

Global options

A number of optional arguments can be used with any Launchpad command.

Option

Description

--disable-telemetry

Disable sending analytics and telemetry data

--accept-license

Accept the end user license agreement

--disable-upgrade-check

Skip check for Launchpad upgrade

--debug

Increase output verbosity

--help

Display command help

Commands

Function

Command

Description

Supported options

Initialize Launchpad

launchpad init

Intializes the cluster config file (usually called launchpad.yaml).

n/a

Initialize or upgrade Launchpad

launchpad apply

After initializing the cluster config file, applies the settings and initializes or upgrades a cluster.

--config

Path to a cluster config file, including the filename (default: launchpad.yaml, read from stdin: -) (default: launchpad.yaml)

--force

Continue installation when prerequisite validation fails (default: false)

Download client configuration

launchpad client-config

The MKE client bundle contains a private and public key pair that authorizes Launchpad to interact with the MKE CLI.

--config

Path to a cluster config file, including the filename (default: launchpad.yaml, read from stdin: -) (default: launchpad.yaml)

Note that the configuration MUST include the MKE credentials (example follows):

apiVersion: launchpad.mirantis.com/mke/v1.3
kind: mke
spec:
  mke:
    adminUsername: admin
    adminPassword: password

Reset or uninstall a cluster

launchpad reset

Resets or uninstalls an MKE cluster.

--config

Path to a cluster config file, including the filename (default: launchpad.yaml, read from stdin: -)

--force

Required when running non-interactively (default: false)

Execute a command or run a remote terminal on a host

launchpad exec

Use Launchpad to run commands or an interactive terminal on the hosts in the configuration.

--config

Path to a cluster config file, including the filename (default: launchpad.yaml, read from stdin: -)

--target value

Target host (example: address[:port])

--interactive

Run interactive (default: false)

--first

Use the first target found in configuration (default: false)

--role value

Use the first target that has this role in configuration

-[command]

The command to run. When blank, will run the default shell.

Show cluster status

launchpad describe

Resets or uninstalls an MKE cluster.

--config

Path to a cluster config file, including the filename (default: launchpad.yaml, read from stdin: -)

-[report name]

currently supported reports: config, mke, msr

Register

launchpad register

Registers a user.

--name

User’s name.

--email

User’s email address.

--company

Name of user’s company.

--accept-license

Accept the end user license agreement.

Generate shell auto-completions

launchpad completion

Completes a specified shell.

--shell

Generates completions for the shell specified following the option.

Installing the completion scripts:

Bash:

$ launchpad completion -s bash > \
/etc/bash_completion.d/launchpad
$ source /etc/bash_completion.d/launchpad

Zsh:

$ launchpad completion -s zsh > \
/usr/local/share/zsh/site-functions/_launchpad
$ source /usr/local/share/zsh/site-functions/_launchpad

Fish:

$ launchpad completion -s fish > \
~/.config/fish/completions/launchpad.fish
$ source ~/.config/fish/completions/launchpad.fish