Blame - content/docs/0.8.7-incubating/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>

226

227

<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>

<li><a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK>=7</a> (Otherwise known as JDK>=1.7).</li>

233

</ul>

234

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

<pre> $ java -version

239

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

240

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

<pre> java version "1.7.0_13"

245

Java(TM) SE Runtime Environment (build 1.7.0_13-b20)

246

Java HotSpot(TM) 64-Bit Server VM (build 23.7-b01, mixed mode)

247

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

248

<p>If you need to upgrade or install java, please follow the instructions below.</p>

<ul>

<li>

<p>For Linux: <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/webnotes/install/linux/linux-jdk.html">JDK 7 Linux Install</a> JDK would be installed at a path under /usr/lib/jvm/jdk-version .</p></li>

254

255

<li>

256

<p>For Mac: <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/webnotes/install/mac/mac-jdk.html">JDK 7 Mac Install</a> JDK would be installed at /Library/Java/JavaVirtualMachines/jdk-version/Contents/Home .</p></li>

257

</ul>

258

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

<pre> $ java -version

263

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

264

<p>If the version information you obtain does not show 1.7, 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)

269

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

270

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

271

272

<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>

273

<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>

274

275

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

276

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

<pre> $ echo $JAVA_HOME

281

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

282

<p>If you do not see any output, JAVA_HOME 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>

287

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

288

<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)

293

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

294

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

<pre> $ echo $JAVA_HOME

299

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

300

301

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

302

<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>

303

304

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

305

<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>

306

307

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

<pre> sudo apt-get install openssh-server

312

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

313

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

314

315

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

316

<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

321

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

322

<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.

327

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

328

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

329

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

330

<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

335

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

336

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

337

<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>

338

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

339

<p>You are here because you were prompted for a password. You need to configure password-less SSH.<br />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 ""

344

Generating public/private rsa key pair.

345

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

346

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

347

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

348

<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.

353

Overwrite (y/n)?

354

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

355

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

<pre> The key fingerprint is:

360

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

361

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

379

$ chmod 700 $HOME/.ssh/authorized_keys

380

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

381

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

<pre> $ ssh 127.0.0.1

386

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

387

<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.

392

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

393

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

394

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

395

<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.

400

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

401

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

402

<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

408

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

409

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

<pre> $ exit

logout

Connection to 127.0.0.1 closed.

416

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

417

418

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

419

<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>

420

<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>

425

426

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

427

</ul>

428

<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

433

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

434

<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

439

INFO: Environment [OK]

440

INFO: Managix Configuration [OK]

441

442

443

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

444

INFO: Environment [OK]

445

INFO: Cluster configuration [OK]

446

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

447

448

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

449

<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

454

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

455

indicating its availability for executing statements/queries.

456

Usage arguments/options:

457

-n Name of the AsterixDB instance.

458

-c Path to the cluster configuration file

459

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

460

<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

465

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

466

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

<pre> INFO: Name:my_asterix

471

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

472

Web-Url:http://127.0.0.1:19001

473

State:ACTIVE

474

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

475

<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>

476

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

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

481

return $message

482

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

483

<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>

484

485

<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>

486

<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>

487

488

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

489

<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>

490

491

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

492

<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.7.0</java_home>

500

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

501

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

502

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

503

<store>storage</store>

504

<working_dir>

505

<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>

511

<cluster_ip>127.0.0.1</cluster_ip>

512

<client_port>1098</client_port>

513

<cluster_port>1099</cluster_port>

514

<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>

523

524

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

525

<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>

532

<cluster_ip>127.0.0.1</cluster_ip>

533

<client_port>1098</client_port>

534

<cluster_port>1099</cluster_port>

535

<http_port>8888</http_port>

</master_node>

<node>

<cluster_ip>127.0.0.1</cluster_ip>

540

</node>

541

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

542

<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>

584

585

<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>

598

<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>

642

</tr>

643

</table>

644

<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>

645

646

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

647

<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>

657

658

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

659

<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>

675

676

<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>

677

<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>

678

679

<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>

680

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

681

682

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

683

<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>

684

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

<pre> machineA> ssh 127.0.0.1

689

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

690

<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.

695

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

696

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

697

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

698

<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

703

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

704

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

705

<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>

706

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

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

711

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

712

machineA> chmod 700 $HOME/.ssh/authorized_keys

713

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

714

<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

720

chmod 700 $HOME/.ssh/authorized_keys

721

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

722

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

<pre> machineA> ssh 127.0.0.1

727

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

728

729

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

730

<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

736

machineA> cd asterix-mgmt

737

machineA> unzip <path to the Managix zip bundle>

738

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

739

<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>

740

<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

745

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

746

<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>

753

<name>rainbow</name>

754

755

756

757

758

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

759

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

760

all machines.

761

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

762

<working_dir>

763

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

</working_dir>

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

768

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

769

Managix creates the directory if it doesn't exist.

770

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

771

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

772

773

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

774

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

775

Managix creates the directory if it doesn't exist.

776

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

777

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

778

779

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

780

has multiple iodevices (disks).

781

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

782

783

784

785

<store>storage</store>

786

787

788

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

789

790

791

<master_node>

792

<id>master</id>

793

<client_ip>128.195.52.177</client_ip>

794

<cluster_ip>192.168.100.0</cluster_ip>

795

<client_port>1098</client_port>

796

<cluster_port>1099</cluster_port>

797

<http_port>8888</http_port>

798

</master_node>

799

800

801

<node>

802

<id>nodeB</id>

803

<cluster_ip>192.168.100.1</cluster_ip>

804

</node>

805

806

807

<node>

808

<id>nodeC</id>

809

<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>

814

<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

819

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

820

<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.

825

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

826

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

827

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

828

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

829

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

<pre> INFO: Environment [OK]

834

INFO: Cluster configuration [OK]

835

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

836

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

837

838

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

839

<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

844

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

845

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

<pre> machineA> managix validate

850

INFO: Environment [OK]

851

INFO: Managix Configuration [OK]

852

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

853

<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>

854

855

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

856

<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

861

862

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

863

indicating its availability for executing statements/queries.

864

Usage arguments/options:

865

-n Name of the AsterixDB instance.

866

-c Path to the cluster configuration file

867

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

868

<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

873

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

874

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

875

<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>

876

877

<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>

878

<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>

879

880

881

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

<td>Command</td>

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

888

889

890

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

891

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

892

893

894

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

895

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

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

900

901

902

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

903

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

904

905

906

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

907

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

908

909

910

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

911

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

912

913

914

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

915

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

916

917

918

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

919

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

920

921

922

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

923

<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>

928

929

930

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

931

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

932

</table>

933

<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>

940

941

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

942

<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

947

948

Provides information about an AsterixDB instance.

949

The following options are available:

950

[-n] Name of the AsterixDB instance.

951

[-admin] Provides a detailed description

952

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

953

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

954

<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

959

INFO: Name:my_asterix

960

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

961

Web-Url:http://127.0.0.1:19001

962

State:ACTIVE

963

Master node:master:127.0.0.1

964

node1:127.0.0.1

965

966

Asterix version:0.0.5

967

Asterix Configuration

968

output_dir = /tmp/asterix_output/

969

Metadata Node:node1

970

Processes

971

NC at 127.0.0.1 [ 22195 ]

972

CC at 127.0.0.1 [ 22161 ]

973

974

Asterix Configuration

975

nc.java.opts :-Xmx1024m

976

cc.java.opts :-Xmx1024m

977

storage.buffercache.pagesize :32768

978

storage.buffercache.size :33554432

979

storage.buffercache.maxopenfiles :214748364

980

storage.memorycomponent.pagesize :32768

981

storage.memorycomponent.numpages :1024

982

