diff --git a/docs/curated/modifiers/org_ip_and_snat.md b/docs/curated/modifiers/org_ip_and_snat.md new file mode 100644 index 0000000..b79cee0 --- /dev/null +++ b/docs/curated/modifiers/org_ip_and_snat.md @@ -0,0 +1,69 @@ +# Ресурсы-модификаторы: внешние IP организации и SNAT на шлюзе + +> ⚠️ Живым прогоном пока **не проверено**. Описаны ресурсы и порядок применения; выводы о поведении +> сделаны по коду провайдера и HAR-записям ЛК. + +Два ресурса выполняют операции `modify` над **уже существующими** услугами. Организация Cloud Director +и сетевой шлюз периметра создаются один раз **вручную в ЛК** и адресуются по UUID. + +## `nubes_vc_org_ip_allocation` + +Выделяет внешние IP на организации (операция `modify`, параметр `vIPConfigure`). + +| Атрибут | Тип | Описание | +|---|---|---| +| `org_uid` | string, обязательный | UUID услуги «Организация в Cloud Director» | +| `vip_configure` | string (JSON), обязательный | Массив аллокаций: `[{"name":"internet-ipv4-v1","count":"3"}]`. `count` — строка | +| `keep_on_destroy` | bool, по умолчанию `false` | Не снимать квоту при `destroy` | + +```hcl +resource "nubes_vc_org_ip_allocation" "this" { + org_uid = var.org_uid + + vip_configure = jsonencode([ + { name = "internet-ipv4-v1", count = "3" } + ]) +} +``` + +Операция имеет **replace-семантику**: массив перезаписывается целиком, поэтому ресурс владеет всей +аллокацией организации, а не отдельным элементом. + +При `destroy` по умолчанию отправляется обратный `modify` с `count = "0"` — квота обнуляется. + +## `nubes_vc_nsxt_snat` + +Включает или выключает SNAT на сетевом шлюзе периметра (операция `modify`, параметр `ipSpaceName`). + +| Атрибут | Тип | Описание | +|---|---|---| +| `nsxt_uid` | string, обязательный | UUID услуги «Сетевой шлюз периметра (Edge)» | +| `ip_space_name` | string, обязательный | Имя ipSpace для внешнего IP; `no-needed` выключает SNAT | +| `keep_on_destroy` | bool, по умолчанию `false` | Не выключать SNAT при `destroy` | + +```hcl +resource "nubes_vc_nsxt_snat" "this" { + nsxt_uid = var.nsxt_uid + ip_space_name = "internet-ipv4-v1" + + depends_on = [nubes_vc_org_ip_allocation.this] +} +``` + +Имя ipSpace должно быть предварительно выделено на организации, поэтому SNAT-ресурс **должен зависеть** +от `nubes_vc_org_ip_allocation`. При `destroy` отправляется `ipSpaceName = "no-needed"`. + +## Зачем отдельные ресурсы + +В схемах ресурсов-инстансов (`nubes_vc_org`, `nubes_vc_nsxt`) эти параметры присутствуют только в +операции `modify` — `create` их не отправляет. Отдельные ресурсы позволяют собрать цепочку +**в одном `apply`** и выстроить корректный порядок зависимостей. + +## Импорт + +Оба ресурса импортируются по UUID родительской услуги: + +```bash +terraform import nubes_vc_org_ip_allocation.this +terraform import nubes_vc_nsxt_snat.this +``` diff --git a/mkdocs.yml b/mkdocs.yml index b202729..949a88a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,3 +60,4 @@ nav: - Глоссарий: 30_registry/guides/glossary.md - Проверенные примеры: - PostgreSQL: curated/postgres/pg_user_db.md + - Ресурсы-модификаторы (IP организации, SNAT): curated/modifiers/org_ip_and_snat.md