Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Till Westmann has submitted this change and it was merged.

Change subject: Doc for single node installation using NCService
..


Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Reviewed-on: https://asterix-gerrit.ics.uci.edu/895
Reviewed-by: Chris Hillery 
Reviewed-by: Jenkins 
Tested-by: Jenkins 
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 112 insertions(+), 0 deletions(-)

Approvals:
  Chris Hillery: Looks good to me, approved
  Jenkins: Looks good to me, but someone else must approve; Verified



diff --git a/asterixdb/asterix-doc/src/site/markdown/ncservice.md 
b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
new file mode 100644
index 000..769c551
--- /dev/null
+++ b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
@@ -0,0 +1,111 @@
+
+
+# Starting a small cluster using the NCService
+
+When running a cluster using the `NCService` there are 3 different kind of
+processes involved:
+
+1. `NCDriver` does the work of a NodeController
+2. `NCService` configures and starts an `NCDriver`
+3. `CCDriver` does the work of a ClusterController and sends the
+configuration to the `NCServices`
+
+To start a small cluster consisting of 2 NodeControllers (`red` and `blue`)
+and 1 ClusterController (`cc`) on a single machine only 2 configuration
+files are required.
+The first one is
+
+`blue.conf`:
+
+[ncservice]
+port=9091
+
+It is a configuration file for the second `NCService`.
+This contains only the port that the `NCService` of the second
+NodeControllers listens to as it is non-standard.
+The first `NCService` does not need a configuration file, as it only uses
+default parameters.
+In a distributed environment with 1 NodeController per machine, no
+`NCService` needs a configuration file.
+
+The second configuration file is
+
+`cc.conf`:
+
+[nc/red]
+txnlogdir=/tmp/asterix/red/txnlog
+coredumpdir=/tmp/asterix/red/coredump
+iodevices=/tmp/asterix/red
+
+[nc/blue]
+port=9091
+txnlogdir=/tmp/asterix/blue/txnlog
+coredumpdir=/tmp/asterix/blue/coredump
+iodevices=/tmp/asterix/blue
+
+[nc]
+app.class=org.apache.asterix.hyracks.bootstrap.NCApplicationEntryPoint
+storagedir=storage
+address=127.0.0.1
+command=asterixnc
+
+[cc]
+cluster.address = 127.0.0.1
+http.port = 12345
+
+This is the configuration file for the cluster and it contains information
+that each `NCService` will use when starting the corresponding `NCDriver` as
+well as information for the `CCDriver`.
+
+To start the cluster simply use the following steps
+
+1. Set BASEDIR to location of an unzipped asterix-server binary assembly (in
+the source tree that's at `asterixdb/asterix-server/target`).
+
+$ export BASEDIR=[..]/asterix-server-0.8.9-SNAPSHOT-binary-assembly
+
+2. Start the 2 `NCServices` for `red` and `blue`.
+
+$ $BASEDIR/bin/asterixncservice -config-file blue.conf > 
blue-service.log 2>&1 &
+$ $BASEDIR/bin/asterixncservice >red-service.log 2>&1 &
+
+3. Start the `CCDriver`.
+
+$ $BASEDIR/bin/asterixcc -config-file cc.conf > cc.log 2>&1 &
+
+The `CCDriver` will connect to the `NCServices` and thus initiate the
+configuration and the start of the `NCDrivers`.
+After running these scripts, `jps` should show a result similar to this:
+
+$ jps
+13184 NCService
+13200 NCDriver
+13185 NCService
+13186 CCDriver
+13533 Jps
+13198 NCDriver
+
+The logs for the `NCDrivers` will be in `$BASEDIR/logs`.
+
+To stop the cluster again simply run
+
+$ kill `jps | egrep '(CDriver|NCService)' | awk '{print $1}'`
+
+to kill all processes.
\ No newline at end of file
diff --git a/asterixdb/asterix-doc/src/site/site.xml 
b/asterixdb/asterix-doc/src/site/site.xml
index 4dadc09..9d5ce6e 100644
--- a/asterixdb/asterix-doc/src/site/site.xml
+++ b/asterixdb/asterix-doc/src/site/site.xml
@@ -74,6 +74,7 @@
 
 
 
+  
   
   
 

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 8
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-Reviewer: Till Westmann 

Change in asterixdb[master]: Doc for single node installation using NCService

[Chris Hillery (Code Review)]

Chris Hillery has posted comments on this change.

Change subject: Doc for single node installation using NCService
..


Patch Set 7: Code-Review+2

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 7
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-Reviewer: Till Westmann 
Gerrit-HasComments: No

Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Hello Chris Hillery, Jenkins,

I'd like you to reexamine a change.  Please visit

https://asterix-gerrit.ics.uci.edu/895

to look at the new patch set (#7).

Change subject: Doc for single node installation using NCService
..

Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 112 insertions(+), 0 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb 
refs/changes/95/895/7
-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 7
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-Reviewer: Till Westmann 

Change in asterixdb[master]: Doc for single node installation using NCService

[Jenkins (Code Review)]

Jenkins has posted comments on this change.

Change subject: Doc for single node installation using NCService
..


Patch Set 6:

Build Started 
https://asterix-jenkins.ics.uci.edu/job/asterix-gerrit-notopic/1553/

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 6
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-Reviewer: Till Westmann 
Gerrit-HasComments: No

Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Hello Jenkins,

I'd like you to reexamine a change.  Please visit

https://asterix-gerrit.ics.uci.edu/895

to look at the new patch set (#6).

Change subject: Doc for single node installation using NCService
..

Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 112 insertions(+), 0 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb 
refs/changes/95/895/6
-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 6
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-Reviewer: Till Westmann 

Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Hello Jenkins,

I'd like you to reexamine a change.  Please visit

https://asterix-gerrit.ics.uci.edu/895

to look at the new patch set (#5).

Change subject: Doc for single node installation using NCService
..

Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 112 insertions(+), 0 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb 
refs/changes/95/895/5
-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 5
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 

Change in asterixdb[master]: Doc for single node installation using NCService

[Jenkins (Code Review)]

Jenkins has posted comments on this change.

Change subject: Doc for single node installation using NCService
..


Patch Set 3:

Build Started 
https://asterix-jenkins.ics.uci.edu/job/asterix-gerrit-notopic/1546/

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 3
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-HasComments: No

Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Hello Jenkins,

I'd like you to reexamine a change.  Please visit

https://asterix-gerrit.ics.uci.edu/895

to look at the new patch set (#3).

Change subject: Doc for single node installation using NCService
..

Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 104 insertions(+), 0 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb 
refs/changes/95/895/3
-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 3
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 

Change in asterixdb[master]: Doc for single node installation using NCService

[Chris Hillery (Code Review)]

Chris Hillery has posted comments on this change.

Change subject: Doc for single node installation using NCService
..


Patch Set 2:

(3 comments)

https://asterix-gerrit.ics.uci.edu/#/c/895/2/asterixdb/asterix-doc/src/site/markdown/ncservice.md
File asterixdb/asterix-doc/src/site/markdown/ncservice.md:

Line 79: $ export 
BINDIR=[..]/asterix-server-0.8.9-SNAPSHOT-binary-assembly/bin
Other than this line, I believe these instructions would work for both an 
in-source build as well as a binary .zip download. Can this one line be made 
more generic with a little description of what "BINDIR" should point to / 
contain?


Line 81: $ $BINDIR/asterixncservice -config-file blue.conf &> 
blue-service.log &
&> is a bash-ism which won't work in strict bourne shell... probably should use 
"blue.conf > blue-service.log 2>&1 &"


Line 97: 13198 NCDriver
Worth adding a note that the NCDriver logs will be in $app.home/logs ?


-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 2
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-HasComments: Yes

Change in asterixdb[master]: Doc for single node installation using NCService

[Jenkins (Code Review)]

Jenkins has posted comments on this change.

Change subject: Doc for single node installation using NCService
..


Patch Set 1:

Build Started 
https://asterix-jenkins.ics.uci.edu/job/asterix-gerrit-notopic/1524/

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann 
Gerrit-Reviewer: Chris Hillery 
Gerrit-Reviewer: Jenkins 
Gerrit-HasComments: No

Change in asterixdb[master]: Doc for single node installation using NCService

[Till Westmann (Code Review)]

Till Westmann has uploaded a new change for review.

  https://asterix-gerrit.ics.uci.edu/895

Change subject: Doc for single node installation using NCService
..

Doc for single node installation using NCService

Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
---
A asterixdb/asterix-doc/src/site/markdown/ncservice.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 104 insertions(+), 0 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb 
refs/changes/95/895/1

diff --git a/asterixdb/asterix-doc/src/site/markdown/ncservice.md 
b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
new file mode 100644
index 000..b724bd7
--- /dev/null
+++ b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
@@ -0,0 +1,103 @@
+
+
+# Starting a small cluster using the NCService
+
+When running a cluster using the `NCService` there are 3 different kind of
+processes involved:
+
+1. `NCDriver` does the work of a NodeController
+2. `NCService` configures and starts an `NCDriver`
+3. `CCDriver` does the work of a ClusterController and sends the
+configuration to the `NCServices`
+
+To start a small cluster consisting of 2 NodeControllers (`red` and `blue`)
+and 1 ClusterController (`cc`) on a single machine only 2 configuration
+files are required.
+The first one is
+
+`blue.conf`:
+
+[ncservice]
+port=9091
+
+It is a configuration file for the second `NCService`.
+This contains only the port that the `NCService` of the second
+NodeControllers listens to as it is non-standard.
+The first `NCService` does not need a configuration file, as it only uses
+default parameters.
+In a distributed environment with 1 NodeController per machine, no
+`NCService` needs a configuration file.
+
+The second configuration file is 
+
+`cc.conf`:
+
+[nc/red]
+txnlogdir=/tmp/asterix/red/txnlog
+coredumpdir=/tmp/asterix/red/coredump
+iodevices=/tmp/asterix/red
+
+[nc/blue]
+port=9091
+txnlogdir=/tmp/asterix/blue/txnlog
+coredumpdir=/tmp/asterix/blue/coredump
+iodevices=/tmp/asterix/blue
+
+[nc]
+app.class=org.apache.asterix.hyracks.bootstrap.NCApplicationEntryPoint
+storagedir=storage
+address=127.0.0.1
+command=asterixnc
+
+[cc]
+cluster.address = 127.0.0.1
+http.port = 12345
+
+This is the configuration file for the cluster and it contains information
+that each `NCService` will use when starting the corresponding `NCDriver` as
+well as information for the `CCDriver`.
+
+To start the cluster simply use the following commands
+
+$ export BINDIR=[..]/asterix-server-0.8.9-SNAPSHOT-binary-assembly/bin
+
+$ $BINDIR/asterixncservice -config-file blue.conf &> blue-service.log &
+$ $BINDIR/asterixncservice &>red-service.log &
+$ $BINDIR/asterixcc -config-file cc.conf &> cc.log &
+
+These will first start the 2 `NCServices` for `red` and `blue` and then
+start the `CCDriver`.
+The `CCDriver` will connect to the `NCServices` and thus initiate the
+configuration and the start of the `NCDrivers`.
+After running these scripts, `jps` should show a result similar to this:
+
+$ jps
+13184 NCService
+13200 NCDriver
+13185 NCService
+13186 CCDriver
+13533 Jps
+13198 NCDriver
+
+To stop the cluster again simply run
+
+$ kill `jps | egrep '(CDriver|NCService)' | awk '{print $1}'`
+
+to kill all processes.
\ No newline at end of file
diff --git a/asterixdb/asterix-doc/src/site/site.xml 
b/asterixdb/asterix-doc/src/site/site.xml
index 4dadc09..9d5ce6e 100644
--- a/asterixdb/asterix-doc/src/site/site.xml
+++ b/asterixdb/asterix-doc/src/site/site.xml
@@ -74,6 +74,7 @@
 
 
 
+  
   
   
 

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/895
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Id0a5ad6e88d72ce2fcaaeabc79fd86c374005ad3
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann