Blame - content/docs/0.9.0/install.html - incubator-asterixdb-site

<p>This is a quickstart guide for getting AsterixDB running in a distributed environment. This guide also introduces the AsterixDB installer (nicknamed <i><i>Managix</i></i>) and describes how it can be used to create and manage an AsterixDB instance. By following the simple steps described in this guide, you will get a running instance of AsterixDB. You shall be able to use AsterixDB from its Web interface and manage its lifecycle using Managix. This document assumes that you are running some version of <i><i>Linux</i></i> or <i><i>MacOS X</i></i>.</p></div>

246

247

<h2><a name="Prerequisites_for_Installing_AsterixDB_Back_to_TOC"></a><a name="PrerequisitesForInstallingAsterixDB" id="PrerequisitesForInstallingAsterixDB">Prerequisites for Installing AsterixDB</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

<p>Prerequisite:</p>

<ul>

</ul>

<p>To know the version of Java installed on your system, execute the following:</p>

<pre>$ java -version

</pre></div></div>

<p>If your version is at least 1.8.0_x, similar to the output shown below, you are good to proceed.</p>

<pre>java version "1.8.0_60"

265

Java(TM) SE Runtime Environment (build 1.8.0_60-b27)

266

Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)

267

</pre></div></div>

268

<p>If you need to upgrade or install java, please follow <a class="externalLink" href="http://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html">Oracle’s instructions</a>. The installation directory for</p>

<ul>

<li>

<p>Linux would be at a path under <tt>/usr/lib/jvm/[jdk-version]</tt>.</p></li>

274

275

<li>

276

<p>Mac would be <tt>/Library/Java/JavaVirtualMachines/[jdk-version]/Contents/Home</tt>.</p></li>

277

</ul>

278

<p>The java installation directory is referred as <tt>JAVA_HOME</tt>. Since we upgraded/installed Java, we need to ensure <tt>JAVA_HOME</tt> points to the installation directory of JDK. Modify your ~/.bash_profile (or ~/.bashrc) and define <tt>JAVA_HOME</tt> accordingly. After the modification, execute the following:</p>

<pre>$ java -version

</pre></div></div>

<p>If the version information you obtain does not show 1.8, you need to update the PATH variable. To do so, execute the following:</p>

<pre>$ echo "PATH=$JAVA_HOME/bin:$PATH" >> ~/.bash_profile (or ~/.bashrc)

289

$ source ~/.bash_profile (or ~/.bashrc)

290

</pre></div></div></div>

291

292

<h2><a name="Section_1:_Single-Machine_AsterixDB_installation_Back_to_TOC"></a><a name="Section1SingleMachineAsterixDBInstallation" id="Section1SingleMachineAsterixDBInstallation">Section 1: Single-Machine AsterixDB installation</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

293

<p>We assume a user called “Joe” with a home directory as /home/joe. On a Mac, the home directory for user Joe would be /Users/joe.</p>

294

295

<h3><a name="Configuring_Environment"></a>Configuring Environment</h3>

296

<p>Ensure that <tt>JAVA_HOME</tt> variable is defined and points to the the java installation directory on your machine. To verify, execute the following:</p>

<pre>$ echo $JAVA_HOME

301

</pre></div></div>

302

<p>If you do not see any output, <tt>JAVA_HOME</tt> is not defined. We need to add the following line to your profile located at /home/joe/.bash_profile or /home/joe/.bashrc, whichever you are using. If you do not have any of these files, create a ~/.bash_profile file.</p>

<pre>export JAVA_HOME=<Path to Java installation directory>

307

</pre></div></div>

308

<p>After you have edited ~/.bash_profile (or ~/.bashrc), execute the following to make the changes effective in current shell:</p>

<pre>$ source /home/joe/.bash_profile (or /home/joe/.bashrc)

313

</pre></div></div>

314

<p>Before proceeding, verify that <tt>JAVA_HOME</tt> is defined by executing the following:</p>

<pre>$ echo $JAVA_HOME

319

</pre></div></div></div>

320

321

<h3><a name="Configuring_SSH"></a>Configuring SSH</h3>

322

<p>If SSH is not enabled on your system, please follow the instruction below to enable/install it or else skip to the section <a href="#Configuring_Password-less_SSH">Configuring Password-less SSH</a>.</p>

323

324

<h4><a name="Enabling_SSH_on_Mac"></a>Enabling SSH on Mac</h4>

325

<p>The Apple Mac OS X operating system has SSH installed by default but the SSH daemon is not enabled. This means you can’t login remotely or do remote copies until you enable it. To enable it, go to ‘System Preferences’. Under ‘Internet & Networking’ there is a ‘Sharing’ icon. Run that. In the list that appears, check the ‘Remote Login’ option. Also check the “All users” radio button for “Allow access for”. This starts the SSH daemon immediately and you can remotely login using your username. The ‘Sharing’ window shows at the bottom the name and IP address to use. You can also find this out using ‘whoami’ and ‘ifconfig’ from the Terminal application.</p></div>

326

327

<h4><a name="Enabling_SSH_on_Linux"></a>Enabling SSH on Linux</h4>

<pre>sudo apt-get install openssh-server

332

</pre></div></div>

333

<p>Assumming that you have enabled SSH on your system, let us proceed.</p></div>

334

335

<h4><a name="Configuring_Password-less_SSH"></a>Configuring Password-less SSH</h4>

336

<p>For our single-machine setup of AsterixDB, we need to configure password-less SSH access to localhost. We assume that you are on the machine where you want to install AsterixDB. To verify if you already have password-less SSH configured, execute the following:</p>

<pre>$ ssh 127.0.0.1

</pre></div></div>

<p>If you get an output similar to one shown below, type “yes” and press enter.</p>

<pre>The authenticity of host '127.0.0.1 (127.0.0.1)' can't be established.

347

RSA key fingerprint is aa:7b:51:90:74:39:c4:f6:28:a2:9d:47:c2:8d:33:31.

348

Are you sure you want to continue connecting (yes/no)?

349

</pre></div></div>

350

