Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / 1befeb1976de14798e69b4e829c4e5b873f869fc / . / docs / 0.9.6 / ncservice.html
blob: 9f6a73877a70bbac318fe2c470be7b3a8c277311 [file] [log] [blame]
Ian Maxon49d15b22020-12-06 16:23:00 -0800[diff] [blame]1<!DOCTYPE html>
2<!--
3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/ncservice.md at 2020-12-06
4 | Rendered using Apache Maven Fluido Skin 1.7
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="20201206" />
11 <meta http-equiv="Content-Language" content="en" />
12 <title>AsterixDB &#x2013; Installation using NCService</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16 <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script>
17
18 </head>
19 <body class="topBarDisabled">
20 <div class="container-fluid">
21 <div id="banner">
22 <div class="pull-left"><a href="./" id="bannerLeft"><img src="images/asterixlogo.png" alt="AsterixDB"/></a></div>
23 <div class="pull-right"></div>
24 <div class="clear"><hr/></div>
25 </div>
26
27 <div id="breadcrumbs">
28 <ul class="breadcrumb">
29 <li id="publishDate">Last Published: 2020-12-06</li>
30 <li id="projectVersion" class="pull-right">Version: 0.9.6-SNAPSHOT</li>
31 <li class="pull-right"><a href="index.html" title="Documentation Home">Documentation Home</a></li>
32 </ul>
33 </div>
34 <div class="row-fluid">
35 <div id="leftColumn" class="span2">
36 <div class="well sidebar-nav">
37 <ul class="nav nav-list">
38 <li class="nav-header">Get Started - Installation</li>
39 <li class="active"><a href="#"><span class="none"></span>Option 1: using NCService</a></li>
40 <li><a href="ansible.html" title="Option 2: using Ansible"><span class="none"></span>Option 2: using Ansible</a></li>
41 <li><a href="aws.html" title="Option 3: using Amazon Web Services"><span class="none"></span>Option 3: using Amazon Web Services</a></li>
42 <li class="nav-header">AsterixDB Primer</li>
43 <li><a href="sqlpp/primer-sqlpp.html" title="Using SQL++"><span class="none"></span>Using SQL++</a></li>
44 <li class="nav-header">Data Model</li>
45 <li><a href="datamodel.html" title="The Asterix Data Model"><span class="none"></span>The Asterix Data Model</a></li>
46 <li class="nav-header">Queries</li>
47 <li><a href="sqlpp/manual.html" title="The SQL++ Query Language"><span class="none"></span>The SQL++ Query Language</a></li>
48 <li><a href="SQLPP.html" title="Raw SQL++ Grammar"><span class="none"></span>Raw SQL++ Grammar</a></li>
49 <li><a href="sqlpp/builtins.html" title="Builtin Functions"><span class="none"></span>Builtin Functions</a></li>
50 <li class="nav-header">API/SDK</li>
51 <li><a href="api.html" title="HTTP API"><span class="none"></span>HTTP API</a></li>
52 <li><a href="csv.html" title="CSV Output"><span class="none"></span>CSV Output</a></li>
53 <li class="nav-header">Advanced Features</li>
54 <li><a href="aql/externaldata.html" title="Accessing External Data"><span class="none"></span>Accessing External Data</a></li>
55 <li><a href="feeds.html" title="Data Ingestion with Feeds"><span class="none"></span>Data Ingestion with Feeds</a></li>
56 <li><a href="udf.html" title="User Defined Functions"><span class="none"></span>User Defined Functions</a></li>
57 <li><a href="sqlpp/filters.html" title="Filter-Based LSM Index Acceleration"><span class="none"></span>Filter-Based LSM Index Acceleration</a></li>
58 <li><a href="sqlpp/fulltext.html" title="Support of Full-text Queries"><span class="none"></span>Support of Full-text Queries</a></li>
59 <li><a href="sqlpp/similarity.html" title="Support of Similarity Queries"><span class="none"></span>Support of Similarity Queries</a></li>
60 <li><a href="interval_join.html" title="Support of Interval Joins"><span class="none"></span>Support of Interval Joins</a></li>
61 <li class="nav-header">Deprecated</li>
62 <li><a href="aql/primer.html" title="AsterixDB Primer: Using AQL"><span class="none"></span>AsterixDB Primer: Using AQL</a></li>
63 <li><a href="aql/manual.html" title="Queries: The Asterix Query Language (AQL)"><span class="none"></span>Queries: The Asterix Query Language (AQL)</a></li>
64 <li><a href="aql/builtins.html" title="Queries: Builtin Functions (AQL)"><span class="none"></span>Queries: Builtin Functions (AQL)</a></li>
65</ul>
66 <hr />
67 <div id="poweredBy">
68 <div class="clear"></div>
69 <div class="clear"></div>
70 <div class="clear"></div>
71 <div class="clear"></div>
72<a href="./" title="AsterixDB" class="builtBy"><img class="builtBy" alt="AsterixDB" src="images/asterixlogo.png" /></a>
73 </div>
74 </div>
75 </div>
76 <div id="bodyColumn" class="span10" >
77<!--
78 ! Licensed to the Apache Software Foundation (ASF) under one
79 ! or more contributor license agreements. See the NOTICE file
80 ! distributed with this work for additional information
81 ! regarding copyright ownership. The ASF licenses this file
82 ! to you under the Apache License, Version 2.0 (the
83 ! "License"); you may not use this file except in compliance
84 ! with the License. You may obtain a copy of the License at
85 !
86 ! http://www.apache.org/licenses/LICENSE-2.0
87 !
88 ! Unless required by applicable law or agreed to in writing,
89 ! software distributed under the License is distributed on an
90 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
91 ! KIND, either express or implied. See the License for the
92 ! specific language governing permissions and limitations
93 ! under the License.
94 !-->
95<h1>Installation using NCService</h1>
96<div class="section">
97<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
98<ul>
99
100<li><a href="#quickstart">Quick Start</a></li>
101<li><a href="#Small_cluster">Starting a small single-machine cluster using the NCService</a></li>
102<li><a href="#Multi_machine">Deploying AsterixDB via NCService in a multi-machine setup</a></li>
103<li><a href="#Parameters">Available Configuration Parameters</a></li>
104</ul>
105<h1><a name="quickstart" id="quickstart">Quick Start</a></h1>
106<p>The fastest way to get set up with a single-machine sample instance of AsterixDB is to use the included sample helper scripts. To do so, in the extracted <tt>asterix-server</tt> directory, navigate to <tt>opt/local/bin/</tt></p>
107
108<div>
109<div>
110<pre class="source">user@localhost:~/
111$cd asterix-server/
112user@localhost:~/asterix-server
113$cd opt/local/bin
114</pre></div></div>
115
116<p>This folder should contain 4 scripts, two pairs of <tt>.sh</tt> and <tt>.bat</tt> files respectively. <tt>start-sample-cluster.sh</tt> will simply start a basic sample cluster using the configuration files located in <tt>opt/local/conf/</tt>.</p>
117
118<div>
119<div>
120<pre class="source">user@localhost:~/a/o/l/bin
121$./start-sample-cluster.sh
122CLUSTERDIR=/home/user/asterix-server/opt/local
123INSTALLDIR=/home/user/asterix-server
124LOGSDIR=/home/user/asterix-server/samples/opt/logs
125
126INFO: Starting sample cluster...
127INFO: Waiting up to 30 seconds for cluster 127.0.0.1:19002 to be available.
128INFO: Cluster started and is ACTIVE.
129user@localhost:~/a/o/l/bin
130$
131</pre></div></div>
132
133<p>Now, there should be a running AsterixDB cluster on the machine. To go to the Web Interface, visit <a class="externalLink" href="http://localhost:19001">http://localhost:19001</a></p>
134
135<div class="source">
136
137<div class="source"><pre class="prettyprint linenums">
138<img src="images/asterixdb_interface.png" alt="The AsterixDB Web Interface" />
139<i>Fig. 1</i>: The AsterixDB Web Interface
140</pre></div>
141</div>
142
143<h1><a name="Small_cluster" id="Small_cluster">Starting a small single-machine cluster using NCService</a></h1>
144<p>The above cluster was started using a script, but below is a description in detail of how precisely this was achieved. The config files here are analagous to the ones within <tt>samples/local/conf</tt>.</p>
145<p>When running a cluster using the <tt>NCService</tt> there are 3 different kinds of processes involved:</p>
146<ul>
147
148<li><tt>NCDriver</tt>, also known as the Node Controller or NC for short. This is the process that does the actual work of queries and data management within the AsterixDB cluster</li>
149<li><tt>NCService</tt> configures and starts the <tt>NCDriver</tt> process. It is a simple daemon whose only purpose is to wait for the <tt>CCDriver</tt> process to call upon it to initiate cluster bootup.</li>
150<li><tt>CCDriver</tt>, which is the Cluster Controller process, also known as the CC. This process manages the distribution of tasks to all NCs, as well as providing the parameters of each NC to the NCService upon cluster startup. It also hosts the Web interface and query compiler and optimizer.</li>
151</ul>
152<p>The cluster startup follows a particular sequence, which is as follows:</p>
153<ol style="list-style-type: decimal">
154
155<li>Each host on which an NC is desired and is mentioned in the configuration, the <tt>NCService</tt> daemon is started first. It will listen and wait for the CC to contact it.</li>
156<li>The one host on which the CC is to be placed is started with an appropriate configuration file.</li>
157<li>The CC contacts all <tt>NCService</tt> daemons and the <tt>NCService</tt> subsequently starts and <tt>NCDriver</tt> process with the configration supplied by the <tt>CC</tt></li>
158<li>Each <tt>NCDriver</tt> then contacts the CC to register itself as started</li>
159</ol>
160<p>This process is briefly illustrated in the diagram below:</p>
161
162<div class="source">
163
164<div class="source"><pre class="prettyprint linenums">
165<img src="images/ncservice.png" alt="The AsterixDB Web Interface" />
166<i>Fig. 2</i>: NCService startup sequence
167</pre></div>
168</div>
169
170<p>To start a small cluster consisting of 2 NodeControllers (<tt>red</tt> and <tt>blue</tt>) and 1 ClusterController (<tt>cc</tt>) on a single machine only 2 configuration files are required. The first one is</p>
171<p><tt>blue.conf</tt>:</p>
172
173<div>
174<div>
175<pre class="source">[ncservice]
176port=9091
177</pre></div></div>
178
179<p>It is a configuration file for the second <tt>NCService</tt>. This contains only the port that the <tt>NCService</tt> of the second NodeControllers listens to as it is non-standard. The first <tt>NCService</tt> does not need a configuration file, as it only uses default parameters. In a distributed environment with 1 NodeController per machine, no <tt>NCService</tt> needs a configuration file.</p>
180<p>The second configuration file is</p>
181<p><tt>cc.conf</tt>:</p>
182
183<div>
184<div>
185<pre class="source">[nc/red]
186txn.log.dir=/tmp/asterix/red/txnlog
187core.dump.dir=/tmp/asterix/red/coredump
188iodevices=/tmp/asterix/red
189
190[nc/blue]
191port=9091
192txn.log.dir=/tmp/asterix/blue/txnlog
193core.dump.dir=/tmp/asterix/blue/coredump
194iodevices=/tmp/asterix/blue
195
196[nc]
197app.class=org.apache.asterix.hyracks.bootstrap.NCApplicationEntryPoint
198address=127.0.0.1
199command=asterixnc
200
201[cc]
202address = 127.0.0.1
203console.listen.port = 12345
204</pre></div></div>
205
206<p>This is the configuration file for the cluster and it contains information that each <tt>NCService</tt> will use when starting the corresponding <tt>NCDriver</tt> as well as information for the <tt>CCDriver</tt>.</p>
207<p>To start the cluster simply use the following steps</p>
208<ol style="list-style-type: decimal">
209
210<li>
211
212<p>Change directory into the asterix-server binary folder</p>
213
214<div>
215<div>
216<pre class="source">user@localhost:~/
217$cd asterix-server/
218user@localhost:~/asterix-server
219$cd samples/local/bin
220</pre></div></div>
221</li>
222<li>
223
224<p>Start the 2 <tt>NCServices</tt> for <tt>red</tt> and <tt>blue</tt>.</p>
225
226<div>
227<div>
228<pre class="source">user@localhost:~/asterix-server
229$bin/asterixncservice -config-file blue.conf &gt; blue-service.log 2&gt;&amp;1 &amp;
230user@localhost:~/asterix-server
231$bin/asterixncservice &gt;red-service.log 2&gt;&amp;1 &amp;
232</pre></div></div>
233</li>
234<li>
235
236<p>Start the <tt>CCDriver</tt>.</p>
237
238<div>
239<div>
240<pre class="source">user@localhost:~/asterix-server
241$bin/asterixcc -config-file cc.conf &gt; cc.log 2&gt;&amp;1 &amp;
242</pre></div></div>
243</li>
244</ol>
245<p>The <tt>CCDriver</tt> will connect to the <tt>NCServices</tt> and thus initiate the configuration and the start of the <tt>NCDrivers</tt>. After running these scripts, <tt>jps</tt> should show a result similar to this:</p>
246
247<div>
248<div>
249<pre class="source">user@localhost:~/asterix-server
250$jps
25113184 NCService
25213200 NCDriver
25313185 NCService
25413186 CCDriver
25513533 Jps
25613198 NCDriver
257</pre></div></div>
258
259<p>The logs for the <tt>NCDrivers</tt> will be in <tt>$BASEDIR/logs</tt>.</p>
260<p>To stop the cluster again simply run</p>
261
262<div>
263<div>
264<pre class="source">$ kill `jps | egrep '(CDriver|NCService)' | awk '{print $1}'`
265</pre></div></div>
266
267<p>to kill all processes.</p>
268<h1><a name="Multi_machine" id="Multi_machine">Deploying AsterixDB via NCService in a multi-machine setup</a></h1>
269<p>Deploying on multiple machines only differs in the configuration file and where each process is actually resident. Take for example a deployment on 3 machines, <tt>cacofonix-1</tt>,<tt>cacofonix-2</tt>,and <tt>cacofonix-3</tt>. <tt>cacofonix-1</tt> will be the CC, and <tt>cacofonix-2</tt> and <tt>cacofonix-3</tt> will be the two NCs, respectively. The configuration would be as follows:</p>
270<p><tt>cc.conf</tt>:</p>
271
272<div>
273<div>
274<pre class="source">[nc/red]
275txn.log.dir=/lv_scratch/asterix/red/txnlog
276core.dump.dir=/lv_scratch/asterix/red/coredump
277iodevices=/lv_scratch/asterix/red
278address=cacofonix-2
279
280[nc/blue]
281txn.log.dir=/lv_scratch/asterix/blue/txnlog
282core.dump.dir=/lv_scratch/asterix/blue/coredump
283iodevices=/lv_scratch/asterix/blue
284address=cacofonix-3
285
286[nc]
287app.class=org.apache.asterix.hyracks.bootstrap.NCApplicationEntryPoint
288storagedir=storage
289command=asterixnc
290
291[cc]
292address = cacofonix-1
293</pre></div></div>
294
295<p>To deploy, first the <tt>asterix-server</tt> binary must be present on each machine. Any method to transfer the archive to each machine will work, but here <tt>scp</tt> will be used for simplicity&#x2019;s sake.</p>
296
297<div>
298<div>
299<pre class="source">user@localhost:~
300$for f in {1,2,3}; scp asterix-server.zip cacofonix-$f:~/; end
301</pre></div></div>
302
303<p>Then unzip the binary on each machine. First, start the <tt>NCService</tt> processes on each of the slave machines. Any way of getting a shell on the machine is fine, be it physical or via <tt>ssh</tt>.</p>
304
305<div>
306<div>
307<pre class="source">user@cacofonix-2 12:41:42 ~/asterix-server/
308$ bin/asterixncservice &gt; red-service.log 2&gt;&amp;1 &amp;
309
310
311user@cacofonix-3 12:41:42 ~/asterix-server/
312$ bin/asterixncservice &gt; blue-service.log 2&gt;&amp;1 &amp;
313</pre></div></div>
314
315<p>Now that each <tt>NCService</tt> is waiting, the CC can be started.</p>
316
317<div>
318<div>
319<pre class="source">user@cacofonix-1 12:41:42 ~/asterix-server/
320$ bin/asterixcc -config-file cc.conf &gt; cc.log 2&gt;&amp;1 &amp;
321</pre></div></div>
322
323<p>The cluster should now be started and the Web UI available on the CC host at the default port.</p>
324<h1><a name="Parameters" id="Parameters">Available Configuration Parameters</a></h1>
325<p>The following parameters are for the master process, under the &#x201c;[cc]&#x201d; section.</p>
326<table border="0" class="table table-striped">
327<thead>
328
329<tr class="a">
330<th> Section </th>
331<th> Parameter </th>
332<th> Meaning </th>
333<th> Default </th></tr>
334</thead><tbody>
335
336<tr class="b">
337<td> cc </td>
338<td> active.port </td>
339<td> The listen port of the active server </td>
340<td> 19003 </td></tr>
341<tr class="a">
342<td> cc </td>
343<td> address </td>
344<td> Default bind address for all services on this cluster controller </td>
345<td> 127.0.0.1 </td></tr>
346<tr class="b">
347<td> cc </td>
348<td> api.port </td>
349<td> The listen port of the API server </td>
350<td> 19002 </td></tr>
351<tr class="a">
352<td> cc </td>
353<td> app.class </td>
354<td> Application CC main class </td>
355<td> org.apache.asterix.hyracks.bootstrap.CCApplication </td></tr>
356<tr class="b">
357<td> cc </td>
358<td> client.listen.address </td>
359<td> Sets the IP Address to listen for connections from clients </td>
360<td> same as address </td></tr>
361<tr class="a">
362<td> cc </td>
363<td> client.listen.port </td>
364<td> Sets the port to listen for connections from clients </td>
365<td> 1098 </td></tr>
366<tr class="b">
367<td> cc </td>
368<td> cluster.listen.address </td>
369<td> Sets the IP Address to listen for connections from NCs </td>
370<td> same as address </td></tr>
371<tr class="a">
372<td> cc </td>
373<td> cluster.listen.port </td>
374<td> Sets the port to listen for connections from node controllers </td>
375<td> 1099 </td></tr>
376<tr class="b">
377<td> cc </td>
378<td> cluster.public.address </td>
379<td> Address that NCs should use to contact this CC </td>
380<td> same as cluster.listen.address </td></tr>
381<tr class="a">
382<td> cc </td>
383<td> cluster.public.port </td>
384<td> Port that NCs should use to contact this CC </td>
385<td> same as cluster.listen.port </td></tr>
386<tr class="b">
387<td> cc </td>
388<td> cluster.topology </td>
389<td> Sets the XML file that defines the cluster topology </td>
390<td> &lt;undefined&gt; </td></tr>
391<tr class="a">
392<td> cc </td>
393<td> console.listen.address </td>
394<td> Sets the listen address for the Cluster Controller </td>
395<td> same as address </td></tr>
396<tr class="b">
397<td> cc </td>
398<td> console.listen.port </td>
399<td> Sets the http port for the Cluster Controller) </td>
400<td> 16001 </td></tr>
401<tr class="a">
402<td> cc </td>
403<td> cores.multiplier </td>
404<td> The factor to multiply by the number of cores to determine maximum query concurrent execution level </td>
405<td> 3 </td></tr>
406<tr class="b">
407<td> cc </td>
408<td> heartbeat.max.misses </td>
409<td> Sets the maximum number of missed heartbeats before a node is marked as dead </td>
410<td> 5 </td></tr>
411<tr class="a">
412<td> cc </td>
413<td> heartbeat.period </td>
414<td> Sets the time duration between two heartbeats from each node controller in milliseconds </td>
415<td> 10000 </td></tr>
416<tr class="b">
417<td> cc </td>
418<td> job.history.size </td>
419<td> Limits the number of historical jobs remembered by the system to the specified value </td>
420<td> 10 </td></tr>
421<tr class="a">
422<td> cc </td>
423<td> job.manager.class </td>
424<td> Specify the implementation class name for the job manager </td>
425<td> org.apache.hyracks.control.cc.job.JobManager </td></tr>
426<tr class="b">
427<td> cc </td>
428<td> job.queue.capacity </td>
429<td> The maximum number of jobs to queue before rejecting new jobs </td>
430<td> 4096 </td></tr>
431<tr class="a">
432<td> cc </td>
433<td> job.queue.class </td>
434<td> Specify the implementation class name for the job queue </td>
435<td> org.apache.hyracks.control.cc.scheduler.FIFOJobQueue </td></tr>
436<tr class="b">
437<td> cc </td>
438<td> profile.dump.period </td>
439<td> Sets the time duration between two profile dumps from each node controller in milliseconds; 0 to disable </td>
440<td> 0 </td></tr>
441<tr class="a">
442<td> cc </td>
443<td> result.sweep.threshold </td>
444<td> The duration within which an instance of the result cleanup should be invoked in milliseconds </td>
445<td> 60000 </td></tr>
446<tr class="b">
447<td> cc </td>
448<td> result.ttl </td>
449<td> Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds </td>
450<td> 86400000 </td></tr>
451<tr class="a">
452<td> cc </td>
453<td> root.dir </td>
454<td> Sets the root folder used for file operations </td>
455<td> ${java.io.tmpdir}/asterixdb/ClusterControllerService </td></tr>
456<tr class="b">
457<td> cc </td>
458<td> web.port </td>
459<td> The listen port of the legacy query interface </td>
460<td> 19001 </td></tr>
461<tr class="a">
462<td> cc </td>
463<td> web.queryinterface.port </td>
464<td> The listen port of the query web interface </td>
465<td> 19006 </td></tr>
466</tbody>
467</table>
468<p>The following parameters for slave processes, under &#x201c;[nc]&#x201d; sections.</p>
469<table border="0" class="table table-striped">
470<thead>
471
472<tr class="a">
473<th> Section </th>
474<th> Parameter </th>
475<th> Meaning </th>
476<th> Default </th></tr>
477</thead><tbody>
478
479<tr class="b">
480<td> nc </td>
481<td> address </td>
482<td> Default IP Address to bind listeners on this NC. All services will bind on this address unless a service-specific listen address is supplied. </td>
483<td> 127.0.0.1 </td></tr>
484<tr class="a">
485<td> nc </td>
486<td> app.class </td>
487<td> Application NC Main Class </td>
488<td> org.apache.asterix.hyracks.bootstrap.NCApplication </td></tr>
489<tr class="b">
490<td> nc </td>
491<td> cluster.address </td>
492<td> Cluster Controller address (required unless specified in config file) </td>
493<td> &lt;undefined&gt; </td></tr>
494<tr class="a">
495<td> nc </td>
496<td> cluster.connect.retries </td>
497<td> Number of attempts to contact CC before giving up </td>
498<td> 5 </td></tr>
499<tr class="b">
500<td> nc </td>
501<td> cluster.listen.address </td>
502<td> IP Address to bind cluster listener on this NC </td>
503<td> same as address </td></tr>
504<tr class="a">
505<td> nc </td>
506<td> cluster.listen.port </td>
507<td> IP port to bind cluster listener </td>
508<td> 0 </td></tr>
509<tr class="b">
510<td> nc </td>
511<td> cluster.port </td>
512<td> Cluster Controller port </td>
513<td> 1099 </td></tr>
514<tr class="a">
515<td> nc </td>
516<td> cluster.public.address </td>
517<td> Public IP Address to announce cluster listener </td>
518<td> same as public.address </td></tr>
519<tr class="b">
520<td> nc </td>
521<td> cluster.public.port </td>
522<td> Public IP port to announce cluster listener </td>
523<td> same as cluster.listen.port </td></tr>
524<tr class="a">
525<td> nc </td>
526<td> command </td>
527<td> Command NCService should invoke to start the NCDriver </td>
528<td> hyracksnc </td></tr>
529<tr class="b">
530<td> nc </td>
531<td> core.dump.dir </td>
532<td> The directory where node core dumps should be written </td>
533<td> ${java.io.tmpdir}/asterixdb/coredump </td></tr>
534<tr class="a">
535<td> nc </td>
536<td> data.listen.address </td>
537<td> IP Address to bind data listener </td>
538<td> same as address </td></tr>
539<tr class="b">
540<td> nc </td>
541<td> data.listen.port </td>
542<td> IP port to bind data listener </td>
543<td> 0 </td></tr>
544<tr class="a">
545<td> nc </td>
546<td> data.public.address </td>
547<td> Public IP Address to announce data listener </td>
548<td> same as public.address </td></tr>
549<tr class="b">
550<td> nc </td>
551<td> data.public.port </td>
552<td> Public IP port to announce data listener </td>
553<td> same as data.listen.port </td></tr>
554<tr class="a">
555<td> nc </td>
556<td> iodevices </td>
557<td> Comma separated list of IO Device mount points </td>
558<td> ${java.io.tmpdir}/asterixdb/iodevice </td></tr>
559<tr class="b">
560<td> nc </td>
561<td> jvm.args </td>
562<td> JVM args to pass to the NCDriver </td>
563<td> &lt;undefined&gt; </td></tr>
564<tr class="a">
565<td> nc </td>
566<td> messaging.listen.address </td>
567<td> IP Address to bind messaging listener </td>
568<td> same as address </td></tr>
569<tr class="b">
570<td> nc </td>
571<td> messaging.listen.port </td>
572<td> IP port to bind messaging listener </td>
573<td> 0 </td></tr>
574<tr class="a">
575<td> nc </td>
576<td> messaging.public.address </td>
577<td> Public IP Address to announce messaging listener </td>
578<td> same as public.address </td></tr>
579<tr class="b">
580<td> nc </td>
581<td> messaging.public.port </td>
582<td> Public IP port to announce messaging listener </td>
583<td> same as messaging.listen.port </td></tr>
584<tr class="a">
585<td> nc </td>
586<td> ncservice.address </td>
587<td> Address the CC should use to contact the NCService associated with this NC </td>
588<td> same as public.address </td></tr>
589<tr class="b">
590<td> nc </td>
591<td> ncservice.pid </td>
592<td> PID of the NCService which launched this NCDriver </td>
593<td> -1 </td></tr>
594<tr class="a">
595<td> nc </td>
596<td> ncservice.port </td>
597<td> Port the CC should use to contact the NCService associated with this NC </td>
598<td> 9090 </td></tr>
599<tr class="b">
600<td> nc </td>
601<td> net.buffer.count </td>
602<td> Number of network buffers per input/output channel </td>
603<td> 1 </td></tr>
604<tr class="a">
605<td> nc </td>
606<td> net.thread.count </td>
607<td> Number of threads to use for Network I/O </td>
608<td> 1 </td></tr>
609<tr class="b">
610<td> nc </td>
611<td> public.address </td>
612<td> Default public address that other processes should use to contact this NC. All services will advertise this address unless a service-specific public address is supplied. </td>
613<td> same as address </td></tr>
614<tr class="a">
615<td> nc </td>
616<td> result.listen.address </td>
617<td> IP Address to bind dataset result distribution listener </td>
618<td> same as address </td></tr>
619<tr class="b">
620<td> nc </td>
621<td> result.listen.port </td>
622<td> IP port to bind dataset result distribution listener </td>
623<td> 0 </td></tr>
624<tr class="a">
625<td> nc </td>
626<td> result.manager.memory </td>
627<td> Memory usable for result caching at this Node Controller in bytes </td>
628<td> -1 (-1 B) </td></tr>
629<tr class="b">
630<td> nc </td>
631<td> result.public.address </td>
632<td> Public IP Address to announce dataset result distribution listener </td>
633<td> same as public.address </td></tr>
634<tr class="a">
635<td> nc </td>
636<td> result.public.port </td>
637<td> Public IP port to announce dataset result distribution listener </td>
638<td> same as result.listen.port </td></tr>
639<tr class="b">
640<td> nc </td>
641<td> result.sweep.threshold </td>
642<td> The duration within which an instance of the result cleanup should be invoked in milliseconds </td>
643<td> 60000 </td></tr>
644<tr class="a">
645<td> nc </td>
646<td> result.ttl </td>
647<td> Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds </td>
648<td> 86400000 </td></tr>
649<tr class="b">
650<td> nc </td>
651<td> storage.buffercache.maxopenfiles </td>
652<td> The maximum number of open files in the buffer cache </td>
653<td> 2147483647 </td></tr>
654<tr class="a">
655<td> nc </td>
656<td> storage.buffercache.pagesize </td>
657<td> The page size in bytes for pages in the buffer cache </td>
658<td> 131072 (128 kB) </td></tr>
659<tr class="b">
660<td> nc </td>
661<td> storage.buffercache.size </td>
662<td> The size of memory allocated to the disk buffer cache. The value should be a multiple of the buffer cache page size. </td>
663<td> 1/4 of the JVM allocated memory </td></tr>
664<tr class="a">
665<td> nc </td>
666<td> storage.lsm.bloomfilter.falsepositiverate </td>
667<td> The maximum acceptable false positive rate for bloom filters associated with LSM indexes </td>
668<td> 0.01 </td></tr>
669<tr class="b">
670<td> nc </td>
671<td> storage.memorycomponent.globalbudget </td>
672<td> The size of memory allocated to the memory components. The value should be a multiple of the memory component page size </td>
673<td> 1/4 of the JVM allocated memory </td></tr>
674<tr class="a">
675<td> nc </td>
676<td> storage.memorycomponent.numcomponents </td>
677<td> The number of memory components to be used per lsm index </td>
678<td> 2 </td></tr>
679<tr class="b">
680<td> nc </td>
681<td> storage.memorycomponent.pagesize </td>
682<td> The page size in bytes for pages allocated to memory components </td>
683<td> 131072 (128 kB) </td></tr>
684<tr class="a">
685<td> nc </td>
686<td> storage.metadata.memorycomponent.numpages </td>
687<td> The number of pages to allocate for a metadata memory component </td>
688<td> 8 </td></tr>
689<tr class="b">
690<td> nc </td>
691<td> txn.log.dir </td>
692<td> The directory where transaction logs should be stored </td>
693<td> ${java.io.tmpdir}/asterixdb/txn-log </td></tr>
694</tbody>
695</table>
696<p>The following parameters are configured under the &#x201c;[common]&#x201d; section.</p>
697<table border="0" class="table table-striped">
698<thead>
699
700<tr class="a">
701<th> Section </th>
702<th> Parameter </th>
703<th> Meaning </th>
704<th> Default </th></tr>
705</thead><tbody>
706
707<tr class="b">
708<td> common </td>
709<td> active.memory.global.budget </td>
710<td> The memory budget (in bytes) for the active runtime </td>
711<td> 67108864 (64 MB) </td></tr>
712<tr class="a">
713<td> common </td>
714<td> compiler.framesize </td>
715<td> The page size (in bytes) for computation </td>
716<td> 32768 (32 kB) </td></tr>
717<tr class="b">
718<td> common </td>
719<td> compiler.groupmemory </td>
720<td> The memory budget (in bytes) for a group by operator instance in a partition </td>
721<td> 33554432 (32 MB) </td></tr>
722<tr class="a">
723<td> common </td>
724<td> compiler.joinmemory </td>
725<td> The memory budget (in bytes) for a join operator instance in a partition </td>
726<td> 33554432 (32 MB) </td></tr>
727<tr class="b">
728<td> common </td>
729<td> compiler.parallelism </td>
730<td> The degree of parallelism for query execution. Zero means to use the storage parallelism as the query execution parallelism, while other integer values dictate the number of query execution parallel partitions. The system will fall back to use the number of all available CPU cores in the cluster as the degree of parallelism if the number set by a user is too large or too small </td>
731<td> 0 </td></tr>
732<tr class="a">
733<td> common </td>
734<td> compiler.sortmemory </td>
735<td> The memory budget (in bytes) for a sort operator instance in a partition </td>
736<td> 33554432 (32 MB) </td></tr>
737<tr class="b">
738<td> common </td>
739<td> compiler.sort.parallel </td>
740<td> Enable full parallel sort for queries </td>
741<td> true </td></tr>
742<tr class="a">
743<td> common </td>
744<td> compiler.sort.samples </td>
745<td> The number of samples taken from each partition to guide the sort operation when full parallel sort is enabled </td>
746<td> 100 </td></tr>
747<tr class="b">
748<td> common </td>
749<td> compiler.textsearchmemory </td>
750<td> The memory budget (in bytes) for an inverted-index-search operator instance in a partition </td>
751<td> 33554432 (32 MB) </td></tr>
752<tr class="a">
753<td> common </td>
754<td> compiler.windowmemory </td>
755<td> The memory budget (in bytes) for a window operator instance in a partition </td>
756<td> 33554432 (32 MB) </td></tr>
757<tr class="b">
758<td> common </td>
759<td> log.level </td>
760<td> The logging level for master and slave processes </td>
761<td> WARNING </td></tr>
762<tr class="a">
763<td> common </td>
764<td> max.wait.active.cluster </td>
765<td> The max pending time (in seconds) for cluster startup. After the threshold, if the cluster still is not up and running, it is considered unavailable </td>
766<td> 60 </td></tr>
767<tr class="b">
768<td> common </td>
769<td> messaging.frame.count </td>
770<td> Number of reusable frames for NC to NC messaging </td>
771<td> 512 </td></tr>
772<tr class="a">
773<td> common </td>
774<td> messaging.frame.size </td>
775<td> The frame size to be used for NC to NC messaging </td>
776<td> 4096 (4 kB) </td></tr>
777<tr class="b">
778<td> common </td>
779<td> metadata.callback.port </td>
780<td> IP port to bind metadata callback listener (0 = random port) </td>
781<td> 0 </td></tr>
782<tr class="a">
783<td> common </td>
784<td> metadata.listen.port </td>
785<td> IP port to bind metadata listener (0 = random port) </td>
786<td> 0 </td></tr>
787<tr class="b">
788<td> common </td>
789<td> metadata.node </td>
790<td> the node which should serve as the metadata node </td>
791<td> &lt;undefined&gt; </td></tr>
792<tr class="a">
793<td> common </td>
794<td> metadata.registration.timeout.secs </td>
795<td> how long in seconds to wait for the metadata node to register with the CC </td>
796<td> 60 </td></tr>
797<tr class="b">
798<td> common </td>
799<td> replication.log.batchsize </td>
800<td> The size in bytes to replicate in each batch </td>
801<td> 4096 (4 kB) </td></tr>
802<tr class="a">
803<td> common </td>
804<td> replication.log.buffer.numpages </td>
805<td> The number of log buffer pages </td>
806<td> 8 </td></tr>
807<tr class="b">
808<td> common </td>
809<td> replication.log.buffer.pagesize </td>
810<td> The size in bytes of each log buffer page </td>
811<td> 131072 (128 kB) </td></tr>
812<tr class="a">
813<td> common </td>
814<td> replication.max.remote.recovery.attempts </td>
815<td> The maximum number of times to attempt to recover from a replica on failure before giving up </td>
816<td> 5 </td></tr>
817<tr class="b">
818<td> common </td>
819<td> replication.timeout </td>
820<td> The time in seconds to timeout when trying to contact a replica, before assuming it is dead </td>
821<td> 15 </td></tr>
822<tr class="a">
823<td> common </td>
824<td> storage.max.active.writable.datasets </td>
825<td> The maximum number of datasets that can be concurrently modified </td>
826<td> 8 </td></tr>
827<tr class="b">
828<td> common </td>
829<td> txn.commitprofiler.enabled </td>
830<td> Enable output of commit profiler logs </td>
831<td> false </td></tr>
832<tr class="a">
833<td> common </td>
834<td> txn.commitprofiler.reportinterval </td>
835<td> Interval (in seconds) to report commit profiler logs </td>
836<td> 5 </td></tr>
837<tr class="b">
838<td> common </td>
839<td> txn.job.recovery.memorysize </td>
840<td> The memory budget for each job job (in bytes) used for recovery </td>
841<td> 67108864 (64 MB) </td></tr>
842<tr class="a">
843<td> common </td>
844<td> txn.lock.escalationthreshold </td>
845<td> The maximum number of entity locks to obtain before upgrading to a dataset lock </td>
846<td> 1000 </td></tr>
847<tr class="b">
848<td> common </td>
849<td> txn.lock.shrinktimer </td>
850<td> The time (in milliseconds) where under utilization of resources will trigger a shrink phase </td>
851<td> 5000 </td></tr>
852<tr class="a">
853<td> common </td>
854<td> txn.lock.timeout.sweepthreshold </td>
855<td> Interval (in milliseconds) for checking lock timeout </td>
856<td> 10000 </td></tr>
857<tr class="b">
858<td> common </td>
859<td> txn.lock.timeout.waitthreshold </td>
860<td> Time out (in milliseconds) of waiting for a lock </td>
861<td> 60000 </td></tr>
862<tr class="a">
863<td> common </td>
864<td> txn.log.buffer.numpages </td>
865<td> The number of pages in the transaction log tail </td>
866<td> 8 </td></tr>
867<tr class="b">
868<td> common </td>
869<td> txn.log.buffer.pagesize </td>
870<td> The page size (in bytes) for transaction log buffer </td>
871<td> 4194304 (4MB) </td></tr>
872<tr class="a">
873<td> common </td>
874<td> txn.log.checkpoint.history </td>
875<td> The number of checkpoints to keep in the transaction log </td>
876<td> 0 </td></tr>
877<tr class="b">
878<td> common </td>
879<td> txn.log.checkpoint.lsnthreshold </td>
880<td> The checkpoint threshold (in terms of LSNs (log sequence numbers) that have been written to the transaction log, i.e., the length of the transaction log) for transaction logs </td>
881<td> 67108864 (64 MB) </td></tr>
882<tr class="a">
883<td> common </td>
884<td> txn.log.checkpoint.pollfrequency </td>
885<td> The frequency (in seconds) the checkpoint thread should check to see if a checkpoint should be written </td>
886<td> 120 </td></tr>
887<tr class="b">
888<td> common </td>
889<td> txn.log.partitionsize </td>
890<td> The maximum size (in bytes) of each transaction log file </td>
891<td> 268435456 (256 MB) </td></tr>
892</tbody>
893</table>
894<p>For the optional NCService process configuration file, the following parameters, under &#x201c;[ncservice]&#x201d; section.</p>
895<table border="0" class="table table-striped">
896<thead>
897
898<tr class="a">
899<th> Parameter </th>
900<th> Meaning </th>
901<th> Default </th></tr>
902</thead><tbody>
903
904<tr class="b">
905<td> address </td>
906<td> The address the NCService listens on for commands from the CC </td>
907<td> (all addresses) </td></tr>
908<tr class="a">
909<td> port </td>
910<td> The port for the NCService listens on for commands from the CC </td>
911<td> 9090 </td></tr>
912<tr class="b">
913<td> logdir </td>
914<td> Directory where NCService logs should be written (&#x2018;-&#x2019; indicates that output should go to stdout) </td>
915<td> ${app.home}/logs (${user.home} if &#x2018;app.home&#x2019; not present in NCService Java system properties. </td></tr>
916</tbody>
917</table></div>
918 </div>
919 </div>
920 </div>
921 <hr/>
922 <footer>
923 <div class="container-fluid">
924 <div class="row-fluid">
925<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
926 feather logo, and the Apache AsterixDB project logo are either
927 registered trademarks or trademarks of The Apache Software
928 Foundation in the United States and other countries.
929 All other marks mentioned may be trademarks or registered
930 trademarks of their respective owners.
931 </div>
932 </div>
933 </div>
934 </footer>
935 </body>
936</html>