https://github.com/romanow/database-migration
Demo application for automatic database migration and rollback process using k8s
https://github.com/romanow/database-migration
database-migrations liquibase spring-boot
Last synced: about 1 month ago
JSON representation
Demo application for automatic database migration and rollback process using k8s
- Host: GitHub
- URL: https://github.com/romanow/database-migration
- Owner: Romanow
- License: mit
- Created: 2023-11-23T19:02:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-02T12:29:30.000Z (10 months ago)
- Last Synced: 2025-04-16T02:15:56.952Z (6 months ago)
- Topics: database-migrations, liquibase, spring-boot
- Language: Kotlin
- Homepage: https://romanow.github.io/database-migration/
- Size: 155 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/Romanow/database-migration/actions/workflows/build.yml)
[](https://github.com/pre-commit/pre-commit)
# Database migration
## Реализация
1. Собрать образ liquibase и запускать как `initContainer`.
2. При откате использовать последнюю версию и помимо `helm rollback `, запускать job для отката до
тега `liquibase rollback --tag=$ROLLBACK_TAG`.
```shell
$ docker run --rm \
--network database-migration \
romanowalex/liquibase-container:latest \
rollback --tag=v3.0 \
--url=jdbc:postgresql://postgres:5432/migration \
--username=program \
--password=test
```
### Прямые и обратные операции
| Операция | Revert |
|:---------------------------------------------------------:|:----------------------------------------------------------------------:|
| `CREATE TABLE (VIEW, INDEX, FUNCTION, TRIGGER, SEQUENCE)` | `DROP` |
| `ADD COLUMN ` | `DROP COLUMN` |
| `ALTER COLUMN ` | `ALTER COLUMN` |
| `ADD CONSTRAINT ...` | `DROP CONSTRAINT` |
| `ALTER ... RENAME TO ...` | `ALTER ... RENAME TO ...` |
| `DROP TABLE (VIEW, FUNCTION, TRIGGER, SEQUENCE)` | `CREATE` |
| `DROP COLUMN (NOT NULL)` | `ADD COLUMN, UPDATE ... SET ..., ALTER COLUMN SET NOT NULL` |
| `DROP CONSTRAINT` | `DELETE ...` (records, which not meet constraint), `CREATE CONSTRAINT` |
| `INSERT` | `DELETE` (can leave unmodified, if doesn't affect process) |
| `UPDATE` | `UPDATE` (can leave unmodified, if doesn't affect process) |
| `DELETE`, `TRUNCATE` | `INSERT` (if possible) |
### Тестовые данные
#### Запрос на получение версии сервиса
**Request**
```http request
GET http://localhost:8080/api/v1/version
```
**Response**
```json
{
"version": "${git.build.version}",
"commit": "${git.commit.id.abbrev}",
"time": "${git.commit.time}"
}
```
#### Запрос на получение данных из БД
**Request**
```http request
GET http://localhost:8080/api/v1/users
```
**Response**
```json
[
{
"name": "${user.name}",
"status": "${user.status}",
"location": "${user.location}"
}
]
```
#### Миграции
1. [Миграция v1.0: Создание таблицы users](src/main/resources/db/liquibase/changelog/v1.0_CreateUserTable.xml)
2. [Миграция v2.0: Изменение поля id на тип IDENTITY](src/main/resources/db/liquibase/changelog/v2.0_ChangeIdToIdentity.xml)
3. [Миграция v3.0: Создание таблицы address и перенесение данных из поля location](src/main/resources/db/liquibase/changelog/v3.0_CreateAddressTable.xml)
4. [Миграция v4.0: Изменение типа колонки status на enum](src/main/resources/db/liquibase/changelog/v4.0_ChangeStatusToEnum.xml)
5. [Миграция v5.0: Партиционирование таблицы users](src/main/resources/db/liquibase/changelog/v5.0_MigrateUsersToPartitions.xml)
6. [Миграция v6.0: Увеличение поля login до 80 символов и добавление новых пользователей](src/main/resources/db/liquibase/changelog/v6.0_EnlargeLoginFieldSize.xml)
## Тестирование в кластере k8s
```shell
# create local cluster
$ kind create cluster --config kind.yml
$ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml
# install required repos
$ helm repo add romanow https://romanow.github.io/helm-charts/
$ helm repo update
# install postgres
$ helm install postgres romanow/postgres --values postgres/values.yaml
# install service
$ helm upgrade \
migration-application \
romanow/java-service \
--values=k8s/migration-application/values.yaml \
--set image.tag="$IMAGE_VERSION" \
--set ingress.name=k8s \
--set ingress.domain=romanow-alex.ru \
--description "$IMAGE_VERSION" \
--install \
--wait
# rollback migration
$ helm install \
--generate-name \
romanow/common-job \
--values=k8s/rollback-job/values.yaml \
--set rollbackTag="$VERSION" \
--wait
# rollback revision
$ helm rollback migration-application "$REVISION" --wait
```