<p>If you are not prompted for a password, that is if you get an output similar to one shown below, it signifies that you already have password-less SSH configured.</p>

<pre>$ ssh 127.0.0.1

Last login: Sat Mar 23 22:52:49 2013

356

</pre></div></div>

357

<p>[Important: Password-less SSH requires the use of a (public,private) key-pair. The key-pair is located as a pair of files under $HOME/.ssh directory. It is required that the (public,private) key-pair files have default names (id_rsa.pub, id_rsa) respectively. If you are using different names, please rename the files to use the default names]</p>

358

<p>Skip to the next section <a href="#Configuring_Managix">Configuring Managix</a>.</p>

359

<p>You are here because you were prompted for a password. You need to configure password-less SSH. We shall generate a (public,private) key-pair as id_rsa.pub and id_rsa respectively. If $HOME/.ssh already contains a (public,private) key-pair, please ensure the files are renamed before proceeding. Follow the instructions below.</p>

<pre>$ ssh-keygen -t rsa -P ""

364

Generating public/private rsa key pair.

365

Enter file in which to save the key (/home/joe/.ssh/id_rsa):

366

[Important: Please ensure that we use the default value, so simply press enter]

367

</pre></div></div>

368

<p>If a key already exists, you should get an output similar to what is shown below. Press ‘y’ to overwrite the existing key. It is required to use the default name. If you wish to not overwrite a pre-existing key, ensure that the pre-existing key is saved with a different name.</p>

<pre>/home/joe/.ssh/id_rsa already exists.

373

Overwrite (y/n)?

374

</pre></div></div>

375

<p>You should see an output similar to one shown below:</p>

<pre>The key fingerprint is:

380

4d:b0:30:14:45:cc:99:86:15:48:17:0b:39:a0:05:ca joe@joe-machine

381

The key's randomart image is:

+--[ RSA 2048]----+

| ..o+B@O= |

|.. o ==*+ |

|.E. oo . |

| o |

| S . |

| |

| |

| |

| |

+-----------------+

</pre></div></div>

<p>Note: for Linux users, you may not get an image representation of the key, but this is not an error. Next, execute the following:</p>

<pre>$ cat $HOME/.ssh/id_rsa.pub >> $HOME/.ssh/authorized_keys

399

$ chmod 700 $HOME/.ssh/authorized_keys

400

</pre></div></div>

401

<p>We shall now retry SSH without password.</p>

<pre>$ ssh 127.0.0.1

</pre></div></div>

<p>You may see an output similar to one shown below:</p>

<pre>The authenticity of host '127.0.0.1 (127.0.0.1)' can't be established.

412

RSA key fingerprint is aa:7b:51:90:74:39:c4:f6:28:a2:9d:47:c2:8d:33:31.

413

Are you sure you want to continue connecting (yes/no)?

414

</pre></div></div>

415

<p>Type ‘yes’ and press the enter key. You should see an output similar to one shown below:</p>

<pre>Warning: Permanently added '127.0.0.1' (RSA) to the list of known hosts.

420

Last login: Thu Mar 28 12:27:10 2013

421

</pre></div></div>

422

<p>You should now be able to log in without being prompted for a password or a response.</p>

<pre>ssh 127.0.0.1

Last login: Sat Mar 23 22:54:40 2013

428

</pre></div></div>

429

<p>Execute ‘exit’ to close the session.</p>

<pre>$ exit

logout

Connection to 127.0.0.1 closed.

436

</pre></div></div></div></div>

437

438

<h3><a name="Configuring_Managix"></a>Configuring Managix</h3>

439

<p>You will need the AsterixDB installer (a.k.a. Managix). Download Managix from <a class="externalLink" href="http://asterixdb.ics.uci.edu/download.html">here</a>; this includes the bits for Managix as well as AsterixDB.</p>

440

<p>To be able to create an AsterixDB instance and manage its lifecycle, the Managix requires you to configure a set of configuration files namely:</p>

<ul>

<li><tt>conf/managix-conf.xml</tt>: A configuration XML file that contains configuration settings for Managix.</li>

445

446

<li>A configuration XML file that describes the nodes in the cluster, e.g., <tt>clusters/local/local.xml</tt>.</li>

447

</ul>

448

<p>Since we intend to run AsterixDB on a single node, Managix can auto-configure itself and populate the above configuration files. To auto-configure Managix, execute the following in the MANAGIX_HOME directory:</p>

<pre>/home/joe/asterix-mgmt> $ managix configure

453

</pre></div></div>

454

<p>Let us do a sample run to validate the set of configuration files auto-generated by Managix.</p>

<pre>/home/joe/asterix-mgmt> $ managix validate

459

INFO: Environment [OK]

460

INFO: Managix Configuration [OK]

461

462

/home/joe/asterix-mgmt> $ managix validate -c clusters/local/local.xml

463

INFO: Environment [OK]

464

INFO: Cluster configuration [OK]

465

</pre></div></div></div>

466

467

<h3><a name="Creating_an_AsterixDB_instance"></a>Creating an AsterixDB instance</h3>

468

<p>Now that we have configured Managix, we shall next create an AsterixDB instance. An AsterixDB instance is identified by a unique name and is created using the <tt>create</tt> command. The usage description for the <tt>create</tt> command can be obtained by executing the following:</p>

<pre>$ managix help -cmd create

473

Creates an AsterixDB instance with a specified name. Post creation, the instance is in ACTIVE state,

474

indicating its availability for executing statements/queries.

475

Usage arguments/options:

476

-n Name of the AsterixDB instance.

477

-c Path to the cluster configuration file

478

</pre></div></div>

479

<p>We shall now use the <tt>create</tt> command to create an AsterixDB instance by the name “my_asterix”. In doing so, we shall use the cluster configuration file that was auto-generated by Managix.</p>

<pre>$ managix create -n my_asterix -c clusters/local/local.xml

484

</pre></div></div>

485

<p>A sample output of the above command is shown below:</p>

<pre>INFO: Name:my_asterix

490

Created:Thu Mar 07 11:14:13 PST 2013

491

Web-Url:http://127.0.0.1:19001

