You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hivemall.apache.org by takuti <gi...@git.apache.org> on 2017/05/18 23:01:57 UTC
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
GitHub user takuti opened a pull request:
https://github.com/apache/incubator-hivemall/pull/81
[HIVEMALL-84-3] Update docker-compose.yml and documents
## What changes were proposed in this pull request?
I tried things written in the Docker on Hivemall documentation and noticed a couple of things we can improve.
- Update `docker-compose.yml` to behave in a similar manner to `docker run`
- Update Docker on Hivemall documentation
## What type of PR is it?
Documentation
## What is the Jira issue?
https://issues.apache.org/jira/browse/HIVEMALL-84
## How was this patch tested?
Manually
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/takuti/incubator-hivemall docker
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-hivemall/pull/81.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #81
----
commit e03f2fa65965eb7dc7441b4a8f68fe251cab0e61
Author: Takuya Kitazawa <k....@gmail.com>
Date: 2017-05-18T22:00:50Z
Fix docker-compose.yml to behave similarly to `docker run`
commit e071eda83e359d824391ed895e0a9059ba31fcfe
Author: Takuya Kitazawa <k....@gmail.com>
Date: 2017-05-18T22:54:15Z
Update docker doc
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117604997
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
owner is used for repository.
repository is used for branch.
tag is used for versioning.
hivemall:release:v0.5-rc.1
hivemall:lastest:20170502-1
hivemall:spark:20170501
owner: hivemall is used only for hivemall. So, okey as it is.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117680849
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
@amaya382 @takuti official Dockerhub can only be used for official Apache releases.
See discussions in
https://issues.apache.org/jira/browse/INFRA-14123?jql=project%20%3D%20INFRA%20AND%20text%20~%20dockerhub
Unofficial docker images better not be advertised officially...
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by coveralls <gi...@git.apache.org>.
Github user coveralls commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
[](https://coveralls.io/builds/11641920)
Coverage increased (+0.3%) to 39.027% when pulling **9e9227bcf11457455a7f7ed95391dce8943ec2d8 on takuti:docker** into **10e7d450fa8257efc5d614957fda514b2b91fdee on apache:master**.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
will check soon.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117606391
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
It's redundant but depart from docker's usual practice...
e.g.
* automated build uses branch or tag (on git) as tag (on docker)
* if become an official repository or under apache, its name will be broken
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-hivemall/pull/81
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
@amaya382 Fixed document, thanks!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
@amaya382 could you check this if you get a chance?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by coveralls <gi...@git.apache.org>.
Github user coveralls commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
[](https://coveralls.io/builds/11593403)
Coverage remained the same at 38.694% when pulling **e071eda83e359d824391ed895e0a9059ba31fcfe on takuti:docker** into **10e7d450fa8257efc5d614957fda514b2b91fdee on apache:master**.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117462083
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
--- End diff --
typo `--volume`. as an other choice, `-v` would be easier
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117882848
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
Even only for release, it sounds nice. Let's try it in the next (first) apache release if possible :)
For now, I've updated the description of the Docker Hub image. I keep the part, but mentioned that the distributed image might be out-of-data. Is it okay for you @myui @amaya382 ?
In terms of naming, it should be re-considered when we officially distribute an image according to ASF release.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117463834
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
This repository is in the wrong way, must be fixed its name as `hivemall` and its tag as version (`{owner}/{repository}:{tag}`, like `hivemall/hivemall:latest` or `hivemall/hivemall:0.4.2-rc.2`).
And if distribute image via dokcerhub, we should prepare automated build to retain consistency and integrity.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
@takuti looks good!
Let's reconsider in other issue/PR
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117603712
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
Ah, I see. This part is written by @myui in commit 10e7d450fa8257efc5d614957fda514b2b91fdee.
Hi @myui, could you make further discussion in here or another issue? I guess this part was temporarily necessary for the BoF session of the Apache BigData conf.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
Even only for release, it sounds nice. Let's try it in the next (first) apache release if possible :)
For now, I've updated the description of the Docker Hub image. I keep the part, but mentioned that the distributed image might be out-of-data. Is it okay for you @myui @amaya382 ?
In terms of naming, it should be re-considered when we officially distribute an image according to ASF release.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
@myui ^ everything is okay?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by coveralls <gi...@git.apache.org>.
Github user coveralls commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
[](https://coveralls.io/builds/11612253)
Coverage remained the same at 38.694% when pulling **1dd46e2a6283b61eb31ef5beb65c52b745313eb2 on takuti:docker** into **10e7d450fa8257efc5d614957fda514b2b91fdee on apache:master**.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by coveralls <gi...@git.apache.org>.
Github user coveralls commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
[](https://coveralls.io/builds/11641920)
Coverage increased (+0.3%) to 39.027% when pulling **9e9227bcf11457455a7f7ed95391dce8943ec2d8 on takuti:docker** into **10e7d450fa8257efc5d614957fda514b2b91fdee on apache:master**.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by takuti <gi...@git.apache.org>.
Github user takuti commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117603729
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
Or, if @amaya382 can set up this, it would be nice after this PR has been merged.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117687709
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
It seems better to distribute TAGGED images on docker hub (`apache/hivemall`) by automated build and distributing NOT TAGGED ones should depend on manual build from Dockerfile.
(The former for evaluation by user, the latter for developer)
http://www.apache.org/dev/release-distribution.html#unreleased
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117716977
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
We can only publish TAGGED image associated with ASF official release. CI release is not allowed in ASF distribution policies.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
Created https://issues.apache.org/jira/browse/HIVEMALL-106
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall issue #81: [HIVEMALL-84-3] Update docker-compose.yml and ...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on the issue:
https://github.com/apache/incubator-hivemall/pull/81
LGTM. Merged to master. Thanks!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by amaya382 <gi...@git.apache.org>.
Github user amaya382 commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117490789
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
--- End diff --
`...-in-docker-hub` ?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hivemall pull request #81: [HIVEMALL-84-3] Update docker-compose.y...
Posted by myui <gi...@git.apache.org>.
Github user myui commented on a diff in the pull request:
https://github.com/apache/incubator-hivemall/pull/81#discussion_r117606427
--- Diff: docs/gitbook/docker/getting_started.md ---
@@ -31,38 +31,73 @@ This page introduces how to run Hivemall on Docker.
# 1. Build image
-## Build using docker-compose
+You have two options in order to build a **hivemall** docker image:
+
+## Using `docker-compose`
- `docker-compose -f resources/docker/docker-compose.yml build`
+```
+$ docker-compose -f resources/docker/docker-compose.yml build
+```
-## Build using docker command
+## Using `docker` command
- `docker build -f resources/docker/Dockerfile .`
+```
+$ docker build -f resources/docker/Dockerfile .
+```
> #### Note
-> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using existing Docker images.
+> You can [skip](./getting_started.html#running-pre-built-docker-image-in-dockerhub) building images by using a pre-build docker image from Docker Hub.
# 2. Run container
-## Run by docker-compose
+If you built an image by yourself, it can be launched by either `docker-compose` or `docker` command:
+
+## By `docker-compose`
+
+```
+$ docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall
+```
+
+You can edit `resources/docker/docker-compose.yml` as needed.
+
+For example, setting `volumes` options enables to mount your local directories to the container as follows:
- 1. Edit `resources/docker/docker-compose.yml`
- 2. `docker-compose -f resources/docker/docker-compose.yml up -d && docker attach hivemall`
+```yml
+volumes:
+ - "../../:/opt/hivemall/" # mount current hivemall dir to `/opt/hivemall` ($HIVEMALL_PATH) on the container
+ - "/path/to/data/:/root/data/" # mount resources to container-side `/root/data` directory
+```
-## Run by docker command
+## By `docker` command
- 1. Find a local docker image by `docker images`.
- 2. Run `docker run -it ${docker_image_id}`.
- Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+Find a local docker image by `docker images`, and hit:
-## Running pre-built Docker image in Dockerhub
+```
+$ docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it ${docker_image_id}
+```
- 1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first.
- 2. Pull pre-build docker image from Dockerhub `docker pull hivemall/latest:20170517`
- 3. `docker run -p 8088:8088 -p 50070:50070 -p 19888:19888 -it hivemall/latest:20170517`
+Refer [Docker reference](https://docs.docker.com/engine/reference/run/) for the command detail.
+
+Similarly to the `volumes` option in the `docker-compose` file, `docker run` has `--volumes` option:
+
+```
+$ docker run ... --volume /path/to/local/hivemall:/opt/hivemall
+```
+
+## Running pre-built Docker image in Docker Hub
You can find pre-built Hivemall docker images in [this repository](https://hub.docker.com/r/hivemall/latest/).
+1. Check [the latest tag](https://hub.docker.com/r/hivemall/latest/tags/) first
--- End diff --
I'll ask for ASF INFRA to get an access to https://hub.docker.com/u/apache/
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---