Adding docs for the source-repositories element

Change-Id: I57244a5cc2f563b2e69eb49388c3c6b49202c9eb
This commit is contained in:
Derek Higgins 2013-07-09 10:46:00 +01:00
parent 9a81644d65
commit 195053108b
2 changed files with 20 additions and 5 deletions

View File

@ -199,14 +199,15 @@ possible approach to this would be to label elements as either a "driver",
- An element that installs and configures Nova might be a bit more complex: - An element that installs and configures Nova might be a bit more complex:
elements/ elements/
service-nova/ service-nova/
source-repository-nova - register a source repository
pre-install.d/ pre-install.d/
50-my-ppa - add a PPA 50-my-ppa - add a PPA
install.d/ install.d/
10-user - common Nova user accts 10-user - common Nova user accts
50-my-pack - install packages from my PPA 50-my-pack - install packages from my PPA
60-nova - install nova and some dependencies 60-nova - install nova and some dependencies
first-boot.d/ first-boot.d/
60-nova - do some post-install config for nova 60-nova - do some post-install config for nova
- In the general case, configuration should probably be handled either by the - In the general case, configuration should probably be handled either by the
meta-data service (eg, during first-boot.d) or via normal CM tools meta-data service (eg, during first-boot.d) or via normal CM tools
@ -233,6 +234,13 @@ It should be noted that this is merely a naming convention to assist in
managing elements. Diskimage-builder is not, and should not be, functionally managing elements. Diskimage-builder is not, and should not be, functionally
dependent upon specific element names. dependent upon specific element names.
- diskimage-builder has the ability to retrieve source code for an element and
place it into a directory on the target image during the extra-data phase. The
default location/branch can then be overridden by the process running
diskimage-builder, making it possible to use the same element to track more
then one branch of a git repository or to get source for a local cache. See
elements/source-repositories/README.md for more information.
Debugging elements Debugging elements
------------------ ------------------

View File

@ -26,8 +26,15 @@ diskimage-builder which can change the details registered by the element, these
for example if you would like diskimage-builder to get ironic from a local for example if you would like diskimage-builder to get ironic from a local
mirror you could set DIB_REPOLOCATION_ironic=git://localgitserver/ironic.git mirror you could set DIB_REPOLOCATION_ironic=git://localgitserver/ironic.git
Alternatively if you would like to use the keystone element and build an image with
keystone from a stable branch then you would set DIB_REPOREF_keystone=stable/grizzly
Git sources will be cloned to \<destination\> Git sources will be cloned to \<destination\>
Tarballs will be extracted to \<destination\>. Tarballs should contain a Tarballs will be extracted to \<destination\>. Tarballs should contain a
single topleval directory, regardless of the name of this top level directory single topleval directory, regardless of the name of this top level directory
it will be renamed to \<destination\> it will be renamed to \<destination\>
If mulitple elements register a source location with the same <destination>
then source-repositories will exit with an error. Care should therefore be taken
to only use elements together that download source to different locations.