492

State:ACTIVE

493

</pre></div></div>

494

<p>The third line above shows the web-url <a class="externalLink" href="http://127.0.0.1:19001">http://127.0.0.1:19001</a> for an AsterixDB’s web interface. The AsterixDB instance is in the ‘ACTIVE’ state, indicating that you may access the web interface by navigating to the web url.</p>

495

<p>Type in the following “Hello World” query in the box:</p>

<pre>let $message := 'Hello World!'

500

return $message

501

</pre></div></div>

502

<p>Press the “Run” button. If the query result shows on the output box, then Congratulations! You have successfully created an AsterixDB instance!</p></div></div>

503

504

<h2><a name="Section_2:_Single-Machine_AsterixDB_installation_Advanced_Back_to_TOC"></a><a name="Section2SingleMachineAsterixDBInstallationAdvanced" id="Section2SingleMachineAsterixDBInstallationAdvanced">Section 2: Single-Machine AsterixDB installation (Advanced)</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

505

<p>We assume that you have successfully completed the single-machine AsterixDB installation by following the instructions above in section <a href="#Section_1:_Single-Machine_AsterixDB_installation">AsterixDB installation</a>. In this section, we shall cover advanced topics related to AsterixDB configuration. Before we proceed, it is imperative to go through some preliminary concepts related to AsterixDB runtime.</p>

506

507

<h3><a name="AsterixDB_Runtime"></a>AsterixDB Runtime</h3>

508

<p>An AsterixDB runtime comprises of a ‘‘master node’’ and a set of ‘‘worker nodes’’, each identified by a unique id. The master node runs a ‘‘Cluster Controller’’ service (a.k.a. ‘‘CC’’), while each worker node runs a ‘‘Node Controller’’ service (a.k.a. ‘‘NC’’). Please note that a node in an AsterixDB cluster is a logical concept in the sense that multiple nodes may map to a single physical machine, which is the case for a single-machine AsterixDB installation. This association or mapping between an AsterixDB node and a physical machine is captured in a cluster configuration XML file. In addition, the XML file contains properties and parameters associated with each node.</p>

509

510

<h4><a name="AsterixDB_Runtime_Configuration"></a>AsterixDB Runtime Configuration</h4>

511

<p>As observed earlier, Managix can auto-configure itself for a single-machine setup. As part of auto-configuration, Managix generated the cluster XML file. Let us understand the components of the generated cluster XML file. If you have configured Managix (via the <tt>configure</tt> command), you can find a similar cluster XML file as $MANAGIX_HOME/clusters/local/local.xml. The following is a sample XML file generated on a Ubuntu (Linux) setup:</p>

<name>local</name>

<java_home>/usr/lib/jvm/jdk1.8.0</java_home>

519

<log_dir>/home/joe/asterix-mgmt/clusters/local/working_dir/logs</log_dir>

520

<txn_log_dir>/home/joe/asterix-mgmt/clusters/local/working_dir/logs</txn_log_dir>

521

<iodevices>/home/joe/asterix-mgmt/clusters/local/working_dir</iodevices>

522

<store>storage</store>

523

<working_dir>

524

<dir>/home/joe/asterix-mgmt/clusters/local/working_dir</dir>

</working_dir>

<master_node>

<id>master</id>

<client_ip>127.0.0.1</client_ip>

530

<cluster_ip>127.0.0.1</cluster_ip>

531

<client_port>1098</client_port>

532

<cluster_port>1099</cluster_port>

533

<http_port>8888</http_port>

</master_node>

<node>

<cluster_ip>127.0.0.1</cluster_ip>

</node>

</cluster>

</pre></div></div>

<p>We shall next explain the components of the cluster configuration XML file.</p></div>

542

543

<h4><a name="a1_Defining_nodes_in_AsterixDB_runtime"></a>(1) Defining nodes in AsterixDB runtime</h4>

544

<p>The single-machine AsterixDB instance configuration that is auto-generated by Managix (using the <tt>configure</tt> command) involves a master node (CC) and a worker node (NC). Each node is assigned a unique id and provided with an ip address (called ‘‘cluster_ip’’) that maps a node to a physical machine. The following snippet from the above XML file captures the master/worker nodes in our AsterixDB installation.</p>

<id>master</id>

<client_ip>127.0.0.1</client_ip>

551

<cluster_ip>127.0.0.1</cluster_ip>

552

<client_port>1098</client_port>

553

<cluster_port>1099</cluster_port>

554

<http_port>8888</http_port>

</master_node>

<node>

<cluster_ip>127.0.0.1</cluster_ip>

559

</node>

560

</pre></div></div>

561

<p>The following is a description of the different elements in the cluster configuration xml file.</p>

<td>Property</td>

<td>Description</td>

</tr>

<td>A unique id for a node.</td>

</tr>

<td>cluster_ip</td>

<td>IP address of the machine to which a node maps to. This address is used for all internal communication between the nodes.</td>

</tr>

<td>client_ip</td>

<td>Provided for the master node. This IP should be reachable from clients that want to connect with AsterixDB via its web interface.</td>

</tr>

<td>client_port</td>

<td>Provided for the master node. This is the port at which the Cluster Controller (CC) service listens for connections from clients.</td>

</tr>

<td>cluster_port</td>

603

604

<td>Provided for the master node. This is the port used by the Cluster Controller (CC) service to listen for connections from Node Controllers (NCs). </td>

</tr>

<td>Provided for the master node. This is the http port used by the Cluster Controller (CC) service. </td>

</tr>

</table></div>

<h4><a name="a2_Properties_associated_with_a_worker_node_NC_in_AsterixDB"></a>(2) Properties associated with a worker node (NC) in AsterixDB</h4>

617

<p>The following is a list of properties associated with each worker node in an AsterixDB configuration.</p>

<td>Property</td>

<td>Description</td>

</tr>

<td>Java installation directory at each node.</td>

</tr>

<td>A directory where the worker node JVM may write logs.</td>

</tr>

<td>A directory where the worker node writes transaction logs.</td>

</tr>

<td>iodevices</td>

