docs(crud): раздел «Как это устроено» — без натянутых терминов
Убрано «(разделение ответственности, decoupling)» — это про модули кода, не про состояния Terraform. Написано прямо: два отдельных файла состояния. Добавлен факт, который был скрыт: связь pg -> apps идёт через apps/creds.json, после смены хоста или пароля файл нужно обновить и повторить apply в apps/. Проверено: чтением файла после правки.
This commit is contained in:
Repinoid
+54
-70
@@ -1,121 +1,105 @@
|
||||
# CRUD Test Stand
|
||||
|
||||
Три приложения (Lucee / Flask / Node.js) + общая PostgreSQL. Каждое делает CRUD
|
||||
в одной таблице `crud_items`.
|
||||
CRUD = Create / Read / Update / Delete — создать, прочитать, изменить, удалить.
|
||||
|
||||
## Структура — ДВЕ папки, ДВА независимых состояния
|
||||
Три приложения (Lucee, Flask, Node.js) работают с одной общей таблицей `crud_items` в PostgreSQL:
|
||||
в любом из них можно добавлять записи, просматривать их, редактировать и удалять.
|
||||
|
||||
```
|
||||
CRUD/
|
||||
├── pg/ ← база данных: кластер PostgreSQL + пользователь + база
|
||||
└── apps/ ← приложения-потребители: Lucee + Flask + Node.js
|
||||
```
|
||||
|
||||
### 🎯 Почему так, а не «всё в одной папке»
|
||||
|
||||
| Зачем | Что это даёт |
|
||||
|---|---|
|
||||
| **`destroy` в `apps/` убивает ТОЛЬКО приложения** | база данных с данными не трогается — она в другом state (`pg/`) |
|
||||
| **БД — общий ресурс** | к одному кластеру можно подключить сколько угодно папок-потребителей: `apps/`, потом ещё `my-service/`, `reporting/` и т.д. |
|
||||
| **Разные жизненные циклы** | приложения пересоздаются сколько угодно раз, БД живёт всё это время |
|
||||
Итог после запуска: добавьте запись в одном приложении — остальные два её увидят.
|
||||
|
||||
---
|
||||
|
||||
## 📋 Порядок запуска (по шагам)
|
||||
## Как это устроено
|
||||
|
||||
### Шаг 0. Скачать репозиторий
|
||||
Два каталога — два отдельных файла состояния Terraform:
|
||||
|
||||
```bash
|
||||
git clone https://gitea.services.ngcloud.ru/terraform/tf_examples.git
|
||||
cd tf_examples/CRUD
|
||||
```
|
||||
CRUD/
|
||||
├── pg/ база данных: кластер PostgreSQL + пользователь + база
|
||||
└── apps/ приложения: Lucee + Flask + Node.js
|
||||
```
|
||||
|
||||
### Шаг 1. База данных — папка `pg/`
|
||||
- `terraform destroy` в `apps/` удаляет **только приложения** — данные в `pg/` остаются;
|
||||
- изменения в одном каталоге не трогают другой: приложения можно пересоздавать сколько угодно, база при этом не меняется;
|
||||
- связь между каталогами — файл `apps/creds.json` (см. шаг 2): он делается из `terraform output` в `pg/`, поэтому после смены хоста или пароля его нужно обновить и повторить `apply` в `apps/`.
|
||||
|
||||
---
|
||||
|
||||
## Запуск — три шага
|
||||
|
||||
### 1. База данных (`pg/`)
|
||||
|
||||
```bash
|
||||
cd pg
|
||||
cp terraform.tfvars.example terraform.tfvars
|
||||
# → отредактировать terraform.tfvars: api_token, realm, s3_name
|
||||
# отредактировать terraform.tfvars (см. таблицу ниже)
|
||||
terraform init
|
||||
terraform apply
|
||||
```
|
||||
|
||||
Создастся кластер PostgreSQL (несколько минут), затем пользователь БД и база.
|
||||
В конце `apply` выводятся outputs, включая пароль (помечен `sensitive`).
|
||||
Создадутся кластер (несколько минут), пользователь БД и база.
|
||||
|
||||
| Переменная | Где брать |
|
||||
| Переменная (`pg/terraform.tfvars`) | Где взять |
|
||||
|---|---|
|
||||
| `api_token` | ЛК → Профиль → Токены → создать «Технический» |
|
||||
| `realm` | ЛК → Кластеры, например `k8s-4-sandbox-nubes-ru` |
|
||||
| `s3_name` | ЛК → S3 → имя экземпляра (для бэкапов PG) |
|
||||
| `api_token` | ЛК → Профиль → Токены → «Технический» |
|
||||
| `realm` | ЛК → Кластеры (например `k8s-4-sandbox-nubes-ru`) |
|
||||
| `s3_name` | ЛК → S3 → имя экземпляра (для бэкапов) |
|
||||
|
||||
### Шаг 2. Передать креды БД в папку приложений 👈 ОДНА команда
|
||||
### 2. Передать креды БД в `apps/`
|
||||
|
||||
```bash
|
||||
# всё ещё в папке pg/
|
||||
terraform output -json > ../apps/creds.json
|
||||
```
|
||||
|
||||
**Что делает:** выгружает хост БД, порт, имя пользователя, имя базы и пароль в файл
|
||||
`apps/creds.json`. Папка `apps/` читает этот файл (см. `apps/locals.tf`).
|
||||
Одна команда выгружает хост, порт, имя пользователя, имя БД и пароль в `apps/creds.json`.
|
||||
Приложения читают этот файл (см. `apps/locals.tf`).
|
||||
|
||||
**Почему файлом:** `pg/` и `apps/` — разные состояния Terraform, значения между ними
|
||||
сами не передаются.
|
||||
> ⚠️ В `creds.json` пароль лежит **открытым текстом**: файл в `apps/.gitignore`, не коммитить и не пересылать.
|
||||
|
||||
> ⚠️ В `creds.json` пароль **в открытом виде**. Файл добавлен в `apps/.gitignore`.
|
||||
> Не коммитить и не пересылать. Если пользователя БД пересоздавали — повторите шаг 2.
|
||||
|
||||
### Шаг 3. Приложения — папка `apps/`
|
||||
### 3. Приложения (`apps/`)
|
||||
|
||||
```bash
|
||||
cd ../apps
|
||||
cp terraform.tfvars.example terraform.tfvars
|
||||
# → отредактировать: api_token (тот же), realm (ТОТ ЖЕ, где создана БД)
|
||||
# → проверить домены в locals.tf: они должны быть УНИКАЛЬНЫМИ
|
||||
# отредактировать terraform.tfvars (см. таблицу ниже)
|
||||
terraform init
|
||||
terraform apply
|
||||
```
|
||||
|
||||
Создадутся три приложения, каждое подключится к общей БД.
|
||||
Создадутся три приложения, подключённые к общей БД.
|
||||
|
||||
| Что менять | Файл | Зачем |
|
||||
| Что заполнить/проверить | Файл | Зачем |
|
||||
|---|---|---|
|
||||
| `api_token`, `realm` | `terraform.tfvars` | доступ к API; realm обязан совпадать с БД |
|
||||
| `lucee_domain` / `flask_domain` / `nodejs_domain` | `locals.tf` | имена доменов — уникальны в облаке |
|
||||
| `*_git_path` | `locals.tf` | репозиторий с кодом приложения |
|
||||
| `api_token` | `apps/terraform.tfvars` | тот же, что в `pg/` |
|
||||
| `realm` | `apps/terraform.tfvars` | должен совпадать с БД |
|
||||
| `lucee_domain`, `flask_domain`, `nodejs_domain` | `apps/locals.tf` | имена доменов — должны быть **уникальны** в облаке |
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Повседневные операции
|
||||
## Повседневные операции
|
||||
|
||||
| Что нужно | Команда |
|
||||
| Задача | Команда |
|
||||
|---|---|
|
||||
| Передеплоить приложения | `cd apps && terraform apply` (БД не затрагивается) |
|
||||
| Снести приложения | `cd apps && terraform destroy` — **БД и данные остаются** |
|
||||
| Передеплоить приложения | `cd apps && terraform apply` |
|
||||
| Удалить приложения | `cd apps && terraform destroy` — БД не трогается |
|
||||
| Изменить БД | `cd pg && terraform apply` |
|
||||
| Снести БД | `cd pg && terraform destroy` — кластер уйдёт в `Suspend`, а не удалится; юзер и база останутся внутри (`keep_on_destroy = true`) |
|
||||
| Добавить ещё одного потребителя той же БД | скопировать `apps/` → своя папка → свой `creds.json` (шаг 2) → свои домены |
|
||||
| Удалить БД | `cd pg && terraform destroy` — кластер уйдёт в `Suspend`, а не удалится |
|
||||
|
||||
### Про `destroy` базы
|
||||
> При `destroy` БД кластер переводится в `Suspend`, а пользователь и база остаются (`keep_on_destroy = true`).
|
||||
> Полное удаление: снять `keep_on_destroy` в `pg/postgres_user_db.tf` и `apply`.
|
||||
|
||||
- Кластер PostgreSQL при `destroy` **не удаляется**, а переводится в `Suspend`
|
||||
(поведение сервиса по умолчанию).
|
||||
- Пользователь и база тоже **не удаляются**: у них `keep_on_destroy = true`. Иначе
|
||||
из живого кластера исчезли бы база и пользователь. Провайдер печатает предупреждение
|
||||
«Подресурс оставлен как есть, а не удалён».
|
||||
- Удалить по-настоящему: снять `keep_on_destroy` в `pg/postgres_user_db.tf` и `apply`.
|
||||
---
|
||||
|
||||
## Состав
|
||||
## Файлы
|
||||
|
||||
| Файл | Ресурс / назначение |
|
||||
| Файл | Что делает |
|
||||
|---|---|
|
||||
| `pg/main.tf` | провайдер + переменные кластера, пользователя, базы |
|
||||
| `pg/postgres.tf` | `nubes_postgres.main_pg` — кластер |
|
||||
| `pg/postgres_user_db.tf` | `nubes_postgres_user` + `nubes_postgres_database` |
|
||||
| `pg/outputs.tf` | выводы для потребителей (хост, порт, юзер, база, пароль) |
|
||||
| `apps/main.tf` | провайдер + переменные приложений |
|
||||
| `apps/locals.tf` | креды из `creds.json` + домены, версии, размеры |
|
||||
| `apps/lucee.tf` | `nubes_lucee.applucee` |
|
||||
| `apps/flask.tf` | `nubes_flask.appflask` |
|
||||
| `apps/nodejs.tf` | `nubes_nodejs.appnodejs` |
|
||||
| `apps/creds.json` | **не в git** — выгрузка кредов из `pg/` (шаг 2) |
|
||||
| `pg/main.tf` | провайдер, переменные кластера/пользователя/базы |
|
||||
| `pg/postgres.tf` | кластер `nubes_postgres.main_pg` |
|
||||
| `pg/postgres_user_db.tf` | пользователь `crud_user_0` + база `pg_db` |
|
||||
| `pg/outputs.tf` | хост, порт, юзер, база, пароль — для выгрузки кредов |
|
||||
| `apps/main.tf` | провайдер, переменные приложений |
|
||||
| `apps/locals.tf` | чтение `creds.json`, домены, версии, размеры |
|
||||
| `apps/lucee.tf`, `apps/flask.tf`, `apps/nodejs.tf` | три приложения |
|
||||
| `apps/creds.json` | генерируется шагом 2, **не в git** |
|
||||
|
||||
Reference in New Issue
Block a user