Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / refs/heads/asf-site / . / content / docs / 0.8.7-incubating / yarn.html
blob: 3e70e8280f84d3d27a7c3e2bc904715670e09c21 [file] [log] [blame]
Ian Maxone2b799e2015-11-24 18:20:03 -0800[diff] [blame]1<!DOCTYPE html>
2<!--
3 | Generated by Apache Maven Doxia at 2015-11-24
4 | Rendered using Apache Maven Fluido Skin 1.3.0
5-->
6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20151124" />
11 <meta http-equiv="Content-Language" content="en" />
12 <title>AsterixDB &#x2013; Introduction</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16
17
18 <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
19
20
21
Ian Maxone2b799e2015-11-24 18:20:03 -0800[diff] [blame]22
Ian Maxone2b799e2015-11-24 18:20:03 -0800[diff] [blame]23
24 </head>
25 <body class="topBarDisabled">
26
27
28
29
30 <div class="container-fluid">
31 <div id="banner">
32 <div class="pull-left">
33 <a href="http://asterixdb.apache.org/" id="bannerLeft">
34 <img src="images/asterixlogo.png" alt="AsterixDB"/>
35 </a>
36 </div>
37 <div class="pull-right"> </div>
38 <div class="clear"><hr/></div>
39 </div>
40
41 <div id="breadcrumbs">
42 <ul class="breadcrumb">
43
44
45 <li id="publishDate">Last Published: 2015-11-24</li>
46
47
48
49 <li id="projectVersion" class="pull-right">Version: 0.8.7-incubating</li>
50
51 <li class="divider pull-right">|</li>
52
53 <li class="pull-right"> <a href="index.html" title="Documentation Home">
54 Documentation Home</a>
55 </li>
56
57 </ul>
58 </div>
59
60
61 <div class="row-fluid">
62 <div id="leftColumn" class="span3">
63 <div class="well sidebar-nav">
64
65
66 <ul class="nav nav-list">
67 <li class="nav-header">Documentation</li>
68
69 <li>
70
71 <a href="install.html" title="Installing and Managing AsterixDB using Managix">
72 <i class="none"></i>
73 Installing and Managing AsterixDB using Managix</a>
74 </li>
75
76 <li class="active">
77
78 <a href="#"><i class="none"></i>Deploying AsterixDB using YARN</a>
79 </li>
80
81 <li>
82
83 <a href="aql/primer.html" title="AsterixDB 101: An ADM and AQL Primer">
84 <i class="none"></i>
85 AsterixDB 101: An ADM and AQL Primer</a>
86 </li>
87
88 <li>
89
90 <a href="aql/primer-sql-like.html" title="AsterixDB 101: An ADM and AQL Primer (For SQL Fans)">
91 <i class="none"></i>
92 AsterixDB 101: An ADM and AQL Primer (For SQL Fans)</a>
93 </li>
94
95 <li>
96
97 <a href="aql/js-sdk.html" title="AsterixDB Javascript SDK">
98 <i class="none"></i>
99 AsterixDB Javascript SDK</a>
100 </li>
101
102 <li>
103
104 <a href="aql/datamodel.html" title="Asterix Data Model (ADM)">
105 <i class="none"></i>
106 Asterix Data Model (ADM)</a>
107 </li>
108
109 <li>
110
111 <a href="aql/manual.html" title="Asterix Query Language (AQL)">
112 <i class="none"></i>
113 Asterix Query Language (AQL)</a>
114 </li>
115
116 <li>
117
118 <a href="aql/functions.html" title="AQL Functions">
119 <i class="none"></i>
120 AQL Functions</a>
121 </li>
122
123 <li>
124
125 <a href="aql/allens.html" title="AQL Allen's Relations Functions">
126 <i class="none"></i>
127 AQL Allen's Relations Functions</a>
128 </li>
129
130 <li>
131
132 <a href="aql/similarity.html" title="AQL Support of Similarity Queries">
133 <i class="none"></i>
134 AQL Support of Similarity Queries</a>
135 </li>
136
137 <li>
138
139 <a href="aql/externaldata.html" title="Accessing External Data">
140 <i class="none"></i>
141 Accessing External Data</a>
142 </li>
143
144 <li>
145
146 <a href="feeds/tutorial.html" title="Support for Data Ingestion in AsterixDB">
147 <i class="none"></i>
148 Support for Data Ingestion in AsterixDB</a>
149 </li>
150
151 <li>
152
153 <a href="udf.html" title="Support for User Defined Functions in AsterixDB">
154 <i class="none"></i>
155 Support for User Defined Functions in AsterixDB</a>
156 </li>
157
158 <li>
159
160 <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
161 <i class="none"></i>
162 Filter-Based LSM Index Acceleration</a>
163 </li>
164
165 <li>
166
167 <a href="api.html" title="HTTP API to AsterixDB">
168 <i class="none"></i>
169 HTTP API to AsterixDB</a>
170 </li>
171 </ul>
172
173
174
175 <hr class="divider" />
176
177 <div id="poweredBy">
178 <div class="clear"></div>
179 <div class="clear"></div>
180 <div class="clear"></div>
181 <a href="https://code.google.com/p/hyracks/" title="Hyracks" class="builtBy">
182 <img class="builtBy" alt="Hyracks" src="images/hyrax_ts.png" />
183 </a>
184 </div>
185 </div>
186 </div>
187
188
189 <div id="bodyColumn" class="span9" >
190
191 <!-- ! Licensed to the Apache Software Foundation (ASF) under one
192 ! or more contributor license agreements. See the NOTICE file
193 ! distributed with this work for additional information
194 ! regarding copyright ownership. The ASF licenses this file
195 ! to you under the Apache License, Version 2.0 (the
196 ! "License"); you may not use this file except in compliance
197 ! with the License. You may obtain a copy of the License at
198 !
199 ! http://www.apache.org/licenses/LICENSE-2.0
200 !
201 ! Unless required by applicable law or agreed to in writing,
202 ! software distributed under the License is distributed on an
203 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
204 ! KIND, either express or implied. See the License for the
205 ! specific language governing permissions and limitations
206 ! under the License.
207 ! --><h1>Introduction</h1>
208<div class="section">
209<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
210
211<ul>
212
213<li><a href="#arch">Architecture Overview</a></li>
214
215<li><a href="#prereq">Prerequisites</a></li>
216
217<li><a href="#tut">Tutorial Installation</a></li>
218
219<li><a href="#faq">FAQ and Common Issues</a></li>
220
221<li><a href="#detail">Reference guide to AsterixDB&#x2019;s YARN Client</a></li>
222</ul>
223<p>This is a guide describing how to deploy AsterixDB onto a YARN-based environment.</p></div>
224<div class="section">
225<h2><a name="AsterixDB_and_the_YARN_environment"></a><a name="arch" id="arch">AsterixDB and the YARN environment</a></h2>
226<p>AsterixDB uses a shared-nothing architecture and local file-based storage- not HDFS. Hence we are reliant on the local storage on each node (&#x2018;iodevices&#x2019; in AsterixDB ). In YARN there are 3 main types of storage available: </p>
227
228<ul>
229
230<li>HDFS file storage (only suitable for long-lived artifacts, can be slower than local disk)</li>
231
232<li>Ephemeral container storage that is cleaned by YARN after a container exits (unsuitable except for transient artifacts)</li>
233
234<li>Node-local destinations not managed by YARN, but which are accesable by the container and live beyond its termination.</li>
235</ul>
236<p>AsterixDB uses only the last type of storage, which is available with both the DefaultContainerExecutor and LinuxContainerExecutor. However keep in mind that with the DefaultContainerExecutor, the directory must be accessable by the same process that the YARN NodeManager is running as, while with the LinuxContainerExecutor it must be accessable by the unix user who is running the job.</p></div>
237<div class="section">
238<h2><a name="Prerequisites"></a><a name="prereq" id="prereq">Prerequisites</a></h2>
239<p>For this tutorial it will be assumed that we have a YARN cluster with the proper environment variables set. To test this, try running the DistributedShell example that is distributed as part of Apache Hadoop. If that sample application can be run successfully then the environment should be acceptable for launching AsterixDB on to your YARN-enabled cluster.</p>
240<div class="section">
241<h3><a name="Vagrant_and_Puppet_Virtualized_cluster_for_Tutorial"></a>Vagrant and Puppet Virtualized cluster for Tutorial</h3>
242<p>For the purposes of this tutorial, a virtualized cluster that matches all of the tutorial configurations can be found at <a class="externalLink" href="https://github.com/parshimers/yarn-sample-cluster">https://github.com/parshimers/yarn-sample-cluster</a>. It requires a machine with about 4-8GB of RAM to run. To start with this cluster, first clone the repository:</p>
243
244<div class="source">
245<div class="source">
246<pre> &#x21aa; git clone https://github.com/parshimers/yarn-sample-cluster.git
247 Cloning into 'yarn-sample-cluster'...
248 remote: Counting objects: 490, done.
249 remote: Compressing objects: 100% (315/315), done.
250 remote: Total 490 (delta 152), reused 490 (delta 152)
251 Receiving objects: 100% (490/490), 521.34 KiB | 201.00 KiB/s, done.
252 Resolving deltas: 100% (152/152), done.
253 Checking connectivity... done.
254</pre></div></div>
255<p>If the &#x2018;hostmanager&#x2019; plugin for Vagrant isn&#x2019;t already installed, install it like so:</p>
256
257<div class="source">
258<div class="source">
259<pre> &#x21aa; vagrant plugin install vagrant-hostmanager
260 Installing the 'vagrant-hostmanager' plugin. This can take a few minutes...
261 Installed the plugin 'vagrant-hostmanager (1.5.0)'!
262</pre></div></div>
263<p>Then start the tutorial cluster. The hostmanger plugin may ask for sudo at some point, because it updates your hosts file to include the virtual machines.</p>
264
265<div class="source">
266<div class="source">
267<pre> &#x21aa; vagrant up
268 Bringing machine 'nc2' up with 'virtualbox' provider...
269 Bringing machine 'nc1' up with 'virtualbox' provider...
270 Bringing machine 'cc' up with 'virtualbox' provider...
271 ...
272</pre></div></div>
273<p>Once vagrant returns, the environment will be ready. The working directory with the Vagrantfile is also visible to each of the virtual machines (in the /vagrant directory), so we will unzip the Asterix binaries here as well for easy access. The YARN binary can be found on the AsterixDB <a class="externalLink" href="http://asterixdb.ics.uci.edu/download.html">downloads page</a></p>
274
275<div class="source">
276<div class="source">
277<pre>&#x21aa; unzip -d asterix-yarn/ asterix-yarn-binary-assembly.zip
278...
279</pre></div></div>
280<p>To log into the node from which we will run the rest of the tutorial, use &#x2018;vagrant ssh&#x2019; to get to the CC node and move to the YARN client&#x2019;s location:</p>
281
282<div class="source">
283<div class="source">
284<pre> &#x21aa; vagrant ssh cc
285 [vagrant@cc ~]$
286 [vagrant@cc ~]$ cd /vagrant/asterix-yarn
287 [vagrant@cc asterix-yarn]$
288</pre></div></div>
289<h1><a name="tut" id="tut">Tutorial installation</a></h1></div></div>
290<div class="section">
291<h2><a name="Configuration"></a>Configuration</h2>
292<p>To deploy AsterixDB onto a YARN cluster, we need to construct a configuration file that describes the resources that will be requested from YARN for AsterixDB. </p>
293
294<div class="source">
295
296<div class="source">
297<pre>
298<img src="images/yarn_clust.png" alt="Illustration of a simple YARN cluster with AsterixDB processes." />
299<i>Fig. 1</i>: Illustration of a simple YARN cluster with AsterixDB processes and their locations
300</pre></div>
301</div>
302<p>This AsterixDB cluster description file corresponds to the above deployed scenario.</p>
303
304<div class="source">
305<div class="source">
306<pre> &lt;cluster xmlns=&quot;yarn_cluster&quot;&gt;
307 &lt;name&gt;my_awesome_instance&lt;/name&gt;
308 &lt;txn_log_dir&gt;/home/yarn/&lt;/txn_log_dir&gt;
309 &lt;iodevices&gt;/home/yarn/&lt;/iodevices&gt;
310 &lt;store&gt;asterix-data&lt;/store&gt;
311 &lt;master_node&gt;
312 &lt;id&gt;cc&lt;/id&gt;
313 &lt;client_ip&gt;10.10.0.2&lt;/client_ip&gt;
314 &lt;cluster_ip&gt;10.10.0.2&lt;/cluster_ip&gt;
315 &lt;client_port&gt;1098&lt;/client_port&gt;
316 &lt;cluster_port&gt;1099&lt;/cluster_port&gt;
317 &lt;http_port&gt;8888&lt;/http_port&gt;
318 &lt;/master_node&gt;
319 &lt;node&gt;
320 &lt;id&gt;nc1&lt;/id&gt;
321 &lt;cluster_ip&gt;10.10.0.3&lt;/cluster_ip&gt;
322 &lt;/node&gt;
323 &lt;node&gt;
324 &lt;id&gt;nc2&lt;/id&gt;
325 &lt;cluster_ip&gt;10.10.0.4&lt;/cluster_ip&gt;
326 &lt;/node&gt;
327 &lt;metadata_node&gt;nc1&lt;/metadata_node&gt;
328 &lt;/cluster&gt;
329</pre></div></div>
330<p>In this example we have 3 NCs and one CC. Each node is defined by a unique name (not necessarily hostname) and an IP on which AsterixDB nodes will listen and communicate with eachother. This is the &#x2018;cluster_ip&#x2019; parameter. The &#x2018;client_ip&#x2019; parameter is the interface on which client-facing services are presented, for example the web interface. For the next step this file will be saved as &#x2018;my_awesome_cluster_desc.xml&#x2019; in the configs directory.</p></div>
331<div class="section">
332<h2><a name="Installing_and_starting_the_instance"></a>Installing and starting the instance</h2>
333<p>With this configuration in hand, the YARN client can be used to deploy AsterixDB onto the cluster:</p>
334
335<div class="source">
336<div class="source">
337<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance -c configs/my_awesome_cluster_desc.xml install
338 Waiting for new AsterixDB Instance to start .
339 Asterix successfully deployed and is now running.
340</pre></div></div>
341<p>The instance will be visible in the YARN RM similar to the below image
342<div class="source"> </p>
343<div class="source">
344<pre> <img src="images/running_inst.png" alt="Illustration of a simple YARN cluster with AsterixDB processes." /> <i>Fig. 2</i>: Hadoop YARN Resource Manager dashboard with running AsterixDB instance </pre></div> </div>
345<p>Once the client returns success, the instance is now ready to be used. We can now use the asterix instance at the CC&#x2019;s IP (10.10.0.2), on the default port (19001).</p>
346
347<div class="source">
348
349<div class="source">
350<pre>
351<img src="images/asterix_webui.png" alt="Illustration of a simple YARN cluster with AsterixDB processes." />
352<i>Fig. 3</i>: AsterixDB Web User Interface
353</pre></div>
354</div>
355<p>From here, to try things out we could run the ADM &amp; AQL 101 tutorial or any other sample workload.</p></div>
356<div class="section">
357<h2><a name="Stopping_the_instance"></a>Stopping the instance</h2>
358<p>To stop the instance that was just deployed, the <tt>stop</tt> command is used:</p>
359
360<div class="source">
361<div class="source">
362<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance stop
363 Stopping instance my_awesome_instance
364</pre></div></div>
365<p>This attempts a graceful shutdown of the instance. If for some reason this does not succeed, the <tt>kill</tt> action can be used to force shutdown in a similar fashion:</p>
366
367<div class="source">
368<div class="source">
369<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance kill
370 Are you sure you want to kill this instance? In-progress tasks will be aborted
371 Are you sure you want to do this? (yes/no): yes
372</pre></div></div></div>
373<div class="section">
374<h2><a name="Managing_stopped_instances"></a>Managing stopped instances</h2>
375<p>After stopping the instance no containers on any YARN NodeManagers are allocated. However, the state of the instance is still persisted on the local disks (and to a lesser extent, HDFS) of each machine where a Node Controller was deployed, in the iodevices and transaction log folders. Every instance, running or not can be viewed via the <tt>describe</tt> action:</p>
376
377<div class="source">
378<div class="source">
379<pre> [vagrant@cc asterix-yarn]$ bin/asterix describe
380 Existing AsterixDB instances:
381 Instance my_awesome_instance is stopped
382</pre></div></div></div>
383<div class="section">
384<h2><a name="Starting_inactive_instances"></a>Starting inactive instances</h2>
385<p>To start the instance back up once more, the <tt>start</tt> action is used:</p>
386
387<div class="source">
388<div class="source">
389<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance start
390 Waiting for AsterixDB instance to resume .
391 Asterix successfully deployed and is now running.
392</pre></div></div></div>
393<div class="section">
394<h2><a name="Shutting_down_vagrant"></a>Shutting down vagrant</h2>
395<p>To stop the virtual machines, issue the vagrant halt command from the host machine in the folder containing the Vagrantfile:</p>
396
397<div class="source">
398<div class="source">
399<pre> &#x21aa; vagrant halt
400</pre></div></div>
401<h1><a name="detail" id="detail">Listing of Commands and Options</a></h1></div>
402<div class="section">
403<h2><a name="Overview"></a>Overview</h2>
404<p>All commands take the format</p>
405
406<div class="source">
407<div class="source">
408<pre> asterix [action-specific option] [action]
409</pre></div></div>
410<div class="section">
411<h3><a name="Technical_details"></a>Technical details</h3>
412<p>AsterixDB&#x2019;s YARN client is based on static allocation of containers within Node Managers based on IP. The AM and CC processes are currently not integrated in any fashion.</p>
413<p>The <tt>asterix</tt> command itself is simply a wrapper/launcher around the AsterixClient java class, that provides time-saving default parameters. It is possible to run the client directly with <tt>java -jar</tt> given the correct options as well.</p></div></div>
414<div class="section">
415<h2><a name="Actions"></a>Actions</h2>
416<p>Below is a description of the various actions available via the AsterixDB YARN client</p>
417
418<table border="0" class="table table-striped">
419 <thead>
420
421<tr class="a">
422
423<th>Action </th>
424
425<th>Description </th>
426 </tr>
427 </thead>
428 <tbody>
429
430<tr class="b">
431
432<td><tt>start</tt> </td>
433
434<td>Starts an existing instance specified by the -name flag </td>
435 </tr>
436
437<tr class="a">
438
439<td><tt>install</tt> </td>
440
441<td>Deploys and starts an AsterixDB instance described by the config specified in the -c parameter, and named by the -n parameter </td>
442 </tr>
443
444<tr class="b">
445
446<td><tt>stop</tt> </td>
447
448<td>Attempts graceful shutdown of an AsterixDB instance specified in the -name parameter </td>
449 </tr>
450
451<tr class="a">
452
453<td><tt>kill</tt> </td>
454
455<td>Forcefully stops an instance by asking YARN to terminate all of its containers. </td>
456 </tr>
457
458<tr class="b">
459
460<td><tt>destroy</tt> </td>
461
462<td>Remove the instance specified by -name and all of its stored resources from the cluster </td>
463 </tr>
464
465<tr class="a">
466
467<td><tt>describe</tt> </td>
468
469<td>Show all instances, running or not, visible to the AsterixDB YARN client </td>
470 </tr>
471
472<tr class="b">
473
474<td><tt>backup</tt> </td>
475
476<td>Copies the artifacts from a stopped instance to another directory on HDFS so that the instance can be reverted to that state </td>
477 </tr>
478
479<tr class="a">
480
481<td><tt>restore</tt> </td>
482
483<td>Restores an instance to the state saved in a snapshot </td>
484 </tr>
485
486<tr class="b">
487
488<td><tt>lsbackup</tt> </td>
489
490<td>Lists the stored snapshots from an instance </td>
491 </tr>
492
493<tr class="a">
494
495<td><tt>rmbackup</tt> </td>
496
497<td>Removes a snapshot from HDFS </td>
498 </tr>
499
500<tr class="b">
501
502<td><tt>libinstall</tt></td>
503
504<td>Installs an external library or UDF for use in queries </td>
505 </tr>
506 </tbody>
507</table></div>
508<div class="section">
509<h2><a name="Options"></a>Options</h2>
510<p>Below are all availabe options, and which actions they can be applied to</p>
511
512<table border="0" class="table table-striped">
513 <thead>
514
515<tr class="a">
516
517<th>Option </th>
518
519<th>Long Form </th>
520
521<th>Short Form </th>
522
523<th>Usage </th>
524
525<th>Applicability </th>
526 </tr>
527 </thead>
528 <tbody>
529
530<tr class="b">
531
532<td>Configuration Path </td>
533
534<td><tt>-asterixConf</tt> </td>
535
536<td><tt>-c</tt> </td>
537
538<td><tt>-c [/path/to/file]</tt>. Path to an AsterixDB Cluster Description File </td>
539
540<td>Only required with <tt>create</tt> . A configuration in DFS defines the existance of an instance. </td>
541 </tr>
542
543<tr class="a">
544
545<td>Instance Name </td>
546
547<td><tt>-name</tt> </td>
548
549<td><tt>-n</tt> </td>
550
551<td><tt>-n [instance name]</tt> Name/Identifier for instance. </td>
552
553<td>Required for all actions except <tt>describe</tt> and <tt>lsbackup</tt> </td>
554 </tr>
555
556<tr class="b">
557
558<td>Asterix Binary Path </td>
559
560<td><tt>-asterixTar</tt> </td>
561
562<td><tt>-tar</tt> </td>
563
564<td><tt>-tar [/path/to/binary]</tt> Path to asterix-server binary. </td>
565
566<td>This is the AsterixDB server binary that is distributed and run on the DFS. Usually set by default via the launcher script and cached for each instance. Can be manually set, only used in <tt>create</tt> and <tt>install</tt> with <tt>-r</tt> </td>
567 </tr>
568
569<tr class="a">
570
571<td>Force </td>
572
573<td><tt>-force</tt> </td>
574
575<td><tt>-f</tt> </td>
576
577<td><tt>-f</tt>. Use at your own risk. Disables any sanity-checking during an action. </td>
578
579<td>Can be applied to any action, but is mostly useful in cases where an instance cannot be removed properly via <tt>destroy</tt> and cleanup of DFS files is desired. </td>
580 </tr>
581
582<tr class="b">
583
584<td>Refresh </td>
585
586<td><tt>-refresh</tt> </td>
587
588<td><tt>-r</tt> </td>
589
590<td><tt>-r</tt>. Replaces cached binary with one mentioned in <tt>-tar</tt>. </td>
591
592<td>This only has an effect with the <tt>start</tt> action. It can be used to replace/upgrade the binary cached for an instance on the DFS. </td>
593 </tr>
594
595<tr class="a">
596
597<td>Base Parameters </td>
598
599<td><tt>-baseConf</tt> </td>
600
601<td><tt>-bc</tt> </td>
602
603<td><tt>-bc [path/to/params]</tt>. Specifies parameter file to use during instance creation/alteration. </td>
604
605<td>This file specifies various internal properties of the AsterixDB system, such as Buffer Cache size and Page size, among many others. It can be helpful to tweak parameters in this file, however caution should be exercised in keeping them at sane values. Only used during <tt>alter</tt> and <tt>create</tt>. </td>
606 </tr>
607
608<tr class="b">
609
610<td>External library path </td>
611
612<td><tt>-externalLibs</tt> </td>
613
614<td><tt>-l</tt> </td>
615
616<td><tt>-l [path/to/library]</tt>. Specifies an external library to upload to an existing instance. </td>
617
618<td>Only used in <tt>libinstall</tt>. Specifies the file containing the external function to install </td>
619 </tr>
620
621<tr class="a">
622
623<td>External library dataverse. </td>
624
625<td><tt>-libDataverse</tt> </td>
626
627<td><tt>-ld</tt> </td>
628
629<td><tt>-ld [existing dataverse name]</tt> </td>
630
631<td>Only used in <tt>libinstall</tt>. Specifies the dataverse to install the library in an <tt>-l</tt> option to. </td>
632 </tr>
633
634<tr class="b">
635
636<td>Snapshot ID </td>
637
638<td><tt>-snapshot</tt> </td>
639
640<td>[none] </td>
641
642<td><tt>-snapshot [backup timestamp/ID]</tt> </td>
643
644<td>Used with <tt>rmbackup</tt> and <tt>restore</tt> to specify which backup to perform the respective operation on. </td>
645 </tr>
646 </tbody>
647</table>
648<h1><a name="faq" id="faq">Frequently Asked Questions and Common Issues</a></h1>
649<div class="section">
650<h3><a name="Q:_Where_are_the_AsterixDB_logs_located"></a>Q: Where are the AsterixDB logs located?</h3>
651<p>A: YARN manages the logs for each container. They are visible in the YARN Resource Manager&#x2019;s web interface or through the hadoop command line utilities ( see <a class="externalLink" href="http://hortonworks.com/blog/simplifying-user-logs-management-and-access-in-yarn/">http://hortonworks.com/blog/simplifying-user-logs-management-and-access-in-yarn/</a> for more details). </p></div>
652<div class="section">
653<h3><a name="Q:_Why_does_AsterixDB_fail_to_start_and_the_logs_contain_errors_like_Container_is_running_beyond_virtual_memory_limits._"></a>Q: Why does AsterixDB fail to start, and the logs contain errors like &#x2018;Container is running beyond virtual memory limits.&#x2019; ?</h3>
654<p>A: This is a quirk of YARN&#x2019;s memory management that can be observed on certain operating systems (mainly CentOS). It is benign unless it causes problems of this type. A work around is to set <tt>yarn.nodemanager.vmem-check-enabled</tt> to <tt>false</tt> in the yarn-site.xml configuration for Hadoop YARN. This makes the NodeManagers avoid checking the virtual memory entirely and instead rely on resident set size to check memory usage among containers.</p></div>
655<div class="section">
656<h3><a name="Q:_How_do_I_upgrade_my_existing_instance"></a>Q: How do I upgrade my existing instance?</h3>
657<p>A: This is a complex question. Generally, one can use the <tt>refresh</tt> option to upgrade the version of an extant AsterixDB instance. However one must be cautious- we do not guarantee ABI compatability between releases. Therefore extreme caution should be exercised when attempting to upgrade this way!</p></div>
658<div class="section">
659<h3><a name="Q:_Does_AsterixDB_work_on_YARN_for_Windows"></a>Q: Does AsterixDB work on YARN for Windows?</h3>
660<p>A: In general, yes! It has been done without much real issue. However it is a infrequent use case, so expect the deployment to have some hiccups. We&#x2019;re always listening on the <a class="externalLink" href="mailto:users@asterixdb.incubator.apache.org">users@asterixdb.incubator.apache.org</a> mailing list for any issues.</p></div></div>
661 </div>
662 </div>
663 </div>
664
665 <hr/>
666
667 <footer>
668 <div class="container-fluid">
669 <div class="row span12">Copyright &copy; 2015
670 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
671 All Rights Reserved.
672
673 </div>
674
675 <?xml version="1.0" encoding="UTF-8"?>
676<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
677 feather logo, and the Apache AsterixDB project logo are either
678 registered trademarks or trademarks of The Apache Software
679 Foundation in the United States and other countries.
680 All other marks mentioned may be trademarks or registered
681 trademarks of their respective owners.</div>
682
683
684 </div>
685 </footer>
686 </body>
687</html>