Update Continuous Integration and Continuous Deployment authored by Fabian Nuraddin Alexander Gabel's avatar Fabian Nuraddin Alexander Gabel
......@@ -25,6 +25,8 @@ Depending on their domain, they carry different prefixes:
* `SSH_` for the review app hosted on [www3.tuhh.de]()
* `TUHH_` for the deployment on the web server of the institute
Sensible variables (none of them are sensible at the moment) can only be accessed for jobs running on the protected branches `master` and `dev`.
Depending on their suffix they are used at certain parts of the corresponding jobs in the pipeline.
## `*_{PRIVATE_KEY,USER,HOST}`
......@@ -62,9 +64,9 @@ The first two stages are testing stages:
* `docker-test`: checks, whether the docker images from the repository's [container registry](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/container_registry) are available
* `testing`: performs various tests of the [preprocessor]() and [building]() routines
* `build`: constructs the various producs like standalone webpages, and TUHH-delivery packages
* `build`: constructs the various products like standalone webpages, and TUHH-delivery packages
* `review`: starts the review apps for the merge request
* `deploy`: ships the products to their final destionation (`asteroid`, `www3`, `www3-dev`, `mat`
* `deploy`: ships the products to their final destination (`asteroid`, `www3`, `www3-dev`, `mat`
### Jobs and Artifacts
......@@ -74,10 +76,33 @@ First all [Docker]() images are tested (or built). The testing stage consists of
Check the code documentation provided by the scripts for further information.
#### `testing`
#### `build`
Here the different products are constructed. Most of them rely on the docker image:
collaborating.tuhh.de:5005/cfg0846/research-topics-mat-tuhh/ubuntu-pandoc
which can also be retrieved from docker.hub or built from the Dockerfile in `/doker/`
The main artifacts of this stage come from the jobs
* [`build-tuhh`]
* [`build-tuhh-asteroid`]
which essentially run the script `build_tuhh.sh` but with different options to account for the deployment site.
#### `review`
Runs the [review apps](https://docs.gitlab.com/ee/ci/review_apps/)
* review_tuhh (`environment` `url` on `www3-dev`)
* review_asteroid (`environment` `url` on asteroid)
#### `deploy`
Runs the jobs that deliver the static webpage to the production sites. Currently the following deployment jobs run in the pipeline:
* `rsync-tuhh-deploy`: sends the outcome of `build-tuhh` to `$TUHH_USER@$TUHH_HOST:$TUHH_DEPLOY/`
* `master-deploy`: sends outcome of `build-tuhh` to `${SSH_USER}"@"${HOST_NAME}":"/usr/local/apache2/htdocs`
```
* `pages`: deploys on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) (only on the gitlab.com-mirror: https://gitlab.com/fabiangabel/research-topics-mat-tuhh )
\ No newline at end of file