Support db migration and initialization for Auto DevOps (!21955) · Merge Requests · GitLab.org / GitLab FOSS

Support db migration and initialization for Auto DevOps

Pre-requisite

⚠ requires charts/auto-deploy-app!7 (merged)
⚠ requires gitlab-ci-yml!201 (merged)

What does this MR do?

if $DB_INITIALIZE is present, deploy an initial release where only $DB_INITIALIZE is run in a special job (and deployments are not rendered/loaded). This is then followed by second release with deployments as usual.

if $DB_MIGRATE, set this value which will trigger a pre-upgrade helm hook.

Due to helm not supporting hook logs, this MR does not show the logs from the intialization and migration logs.

What are the relevant issue numbers?

https://gitlab.com/gitlab-org/gitlab-ce/issues/48004

Tasks

Document :

For an example Rails project :

We can set DB_INITIALIZE: cd /app && RAILS_ENV=production bin/setup and DB_MIGRATE: cd app && RAILS_ENV=production bin/update
/app is from herokuish buildpacks. Can use $APP_PATH too
Also, there is only one chance to run $DB_INITIALIZE. If the first deploy successfully completes, $DB_INITIALIZE will never be run again. If $DB_INITIALIZE is present during the first deploy though and it errors or fails, that doesn't cound as a successfully first deploy

Does this MR meet the acceptance criteria?

Changelog entry added, if necessary
Documentation created/updated
Tests added for this feature/bug
Conforms to the code review guidelines
Conforms to the merge request performance guidelines
Conforms to the style guides
Conforms to the database guides

Closes #48004 (closed)

## Pre-requisite

- :warning: requires https://gitlab.com/charts/auto-deploy-app/merge_requests/7
- :warning: requires https://gitlab.com/gitlab-org/gitlab-ci-yml/merge_requests/201

## What does this MR do?

if `$DB_INITIALIZE` is present, deploy an initial release
where only `$DB_INITIALIZE` is run in a special job (and deployments are
not rendered/loaded). This is then followed by second release with
deployments as usual.

if `$DB_MIGRATE`, set this value which will trigger a pre-upgrade helm
hook.

Due to [helm not supporting hook logs](https://github.com/helm/helm/issues/2298), this MR does not show the logs from the intialization and migration logs.

## What are the relevant issue numbers?

https://gitlab.com/gitlab-org/gitlab-ce/issues/48004

## Tasks

- [x] Document :

For an example Rails project :

* We can set `DB_INITIALIZE`: `cd /app && RAILS_ENV=production bin/setup` and `DB_MIGRATE`: `cd app && RAILS_ENV=production bin/update`
* `/app` is from [herokuish buildpacks](https://github.com/gliderlabs/herokuish#paths). Can use `$APP_PATH` too

* Also, there is only one chance to run `$DB_INITIALIZE`. If the first deploy successfully completes, `$DB_INITIALIZE` will never be run again. If `$DB_INITIALIZE` is present during the first deploy though and it errors or fails, that doesn't cound as a successfully first deploy

## Does this MR meet the acceptance criteria?

- [x] [Changelog entry](https://docs.gitlab.com/ee/development/changelog.html) added, if necessary
- [x] [Documentation created/updated](https://docs.gitlab.com/ee/development/documentation/index.html#contributing-to-docs)
- [x] [Tests added for this feature/bug](https://docs.gitlab.com/ee/development/testing_guide/index.html)
- [x] Conforms to the [code review guidelines](https://docs.gitlab.com/ee/development/code_review.html)
- [x] Conforms to the [merge request performance guidelines](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
- [x] Conforms to the [style guides](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/CONTRIBUTING.md#style-guides)
- [x] Conforms to the [database guides](https://docs.gitlab.com/ee/development/README.html#databases-guides)

Closes #48004

Edited Oct 02, 2018 by Thong Kuah