aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbhishek Girish <agirish@apache.org>2018-06-25 13:01:04 -0700
committerSorabh Hamirwasia <sorabh@apache.org>2018-07-12 13:45:52 -0700
commita97cce34e9f7ae9d522bf0542a984160d95a787c (patch)
tree69eaefc6d61f0825c03affaee3907e8ddec28dc9
parentd4f3304178f09f9fd7593ea70ffbff949c289e82 (diff)
DRILL-6346: Create an Official Drill Docker Container
closes #1348
-rwxr-xr-xdistribution/Dockerfile35
-rw-r--r--distribution/pom.xml28
-rw-r--r--docs/dev/Docker.md97
-rw-r--r--pom.xml1
4 files changed, 161 insertions, 0 deletions
diff --git a/distribution/Dockerfile b/distribution/Dockerfile
new file mode 100755
index 000000000..1ea1e4566
--- /dev/null
+++ b/distribution/Dockerfile
@@ -0,0 +1,35 @@
+#
+# 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 centos:7
+
+# Project version defined in pom.xml is passed as an argument
+ARG VERSION
+
+# JDK 8 is a pre-requisite to run Drill ; 'which' package is needed for drill-config.sh
+RUN yum install -y java-1.8.0-openjdk-devel which ; yum clean all ; rm -rf /var/cache/yum
+
+# The drill tarball is generated upon building the Drill project
+COPY target/apache-drill-$VERSION.tar.gz /tmp
+
+# Drill binaries are extracted into the '/opt/drill' directory
+RUN mkdir /opt/drill
+RUN tar -xvzf /tmp/apache-drill-$VERSION.tar.gz --directory=/opt/drill --strip-components 1
+
+# Starts Drill in embedded mode and connects to Sqlline
+ENTRYPOINT /opt/drill/bin/drill-embedded
diff --git a/distribution/pom.xml b/distribution/pom.xml
index 796b02e4e..b23fe896c 100644
--- a/distribution/pom.xml
+++ b/distribution/pom.xml
@@ -485,6 +485,34 @@
</plugins>
</build>
</profile>
+ <profile>
+ <id>docker</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>com.spotify</groupId>
+ <artifactId>dockerfile-maven-plugin</artifactId>
+ <version>1.4.3</version>
+ <executions>
+ <execution>
+ <id>docker-image</id>
+ <goals>
+ <goal>build</goal>
+ <goal>push</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <repository>${docker.repository}</repository>
+ <tag>${project.version}</tag>
+ <buildArgs>
+ <VERSION>${project.version}</VERSION>
+ </buildArgs>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
</profiles>
</project>
diff --git a/docs/dev/Docker.md b/docs/dev/Docker.md
new file mode 100644
index 000000000..acfea484c
--- /dev/null
+++ b/docs/dev/Docker.md
@@ -0,0 +1,97 @@
+# How to build, publish and run a Apache Drill Docker image
+
+## Prerequisites
+
+ To build an Apache Drill docker image, you need to have the following software installed on your system to successfully complete a build.
+ * [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
+ * [Maven 3.3.1 or greater](https://maven.apache.org/download.cgi)
+ * [Docker CE](https://store.docker.com/search?type=edition&offering=community)
+
+ If you are using an older Mac or PC, additionally configure [docker-machine](https://docs.docker.com/machine/overview/#what-is-docker-machine) on your system
+
+## Checkout
+```
+git clone https://github.com/apache/drill.git
+```
+## Build Drill
+```
+$ cd drill
+$ mvn clean install
+```
+## Build Docker Image
+```
+$ cd distribution
+$ mvn dockerfile:build -Pdocker
+```
+## Push Docker Image
+
+ By default, the docker image built above is configured to be pushed to [Drill Docker Hub](https://hub.docker.com/r/drill/apache-drill/) to create official Drill Docker images.
+```
+$ cd distribution
+$ mvn dockerfile:push -Pdocker
+```
+ You can configure the repository in pom.xml to point to any private or public container registry, or specify it in your mvn command.
+```
+$ cd distribution
+$ mvn dockerfile:push -Pdocker -Pdocker.repository=<my_repo>
+```
+## Run Docker Container
+
+ Running the Docker container should start Drill in embedded mode and connect to Sqlline.
+```
+$ docker run -i --name drill-1.14.0 -p 8047:8047 -t drill/apache-drill:1.14.0 /bin/bash
+Jun 29, 2018 3:28:21 AM org.glassfish.jersey.server.ApplicationHandler initialize
+INFO: Initiating Jersey application, version Jersey: 2.8 2014-04-29 01:25:26...
+apache drill 1.14.0
+"json ain't no thang"
+0: jdbc:drill:zk=local> select version from sys.version;
++------------+
+| version |
++------------+
+| 1.14.0 |
++------------+
+1 row selected (0.28 seconds)
+```
+
+ You can also run the container in detached mode and connect to sqlline using drill-localhost.
+```
+$ docker run -i --name drill-1.14.0 -p 8047:8047 --detach -t drill/apache-drill:1.14.0 /bin/bash
+<displays container ID>
+
+$ docker exec -it drill-1.14.0 bash
+<connects to container>
+
+$ /opt/drill/bin/drill-localhost
+apache drill 1.14.0
+"json ain't no thang"
+0: jdbc:drill:drillbit=localhost> select version from sys.version;
++------------+
+| version |
++------------+
+| 1.14.0 |
++------------+
+1 row selected (0.28 seconds)
+```
+
+## Querying Data
+
+ By default, you can only query files which are accessible within the container. For example, the sample data which ships with Drill.
+```
+> select first_name, last_name from cp.`employee.json` limit 1;
++-------------+------------+
+| first_name | last_name |
++-------------+------------+
+| Sheri | Nowmer |
++-------------+------------+
+1 row selected (0.256 seconds)
+```
+
+ To query files outside of the container, you can configure [docker volumes](https://docs.docker.com/storage/volumes/#start-a-service-with-volumes)
+
+## Drill Web UI
+
+ Drill web UI can be accessed using http://localhost:8047 once the Drill docker container is up and running. On Windows, you may need to specify the IP address of your system instead of 'localhost'.
+
+## More information
+
+ For more information including how to run Apache Drill in a Docker container, visit the [Apache Drill Documentation](http://drill.apache.org/docs/)
diff --git a/pom.xml b/pom.xml
index 56582c316..e1954340e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -87,6 +87,7 @@
<additionalparam>-Xdoclint:none</additionalparam>
<rat.skip>true</rat.skip>
<license.skip>true</license.skip>
+ <docker.repository>drill/apache-drill</docker.repository>
</properties>
<scm>