Repository: incubator-eagle Updated Branches: refs/heads/master 296b14579 -> 403e959d8
[EAGLE-64] Push eagle docker image to docker hub https://issues.apache.org/jira/browse/EAGLE-64 Author: h...@apache.org Reviewer: h...@apache.org Closes #15 from haoch:EAGLE-64 Project: http://git-wip-us.apache.org/repos/asf/incubator-eagle/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-eagle/commit/403e959d Tree: http://git-wip-us.apache.org/repos/asf/incubator-eagle/tree/403e959d Diff: http://git-wip-us.apache.org/repos/asf/incubator-eagle/diff/403e959d Branch: refs/heads/master Commit: 403e959d80b4a71455a31ab8931ac8804c026295 Parents: 296b145 Author: Hao Chen <h...@apache.org> Authored: Thu Dec 3 15:34:11 2015 +0800 Committer: Hao Chen <h...@apache.org> Committed: Thu Dec 3 15:34:11 2015 +0800 ---------------------------------------------------------------------- README.md | 23 ++++++++++--- eagle-external/eagle-docker/README.md | 55 +++++++++++++++++++++++++----- 2 files changed, 66 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/403e959d/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 480538d..4ded494 100755 --- a/README.md +++ b/README.md @@ -29,12 +29,24 @@ For more details, please visit [https://eagle.incubator.apache.org](https://eagl You can find the latest Eagle documentation on the [https://eagle.incubator.apache.org](https://eagle.incubator.apache.org/docs). This [README](README) file only contains basic setup instructions. ## Getting Started -The fastest way to get started with Eagle is using [eagle-docker](eagle-external/eagle-docker) (require docker environment) +The fastest way to get started with Eagle is to run with [docker](https://github.com/docker/docker) by one of following options: - git clone https://github.com/apache/incubator-eagle.git - incubator-eagle/eagle-docker boot +* Pull latest eagle docker image from [docker hub](https://hub.docker.com/r/apacheeagle/sandbox/) directly: -As an alternative option, you could install eagle package in sandbox manualy (see [https://eagle.incubator.apache.org/docs/deployment-in-sandbox.html](https://eagle.incubator.apache.org/docs/deployment-in-sandbox.html)) + docker pull apacheeagle/sandbox + + Deploy eagle in n-nodes (1 node by default) cluster + + wget https://raw.githubusercontent.com/apache/incubator-eagle/master/eagle-external/eagle-docker/bin/eagle-lib.sh + source eagle-lib.sh + eagle-deploy-cluster 1 + +* Build eagle docker image from source code with [eagle-docker](eagle-external/eagle-docker) tool. + + git clone https://github.com/apache/incubator-eagle.git + cd incubator-eagle && ./eagle-docker boot + +As another alternative option, you could [install eagle package in sandbox](https://eagle.incubator.apache.org/docs/deployment-in-sandbox.html) manualy as well. ## Building Eagle Eagle is built using [Apache Maven](https://maven.apache.org/). To build Eagle, run: @@ -47,5 +59,8 @@ After successfully building, you will find eagle binary tarball under _eagle-ass The fastest way to get response from eagle community is to send email to the mail list [d...@eagle.incubator.apache.org](mailto:d...@eagle.incubator.apache.org), and remember to subscribe our mail list via [dev-subscr...@eagle.incubator.apache.org](mailto:dev-subscr...@eagle.incubator.apache.org) +## FAQ +[https://cwiki.apache.org/confluence/display/EAG/FAQ](https://cwiki.apache.org/confluence/display/EAG/FAQ) + ## License Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). More details, please refer to [LICENSE](LICENSE) file. http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/403e959d/eagle-external/eagle-docker/README.md ---------------------------------------------------------------------- diff --git a/eagle-external/eagle-docker/README.md b/eagle-external/eagle-docker/README.md index e3d35dc..2f7ed3e 100644 --- a/eagle-external/eagle-docker/README.md +++ b/eagle-external/eagle-docker/README.md @@ -1,14 +1,50 @@ +<!-- +{% comment %} +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. +{% endcomment %} +--> + # Eagle in Docker -> Docker image for Apache Eagle http://eagle.incubator.apache.org +> Docker image for Apache Eagle https://hub.docker.com/r/apacheeagle/sandbox This is docker container for eagle to help users to have a quick preview about eagle features. And this project is to build apache/eagle images and provide eagle-functions to start the containers of eagle. ## Prerequisite -* Docker environment (see [https://www.docker.com](https://www.docker.com/)) +* [Apache Maven](https://maven.apache.org) +* [NPM](https://www.npmjs.com) +* [Docker](https://www.docker.com) + * [Mac OS X](http://docs.docker.com/mac/started) + * [Linux](http://docs.docker.com/linux/started) + * [Windows](http://docs.docker.com/windows/started) + +## Getting Started +The fastest way to get started with Eagle is to run with [docker](https://github.com/docker/docker) by one of following options: + +* Pull latest eagle docker image from [docker hub](https://hub.docker.com/r/apacheeagle/sandbox/) directly: + + docker pull apacheeagle/sandbox -## CLI Usage ## +* Build eagle docker image from source code with [eagle-docker](eagle-external/eagle-docker) + + git clone https://github.com/apache/incubator-eagle.git + cd incubator-eagle && ./eagle-docker boot + +## Usage ## Basic usage of the entry script of eagle-docker: [bin/eagle-docker.sh](bin/eagle-docker.sh) Usage: ./eagle-docker [options] [command] @@ -29,18 +65,18 @@ Basic usage of the entry script of eagle-docker: [bin/eagle-docker.sh](bin/eagle --node [num] Docker instances node number, default is 1 --help Display eagle docker image usage information -## Advanced Commands +## Advanced 1. **Build Image**: Go to the root directory where the [Dockerfile](Dockerfile) is in, build image with following command: - docker built -t apache/eagle:0.1.0 . + docker built -t apacheeagle/sandbox . - > The docker image is named `apache/eagle`. Eagle docker image is based on [`ambari:1.7.0`](https://github.com/sequenceiq/docker-ambari), it will install ganglia, hbase,hive,storm,kafka and so on in this image. Add startup script and buleprint file into image. + > The docker image is named `apacheeagle/sandbox`. Eagle docker image is based on [`ambari:1.7.0`](https://github.com/sequenceiq/docker-ambari), it will install ganglia, hbase,hive,storm,kafka and so on in this image. Add startup script and buleprint file into image. -2. **Verify Image**: After building the `apache/eagle` image successfully, verify the images and could find eagle image. +2. **Verify Image**: After building the `apacheeagle/sandbox` image successfully, verify the images and could find eagle image. docker images -3. **Deploy Image**: This project also provides helper functions in script [eagle-functions](eagle-functions) for convenience. +3. **Deploy Image**: This project also provides helper functions in script [eagle-lib.sh](bin/eagle-lib.sh) for convenience. # Firstly, load the helper functions into context source eagle-functions @@ -71,5 +107,8 @@ Basic usage of the entry script of eagle-docker: [bin/eagle-docker.sh](bin/eagle The fastest way to get response from eagle community is to send email to the mail list [d...@eagle.incubator.apache.org](mailto:d...@eagle.incubator.apache.org), and remember to subscribe our mail list via [dev-subscr...@eagle.incubator.apache.org](mailto:dev-subscr...@eagle.incubator.apache.org) +## FAQ +[https://cwiki.apache.org/confluence/display/EAG/FAQ#FAQ-EagleDocker](https://cwiki.apache.org/confluence/display/EAG/FAQ#FAQ-EagleDocker) + ## License Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). More details, please refer to [LICENSE](LICENSE) file.