Echo to summary log file

This function should be used to send messages out to the summary log file which makes for good high level progress monitoring.

Stop at a specific phase

Use is DEPRECATED and will be removed once the refactor is done.

Normalize config values to True or False Accepts as False: 0 no No NO false False FALSE Accepts as True: 1 yes Yes YES true True TRUE VAR=$(trueorfalse default-value test-value)

git clone only if directory doesn't exist already. Since DEST might not be owned by the installation user, we create the directory and change the ownership to the proper user. Set global RECLONE=yes to simulate a clone when dest-dir exists Set global ERROR_ON_CLONE=True to abort execution with an error if the git repo does not exist (default is False, meaning the repo will be cloned). Uses globals ERROR_ON_CLONE, OFFLINE, RECLONE git_clone remote dest-dir branch

print out the results so we know what change was used in the logs

If our branch name is a gerrit style refs/changes/...

do a full clone only if the directory doesn't exist

This checkout syntax works for both branches and tags

if it does exist then simulate what clone does if asked to RECLONE

set the url to pull from and fetch

remove the existing ignored files (like pyc) as they cause breakage (due to the py files having older timestamps than our pyc, so python thinks the pyc files are correct using them)

handle git_ref accordingly to type (tag, branch)

print out the results so we know what change was used in the logs

git can sometimes get itself infinitely stuck with transient network errors or other issues with the remote end. This wraps git in a timeout/retry loop and is intended to watch over non-local git processes that might hang. GIT_TIMEOUT, if set, is passed directly to timeout(1); otherwise the default value of 0 maintains the status quo of waiting forever. usage: git_timed <git-command>

124 is timeout(1)'s special return code when it reached the timeout; otherwise assume fatal failure

git update using reference as a branch. git_update_branch ref

a local branch might not exist

git update using reference as a branch. git_update_remote_branch ref

git update using reference as a tag. Be careful editing source at that repo as working copy will be in a detached mode git_update_tag ref

fetching given tag only

Fetch Base Devstack

Get DevStack if it doesn't exist

Fetch Target Devstack

This depends on REQUIREMENTS_DIR being set in grenaderc, which it needs to be to have gotten this far.

When Python 3 is supported by an application, adding the specific version of Python 3 to this variable will install the app using that version of the interpreter instead of 2.7.

Load up a copy of the downloaded images if not present

dsconf is required only by this function and devstack_localrc but only when the base is installed by grenade. Moreover, when the deployment of base is not performed by grenade, installing devstack-tools just before creating the resources also updates pbr (at least from rocky->master) leading to an exception in running services using pbr methods (for example nova-conductor) probably because they are still looking for the old version.

Set up base localrc

if there is a localrc, make that a local.conf.orig and get rid of the artifact

Convert to a local.conf

if a local.conf exists, merge that into local.conf.orig (which we're going to remerge later)

put devstack.local.conf.target in place as local.conf

if local.conf.orig or localrc.orig exists, append it to local.conf

if devstack.local.conf exists append it to locarc

... time for TARGET

Set up target local.conf

if there is a localrc, make that a local.conf.orig and get rid of the artifact

Convert to a local.conf

if a local.conf exists, merge that into local.conf.orig (which we're going to remerge later)

put devstack.local.conf.target in place as local.conf

if local.conf.orig or localrc.orig exists, append it to local.conf

if devstack.local.conf exists append it to locarc