<td>Comma separated list of IO Device mount points.</td>

</tr>

<td>store</td>

<td>A data directory (under each iodevice) that AsterixDB uses to store data belonging to dataset(s).</td>

661

</tr>

662

</table>

663

<p>All the above properties can be defined at the global level or a local level. In the former case, these properties apply to all the nodes in an AsterixDB configuration. In the latter case, these properties apply only to the node(s) under which they are defined. A property defined at the local level overrides the definition at the global level.</p></div>

664

665

<h4><a name="a3_Working_directory_of_an_AsterixDB_instance"></a>(3) Working directory of an AsterixDB instance</h4>

666

<p>Next we explain the following setting in the file $MANAGIX_HOME/clusters/local/local.xml.</p>

<dir>/Users/joe/asterix-mgmt/clusters/local/working_dir</dir>

</working_dir>

</pre></div></div>

<p>Managix associates a working directory with an AsterixDB instance and uses this directory for transferring binaries to each node. If there is a directory that is readable by each node, Managix can use it to place binaries that can be accessed and used by all the nodes in the AsterixDB set up. A network file system (NFS) provides such a functionality for a cluster of physical machines so that a path on NFS is accessible from each machine in the cluster. In the single-machine set up described above, all nodes correspond to a single physical machine. Each path on the local file system is accessible to all the nodes in the AsterixDB setup and the boolean value for NFS above is thus set to <tt>true</tt>.</p></div></div>

676

677

<h3><a name="Managix_Configuration"></a>Managix Configuration</h3>

678

<p>Managix allows creation and management of multiple AsterixDB instances and uses Zookeeper as its back-end database to keep track of information related to each instance. We need to provide a set of one or more hosts that Managix can use to run a Zookeeper instance. Zookeeper runs as a daemon process on each of the specified hosts. At each host, Zookeeper stores data under the Zookeeper home directory specified as part of the configuration. The following is an example configuration <tt>$MANAGIX_HOME/conf/managix-conf.xml</tt> that has Zookeeper running on the localhost (127.0.0.1) :</p>

<homeDir>/home/joe/asterix/.installer/zookeeper</homeDir>

</servers>

</zookeeper>

</configuration>

</pre></div></div>

<p>It is possible to have a single host for Zookeeper. A larger number of hosts would use Zookeeper’s replication and fault-tolerance feature such that a failure of a host running Zookeeper would not result in loss of information about existing AsterixDB instances.</p></div></div>

694

695

<h2><a name="Section_3:_Installing_AsterixDB_on_a_Cluster_of_Multiple_MachinesBack_to_TOC"></a><a name="Section3InstallingAsterixDBOnAClusterOfMultipleMachines" id="Section3InstallingAsterixDBOnAClusterOfMultipleMachines">Section 3: Installing AsterixDB on a Cluster of Multiple Machines</a><font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

696

<p>We assume that you have read the two sections above on single-machine AsterixDB setup. Next we explain how to install AsterixDB in a cluster of multiple machines. As an example, we assume we want to setup AsterixDB on a cluster of three machines, in which we use one machine (called machine A) as the master node and two other machines (called machine B and machine C) as the worker nodes, as shown in the following diagram:</p>

697

698

<p>Notice that each machine has a ‘‘cluster_ip’’ address, which is used by these machines for their intra-cluster communication. Meanwhile, the master machine also has a ‘‘client_ip’’ address, using which an end-user outside the cluster can communicate with this machine. The reason we differentiate between these two types of IP addresses is that we can have a cluster of machines using a private network. In this case they have internal ip addresses that cannot be used outside the network. In the case all the machines are on a public network, the “client_ip” and “cluster_ip” of the master machine can share the same address.</p>

699

<p>Next we describe how to set up AsterixDB in this cluster, assuming no Managix has been installed on these machines.</p>

700

701

<h3><a name="Step_1:_Configure_SSH"></a>Step (1): Configure SSH</h3>

702

<p>The steps of setting up SSH are similar to those in the single-machine setup case. We assume we have a common user account called “joe” on each machine in the cluster.</p>

703

<p>On the master machine, do the following:</p>

<pre>machineA> ssh 127.0.0.1

708

</pre></div></div>

709

<p>If you get an output similar to one shown below, type “yes” and press enter.</p>

<pre>The authenticity of host '127.0.0.1 (127.0.0.1)' can't be established.

714

RSA key fingerprint is aa:7b:51:90:74:39:c4:f6:28:a2:9d:47:c2:8d:33:31.

715

Are you sure you want to continue connecting (yes/no)?

716

</pre></div></div>

717

<p>If you are not prompted for a password, that is if you get an output similar to one shown below, it signifies that you already have password-less SSH configured.</p>

<pre>$ ssh 127.0.0.1

Last login: Sat Mar 23 22:52:49 2013

723

</pre></div></div>

724

<p>[Important: Password-less SSH requires the use of a (public,private) key-pair. The key-pair is located as a pair of files under $HOME/.ssh directory. It is required that the (public,private) key-pair files have default names (id_rsa.pub, id_rsa) respectively. If you are using different names, please rename the files to use the default names]</p>

725

<p>If you are prompted for a password, execute the following</p>

<pre>machineA> ssh-keygen -t rsa -P ""

730

machineA> cat $HOME/.ssh/id_rsa.pub >> $HOME/.ssh/authorized_keys

731

machineA> chmod 700 $HOME/.ssh/authorized_keys

732

</pre></div></div>

733

<p>If $HOME is not on the NFS, copy the id_rsa.pub to the directory ~/.ssh (login with the same account) on each machine, and then do the following on each machine. (Notice that this step is not needed if the folder “.ssh” is on the NFS and can be accessed by all the nodes.)</p>

<pre>cd ~/.ssh

cat id_rsa.pub >> authorized_keys

739

chmod 700 $HOME/.ssh/authorized_keys

740

</pre></div></div>

741

<p>Then run the following step again and type “yes” if prompted:</p>

<pre>machineA> ssh 127.0.0.1

746

</pre></div></div></div>

747

748

