You are viewing a plain text version of this content. The canonical link for it is here.

Posted to notifications@asterixdb.apache.org by "Till Westmann (Code Review)" <do...@asterixdb.incubator.apache.org> on 2017/02/11 07:05:35 UTC

Change in asterixdb[master]: Add instructions for the sample cluster

Till Westmann has uploaded a new change for review.

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

Change subject: Add instructions for the sample cluster
......................................................................

Add instructions for the sample cluster

Change-Id: Ib8b7fed93c1b0fe4475da60e8d4da2c221a64310
---
A asterixdb/asterix-doc/src/site/markdown/samplecluster.md
M asterixdb/asterix-doc/src/site/site.xml
2 files changed, 50 insertions(+), 3 deletions(-)


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

diff --git a/asterixdb/asterix-doc/src/site/markdown/samplecluster.md b/asterixdb/asterix-doc/src/site/markdown/samplecluster.md
new file mode 100644
index 0000000..84e40dd
--- /dev/null
+++ b/asterixdb/asterix-doc/src/site/markdown/samplecluster.md
@@ -0,0 +1,46 @@
+<!--
+ ! Licensed to the Apache Software Foundation (ASF) under one
+ ! or more contributor license agreements.  See the NOTICE file
+ ! distributed with this work for additional information
+ ! regarding copyright ownership.  The ASF licenses this file
+ ! to you under the Apache License, Version 2.0 (the
+ ! "License"); you may not use this file except in compliance
+ ! with the License.  You may obtain a copy of the License at
+ !
+ !   http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing,
+ ! software distributed under the License is distributed on an
+ ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ! KIND, either express or implied.  See the License for the
+ ! specific language governing permissions and limitations
+ ! under the License.
+ !-->
+
+#  <a id="Small_cluster">Start the single machine sample cluster</a>
+
+The easiest way to start playing with AsterixDB is to run the sample cluster
+that is available in the `asterix-server-X.Y.Z-binary-assembly.zip` archive.
+To do this
+
+1.  Download the server package from the
+    [download page](http://asterixdb.apache.org/download.html)
+2.  Expand the archive
+
+        $ unzip asterix-server-X.Y.Z-binary-assembly.zip
+
+3.  Change into the directory
+
+        $ cd asterix-server-X.Y.Z-binary-assembly
+
+4.  Start the sample cluster
+
+        $ ./samples/local/bin/start-sample-cluster.sh
+
+5.  Open browser at [http://localhost:19001/](http://localhost:19001/) and
+    start playing (e.g. by following the
+    [SQL++ primer](sqlpp/primer-sqlpp.html)).
+6. When you are done playing you can stop the cluster
+
+        $ ./samples/local/bin/stop-sample-cluster.sh
+
diff --git a/asterixdb/asterix-doc/src/site/site.xml b/asterixdb/asterix-doc/src/site/site.xml
index 0e2efc8..5c872be 100644
--- a/asterixdb/asterix-doc/src/site/site.xml
+++ b/asterixdb/asterix-doc/src/site/site.xml
@@ -74,9 +74,10 @@
     </links>
 
     <menu name="Get Started - Installation">
-      <item name="Option 1: using NCService" href="ncservice.html"/>
-      <item name="Option 2: using Managix" href="install.html"/>
-      <item name="Option 3: using YARN" href="yarn.html"/>
+      <item name="Option 1: run a simple sample cluster" href="samplecluster.html"/>
+      <item name="Option 2: using NCService" href="ncservice.html"/>
+      <item name="Option 3: using Managix" href="install.html"/>
+      <item name="Option 4: using YARN" href="yarn.html"/>
     </menu>
 
     <menu name = "AsterixDB Primer">

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib8b7fed93c1b0fe4475da60e8d4da2c221a64310
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Till Westmann <ti...@apache.org>