diff --git a/docs/developer-env.md b/docs/developer-env.md new file mode 100644 index 0000000000..ab2ee33a6b --- /dev/null +++ b/docs/developer-env.md @@ -0,0 +1,43 @@ +# Developer env + +The basic starting enviroment will be created using `docker-compose`. +This environment will start up the openstack services listed in the +compose directory. + +To start, setup your environment variables. + + $ cd kolla + $ ./tools/genenv.sh + +The `genenv.sh` script will create an openstack.env file +and an openrc file in your current directory. The openstack.env +file contains all of your initialized environment variables, which +you can edit for a different setup. + +Next, run the start script. + + $ ./start.sh + +The `start.sh` script is responsible for starting the containers +using `docker-compose -f up -d`. + +If you want to start a container set by hand use this template + + $ docker-compose -f glance-api-registry.yml up -d + +# Debug + +You can follow a container's status by doing + + $ sudo docker ps -a + +If any of the containers exited you can check the logs by doing + + $ sudo docker logs + $ docker-compose logs + +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 \ + --net=host + --env-file=openstack.env kollaglue/fedora-rdo-glance-api:latest