<h3><a name="Step_2:_Define_the_AsterixDB_cluster"></a>Step (2): Define the AsterixDB cluster</h3>

749

<p>We first log into the master machine as the user “joe”. On this machine, download Managix from <a class="externalLink" href="http://asterixdb.ics.uci.edu/download.html">here</a> (save as above), then do the following steps similar to the single-machine case described above:</p>

<pre>machineA> cd ~

machineA> mkdir asterix-mgmt

755

machineA> cd asterix-mgmt

756

machineA> unzip <path to the Managix zip bundle>

757

</pre></div></div>

758

<p>Note that it is recommended that MANAGIX_HOME is not located on a network file system (NFS). Managix creates artifacts/logs that are not required to be shared. Any overhead associated with creating artifacts/logs on the NFS should be avoided.</p>

759

<p>We also need an AsterixDB configuration XML file for the cluster. We give the name to the cluster, say, “rainbow”. We create a folder for the configuration of this cluster:</p>

<pre>machineA> mkdir asterix-mgmt/rainbow_cluster

764

</pre></div></div>

765

<p>For this cluster we create a configuration file <tt>$MANAGIX_HOME/rainbow_cluster/rainbow.xml</tt>. The following is a sample file with explanation of the properties:</p>

772

<name>rainbow</name>

773

774

775

776

777

<!-- The working directory of Managix. It is recommended for the working

778

directory to be on a network file system (NFS) that can accessed by

779

all machines.

780

Managix creates the directory if it it doesn't exist. -->

781

<working_dir>

782

<dir>/home/joe/managix-workingDir</dir>

</working_dir>

<!-- Directory for Asterix to store worker logs information for each machine.

787

Needs to be on the local file system of each machine.

788

Managix creates the directory if it doesn't exist.

789

This property can be overriden for a node by redefining at the node level. -->

790

<log_dir>/mnt/joe/logs</log_dir>

791

792

<!-- Directory for Asterix to store transaction log information for each machine.

793

Needs to be on the local file system of each machine.

794

Managix creates the directory if it doesn't exist.

795

This property can be overriden for a node by redefining at the node level. -->

796

<txn_log_dir>/mnt/joe/txn_logs</txn_log_dir>

797

798

<!-- Mount point of an iodevice. Use a comma separated list for a machine that

799

has multiple iodevices (disks).

800

This property can be overriden for a node by redefining at the node level. -->

801

802

803

804

<store>storage</store>

805

806

807

<java_home>/usr/lib/jvm/jdk1.8.0</java_home>

808

809

810

<master_node>

811

<id>master</id>

812

<client_ip>128.195.52.177</client_ip>

813

<cluster_ip>192.168.100.0</cluster_ip>

814

<client_port>1098</client_port>

815

<cluster_port>1099</cluster_port>

816

<http_port>8888</http_port>

817

</master_node>

818

819

820

<node>

821

<id>nodeB</id>

822

<cluster_ip>192.168.100.1</cluster_ip>

823

</node>

824

825

826

<node>

827

<id>nodeC</id>

828

<cluster_ip>192.168.100.2</cluster_ip>

</node>

</cluster>

</pre></div></div>

<p>As stated before, each of the above properties can be defined at the cluster level, in which case it applies to all the nodes in the system. Each property can also be defined at a node level.</p>

833

<p>Once we have formed the cluster XML file, we can validate the configuration by doing the following:</p>

<pre>managix validate -c rainbow_cluster/rainbow.xml

838

</pre></div></div>

839

<p>This will verify the contents of the file, and also attempt to ssh to each node in the cluster to ensure that password-less SSH is configured correctly. You may see output like</p>

<pre>The authenticity of host '192.168.100.1 (192.168.100.1)' can't be established.

844

RSA key fingerprint is 89:80:31:1f:be:51:16:d7:2b:f5:e0:b3:2c:bd:83:94.

845

Are you sure you want to continue connecting (yes/no)?

846

</pre></div></div>

847

<p>and this output may be repeated for each node in the cluster. Answer “yes” each time.</p>

848

<p>If the final output contains the following lines (possibly separated by the RSA prompts mentione above):</p>

<pre>INFO: Environment [OK]

853

INFO: Cluster configuration [OK]

854

</pre></div></div>

855

<p>it means that the XML configuration file is correct!</p></div>

856

857

<h3><a name="Step_3:_Configuring_Managix"></a>Step (3): Configuring Managix</h3>

858

<p>Managix uses a configuration XML file at <tt>$MANAGIX_HOME/conf/managix-conf.xml</tt> to configure its own properties, such as its Zookeeper service. We can use the <tt>configure</tt> command to auto-generate this configuration file:</p>

<pre>machineA> managix configure

863

</pre></div></div>

864

<p>We use the <tt>validate</tt> command to validate the Managix configuration. To do so, execute the following.</p>

<pre>machineA> managix validate

869

INFO: Environment [OK]

870

INFO: Managix Configuration [OK]

871

</pre></div></div>

872

<p>Note that the <tt>configure</tt> command also generates a cluster configuration XML file at $MANAGIX_HOME/clusters/local/local.xml. This file is not needed in the case of a cluster of machines.</p></div>

873

874

<h3><a name="Step_4:_Creating_an_AsterixDB_instance"></a>Step (4): Creating an AsterixDB instance</h3>

875

<p>Now that we have configured Managix, we shall next create an AsterixDB instance, which is identified by a unique name and is created using the <tt>create</tt> command. The usage description for the <tt>create</tt> command can be obtained by executing the following:</p>

<pre>machineA> managix help -cmd create

880

881

Creates an AsterixDB instance with a specified name. Post creation, the instance is in ACTIVE state,

882

indicating its availability for executing statements/queries.

883

Usage arguments/options:

884

-n Name of the AsterixDB instance.

885

-c Path to the cluster configuration file

886

</pre></div></div>

887

<p>We shall now use the <tt>create</tt> command to create an AsterixDB instance called “rainbow_asterix”. In doing so, we shall use the cluster configuration file that was auto-generated by Managix.</p>

