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

All Launchpad commands begin wth launchpad or lp.

launchpad <command>

Command

Description

init

Initialize Launchpad.

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

Supported options:

n/a

apply

Initialize or upgrade Launchpad.

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

Supported options:

--config

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

--force

Continue installation when prerequisite validation fails (default: false)

client-config

Download client configuration.

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

Supported options:

--config

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

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

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

reset

Reset or uninstall a cluster.

Resets or uninstalls an MKE cluster.

Supported options:

--config

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

--force

Required when running non-interactively (default: false)

exec

Execute a command or run a remote terminal on a host.

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

Supported options:

--config

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

--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.

describe

Presents basic information that correlates to the command target.

When the launchpad describe hosts command is run, the information delivered includes the IP address, the internal IP, the host name, the set role, the operating system, and the MCR version of each host. When the launchpad describe MKE or launchpad describe MSR is run, the command returns the product version number for the product targeted, as well as the URL of the administation user interface.

Supported options:

--config

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

-[report name]

currently supported reports: config, mke, msr

register

Registers a user.

Supported options:

--name

User’s name.

--email

User’s email address.

--company

Name of user’s company.

--accept-license

Accept the end user license agreement.

completion

Generate shell auto-completions.

Completes a specified shell.

Supported options:

--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