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>

1 files changed, 27 insertions, 20 deletions

diff --git a/ansible/group_vars/all.yml b/ansible/group_vars/all.yml
index d2385f65..dbb05205 100755
--- a/ansible/group_vars/all.yml
+++ b/ansible/group_vars/all.yml
@@ -5,15 +5,18 @@
 
 # Resource host information
 
-# folder on resource host where tars with resources are present
+# Directory on resource host where tars with resources are present
 resources_dir:
 
-# tarfile name within this folder with offline infrastructure sw
+# tarfile name within resources_dir directory with offline infrastructure binaries.
+# Content of APP_BINARY_RESOURCES_DIR (defined in package.conf) packaged by package.sh to single tar file.
 resources_filename:
 
+# tarfile name within resources_dir directory with auxiliary resources.
+# Content of APP_AUX_BINARIES (defined in package.conf) packaged by package.sh to single tar file.
 # the purpose of auxiliary resources is to provide user an interface
-# of how to distribute to infra node another big tar which might be
-# usefull later on in application playbooks, optional param
+# to distribute to infra node tar file with application specific files.
+# Docker images in tar format are currently the only supported content of aux_resources package.
 aux_resources_filename:
 
 # resources can be exported via nfs
@@ -23,14 +26,17 @@ resources_on_nfs: no
 
 # Infra node specific information
 
-# offline solution source data binaries will be decompressed in following dir on infra
+# Offline solution source data binaries (resources_filename tar) will be
+# decompressed in this directory on target infra server.
 # e.g. app_data_path: /opt/onap
 app_data_path:
 
-# additional data path for auxiliary data transfer
-# e.g. aux_data_path: /opt/onap/onap_me_docker_images
-aux_data_path:
-
+# Path for auxiliary data in target infra server.
+# Data from resource host defined by aux_resources_filename variable is placed to this directory.
+# Currently docker images in tar format are supported (see runtime_images parameter).
+# Could be used for other kind of application specific data also.
+# e.g. aux_data_path: /opt/onap/my_extra_pods_docker_images
+aux_data_path: "{{ app_data_path }}/runtime_images_source_dir"
 
 
 ##########################################
@@ -62,24 +68,24 @@ deploy_rpm_repository: yes
 # e.g. app_name: ONAP
 app_name:
 
-# as nexus blob is prepopulated during build time following block
-# of runtime_images code provides an alternative way how to insert
-# specified images into nexus during infrastructure playbook execution
-# images specified in there must be available inside aux_resources_filename
-# tar file
+# runtime_images provides an way to insert docker images
+# into nexus during infrastructure playbook execution (populated to nexus at runtime).
+# images specified must be available inside aux_resources_filename
+# tar file that is extracted by installer into aux_data_path directory in infra server.
+# Source format of an image is .tar file in aux_data_path directory and all .tar
+# files in that dir are checked to match runtime_images definition.
 # if runtime_images are not specified nothing is inserted on top of existing
-# prebuilt nexus blob in installation time
-# Component name must match with tar filename
+# prebuilt nexus blob in installation time.
+# Component name must match with tar filename!
 # e.g.
 # aaa-component-0.0.1.tar is expected in aux_data_path for aaa-component image
 #runtime_images:
-  #  aaa-component-0.0.1:
+#    aaa-component-0.0.1:
 #    registry: "nexus3.onap.org:10001"
 #    path:     "/onap/components/aaa-component"
 #    tag:      "latest"
 runtime_images:
 
-
 ###############################
 # Application specific params #
 ###############################
@@ -102,8 +108,9 @@ project_configuration:
 # script!
 app_helm_charts_install_directory: "/ansible/application/helm_charts"
 
-# to specify target dir where helm charts should be copied into on infra node
-# this should be directory with all charts and Makefile
+# Specify target dir where helm charts are copied into on infra node.
+# (same as content of "app_helm_charts_install_directory" copied by installer to this dir.)
+# This must be directory with all charts and Makefile.
 # e.g. app_helm_charts_infra_directory: "{{ app_data_path }}/helm_charts"
 app_helm_charts_infra_directory: "{{ app_data_path }}/helm_charts"