You are viewing an older version of this section. View current production version.



MemSQL Helios does not support this command.

Deploy a MemSQL cluster locally.


memsql-deploy cluster-in-a-box conveniently runs various memsql-toolbox-config,
memsql-deploy, and memsql-admin commands as a single command to produce a simple
MemSQL configuration (a master aggregator and a leaf node) that can be connected
to and queried. This MemSQL "cluster" is meant for testing purposes. To set up a
cluster on more than one machine, see 'memsql-deploy setup-cluster'.

Example usages:

    memsql-deploy cluster-in-a-box --license AAAAAAa/Aaa/AA== --password PASSW0RD

This will install the latest released version of memsql-server on the local
machine and deploy a master aggregator on port 3306 and a leaf node on port
3307. A valid license is required.

Password for the MemSQL root user must be set either with '--password' flag, or in MEMSQL_PASSWORD environment variable.

If you want to install a version other than the latest released version, you can
specify a different released version, or the path to a memsql-server package:

    memsql-deploy cluster-in-a-box --license AAAAAAa/Aaa/AA== --version 6.7.0 --password PASSW0RD

    memsql-deploy cluster-in-a-box --license AAAAAAa/Aaa/AA== --file-path path/to/memsql-server.deb --password PASSW0RD
    memsql-deploy cluster-in-a-box --license AAAAAAa/Aaa/AA== --file-path path/to/memsql-server.rpm --password PASSW0RD

  memsql-deploy cluster-in-a-box [flags]

      --file-path ABSOLUTE_PATH                The memsql-server package to install.
      --force-package-format {deb, rpm, tar}   Specify 'deb', 'rpm', or 'tar' package format. Required if you have both deb and rpm package managers installed.
  -h, --help                                   help for cluster-in-a-box
      --license LICENSE                        MemSQL license for the cluster.
      --password STRING                        Password for the MemSQL root user on each node.
      --version VERSION                        The version of memsql-server to install. (default production:latest)

Global Flags:
      --backup-cache FILE_PATH              File path for the backup cache
      --cache-file FILE_PATH                File path for the Toolbox node cache
  -c, --config FILE_PATH                    the Toolbox configuration file path
  -j, --json                                Enable JSON output
      --parallelism POSITIVE_INTEGER        Maximum amount of operations to be run in parallel
      --runtime-dir DIRECTORY_PATH          where to put Toolbox runtime data
      --ssh-max-sessions POSITIVE_INTEGER   Maximum number of SSH sessions to open per host, must be at least 3
      --state-file FILE_PATH                the Toolbox state file path
  -v, --verbosity count                     Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
  -y, --yes                                 Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default


If you already have the local host machine registered through memsql-toolbox-config, you will have to unregister the host machine before you can run this command.

This command is interactive unless you use either the --yes or --json flags to override interactive behavior.


The following example uses the cluster-in-a-box command to install a master aggregator and a leaf node on the local host machine.

memsql-deploy cluster-in-a-box --license <base64-encoded_license>
memsql-deploy will perform the following actions:
  · Install memsql-server 6.7.1 locally
  · Deploy a master aggregator on port 3306
  · Deploy a leaf node on port 3307

Would you like to continue? [y/N]: y
✓ Downloaded memsql-server 6.7.1
Installing MemSQL locally...
✓ Installed MemSQL 6.7.1 locally
✓ Deployed master aggregator on port 3306
✓ Deployed leaf node on port 3307

To view your cluster, run 'memsql-admin list-nodes'