<pre>machineA> managix create -n rainbow_asterix -c clusters/rainbow.xml

892

</pre></div></div>

893

<p>If the response message does not have warning, then Congratulations! You have successfully installed AsterixDB on this cluster of machines!</p>

894

<p>Please refer to the section <a href="#Section_4:_Managing_the_Lifecycle_of_an_AsterixDB_Instance">Managing the Lifecycle of an AsterixDB Instance</a> for a detailed description on the set of available commands/operations that let you manage the lifecycle of an AsterixDB instance. Note that the output of the commands varies with the cluster definition and may not apply to the cluster specification you built above.</p></div></div>

895

896

<h2><a name="Section_4:_Managing_the_Lifecycle_of_an_AsterixDB_Instance_Back_to_TOC"></a><a name="Section4ManagingTheLifecycleOfAnAsterixDBInstance" id="Section4ManagingTheLifecycleOfAnAsterixDBInstance">Section 4: Managing the Lifecycle of an AsterixDB Instance</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

897

<p>Now that we have an AsterixDB instance running, let us use Managix to manage the instance’s lifecycle. Managix provides the following set of commands/operations:</p>

898

899

900

<h4><a name="Managix_Commands"></a>Managix Commands</h4>

<td>Command</td>

<td>Description</td></tr>

907

908

909

<td><a href="#Creating_an_AsterixDB_instance">create</a></td>

910

<td>Creates a new asterix instance.</td></tr>

911

912

913

<td><a href="#Describe_Command">describe</a></td>

914

<td>Describes an existing asterix instance.</td></tr>

<td>Stops an asterix instance that is in the ACTIVE state.</td></tr>

919

920

921

<td><a href="#Start_Command">start</a></td>

922

<td>Starts an AsterixDB instance.</td></tr>

923

924

925

<td><a href="#Backup_Command">backup</a></td>

926

<td>Creates a backup for an existing AsterixDB instance.</td></tr>

927

928

929

<td><a href="#Restore_Command">restore</a></td>

930

<td>Restores an AsterixDB instance.</td></tr>

931

932

933

<td><a href="#Delete_Command">delete</a></td>

934

<td>Deletes an AsterixDB instance.</td></tr>

935

936

937

<td><a href="#Configuring_Managix">validate</a></td>

938

<td>Validates the installer/cluster configuration.</td></tr>

939

940

941

<td><a href="#Configuring_Managix">configure</a></td>

942

<td>Auto generates a configuration for an AsterixDB instance.</td></tr>

<td>Produces a zip archive containing log files from each node in an AsterixDB instance.</td></tr>

947

948

949

<td><a href="#Shutdown_Command">shutdown</a></td>

950

<td>Shuts down the installer service.</td></tr>

951

</table>

952

<p>You may obtain the above listing by simply executing ‘managix’ :</p>

<pre>$ managix

</pre></div></div>

<p>We already talked about <tt>create</tt> and <tt>validate</tt> commands. We shall next explain the rest of the commands listed above. We also provide sample output messages of these commands assuming we are running an AsterixDB instance on a single machine.</p>

959

960

<h5><a name="Describe_Command"></a>Describe Command</h5>

961

<p>The <tt>describe</tt> command provides information about an AsterixDB instance. The usage can be looked up by executing the following:</p>

<pre>$ managix help -cmd describe

966

967

Provides information about an AsterixDB instance.

968

The following options are available:

969

[-n] Name of the AsterixDB instance.

970

[-admin] Provides a detailed description

971

</pre></div></div>

972

<p>The brackets indicate optional flags.</p>

973

<p>The output of the <tt>describe</tt> command when used without the <tt>admin</tt> flag contains minimal information and is similar to the output of the <tt>create</tt> command. Let us try running the describe command in “admin” mode.</p>

<pre>$ managix describe -n my_asterix -admin

978

INFO: Name:my_asterix

979

Created:Thu Mar 07 19:07:00 PST 2013

980

Web-Url:http://127.0.0.1:19001

981

State:ACTIVE

982

Master node:master:127.0.0.1

983

node1:127.0.0.1

984

985

Asterix version:0.0.5

986

Asterix Configuration

987

output_dir = /tmp/asterix_output/

988

Metadata Node:node1

989

Processes

990

NC at 127.0.0.1 [ 22195 ]

991

CC at 127.0.0.1 [ 22161 ]

992

993

Asterix Configuration

994

nc.java.opts :-Xmx1024m

995

cc.java.opts :-Xmx1024m

996

storage.buffercache.pagesize :32768

997

storage.buffercache.size :33554432

998

storage.buffercache.maxopenfiles :214748364

999

storage.memorycomponent.pagesize :32768

1000

storage.memorycomponent.numpages :1024

1001

storage.memorycomponent.globalbudget :536870192

1002

storage.lsm.mergethreshold :3

1003

storage.lsm.bloomfilter.falsepositiverate:0.01

1004

txn.log.buffer.numpages :8

1005

txn.log.buffer.pagesize :131072

1006

txn.log.partitionsize :2147483648

1007

txn.log.disksectorsize :4096

1008

txn.log.groupcommitinterval :1

1009

txn.log.checkpoint.lsnthreshold :67108864

1010

txn.log.checkpoint.pollfrequency :120

1011

txn.log.checkpoint.history :0

1012

txn.lock.escalationthreshold :1000

1013

txn.lock.shrinktimer :5000

1014

txn.lock.timeout.waitthreshold :60000

1015

txn.lock.timeout.sweepthreshold :10000

1016

compiler.sortmemory :33554432

1017

compiler.joinmemory :33554432

1018

compiler.framesize :32768

web.port :19001

api.port :19002

log.level :INFO

</pre></div></div>

<p>As seen above, the instance ‘my_asterix’ is configured such that all processes running at the localhost (127.0.0.1). The process id for each process (JVM) is shown next to it.</p></div>

1024

1025

<h5><a name="Stop_Command"></a>Stop Command</h5>

1026

<p>The <tt>stop</tt> command can be used for shutting down an AsterixDB instance. After that, the instance is unavailable for executing queries. The usage can be looked up by executing the following.</p>

