diff --git a/docs/developer-env.md b/docs/developer-env.md index a1ba772a33c75b6266b577293f002539a7a76486..6a5c146608ea181c5d1ce0e932448212991949ec 100644 --- a/docs/developer-env.md +++ b/docs/developer-env.md @@ -1,4 +1,11 @@ -# Developer env +# Developer Environment + +If you are developing Kolla on an existing OpenStack cloud +that supports Heat, then follow the Heat template [README][]. +Otherwise, follow the instructions below to manually create +your Kolla development environment. + +[README]: https://github.com/stackforge/kolla/tree/version-m3/devenv/README.md In order to run Kolla, it is mandatory to run a version of `docker-compose` that includes pid: host support. One of the @@ -11,10 +18,12 @@ The pull request is: Until then, it must be retrieved via git and installed: - git pull http://github.com/sdake/fig + git clone http://github.com/sdake/fig cd fig - sudo pip install . + sudo pip install -e . sudo pip install -U docker-py + sudo pip install -e . + sudo pip install six==1.7.3 The docker-compose version available via the sdake repository has been rebased on to a master version of docker-compose which requires the @@ -23,10 +32,16 @@ packaging and is only available by building from source. Docker also distributes pre-built binaries for docker. It is recommended to just run the docker provided binaries rather then building from source: +If a version of Docker other than 1.5.0-dev is currently running +on your system, stop it: + sudo systemctl stop docker sudo killall -9 docker - curl https://master.dockerproject.com/linux/amd64/docker-1.5.0-dev -o docker-dev - sudo ./docker-dev -d + +Next, download and run the Docker 1.5.0-dev binary: + + wget https://master.dockerproject.com/linux/amd64/docker-1.5.0-dev -O docker + sudo ./docker -d & The basic starting environment will be created using `docker-compose`. This environment will start up the openstack services listed in the @@ -55,19 +70,22 @@ If you want to start a container set by hand use this template # Debug +All Docker commands should be run from the directory of the Docker binary, +by default this is `/`. + You can follow a container's status by doing - $ sudo docker ps -a + $ sudo ./docker ps -a If any of the containers exited you can check the logs by doing - $ sudo docker logs <glance-api-container> + $ sudo ./docker logs <glance-api-container> $ docker-compose logs <glance-api-container> If you want to start a individual service like `glance-api` by hand, then use this template. This is a good method to test and troubleshoot an individual container. - $ docker run --name glance-api -d \ + $ sudo ./docker run --name glance-api -d \ --net=host --env-file=openstack.env kollaglue/fedora-rdo-glance-api:latest