Repository: incubator-distributedlog Updated Branches: refs/heads/master a5dd5adce -> 71090570d
DL-25: Documentation for vagrant and docker deployment Author: arvindkandhare <[email protected]> Reviewers: Franck Cuny <[email protected]>, Sijie Guo <[email protected]> Closes #3 from arvindkandhare/arvind_master and squashes the following commits: 812acaf [arvindkandhare] Steps to create and use docker container df8a7db [arvindkandhare] Docs explaining vagrant deployment 8d3350a [arvindkandhare] Create vagrant.rst b1ec1e3 [arvindkandhare] Create docker.rst 3644d24 [arvindkandhare] Merge pull request #1 from arvindkandhare/arvind_master Project: http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/commit/71090570 Tree: http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/tree/71090570 Diff: http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/diff/71090570 Branch: refs/heads/master Commit: 71090570d636048526d660da49948fe9d6bcb097 Parents: a5dd5ad Author: arvindkandhare <[email protected]> Authored: Tue Aug 16 20:12:27 2016 -0700 Committer: Franck Cuny <[email protected]> Committed: Tue Aug 16 20:12:27 2016 -0700 ---------------------------------------------------------------------- docs/operations/docker.rst | 36 ++++++++++++++++++++++++++++++++++++ docs/operations/vagrant.rst | 18 ++++++++++++++++++ 2 files changed, 54 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/71090570/docs/operations/docker.rst ---------------------------------------------------------------------- diff --git a/docs/operations/docker.rst b/docs/operations/docker.rst new file mode 100644 index 0000000..c9bd921 --- /dev/null +++ b/docs/operations/docker.rst @@ -0,0 +1,36 @@ +Deploying distributed log using docker +====================================== + +Prerequesites: +------------ +1. Docker + +Steps: +------ +1. Create a snapshot using + +``` +./scripts/snapshot +``` + +2. Create your own docker image using + +``` +docker build -t <your image name> . +``` + +3. You can run the docker container using + +``` +docker run -e ZK_SERVERS=<zk server list> -e DEPLOY_BK=<true|false> -e DEPLOY_WP=<true|false> <your image name> +``` + +Environment variables +---------------------- + +Following are the environment variables which can change how the docker container runs. + +1. ZK_SERVERS: ZK servers running exernally (the container does not run a zookeeper) +2. DEPLOY_BOTH: Deploys writeproxies as well as the bookies +3. DEPLOY_WP: Flag to notify that a writeproxy needs to be deployed +4. DEPLOY_BK: Flag to notify that a bookie needs to be deployed http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/71090570/docs/operations/vagrant.rst ---------------------------------------------------------------------- diff --git a/docs/operations/vagrant.rst b/docs/operations/vagrant.rst new file mode 100644 index 0000000..70e6fb0 --- /dev/null +++ b/docs/operations/vagrant.rst @@ -0,0 +1,18 @@ +Sample Deployment using vagrant +================================ + +This file explains vagrant deployment. + +Prerequesites +-------------- +1. Vagrant: From https://www.vagrantup.com/downloads.html +2. vagrant-hostmanager plugin: From https://github.com/devopsgroup-io/vagrant-hostmanager + +Steps +----- +1. Create a snapshot using ./scripts/snapshot +2. Run vagrant up from the root directory of the enlistment +3. Vagrant brings up a zookeepers with machine names: zk1,zk2, .... with IP addresses 192.168.50.11,192.168.50.12,.... +4. Vagrant brings the bookies with machine names: node1,node2, ... with IP addresses 192.168.50.51,192.168.50.52,.... +5. The script will also start writeproxies at distributedlog://$PUBLIC_ZOOKEEPER_ADDRESSES/messaging/distributedlog/mynamespace as the namespace. If you want it to point to a different namespace/port/shard, please update the ./vagrant/bk.sh script. +6. If you want to run the client on the host machine, please add these node names and their IP addresses to the /etc/hosts file on the host.
