From 07f22a338861485a610db65d0d3a47df421414a7 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Thu, 1 Sep 2016 14:46:03 -0700 Subject: [PATCH] Document source glean installs in simple-init It is possible and often desired to install glean from a source repository when using the simple-init element. Document the process for doing this. Change-Id: Ie7c690406b14aae07d73261879b7ce8a2ed9dd8d --- elements/simple-init/README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/elements/simple-init/README.rst b/elements/simple-init/README.rst index b5ad1022..dd131d9f 100644 --- a/elements/simple-init/README.rst +++ b/elements/simple-init/README.rst @@ -33,3 +33,28 @@ not there. Finally, glean will handle ssh-keypair-injection from config drive if cloud-init is not installed. + +Chosing glean installation source +--------------------------------- + +By default glean is installed using pip using the latest release on pypi. +It is also possible to install glean from a specified git repository +location. This is useful for debugging and testing new glean changes +for example. To do this you need to set these variables:: + + DIB_INSTALLTYPE_simple_init=repo + DIB_REPOLOCATION_glean=/path/to/glean/repo + DIB_REPOREF_glean=name_of_git_ref + +For example to test glean change 364516 do:: + + git clone https://git.openstack.org/openstack-infra/glean /tmp/glean + cd /tmp/glean + git review -d 364516 + git checkout -b my-test-ref + +Then set your DIB env vars like this before running DIB:: + + DIB_INSTALLTYPE_simple_init=repo + DIB_REPOLOCATION_glean=/tmp/glean + DIB_REPOREF_glean=my-test-ref