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