storage.memorycomponent.globalbudget :536870192

983

storage.lsm.mergethreshold :3

984

storage.lsm.bloomfilter.falsepositiverate:0.01

985

txn.log.buffer.numpages :8

986

txn.log.buffer.pagesize :131072

987

txn.log.partitionsize :2147483648

988

txn.log.disksectorsize :4096

989

txn.log.groupcommitinterval :1

990

txn.log.checkpoint.lsnthreshold :67108864

991

txn.log.checkpoint.pollfrequency :120

992

txn.log.checkpoint.history :0

993

txn.lock.escalationthreshold :1000

994

txn.lock.shrinktimer :5000

995

txn.lock.timeout.waitthreshold :60000

996

txn.lock.timeout.sweepthreshold :10000

997

compiler.sortmemory :33554432

998

compiler.joinmemory :33554432

999

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>

1005

1006

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

1007

<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

1012

1013

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

1014

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

1015

1016

Available arguments/options

1017

-n name of the AsterixDB instance.

1018

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

1019

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

<pre> $ managix stop -n my_asterix

1024

INFO: Stopped AsterixDB instance: my_asterix

1025

1026

1027

$ managix describe -n my_asterix

1028

INFO: Name: my_asterix

1029

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

1030

Web-Url:http://127.0.0.1:19001

1031

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

1032

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

1033

1034

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

1035

<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

1040

1041

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.

1042

1043

Available arguments/options

1044

-n name of the AsterixDB instance.

1045

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

1046

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

<pre> $ managix start -n my_asterix

1051

INFO: Name:my_asterix

1052

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

1053

Web-Url:http://127.0.0.1:19001

1054

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

1055

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

1056

1057

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

1058

<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>

1059

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

1060

<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>

1066

</backup>

1067

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

1068

<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

1073

INFO: Stopped AsterixDB instance: my_asterix

1074

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

1075

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

<pre> $ managix backup -n my_asterix

1080

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

1081

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

1082

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

1083

<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

1100

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

1101

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

1102

<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

1107

INFO: Name:my_asterix

1108

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

1109

Web-Url:http://127.0.0.1:19001

1110

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

1111

Master node:master:127.0.0.1

1112

node1:127.0.0.1

1113

1114

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

1115

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

1116

1117

Asterix version:0.0.5

1118

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>

1123

1124

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

1125

<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

1130

1131

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

1132

Available arguments/options

1133

1134

-n name of the AsterixDB instance

1135

-b id of the backup snapshot

1136

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

1137

<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

1142

INFO: AsterixDB instance: my_asterix has been restored from backup

1143

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

1144

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

1145

1146

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

1147

<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

1152

1153

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

1154

1155

Available arguments/options

1156

-n name of the AsterixDB instance.

1157

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

1158

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

1159

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

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

1164

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

1165

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

1166

1167

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

1168

<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

1173

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

1174

1175

Available arguments/options

1176

-n name of the AsterixDB instance.

1177

1178

1179

$ managix delete -n my_asterix

1180

INFO: AsterixDB instance my_asterix deleted.

1181

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

1182

1183

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

1184

<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

1189

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

1190

1191

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

1192

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

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

1197

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

1198

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

<pre> $ managix help -cmd configure

1203

1204

Auto-generates the AsterixDB installer configruation settings and AsterixDB cluster

1205

configuration settings for a single node setup.

1206

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

1207

1208

<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>

1213

<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>

1214

1215

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

1216

<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

1221

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

1222

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

1223

<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>

1224

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

<pre> managix stop -n my_asterix

1229

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

1230

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

1231

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

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

1236

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

1237

1238

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

1239

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

1240

1241

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

1242

<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>

1243

1244

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

1245

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

1246

1247

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

1248

<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>

1249

1250

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

1251

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

1252

1253

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

1254

<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>

1255

<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>

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

<p>Limitations:-</p>

1263

<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>

1264

<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/>