This installation option provides several wrapped Ansible-based scripts to deploy, start, stop, and erase an AsterixDB instance on a multi-node cluster without requiring users to interact with each individual node in the cluster.


  • Supported operating systems: Linux and MacOS

  • Install pip on your client machine:


     $ sudo yum install python-pip


     $ sudo apt-get install python-pip


     $ brew install pip
  • Install Ansible, boto, and boto3 on your client machine:

     $ pip install ansible
     $ pip install boto
     $ pip install boto3

    Note that you might need sudo depending on your system configuration.

    Make sure that the version of Ansible is no less than

     $ ansible --version
  • Download the AsterixDB distribution package, unzip it, and navigate to opt/ansible/

     $ cd opt/ansible

    The following files and directories are in the directory opt/ansible:

     README  bin  conf  yaml

    bin contains scripts that deploy, start, stop and erase a multi-node AsterixDB cluster, according to the configuration specified in files under conf, and yaml contains internal Ansible scripts that the shell scripts in bin use.

Cluster Configuration

  • Nodes and account. Edit the inventory file conf/inventory when necessary. You mostly only need to specify the node DNS names (or IPs) for the cluster controller, i.e., the master node, in the [cc] section, and node controllers, i.e., slave nodes, in the [ncs] section. The following example configures a cluster with two slave nodes ( and and one master node (


    Configure passwordless ssh from your current client that runs the scripts to all nodes listed in conf/inventory as well as localhost. If the ssh user account for target machines is different from your current username, please uncomment and edit the following two lines:

     ;ansible_ssh_user=<fill with your ssh account username>

    If you want to specify advanced Ansible builtin variables, please refer to the Ansible documentation.

  • Remote working directories. Edit conf/instance_settings.yml to change the remote binary directory (the variable “binarydir”) when necessary. By default, the binary directory will be under the home directory (as the value of Ansible builtin variable ansible_env.HOME) of the ssh user account on each node.

Cluster Lifecycle Management

  • Deploy the binary to all nodes:

     $ bin/
  • Every time before starting the AsterixDB cluster, you can edit the instance configuration file conf/instance/cc.conf, except that IP addresses/DNS names are generated and cannot be changed. All available parameters and their usage can be found here.

  • Launch your AsterixDB cluster:

     $ bin/

    Now you can use the multi-node AsterixDB cluster by opening the master node listed in conf/inventory at port 19001 (which can be customized in conf/instance/cc.conf) in your browser.

  • If you want to stop the the multi-node AsterixDB cluster, run the following script:

     $ bin/
  • If you want to remove the binary on all nodes, run the following script:

     $ bin/