Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / refs/heads/asf-site / . / content / docs / 0.8.8-incubating / yarn.html
blob: 6ae44c753a2687ed7fb550a8513cd764915ca853 [file] [log] [blame]
Yingyi Bu08953b22016-03-25 15:23:26 -0700[diff] [blame]1<!DOCTYPE html>
2<!--
3 | Generated by Apache Maven Doxia at 2016-03-25
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="20160325" />
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
Yingyi Bu08953b22016-03-25 15:23:26 -0700[diff] [blame]22
Yingyi Bu08953b22016-03-25 15:23:26 -0700[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: 2016-03-25</li>
46
47
48
49 <li id="projectVersion" class="pull-right">Version: 0.8.8-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
Yingyi Bu08953b22016-03-25 15:23:26 -0700[diff] [blame]97 <a href="aql/datamodel.html" title="Asterix Data Model (ADM)">
98 <i class="none"></i>
99 Asterix Data Model (ADM)</a>
100 </li>
101
102 <li>
103
104 <a href="aql/manual.html" title="Asterix Query Language (AQL)">
105 <i class="none"></i>
106 Asterix Query Language (AQL)</a>
107 </li>
108
109 <li>
110
111 <a href="aql/functions.html" title="AQL Functions">
112 <i class="none"></i>
113 AQL Functions</a>
114 </li>
115
116 <li>
117
118 <a href="aql/allens.html" title="AQL Allen's Relations Functions">
119 <i class="none"></i>
120 AQL Allen's Relations Functions</a>
121 </li>
122
123 <li>
124
125 <a href="aql/similarity.html" title="AQL Support of Similarity Queries">
126 <i class="none"></i>
127 AQL Support of Similarity Queries</a>
128 </li>
129
130 <li>
131
132 <a href="aql/externaldata.html" title="Accessing External Data">
133 <i class="none"></i>
134 Accessing External Data</a>
135 </li>
136
137 <li>
138
139 <a href="feeds/tutorial.html" title="Support for Data Ingestion in AsterixDB">
140 <i class="none"></i>
141 Support for Data Ingestion in AsterixDB</a>
142 </li>
143
144 <li>
145
146 <a href="udf.html" title="Support for User Defined Functions in AsterixDB">
147 <i class="none"></i>
148 Support for User Defined Functions in AsterixDB</a>
149 </li>
150
151 <li>
152
153 <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
154 <i class="none"></i>
155 Filter-Based LSM Index Acceleration</a>
156 </li>
157
158 <li>
159
160 <a href="api.html" title="HTTP API to AsterixDB">
161 <i class="none"></i>
162 HTTP API to AsterixDB</a>
163 </li>
164 </ul>
165
166
167
168 <hr class="divider" />
169
170 <div id="poweredBy">
171 <div class="clear"></div>
172 <div class="clear"></div>
173 <div class="clear"></div>
174 <a href="https://code.google.com/p/hyracks/" title="Hyracks" class="builtBy">
175 <img class="builtBy" alt="Hyracks" src="images/hyrax_ts.png" />
176 </a>
177 </div>
178 </div>
179 </div>
180
181
182 <div id="bodyColumn" class="span9" >
183
184 <!-- ! Licensed to the Apache Software Foundation (ASF) under one
185 ! or more contributor license agreements. See the NOTICE file
186 ! distributed with this work for additional information
187 ! regarding copyright ownership. The ASF licenses this file
188 ! to you under the Apache License, Version 2.0 (the
189 ! "License"); you may not use this file except in compliance
190 ! with the License. You may obtain a copy of the License at
191 !
192 ! http://www.apache.org/licenses/LICENSE-2.0
193 !
194 ! Unless required by applicable law or agreed to in writing,
195 ! software distributed under the License is distributed on an
196 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
197 ! KIND, either express or implied. See the License for the
198 ! specific language governing permissions and limitations
199 ! under the License.
200 ! --><h1>Introduction</h1>
201<div class="section">
202<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
203
204<ul>
205
206<li><a href="#arch">Architecture Overview</a></li>
207
208<li><a href="#prereq">Prerequisites</a></li>
209
210<li><a href="#tut">Tutorial Installation</a></li>
211
212<li><a href="#faq">FAQ and Common Issues</a></li>
213
214<li><a href="#detail">Reference guide to AsterixDB&#x2019;s YARN Client</a></li>
215</ul>
216<p>This is a guide describing how to deploy AsterixDB onto a YARN-based environment.</p></div>
217<div class="section">
218<h2><a name="AsterixDB_and_the_YARN_environment"></a><a name="arch" id="arch">AsterixDB and the YARN environment</a></h2>
219<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>
220
221<ul>
222
223<li>HDFS file storage (only suitable for long-lived artifacts, can be slower than local disk)</li>
224
225<li>Ephemeral container storage that is cleaned by YARN after a container exits (unsuitable except for transient artifacts)</li>
226
227<li>Node-local destinations not managed by YARN, but which are accesable by the container and live beyond its termination.</li>
228</ul>
229<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>
230<div class="section">
231<h2><a name="Prerequisites"></a><a name="prereq" id="prereq">Prerequisites</a></h2>
232<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>
233<div class="section">
234<h3><a name="Vagrant_and_Puppet_Virtualized_cluster_for_Tutorial"></a>Vagrant and Puppet Virtualized cluster for Tutorial</h3>
235<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>
236
237<div class="source">
238<div class="source">
239<pre> &#x21aa; git clone https://github.com/parshimers/yarn-sample-cluster.git
240 Cloning into 'yarn-sample-cluster'...
241 remote: Counting objects: 490, done.
242 remote: Compressing objects: 100% (315/315), done.
243 remote: Total 490 (delta 152), reused 490 (delta 152)
244 Receiving objects: 100% (490/490), 521.34 KiB | 201.00 KiB/s, done.
245 Resolving deltas: 100% (152/152), done.
246 Checking connectivity... done.
247</pre></div></div>
248<p>If the &#x2018;hostmanager&#x2019; plugin for Vagrant isn&#x2019;t already installed, install it like so:</p>
249
250<div class="source">
251<div class="source">
252<pre> &#x21aa; vagrant plugin install vagrant-hostmanager
253 Installing the 'vagrant-hostmanager' plugin. This can take a few minutes...
254 Installed the plugin 'vagrant-hostmanager (1.5.0)'!
255</pre></div></div>
256<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>
257
258<div class="source">
259<div class="source">
260<pre> &#x21aa; vagrant up
261 Bringing machine 'nc2' up with 'virtualbox' provider...
262 Bringing machine 'nc1' up with 'virtualbox' provider...
263 Bringing machine 'cc' up with 'virtualbox' provider...
264 ...
265</pre></div></div>
Ian Maxonb0e7b1f2017-01-17 15:17:34 -0800[diff] [blame]266<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="https://asterixdb.apache.org/download.html">downloads page</a></p>
Yingyi Bu08953b22016-03-25 15:23:26 -0700[diff] [blame]267
268<div class="source">
269<div class="source">
270<pre>&#x21aa; unzip -d asterix-yarn/ asterix-yarn-binary-assembly.zip
271...
272</pre></div></div>
273<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>
274
275<div class="source">
276<div class="source">
277<pre> &#x21aa; vagrant ssh cc
278 [vagrant@cc ~]$
279 [vagrant@cc ~]$ cd /vagrant/asterix-yarn
280 [vagrant@cc asterix-yarn]$
281</pre></div></div>
282<h1><a name="tut" id="tut">Tutorial installation</a></h1></div></div>
283<div class="section">
284<h2><a name="Configuration"></a>Configuration</h2>
285<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>
286
287<div class="source">
288
289<div class="source">
290<pre>
291<img src="images/yarn_clust.png" alt="Illustration of a simple YARN cluster with AsterixDB processes." />
292<i>Fig. 1</i>: Illustration of a simple YARN cluster with AsterixDB processes and their locations
293</pre></div>
294</div>
295<p>This AsterixDB cluster description file corresponds to the above deployed scenario.</p>
296
297<div class="source">
298<div class="source">
299<pre> &lt;cluster xmlns=&quot;yarn_cluster&quot;&gt;
300 &lt;name&gt;my_awesome_instance&lt;/name&gt;
301 &lt;txn_log_dir&gt;/home/yarn/&lt;/txn_log_dir&gt;
302 &lt;iodevices&gt;/home/yarn/&lt;/iodevices&gt;
303 &lt;store&gt;asterix-data&lt;/store&gt;
304 &lt;master_node&gt;
305 &lt;id&gt;cc&lt;/id&gt;
306 &lt;client_ip&gt;10.10.0.2&lt;/client_ip&gt;
307 &lt;cluster_ip&gt;10.10.0.2&lt;/cluster_ip&gt;
308 &lt;client_port&gt;1098&lt;/client_port&gt;
309 &lt;cluster_port&gt;1099&lt;/cluster_port&gt;
310 &lt;http_port&gt;8888&lt;/http_port&gt;
311 &lt;/master_node&gt;
312 &lt;node&gt;
313 &lt;id&gt;nc1&lt;/id&gt;
314 &lt;cluster_ip&gt;10.10.0.3&lt;/cluster_ip&gt;
315 &lt;/node&gt;
316 &lt;node&gt;
317 &lt;id&gt;nc2&lt;/id&gt;
318 &lt;cluster_ip&gt;10.10.0.4&lt;/cluster_ip&gt;
319 &lt;/node&gt;
320 &lt;metadata_node&gt;nc1&lt;/metadata_node&gt;
321 &lt;/cluster&gt;
322</pre></div></div>
323<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>
324<div class="section">
325<h2><a name="Installing_and_starting_the_instance"></a>Installing and starting the instance</h2>
326<p>With this configuration in hand, the YARN client can be used to deploy AsterixDB onto the cluster:</p>
327
328<div class="source">
329<div class="source">
330<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance -c configs/my_awesome_cluster_desc.xml install
331 Waiting for new AsterixDB Instance to start .
332 Asterix successfully deployed and is now running.
333</pre></div></div>
334<p>The instance will be visible in the YARN RM similar to the below image
335<div class="source"> </p>
336<div class="source">
337<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>
338<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>
339
340<div class="source">
341
342<div class="source">
343<pre>
344<img src="images/asterix_webui.png" alt="Illustration of a simple YARN cluster with AsterixDB processes." />
345<i>Fig. 3</i>: AsterixDB Web User Interface
346</pre></div>
347</div>
348<p>From here, to try things out we could run the ADM &amp; AQL 101 tutorial or any other sample workload.</p></div>
349<div class="section">
350<h2><a name="Stopping_the_instance"></a>Stopping the instance</h2>
351<p>To stop the instance that was just deployed, the <tt>stop</tt> command is used:</p>
352
353<div class="source">
354<div class="source">
355<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance stop
356 Stopping instance my_awesome_instance
357</pre></div></div>
358<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>
359
360<div class="source">
361<div class="source">
362<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance kill
363 Are you sure you want to kill this instance? In-progress tasks will be aborted
364 Are you sure you want to do this? (yes/no): yes
365</pre></div></div></div>
366<div class="section">
367<h2><a name="Managing_stopped_instances"></a>Managing stopped instances</h2>
368<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>
369
370<div class="source">
371<div class="source">
372<pre> [vagrant@cc asterix-yarn]$ bin/asterix describe
373 Existing AsterixDB instances:
374 Instance my_awesome_instance is stopped
375</pre></div></div></div>
376<div class="section">
377<h2><a name="Starting_inactive_instances"></a>Starting inactive instances</h2>
378<p>To start the instance back up once more, the <tt>start</tt> action is used:</p>
379
380<div class="source">
381<div class="source">
382<pre> [vagrant@cc asterix-yarn]$ bin/asterix -n my_awesome_instance start
383 Waiting for AsterixDB instance to resume .
384 Asterix successfully deployed and is now running.
385</pre></div></div></div>
386<div class="section">
387<h2><a name="Shutting_down_vagrant"></a>Shutting down vagrant</h2>
388<p>To stop the virtual machines, issue the vagrant halt command from the host machine in the folder containing the Vagrantfile:</p>
389
390<div class="source">
391<div class="source">
392<pre> &#x21aa; vagrant halt
393</pre></div></div>
394<h1><a name="detail" id="detail">Listing of Commands and Options</a></h1></div>
395<div class="section">
396<h2><a name="Overview"></a>Overview</h2>
397<p>All commands take the format</p>
398
399<div class="source">
400<div class="source">
401<pre> asterix [action-specific option] [action]
402</pre></div></div>
403<div class="section">
404<h3><a name="Technical_details"></a>Technical details</h3>
405<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>
406<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>
407<div class="section">
408<h2><a name="Actions"></a>Actions</h2>
409<p>Below is a description of the various actions available via the AsterixDB YARN client</p>
410
411<table border="0" class="table table-striped">
412 <thead>
413
414<tr class="a">
415
416<th>Action </th>
417
418<th>Description </th>
419 </tr>
420 </thead>
421 <tbody>
422
423<tr class="b">
424
425<td><tt>start</tt> </td>
426
427<td>Starts an existing instance specified by the -name flag </td>
428 </tr>
429
430<tr class="a">
431
432<td><tt>install</tt> </td>
433
434<td>Deploys and starts an AsterixDB instance described by the config specified in the -c parameter, and named by the -n parameter </td>
435 </tr>
436
437<tr class="b">
438
439<td><tt>stop</tt> </td>
440
441<td>Attempts graceful shutdown of an AsterixDB instance specified in the -name parameter </td>
442 </tr>
443
444<tr class="a">
445
446<td><tt>kill</tt> </td>
447
448<td>Forcefully stops an instance by asking YARN to terminate all of its containers. </td>
449 </tr>
450
451<tr class="b">
452
453<td><tt>destroy</tt> </td>
454
455<td>Remove the instance specified by -name and all of its stored resources from the cluster </td>
456 </tr>
457
458<tr class="a">
459
460<td><tt>describe</tt> </td>
461
462<td>Show all instances, running or not, visible to the AsterixDB YARN client </td>
463 </tr>
464
465<tr class="b">
466
467<td><tt>backup</tt> </td>
468
469<td>Copies the artifacts from a stopped instance to another directory on HDFS so that the instance can be reverted to that state </td>
470 </tr>
471
472<tr class="a">
473
474<td><tt>restore</tt> </td>
475
476<td>Restores an instance to the state saved in a snapshot </td>
477 </tr>
478
479<tr class="b">
480
481<td><tt>lsbackup</tt> </td>
482
483<td>Lists the stored snapshots from an instance </td>
484 </tr>
485
486<tr class="a">
487
488<td><tt>rmbackup</tt> </td>
489
490<td>Removes a snapshot from HDFS </td>
491 </tr>
492
493<tr class="b">
494
495<td><tt>libinstall</tt></td>
496
497<td>Installs an external library or UDF for use in queries </td>
498 </tr>
499 </tbody>
500</table></div>
501<div class="section">
502<h2><a name="Options"></a>Options</h2>
503<p>Below are all availabe options, and which actions they can be applied to</p>
504
505<table border="0" class="table table-striped">
506 <thead>
507
508<tr class="a">
509
510<th>Option </th>
511
512<th>Long Form </th>
513
514<th>Short Form </th>
515
516<th>Usage </th>
517
518<th>Applicability </th>
519 </tr>
520 </thead>
521 <tbody>
522
523<tr class="b">
524
525<td>Configuration Path </td>
526
527<td><tt>-asterixConf</tt> </td>
528
529<td><tt>-c</tt> </td>
530
531<td><tt>-c [/path/to/file]</tt>. Path to an AsterixDB Cluster Description File </td>
532
533<td>Only required with <tt>create</tt> . A configuration in DFS defines the existance of an instance. </td>
534 </tr>
535
536<tr class="a">
537
538<td>Instance Name </td>
539
540<td><tt>-name</tt> </td>
541
542<td><tt>-n</tt> </td>
543
544<td><tt>-n [instance name]</tt> Name/Identifier for instance. </td>
545
546<td>Required for all actions except <tt>describe</tt> and <tt>lsbackup</tt> </td>
547 </tr>
548
549<tr class="b">
550
551<td>Asterix Binary Path </td>
552
553<td><tt>-asterixTar</tt> </td>
554
555<td><tt>-tar</tt> </td>
556
557<td><tt>-tar [/path/to/binary]</tt> Path to asterix-server binary. </td>
558
559<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>
560 </tr>
561
562<tr class="a">
563
564<td>Force </td>
565
566<td><tt>-force</tt> </td>
567
568<td><tt>-f</tt> </td>
569
570<td><tt>-f</tt>. Use at your own risk. Disables any sanity-checking during an action. </td>
571
572<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>
573 </tr>
574
575<tr class="b">
576
577<td>Refresh </td>
578
579<td><tt>-refresh</tt> </td>
580
581<td><tt>-r</tt> </td>
582
583<td><tt>-r</tt>. Replaces cached binary with one mentioned in <tt>-tar</tt>. </td>
584
585<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>
586 </tr>
587
588<tr class="a">
589
590<td>Base Parameters </td>
591
592<td><tt>-baseConf</tt> </td>
593
594<td><tt>-bc</tt> </td>
595
596<td><tt>-bc [path/to/params]</tt>. Specifies parameter file to use during instance creation/alteration. </td>
597
598<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>
599 </tr>
600
601<tr class="b">
602
603<td>External library path </td>
604
605<td><tt>-externalLibs</tt> </td>
606
607<td><tt>-l</tt> </td>
608
609<td><tt>-l [path/to/library]</tt>. Specifies an external library to upload to an existing instance. </td>
610
611<td>Only used in <tt>libinstall</tt>. Specifies the file containing the external function to install </td>
612 </tr>
613
614<tr class="a">
615
616<td>External library dataverse. </td>
617
618<td><tt>-libDataverse</tt> </td>
619
620<td><tt>-ld</tt> </td>
621
622<td><tt>-ld [existing dataverse name]</tt> </td>
623
624<td>Only used in <tt>libinstall</tt>. Specifies the dataverse to install the library in an <tt>-l</tt> option to. </td>
625 </tr>
626
627<tr class="b">
628
629<td>Snapshot ID </td>
630
631<td><tt>-snapshot</tt> </td>
632
633<td>[none] </td>
634
635<td><tt>-snapshot [backup timestamp/ID]</tt> </td>
636
637<td>Used with <tt>rmbackup</tt> and <tt>restore</tt> to specify which backup to perform the respective operation on. </td>
638 </tr>
639 </tbody>
640</table>
641<h1><a name="faq" id="faq">Frequently Asked Questions and Common Issues</a></h1>
642<div class="section">
643<h3><a name="Q:_Where_are_the_AsterixDB_logs_located"></a>Q: Where are the AsterixDB logs located?</h3>
644<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>
645<div class="section">
646<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>
647<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>
648<div class="section">
649<h3><a name="Q:_How_do_I_upgrade_my_existing_instance"></a>Q: How do I upgrade my existing instance?</h3>
650<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>
651<div class="section">
652<h3><a name="Q:_Does_AsterixDB_work_on_YARN_for_Windows"></a>Q: Does AsterixDB work on YARN for Windows?</h3>
653<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>
654 </div>
655 </div>
656 </div>
657
658 <hr/>
659
660 <footer>
661 <div class="container-fluid">
662 <div class="row span12">Copyright &copy; 2016
663 <a href="http://www.apache.org/">The Apache Software Foundation</a>.
664 All Rights Reserved.
665
666 </div>
667
668 <?xml version="1.0" encoding="UTF-8"?>
669<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
670 feather logo, and the Apache AsterixDB project logo are either
671 registered trademarks or trademarks of The Apache Software
672 Foundation in the United States and other countries.
673 All other marks mentioned may be trademarks or registered
674 trademarks of their respective owners.</div>
675
676
677 </div>
678 </footer>
679 </body>
680</html>