<pre>$ managix help -cmd stop

1031

1032

Shuts an AsterixDB instance that is in ACTIVE state. After executing the stop command, the AsterixDB instance transits

1033

to the INACTIVE state, indicating that it is no longer available for executing queries.

1034

1035

Available arguments/options

1036

-n name of the AsterixDB instance.

1037

</pre></div></div>

1038

<p>To stop the AsterixDB instance.</p>

<pre>$ managix stop -n my_asterix

1043

INFO: Stopped AsterixDB instance: my_asterix

1044

1045

$ managix describe -n my_asterix

1046

INFO: Name: my_asterix

1047

Created:Thu Mar 07 19:07:00 PST 2013

1048

Web-Url:http://127.0.0.1:19001

1049

State:INACTIVE (Fri Mar 08 09:49:00 PST 2013)

1050

</pre></div></div></div>

1051

1052

<h5><a name="Start_Command"></a>Start Command</h5>

1053

<p>The <tt>start</tt> command starts an AsterixDB instance that is in the INACTIVE state. The usage can be looked up by executing the following:</p>

<pre> $ managix help -cmd start

1058

1059

Starts an AsterixDB instance that is in INACTIVE state. After executing the start command, the AsterixDB instance transits to the ACTIVE state, indicating that it is now available for executing statements/queries.

1060

1061

Available arguments/options

1062

-n name of the AsterixDB instance.

1063

</pre></div></div>

1064

<p>Let us now start the AsterixDB instance.</p>

<pre> $ managix start -n my_asterix

1069

INFO: Name:my_asterix

1070

Created:Thu Mar 07 19:07:00 PST 2013

1071

Web-Url:http://127.0.0.1:19001

1072

State:ACTIVE (Fri Mar 08 09:49:00 PST 2013)

1073

</pre></div></div></div>

1074

1075

<h5><a name="Backup_Command"></a>Backup Command</h5>

1076

<p>The backup command allows you to take a backup of the data stored with an AsterixDB instance. The backup can be taken on the local file system or on an HDFS instance. In either case, the snapshots are stored under a backup directory. You need to make sure the backup directory has appropriate read/write permissions. Configuring settings for backup can be found inside the Managix’s configuration file located at <tt>$MANAGIX_HOME/conf/managix-conf.xml</tt>.</p>

1077

<p><i>Configuring backup on the local file system</i></p>

1078

<p>We need to provide a path to a backup directory on the local file system. The backup directory can be configured be editing the Managix configuration XML, found at <tt>$MANAGIX_HOME/conf/managix-conf.xml</tt>.</p>

<backupDir>Provide path to the backup directory here</backupDir>

1084

</backup>

1085

</pre></div></div>

1086

<p>Prior to taking a backup of an AsterixDB instance, it is required for the instance to be in the INACTIVE state. We do so by using the <tt>stop</tt> command, as shown below:</p>

<pre>$ managix stop -n my_asterix

1091

INFO: Stopped AsterixDB instance: my_asterix

1092

</pre></div></div>

1093

<p>We can now take the backup by executing the following:</p>

<pre>$ managix backup -n my_asterix

1098

INFO: my_asterix backed up 0_Fri Mar 08 16:16:34 PST 2013 (LOCAL)

1099

</pre></div></div>

1100

<p><i>Configuring backup on an HDFS instance</i></p>

1101

<p>To configure a backup to be taken on an HDFS instance, we need to provide required information about the running HDFS instance. This information includes the HDFS version and the HDFS url. Simply edit the Managix configuration file and provide the required information.</p>

<backupDir>Provide path to the backup directory here</backupDir>

<hdfs>

</hdfs>

</backup>

</pre></div></div>

<p>A sample output when a backup is taken on an HDFS is shown below:</p>

<pre>$ managix backup -n my_asterix

1118

INFO: my_asterix backed up 1_Fri Mar 08 17:10:38 PST 2013 (HDFS)

1119

</pre></div></div>

1120

<p>Each time we take a backup, we are provided with a unique id (a monotonically increasing value starting with 0). This id is required when we need to restore from a previously taken backup. Information about all available backup snapshots can be obtained by using the <tt>describe</tt> command in the admin mode, as shown below:</p>

<pre>$ managix describe -n my_asterix -admin

1125

INFO: Name:my_asterix

1126

Created:Fri Mar 08 15:11:12 PST 2013

1127

Web-Url:http://127.0.0.1:19001

1128

State:INACTIVE (Fri Mar 08 16:14:20 PST 2013)

1129

Master node:master:127.0.0.1

1130

node1:127.0.0.1

1131

1132

Backup:0 created at Fri Mar 08 16:16:34 PST 2013 (LOCAL)

1133

Backup:1 created at Fri Mar 08 17:10:38 PST 2013 (HDFS)

1134

1135

Asterix version:0.0.5

1136

Asterix Configuration

Metadata Node:node1

Processes

</pre></div></div>

<p>The above output shows the available backup identified by it’s id (0). We shall next describe the method for restoring an AsterixDB instance from a backup snapshot.</p></div>

1141

1142

<h5><a name="Restore_Command"></a>Restore Command</h5>

1143

<p>The <tt>restore</tt> command allows you to restore an AsterixDB instance’s data from a previously taken backup. The usage description can be obtained as follows:</p>

<pre>$ managix help -cmd restore

1148

1149

Restores an AsterixDB instance's data from a previously taken backup.

1150

Available arguments/options

1151

1152

-n name of the AsterixDB instance

1153

-b id of the backup snapshot

1154

</pre></div></div>

1155

<p>The following command restores our AsterixDB instance from the backup snapshot identified by the id (0). Prior to restoring an instance from a backup, it is required that the instance is in the INACTIVE state.</p>

<pre>$ managix restore -n my_asterix -b 0

1160

INFO: AsterixDB instance: my_asterix has been restored from backup

1161

</pre></div></div>

1162

<p>You can start the AsterixDB instance by using the start command.</p></div>

1163

1164

<h5><a name="Log_Command"></a>Log Command</h5>

1165

