Refine application_pre_install_role variable usage 25/79625/6
authorBartek Grzybowski <b.grzybowski@partner.samsung.com>
Mon, 4 Mar 2019 14:34:19 +0000 (15:34 +0100)
committerBartek Grzybowski <b.grzybowski@partner.samsung.com>
Thu, 7 Mar 2019 10:54:19 +0000 (11:54 +0100)
As 'application_pre_install_role' variable set in
config/application_configuration.yml must stay in
sync with patch role directory name defined in
package.conf under APP_CONFIGURATION variable, it's
name shall stay under complete user control without
any variable as part of it's name.

App_helm_build_targets list and app_helm_chart_name
should default to 'onap' in application_configuration.yml
as customizing them isn't supported at the moment.

Also fixed some wording in comments/docs in relevant
files.

Change-Id: I82b6dd519fbc3426739a11fac1e02eb495a668c0
Issue-ID: OOM-1697
Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
ansible/.gitignore
ansible/application/README.md
ansible/group_vars/all.yml
build/package.conf
config/application_configuration.yml

index 521beaa..e5505c9 100644 (file)
@@ -1,2 +1,3 @@
 ansible_chroot
 application/*
+certs/
index d260b3c..36f69bd 100644 (file)
@@ -6,9 +6,10 @@ also on target server where package is installed.
 
 ## Application configuration
 
-All application related configuration variables are defined in file
-`application_configuration.yml` in this folder. The name of configuration file
-does not matter but it must be given to ansible run as command line variable file.
+All application related configuration variables are defined in the
+`application_configuration.yml` file in this folder. The name of the configuration
+file can be altered but it must be passed to ansible run as command line
+variable file nevertheless.
 
 Example:
 ```
@@ -26,12 +27,14 @@ Helm charts transfer from packaging up to the target infra server.
 ## Application specific roles
 
 Installer supports optional custom pre and post install roles. Custom roles' code folders
-are placed to this directory at packaging time and name of those folders are configured in
-application.yml with variable `application_pre_install_role` and `application_post_install_role`.
+are placed into this directory at packaging time and names of those folders shall be configured in
+application_configuration.yml with variable `application_pre_install_role` and `application_post_install_role`.
+Note that these directory names must correspond to those configured in APP_CONFIGURATION inside package.conf
+during package build time.
 
 Example:
 ```
-application_pre_install_role: "{{ app_name }}-patch-role"
+application_pre_install_role: "my-pre-install-role"
 ```
 
 ## Inventory hosts
index dc40238..8536395 100755 (executable)
@@ -113,7 +113,7 @@ app_helm_charts_infra_directory: "{{ app_data_path }}/helm_charts"
 
 # Main Helm chart to install
 # e.g. app_helm_chart_name: onap
-app_helm_chart_name: "{{ app_name }}"
+app_helm_chart_name:
 
 # Targets for helm charts repository build
 # e.g. for ONAP Casablanca
@@ -137,7 +137,7 @@ app_kubernetes_namespace: "{{ app_name }}"
 
 # Optional application custom Ansible roles name for pre and post install logic.
 # Location of additional custom roles is defined in ansible.cfg with roles_path.
-# e.g. application_pre_install_role: "{{ app_name }}-patch-role"
+# e.g. application_pre_install_role: "my-pre-install-role"
 application_pre_install_role:
 application_post_install_role:
 
index 29ca3cb..7d6a1b8 100644 (file)
@@ -30,12 +30,12 @@ HELM_CHARTS_DIR=/tmp/oom-clone/kubernetes
 
 # APP_CONFIGURATION array variable can be used to provide files/directories
 # into sw package available for the Ansible process to consume.
-# The main configuration for you application is a yml file
+# The main configuration file for your application is
 # "application_configuration.yml" (name of file can be anything) where user
-# need to provide values to control ansible installer process. Yml file is given
+# shall provide values to control ansible installer process. Yml file is given
 # as command line parameter to ansible run.
 # See more from UserGuide documentation (LINK HERE) how to use installer.
-# Available configuration parameters user can configure is seen from group_vars files:
+# Available configuration parameters user can configure are seen from group_vars files:
 #   ansible/group_vars/all.yml
 #   ansible/group_vars/infrastucture.yml
 #   ansible/group_vars/kubernetes.yml
@@ -46,10 +46,10 @@ HELM_CHARTS_DIR=/tmp/oom-clone/kubernetes
 #   application_pre_install_role: my-pre-install-role
 #   application_post_install_role: my-post-install-role
 # And according to Ansible functionality, roles' code must be placed to directories
-# with the same name.
+# with the same name:
 #APP_CONFIGURATION=(
 #    <offline-installer-clone>/config/application_configuration.yml
-#    <offline-installer-clone>/patches/onap-casablanca-patch-role
+#    <offline-installer-clone>/patches/my-pre-install-role
 #    ~/myappfiles/my-post-install-role
 #)
 APP_CONFIGURATION=(
index 25737ed..12dc13a 100755 (executable)
@@ -16,6 +16,6 @@ certificates:
   locality_name: Krakow
 app_helm_build_targets:
   - all
-  - "{{ app_name }}"
-application_pre_install_role: "{{ app_name }}-casablanca-patch-role"
-
+  - onap
+app_helm_chart_name: onap
+application_pre_install_role: "onap-casablanca-patch-role"