Samuli Silvius | fe11111 | 2019-02-05 09:45:24 +0200 | [diff] [blame] | 1 | # For the packaging script it is expected that all artifacts are present on local file system. |
| 2 | # Artifacts include: |
| 3 | # - installer source code (this git repository content) |
| 4 | # - all binary artifacts pre-downloaded from internet (docker images, rpm packages, npm packages, Maven artifacts etc.) |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 5 | # Script will create 3 packages: |
| 6 | # offline-${PROJECT_NAME}-${PROJECT_VERSION}-sw.tar |
| 7 | # - installer code (ansible dir in this git repo) |
| 8 | # - Files/dirs defined by APP_CONFIGURATION if any. |
| 9 | # - Directory content of HELM_CHARTS_DIR if defined. |
| 10 | # offline-${PROJECT_NAME}-${PROJECT_VERSION}-resources.tar |
| 11 | # - Directory content of APP_BINARY_RESOURCES_DIR if defined. |
| 12 | # offline-${PROJECT_NAME}-${PROJECT_VERSION}-aux-resources.tar |
| 13 | # - Files defined by APP_AUX_BINARIES if any. |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 14 | |
| 15 | ########################### |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 16 | # Application Helm charts # |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 17 | ########################### |
| 18 | |
Samuli Silvius | fe11111 | 2019-02-05 09:45:24 +0200 | [diff] [blame] | 19 | # Provide application installed to Kubernetes cluster. Helm chart is the supported format https://helm.sh/. |
| 20 | # Directory provided here must contain all the Chart directories of the application (https://docs.helm.sh/developing_charts/#charts) and Makefile. |
| 21 | # E.g. in case of ONAP oom repo it will be the content of kubernetes directory. |
| 22 | # NOTE: Leaving this variable commented out will mean that no Helm application will be installed to |
| 23 | # offline Kubernetes cluster. This may be sometimes wanted. |
Samuli Silvius | 6e5b45a | 2019-02-04 12:52:20 +0200 | [diff] [blame] | 24 | #HELM_CHARTS_DIR=~/myclones/casablanca_oom/ |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 25 | |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 26 | ##################################### |
| 27 | # Application install configuration # |
| 28 | ##################################### |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 29 | |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 30 | # APP_CONFIGURATION array variable can be used to provide files/directories |
| 31 | # into sw package available for the Ansible process to consume. |
| 32 | # The main configuration for you application is a yml file |
| 33 | # "application_configuration.yml" (name of file can be anything) where user |
| 34 | # need to provide values to control ansible installer process. Yml file is given |
| 35 | # as command line parameter to ansible run. |
| 36 | # See more from UserGuide documentation (LINK HERE) how to use installer. |
| 37 | # Available configuration parameters user can configure is seen from group_vars files: |
| 38 | # ansible/group_vars/all.yml |
| 39 | # ansible/group_vars/infrastucture.yml |
| 40 | # ansible/group_vars/kubernetes.yml |
| 41 | # Additionally user can optionally provide own ansible roles code to customize install process. |
| 42 | # At the moment 2 custom ansible roles are supported pre and post install roles, which are |
| 43 | # run by installer prior Helm install and after Kubernetes app has been installed. |
| 44 | # In application_configuration.yml those role names are configured with variables: |
| 45 | # application_pre_install_role: my-pre-install-role |
| 46 | # application_post_install_role: my-post-install-role |
| 47 | # And according to Ansible functionality, roles' code must be placed to directories |
| 48 | # with the same name. |
| 49 | #APP_CONFIGURATION=( |
| 50 | # <offline-installer-clone>/config/application_configuration.yml |
| 51 | # <offline-installer-clone>/patches/onap-casablanca-patch-role |
| 52 | # ~/myappfiles/my-post-install-role |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 53 | #) |
| 54 | |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 55 | # APP_BINARY_RESOURCES_DIR is variable to directory containing directories and files for offline |
| 56 | # installer infra and the the application run in that infra. |
| 57 | # Currently mixed with infra and app binaries to same, maybe to be separated in the future. |
| 58 | # Following directories and files are expected: |
| 59 | # downloads ... directory with exacutable binaries for offline infra usage (e.g. rancher, kubectl, jq, helm) |
| 60 | # git-repo ... directory with git repos for application needs to be simulated |
| 61 | # http ... directory with http simulation files (e.g. Maven artifacts are simulated here) |
| 62 | # offline_data ... directory with offline infra specific docker images |
| 63 | # pkg ... directory with rpm/deb packages mainly for offline infra |
| 64 | # nexus_data.tar ... tar file with pre-generated nexus blobs containing e.g. docker images for the application. |
| 65 | #APP_BINARY_RESOURCES_DIR=~/myappfiles/all_binaries |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 66 | |
Samuli Silvius | 426e6c0 | 2019-02-06 11:25:01 +0200 | [diff] [blame^] | 67 | # APP_AUX_BINARIES is array variable for additional application files. |
| 68 | # Docker images supported currently in tar format. |
| 69 | #APP_AUX_BINARIES=( |
| 70 | # ~/myappfiles/docker_images_populated_runtime/aaa-component-0.0.1.tar |
| 71 | # ~/myappfiles/docker_images_populated_runtime/xyz-component-0.0.1.tar |
Petr Ospalý | 170d94b | 2018-12-20 16:40:58 +0100 | [diff] [blame] | 72 | #) |