<p>The <tt>log</tt> command allows you to collect the log files coresponding to each node of an AsterixDB instance into a zip archive. The zip archive is produced on the local file system of the machine running managix.</p>

<pre>$ managix help -cmd log

1170

1171

Creates a zip archive containing log files corresponding to each worker node (NC) and the master (CC) for an AsterixDB instance

1172

1173

Available arguments/options

1174

-n name of the AsterixDB instance.

1175

-d destination directory for producing the zip archive. Defaults to $MANAGIX_HOME/logdump.

1176

</pre></div></div>

1177

<p>The following is an example showing the use of the log command.</p>

<pre>$ managix log -n my_asterix -d /Users/joe/logdump

1182

INFO: Log zip archive created at /Users/joe/logdump/log_Thu_Jun_06_00:53:51_PDT_2013.zip

1183

</pre></div></div></div>

1184

1185

<h5><a name="Delete_Command"></a>Delete Command</h5>

1186

<p>As the name suggests, the <tt>delete</tt> command permanently removes an AsterixDB instance by cleaning up all associated data/artifacts. The usage can be looked up by executing the following:</p>

<pre>$ managix help -cmd delete

1191

Permanently deletes an AsterixDB instance. The instance must be in the INACTIVE state.

1192

1193

Available arguments/options

1194

-n name of the AsterixDB instance.

1195

1196

1197

$ managix delete -n my_asterix

1198

INFO: AsterixDB instance my_asterix deleted.

1199

</pre></div></div></div>

1200

1201

<h5><a name="Shutdown_Command"></a>Shutdown Command</h5>

1202

<p>Managix uses Zookeeper service for storing all information about created AsterixDB instances. The Zookeeper service runs in the background and can be shut down using the <tt>shutdown</tt> command.</p>

<pre>$ managix shutdown

1207

</pre></div></div></div>

1208

1209

<h5><a name="Help_Command"></a>Help Command</h5>

1210

<p>The <tt>help</tt> command provides a usage description of a Managix command.</p>

<pre>$ managix help -cmd <command name>

1215

</pre></div></div>

1216

<p>As an example, for looking up the help for the <tt>configure</tt> command, execute the following</p>

<pre>$ managix help -cmd configure

1221

1222

Auto-generates the AsterixDB installer configruation settings and AsterixDB cluster

1223

configuration settings for a single node setup.

1224

</pre></div></div></div></div></div></div>

1225

1226

<h2><a name="Section_5:_Frequently_Asked_Questions_Back_to_TOC"></a><a name="Section5FAQ" id="Section5FAQ">Section 5: Frequently Asked Questions</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>

<h5><a name="Question"></a>Question</h5>

1231

<p>What happens if a machine acting as a node in the Asterix cluster becomes unreachable for some reason (network partition/machine failure) ?</p></div>

1232

1233

<h5><a name="Answer"></a>Answer</h5>

1234

<p>When a node leaves the Asterix cluster, the AsterixDB instance transits to an ‘UNUSABLE’ state, indicating that it is no longer available for serving queries. To know which set of node(s) left the cluster, run the describe command with -admin flag.</p>

<pre>$ $MANAGIX_HOME/bin/managix describe -n <name of the AsterixDB instance>-admin

1239

</pre></div></div>

1240

<p>Above command will show the state of AsterixDB instance and list the set of nodes that have left the cluster.</p>

1241

<p>The failed node must be brought back to re-join the cluster. Once done, you may bring back the instance to an ‘ACTIVE’ state by executing the following sequence.</p>

1242

<p>1) Get rid of the Asterix processes running on the nodes in the cluster:-</p>

<pre>managix stop -n my_asterix

1247

</pre></div></div>

1248

<p>The processes associated with the instance are terminated and the instance moves to the INACTIVE state.</p>

1249

<p>2) Start the AsterixDB instance using the start command.</p>

<pre>managix start -n <name of your AsterixDB instance>

1254

</pre></div></div></div>

1255

1256

<h5><a name="Question"></a>Question</h5>

1257

<p>Do I need to create all the directories/paths I put into the cluster configuration XML ?</p></div>

1258

1259

<h5><a name="Answer"></a>Answer</h5>

1260

<p>Managix will create a path if it is not existing. It does so using the user account mentioned in the cluster configuration xml. Please ensure that the user account has appropriate permissions for creating the missing paths.</p></div>

1261

1262

<h5><a name="Question"></a>Question</h5>

1263

<p>Should MANAGIX_HOME be on the network file system (NFS) ?</p></div>

1264

1265

<h5><a name="Answer"></a>Answer</h5>

1266

<p>It is recommended that MANAGIX_HOME is not on the NFS. Managix produces artifacts/logs on disk which are not required to be shared. As such an overhead in creating the artifacts/logs on the NFS should be avoided.</p></div>

1267

1268

<h5><a name="Question"></a>Question</h5>

1269

<p>How do we change the underlying code (apply a code patch) for an ‘active’ asterix instance?</p></div>

1270

1271

<h5><a name="Answer"></a>Answer</h5>

1272

<p>At times, end-user (particularly asterix developer) may run into the need to altering the underlying code that is being run by an asterix instance. In the current version of managix, this can be achieved as follows:-</p>

1273

<p>Assume that you have an ‘active’ instance by the name a1 that is running version v1 of asterix. You have a revised version of asterix - v2 that fixes some bug(s).</p>

1274

<p>To upgrade asterix from v1 to v2:-</p>

1275

<p>step 1) managix stop -n a1</p>

1276

<p>step 2) managix shutdown</p>

1277

<p>step 3) copy asterix-server zip (version v2) to asterix/</p>

1278

<p>step 4) managix start -n a1</p>

1279

<p>a1 now is running on version v2.</p>

1280

<p>Limitations:-</p>

1281

<p>a) Obviously this wont work in a situation where v2 has made a change that is incompatible with earlier version, such altering schema.</p>

1282

<p>b) A change in asterix zip applies to all existing instances (after a restart) and subsequent instances that user creates.</p></div></div></div></div>

</div>

</div>

</div>

<hr/>