cloudypad CLI usage

Global usage

Available commands:

$ cloudypad --help

Usage: cloudypad [options] [command]

Cloudy Pad CLI to manage your own gaming instance in the Cloud.

Options:
  -v, --verbose               Verbosity level (0: silly, 1: trace, 2: debug, 3: info, 4: warn, 5: error, 6: fatal). Alternatively, use
                              CLOUDYPAD_LOG_LEVEL environment variable.
  -V, --version               output the version number
  -h, --help                  display help for command

Commands:
  create                      Create a new instance. See subcommands for each provider options.
  update                      Update an existing instance. See subcommands for each provider options.
  list [options]              List all instances
  start [options] <name>      Start an instance
  stop [options] <name>       Stop an instance
  restart [options] <name>    Restart an instance. Depending on provider this operation may be synchronous.
  get <name>                  Get current state of an instance and its status (running, provisioned, configured, ready)
  provision [options] <name>  Provision an instance (deploy or update Cloud resources)
  configure [options] <name>  Configure an instance (connect to instance and install drivers, packages, etc.)
  deploy [options] <name>     Deploy an instance: provision and configure it. Equivalent to running provision and configure commands sequentially.
  destroy [options] <name>    Destroy an instance
  pair <name>                 Pair an instance with Moonlight
  help [command]              display help for command

Create instances

Use cloudypad create. It will prompt for required parameters depending on your Cloud Provider.

cloudypad create 

# Or for a specific provider
cloudy pad create azure
cloudy pad create aws
cloudy pad create gcp # Google
cloudy pad create paperspace
cloudy pad create scaleway

You can also specify all arguments as flags for non-interactive creation, for example:

cloudypad create aws \
  --name $instance_name \
  --instance-type g4dn.xlarge \
  --disk-size 100 \
  --public-ip-type static \
  --region eu-central-1 \
  --spot \
  --streaming-server [sunshine|wolf] \
  --cost-alert [disable|no|false|0] \
  --cost-limit 40 \
  --cost-notification-email me@example.com \
  --ratelimit-max-mbps 40 \
  --yes --overwrite-existing

Use cloudypad create <provider> --help for available flags.

Use instances: start, stop, list, get

List existing instances:

cloudypad list

Get instance details:

cloudypad get mypad

Start/stop/restart instance:

cloudypad start mypad
cloudypad stop mypad
cloudypad restart mypad

By default instance stop/start/restart triggers the action without waiting. Wait for action to finish with --wait (and optionally timeout <seconds>)

cloudypad [start|top|restart] mypad --wait --timeout 180

Update instances

To update your instance to latest version:

cloudypad deploy my-instance

deploy will provision and configure your instance with latest Cloudy Pad version.

Destroy instances

Destroy instance:

cloudypad destroy mypad

A confirmation prompt will appear by default, you can skip with:

cloudypad destroy mypad --yes

Instance deployment lifecycle

When you create your instance, creation process goes through various steps:

  • Provisioning: create all Cloud resources for your instance (virtual machine, IP address, virtual disk...)
  • Configuration: install required packages and softwares on your instance (eg. Wolf server)
  • Pairing: pair your instance with Moonlight

These actions can be performed directly via commands below.

Provision an instance to create/update Cloud resources for your instance.

cloudypad provision mypad

Run instance configuration:

cloudypad configure mypad

Pair Moonlight with an existing instance:

cloudypad pair mypad

Environment variables

Cloudy Pad built-in environment variables

Environment variables used by Cloudy Pad and example values

# Log level. Also exposed via CLI --verbose flag.
# 0: silly, 1: trace, 2: debug, 3: info, 4: warn, 5: error, 6: fatal
CLOUDYPAD_LOG_LEVEL=3

# Set -x bash flag to show all commands executed by launcher script
CLOUDYPAD_CLI_LAUNCHER_DEBUG=1

# Home directory for Cloudy Pad data
CLOUDYPAD_HOME=~/.cloudypad

# Cloudy Pad version to use for launcher.
# Beware: changing this value will change Cloudy Pad container image used
# which may not be compatible with launch version installed
CLOUDYPAD_VERSION=0.7.0

# Override Cloudy Pad container image used by launcher
CLOUDYPAD_IMAGE="crafteo/cloudypad:$CLOUDYPAD_VERSION"

Other environment variables

Cloudy Pad relies on external tools and libraries like AWS library and Ansible to manage your instances. Some variables can set to alter behavior.

See env_vars variable in launcher script for details.

Global configuration

A global configuration is saved under $HOME/.cloudypad/config.yml. Later version will add commands to manipulate this configuration.