Add documentation and some modifications

mfelgamal · mfelgamal · commit e6423098786f · 2016-10-22T01:25:53.000+02:00
diff --git a/dev/create_release.sh b/dev/create_release.sh
@@ -45,7 +45,7 @@ GIT_TAG="$2"
 
 function build_docker_base() {
   # build base image
-  docker build -t ${DOCKER_USERNAME}/zeppelin-base:latest "${WORKING_DIR}/zeppelin/scripts/docker/zeppelin-base"
+  docker build -t ${DOCKER_USERNAME}/zeppelin-base:latest "${BASEDIR}/../scripts/docker/zeppelin-base"
 }
 function build_docker_image() {
   # build release image
diff --git a/docs/install/docker.md b/docs/install/docker.md
@@ -0,0 +1,57 @@
+---
+layout: page
+title: "Apache Zeppelin Releases Docker Images"
+description: "This document contains instructions about making docker containers for Zeppelin. It mainly provides guidance into how to create, publish and run docker images for zeppelin releases."
+group: install
+---
+<!--
+Licensed 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.
+-->
+{% include JB/setup %}
+
+# Apache Zeppelin Releases Docker Images
+
+<div id="toc"></div>
+
+## Overview 
+This document contains instructions about making docker containers for Zeppelin. It mainly provides guidance into how to create, publish and run docker images for zeppelin releases.
+
+## Quick Start
+### Installing Docker
+You need to [install docker](https://docs.docker.com/engine/installation/) on your machine.
+
+### Creating and Publishing Zeppelin docker image 
+* In order to be able to create and/or publish an image, you need to set the **DockerHub** credentials `DOCKER_USERNAME, DOCKER_PASSWORD, DOCKER_EMAIL` variables as environment variables.
+ 
+* To create an image for some release use :
+`create_release.sh <release-version> <git-tag>`.
+* To publish the created image use :
+`publish_release.sh <release-version> <git-tag>`
+
+### Running a Zeppelin  docker image 
+
+* To start Zeppelin, you need to pull the zeppelin release image: 
+```
+docker pull ${DOCKER_USERNAME}/zeppelin-release:<release-version>
+docker run --rm -p 8080:8080 -p 8081:8081 ${DOCKER_USERNAME}/zeppelin-release:<release-version> bash
+```
+* Then a docker container will start with a Zeppelin release on path :
+`/usr/local/zeppelin/`
+
+* Run zeppelin inside docker:
+```
+/usr/local/zeppelin/bin/zeppelin-daemon start
+```
+
+* Zeppelin will run at `http://localhost:8080`.
+
diff --git a/scripts/docker/zeppelin-base/Dockerfile b/scripts/docker/zeppelin-base/Dockerfile
@@ -1,5 +1,21 @@
+# 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.
+#
+
 FROM alpine:3.3
-MAINTAINER Mahmoud Elgamal <mahmoudf.elgamal@gmail.com>
+MAINTAINER Apache Software Foundation <dev@zeppelin.apache.org>
 
 RUN apk add --update bash curl openjdk7-jre wget ca-certificates openssl && rm -rf /var/cache/apk/*
 

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ GIT_TAG="$2"`
`45`	`45`
`46`	`46`	`function build_docker_base() {`
`47`	`47`	`# build base image`
`48`		`- docker build -t ${DOCKER_USERNAME}/zeppelin-base:latest "${WORKING_DIR}/zeppelin/scripts/docker/zeppelin-base"`
	`48`	`+ docker build -t ${DOCKER_USERNAME}/zeppelin-base:latest "${BASEDIR}/../scripts/docker/zeppelin-base"`
`49`	`49`	`}`
`50`	`50`	`function build_docker_image() {`
`51`	`51`	`# build release image`