diff options
| author |   Samuli Silvius <s.silvius@partner.samsung.com> | 2019-02-06 11:25:01 +0200 |
|---|---|---|
| committer | Samuli Silvius <s.silvius@partner.samsung.com> | 2019-02-12 09:37:14 +0200 |
| commit | 426e6c09fe0c8a0d0c35631231f023eaf8823775 (patch) | |
| tree | 0b807ac6e1d50ab7203eec6be18702778a6612fa /doc | |
| parent | fe111116be4128a9fb90d175c38e0aa955e7e33f (diff) | |
Clarify packaging variables documentation
For the user package.sh/package.conf is a bit confusing
and variables are not well named nor documented.
Binary definition can be also simplified by providing
just single directory to take binaries from.
Corresponding variable documentation on installer
side (ansible code) is also confusing and missing
relation to packaging variables
This commit aims on improving that documentation.
Issue-ID: OOM-1633
Change-Id: I81261f51d393f434eac26c4a46624388671bd36b
Signed-off-by: Samuli Silvius <s.silvius@partner.samsung.com>
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/BuildGuide.rst | 23 |
1 files changed, 9 insertions, 14 deletions
diff --git a/doc/BuildGuide.rst b/doc/BuildGuide.rst index 6e36b253..a06180e0 100755 --- a/doc/BuildGuide.rst +++ b/doc/BuildGuide.rst @@ -305,23 +305,19 @@ For the packagin itself it's necessary to prepare configuration. You can use ./onap/install/onap-offline/build/package.conf as template or directly modify it. -There are some parameters needs to be set in configuration file and some -are optional: +There are some parameters needs to be set in configuration file. +---------------------------------------+------------------------------------------------------------------------------+ | Parameter | Description | +=======================================+==============================================================================+ -| SOFTWARE\_PACKAGE\_BASENAME | defines package name prefix (e.g. onap-offline) | +| HELM\_CHARTS\_DIR | directory with Helm charts for the application | +---------------------------------------+------------------------------------------------------------------------------+ -| HELM\_CHARTS\_DIR | oom directory from oom git repostitory | +| APP\_CONFIGURATION | application install configuration (application_configuration.yml) for | +| | ansible installer and custom ansible role code directories if any | +---------------------------------------+------------------------------------------------------------------------------+ -| SW\_PACKAGE\_ADDONS | specific entries which are inserted into ./ansible/application | +| APP\_BINARY\_RESOURCES\_DIR | directory with all (binary) resources for offline infra and application | +---------------------------------------+------------------------------------------------------------------------------+ -| EXTERNAL\_BINARIES\_PACKAGE\_ADDONS | other addons used as resources | -+---------------------------------------+------------------------------------------------------------------------------+ -| PREPARE\_AUX\_PACKAGE | boolean condition if prepare AUX package [optional] | -+---------------------------------------+------------------------------------------------------------------------------+ -| AUX\_BINARIES\_PACKAGE\_ADDONS | additional binaries such as docker images loaded during runtime [optional] | +| APP\_AUX\_BINARIES | additional binaries such as docker images loaded during runtime [optional] | +---------------------------------------+------------------------------------------------------------------------------+ Offline installer packages are created with prepopulated data via @@ -336,9 +332,8 @@ E.g. So in the target directory you should find tar files with -<PACKAGE\_BASE\_NAME>-<PROJECT\_NAME>-<PROJECT\_VERSION>-sw.tar +offline-<PROJECT\_NAME>-<PROJECT\_VERSION>-sw.tar -<PACKAGE\_BASE\_NAME>-<PROJECT\_NAME>-<PROJECT\_VERSION>-resources.tar +offline-<PROJECT\_NAME>-<PROJECT\_VERSION>-resources.tar -Optionally: -<PACKAGE\_BASE\_NAME>-<PROJECT\_NAME>-<PROJECT\_VERSION>-aux-resources.tar +offline-<PROJECT\_NAME>-<PROJECT\_VERSION>-aux-resources.tar |