`os-refresh-config` README enhancement
Added explanation on phases. Change-Id: I7017134a4a80040c0ac66eba56b082c647fd5c17
This commit is contained in:
parent
36c4d8f252
commit
fb63aa10bd
32
README.rst
32
README.rst
|
@ -1,5 +1,27 @@
|
|||
Runs through all of the phases to ensure configuration is applied and
|
||||
enabled on a machine. Will exit with an error if any phase has a
|
||||
problem. Scripts should not depend on eachother having worked properly.
|
||||
Set ``OS_REFRESH_CONFIG_BASE_DIR`` environment variable to override the
|
||||
default
|
||||
=================
|
||||
os-refresh-config
|
||||
=================
|
||||
|
||||
`os-refresh-config` uses `dib-run-parts` to run scripts in a
|
||||
pre-defined set of directories::
|
||||
|
||||
/opt/stack/os-config-refresh/pre-configure.d
|
||||
/opt/stack/os-config-refresh/configure.d
|
||||
/opt/stack/os-config-refresh/migration.d
|
||||
/opt/stack/os-config-refresh/post-configure.d
|
||||
|
||||
`/opt/stack/os-config-refresh` is the default base directory. You can
|
||||
set `OS_REFRESH_CONFIG_BASE_DIR` environment variable to override the
|
||||
default one.
|
||||
|
||||
Its intended purpose is to separate scripts execution into 4 phases:
|
||||
|
||||
1. Quiesce(pre-configure.d),
|
||||
2. Configure(configure.d),
|
||||
3. Migrate(migration.d),
|
||||
4. Activate(post-configure.d).
|
||||
|
||||
It runs through all the phases above to ensure configuration is
|
||||
applied and enabled on a machine. It will exit with an error if any
|
||||
phase has a problem. The scripts in each phase should not depend on
|
||||
each other having worked properly.
|
||||
|
|
Loading…
Reference in New Issue