Commands

SYNOPSIS

mdbci [options] command

OPTIONS

-a, --attempts [number]

How many times to perform certain action.

-b, --boxes [boxes file]

Uses [boxes file] for existing boxes. By default 'boxes.json' will be used as boxes file.

-c, --command [command]

Set command to execute.

--configuration-file [path]

Path to the configuration file used for a command.

-f, --field [box configuration field]

Use [box configuration field] for existing box configuration field.

--force

Use the --force flag to remove interactivity.

-i, --platform-version [version]

Platform version for the show boxes command. Must be used together with --platform option.

--ipv6

If ipv6 must be added to network_config file (also enables ipv6 for libvirt).

--json

Print information in json format.

-k, --key [key file]

Key file to the node for public_keys command.

--keep-template

Do not destroy the template during the destroy command.

--maxscale-ci [release]

Name of the MaxScale release in the CI repository. Used during repository generation command.

-n, --box-name [box name]

Use [box name] for existing box names.

-node-name [node name]

Name of the node.

-o, --platform [name]

Platform name for the show boxes command.

-p, --product [product name]

Product name for setup repository and install product commands.

--path-to-nodes [path]

Path to directory with nodes configuration.

-r, --repo-dir [path]

Set path to the product repository overriding the default locations.

-s, --silent

Keep silence, output only requested info or nothing if not available.

--snapshot-name [Name]

Name of the snapshot.

-t, --template [configuration file]

Uses [configuration file] for running instance. By default instance.json will be used as configuration template.

--user

Name of the user to create.

-v, --product-version [version]

Product version for setup repo and install product commands.

-w, --override

Override previous configuration.

COMMANDS

check_relevance

Check for relevance of 'network_config' file.

clean-unused-resources

Destroy additional cloud resources that are lost or unused. More about clean-unused-resources command

configure

Create a configuration file for MDBCI

create_user

Creates a new user on the VM.

deploy-examples

Deploy examples from AppImage to the current working directory.

destroy

Destroy configuration with all artefacts or a single node.

generate

Generate a configuration based on the template.

generate-product-repositories

Generate product repository configuration for all known products.

help

Show information about MDBCI tool and it commands. More about help command

install_product

Install a product onto the configuration node. More about install_product command

list_cloud_instances

Show list all active instances on Cloud Providers.

list-cloud-resources

Show all cloud resources (VMs, disks, key pairs, security groups) More about list-cloud-resources command

remove_product

Remove the product on selected node.

provide-files

Provide files from the local computer to the Node.

public_keys

Copy ssh keys to configured nodes.

setup-dependencies

Install all dependencies.

setup_repo

Install product repository and update it. More about setup_repo command

show

Get information about MDBCI and configurations. More about show subcommands

snapshot

Manage snapshots of configurations and nodes.

ssh

Execute command on the configuration node.

sudo

Execute command using sudo on the node.

up

Setup environment as specified in the configuration.

update-configuration

Update the service configuration file and restart the service.

SHOW SUB COMMANDS

box, boxes, boxinfo, boxkeys, help, keyfile, network, network_config, platforms, private_ip, provider, repos, versions More about show repos command

EXAMPLES

mdbci show versions --platform ubuntu

mdbci show boxes --platform centos

mdbci show boxes --platform ubuntu --platform-version trusty

mdbci show versions --platform ubuntu

mdbci show box T/node

mdbci show boxinfo --box-name centos_6_vbox --field box

mdbci show boxinfo --box-name suse_13_aws

mdbci show provider suse_13_aws

mdbci sudo --command "tail /var/log/anaconda.syslog" T/node0 --silent

mdbci ssh --command "cat script.sh" T/node1

mdbci --repo-dir /home/testbed/config/repos show repos

mdbci up --attempts 4 T/node0

mdbci setup_repo --product maxscale T/node0

mdbci setup_repo --product mariadb --product-version 10.0 T/node0

mdbci install_product --product maxscale T/node0

mdbci public_keys --key keyfile.pem T/node0

mdbci snapshot list --path-to-nodes T --node-name N

mdbci snapshot [take, revert, delete] --path-to-nodes T [ --node-name N ] --snapshot-name S