List of Gitlab Variables for mDIS
There are three main stages of gitlab-ci actions, "vanilla", "foundation", "blank".
- "vanilla" instance: 1:1 copy of IG Bremen codebase
- "foundation" instance: intermediate1, few customizations
- "blank" instance: intermediate2, almost finished (4. > "production" instance: final instance - live, tested, populated with data - not yet implemented)
For each of these stages a different set of config variables is needed. This is why the table below is so long.
Configuration page of these variables: see Settings Page (Admin Access needed).
Variables: Explanations and examplary values
Some Variable Names and Values might have changed meanwhile.
The true values and current values of these variables are sometimes different (in particular passwords and accesstokens), or might no longer be in use, or additional variables might exist:
| Key | Example Value | Explanation |
|---|---|---|
| BRANCH_CUSTOM | master--git-gfz--ci-cd | branch name where .gitlab-ci.yml file resides |
| BRANCH_BLANK | master--git-gfz--ci-cd | branch name where .gitlab-ci.yml file resides |
| CONTAINER_REGISTRY_HOST | git.gfz.de | where the container registry for mdisimages is located |
| CONTAINER_REGISTRY_USER | knb | user name for the container registry, with write access ("push") |
| DOCKERFILE_BASE | Dockerfile-php81-node18.dockerfile | Build instructions for the base image |
| DOCKERFILE_MDIS_CUSTOM | Dockerfile-mdis-foundation.dockerfile | Build instructions for the foundation image |
| DOCKERFILE_MDIS_BLANK | Dockerfile-mdis-blank.dockerfile | Build instructions for the blank image |
| DOCKER_REGISTRY_GROUP | icdp-osg | Account name for the container registry (use employee group instead of single user) |
| DOCKER_REGISTRY_GROUP_ACCESSTOKEN | eX2WK_______________ | Access token for the container registry (write, push) |
| DOCKER_REGISTRY_URL | git.gfz.de:5000 | URL of the container registry |
| GITHUB_TOKEN | github_pat_11AA_____ | a 3rd party file must be downloaded from Gihub(with Personal Token, anonymous accesses are capped) |
| MDIS_CUSTOM_DOMAIN | wb31.gfz.de | domain name for the "foundation" instance (intermediate1), testing on this host |
| MDIS_CUSTOM_INSTANCE_NAME | mdis-foundation | name of the foundation instance |
| MDIS_CUSTOM_PATH | mdis/foundation | URL path to the foundation instance |
| MDIS_FOUNDATION_NAME | php82_node18_mdis_foundation | name of the "foundation" Yii2/PHP image |
| MDIS_BLANK_DOMAIN | wb31.gfz.de | domain name for the blank (intermediate2) instance, testing on this host |
| MDIS_BLANK_INSTANCE_NAME | mdis-blank | name of the blank instance |
| MDIS_BLANK_PATH | mdis/blank | URL path to the blank instance |
| MDIS_USER1_EMAIL | dm_icdp@gfz.de | mDIS login screen: email address of the first user |
| MDIS_USER1_NAME | dm_icdp | mDIS login screen: name of the first user |
| MDIS_USER1_PASSWORD | (dm_icdp_pw) | mDIS login screen: password of the first user |
| MDIS_USER1_ROLE | administrator | mDIS login screen: role of the first user |
| MDIS_VANILLA_NODE_IMAGE | node:16.17.0 | node image for the vanilla instance |
| MDIS_VANILLA_YII2IMAGE | yiisoftware/yii2-php:7.4-apache | Yii2/PHP image for the vanilla instance |
| MYSQL_CUSTOM_DATABASE | dis_test_foundation | name of the mySQL database for the "foundation" instance |
| MYSQL_CUSTOM_HOST | wb31.gfz.de:8508 | host name of the mySQL database for the "foundation" instance |
| MYSQL_CUSTOM_PASSWORD | dis_db_password | password for the mySQL database for the "foundation" instance |
| MYSQL_CUSTOM_ROOT_PASSWORD | my_root_pw | mySQL root user password for the mySQL database for the "foundation" instance |
| MYSQL_CUSTOM_USER | dis_db_user | user name for the mySQL database for the "foundation" instance |
| MYSQL_BLANK_DATABASE | dis_test_blank | name of the mySQL database for the blank instance |
| MYSQL_BLANK_HOST | wb31.gfz.de:8508 | host name of the mySQL database for the blank instance |
| MYSQL_BLANK_PASSWORD | dis_db_password | password for the mySQL database for the blank instance |
| MYSQL_BLANK_USER | dis_db_user | user name for the mySQL database for the blank instance |
| MYSQL_VANILLA_DATABASE | dis_test_vanilla | name of the mySQL database for the vanilla instance |
| MYSQL_VANILLA_DOCKERHUB_IMAGE | mysql:8.0.33-debian | mySQL image for the vanilla instance |
| MYSQL_VANILLA_HOST | wb31.gfz.de:8508 | host name of the mySQL database for the vanilla instance |
| MYSQL_VANILLA_PASSWORD | dis_db_password | password for the mySQL database for the vanilla instance |
| MYSQL_VANILLA_USER | dis_db_user | user name for the mySQL database for the vanilla instance |
2023-08-14