docs(curated): страницы примеров приведены к реальным файлам (versions/provider/variables/outputs), организация по имени, снята пометка «не проверено»
This commit is contained in:
@@ -1,75 +1,74 @@
|
||||
# Ресурсы-модификаторы: внешние IP организации и SNAT на шлюзе
|
||||
|
||||
> ⚠️ Живым прогоном пока **не проверено**. Описаны ресурсы и порядок применения; выводы о поведении
|
||||
> сделаны по коду провайдера и HAR-записям ЛК.
|
||||
Два ресурса работают с **уже существующими** услугами:
|
||||
|
||||
Два ресурса выполняют операции `modify` над **уже существующими** услугами. Организация Cloud Director
|
||||
и сетевой шлюз периметра создаются один раз **вручную в ЛК** и адресуются по UUID.
|
||||
- `nubes_vc_org_ip_allocation` — выделяет внешние IP на организации;
|
||||
- `nubes_vc_nsxt_snat` — включает SNAT на сетевом шлюзе периметра.
|
||||
|
||||
## `nubes_vc_org_ip_allocation`
|
||||
Эти параметры нельзя задать при создании услуги обычным ресурсом, поэтому они вынесены в отдельные
|
||||
ресурсы: так вся цепочка поднимается одним `apply` и в правильном порядке.
|
||||
|
||||
Выделяет внешние IP на организации (операция `modify`, параметр `vIPConfigure`).
|
||||
Оба ресурса проверены живым прогоном: создание, проверка состояния в ЛК и удаление.
|
||||
|
||||
Полный рабочий пример (vDC + Edge + IP + SNAT) — на странице
|
||||
[«Как развернуть vDC, Edge, внешние IP и SNAT»](../pipeline/vdc_edge_ip_snat.md),
|
||||
файлы — в репозитории `tf_examples`, папка `fullpipe_chain`.
|
||||
|
||||
## `nubes_vc_org_ip_allocation` — внешние IP на организации
|
||||
|
||||
| Атрибут | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `organization` | string, обязательный | Организация: имя из ЛК или её UUID |
|
||||
| `vip_configure` | string (JSON), обязательный | Массив аллокаций: `[{"name":"internet-ipv4-v1","count":"3"}]`. `count` — строка |
|
||||
| `keep_on_destroy` | bool, по умолчанию `false` | Не снимать квоту при `destroy` |
|
||||
|
||||
Порядок ключей и форматирование не важны — сравнение смысловое (важно потому, что `jsonencode` сортирует
|
||||
ключи по алфавиту).
|
||||
|
||||
Снять аллокацию через `vip_configure` **нельзя** (пустой массив отклоняется): для этого удали ресурс —
|
||||
тогда отправится обратный `modify` с `count = "0"`.
|
||||
| `organization` | string, обязательный | Организация: название услуги из ЛК или её UUID |
|
||||
| `vip_configure` | string (JSON), обязательный | Сколько IP выделить: `[{"name":"internet-ipv4-v1","count":"3"}]`. `count` — строкой |
|
||||
| `keep_on_destroy` | bool, по умолчанию `false` | `false` — при удалении квота обнуляется; `true` — остаётся как есть |
|
||||
|
||||
```hcl
|
||||
resource "nubes_vc_org_ip_allocation" "this" {
|
||||
organization = var.organization
|
||||
organization = "organ" # название услуги из ЛК
|
||||
|
||||
vip_configure = jsonencode([
|
||||
{ name = "internet-ipv4-v1", count = "3" }
|
||||
])
|
||||
|
||||
keep_on_destroy = false
|
||||
}
|
||||
```
|
||||
|
||||
Операция имеет **replace-семантику**: массив перезаписывается целиком, поэтому ресурс владеет всей
|
||||
аллокацией организации, а не отдельным элементом.
|
||||
Как это работает:
|
||||
|
||||
При `destroy` по умолчанию отправляется обратный `modify` с `count = "0"` — квота обнуляется.
|
||||
- массив `vip_configure` записывается **целиком**, поэтому ресурс владеет всей аллокацией организации:
|
||||
если нужно поменять количество — меняйте значение и делайте `apply`;
|
||||
- снять аллокацию через пустой массив нельзя — для этого удалите ресурс
|
||||
(`terraform destroy -target=nubes_vc_org_ip_allocation.this`), тогда отправится запрос с `count = "0"`.
|
||||
|
||||
## `nubes_vc_nsxt_snat`
|
||||
|
||||
Включает или выключает SNAT на сетевом шлюзе периметра (операция `modify`, параметр `ipSpaceName`).
|
||||
## `nubes_vc_nsxt_snat` — SNAT на шлюзе
|
||||
|
||||
| Атрибут | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `nsxt_uid` | string, обязательный | UUID услуги «Сетевой шлюз периметра (Edge)» |
|
||||
| `ip_space_name` | string, обязательный | Имя ipSpace для внешнего IP; `no-needed` выключает SNAT |
|
||||
| `keep_on_destroy` | bool, по умолчанию `false` | Не выключать SNAT при `destroy` |
|
||||
| `ip_space_name` | string, обязательный | Имя ipSpace для внешнего IP; значение `no-needed` выключает SNAT |
|
||||
| `keep_on_destroy` | bool, по умолчанию `false` | `false` — при удалении SNAT выключается; `true` — остаётся как есть |
|
||||
|
||||
```hcl
|
||||
resource "nubes_vc_nsxt_snat" "this" {
|
||||
nsxt_uid = var.nsxt_uid
|
||||
nsxt_uid = nubes_vc_nsxt.edge.id # UUID шлюза из этого же конфига
|
||||
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"`.
|
||||
Если шлюз создаётся в этом же конфиге, UUID искать вручную не нужно — используйте
|
||||
`nubes_vc_nsxt.edge.id`. Если шлюз уже существует, UUID виден в карточке услуги в ЛК.
|
||||
|
||||
## Зачем отдельные ресурсы
|
||||
|
||||
В схемах ресурсов-инстансов (`nubes_vc_org`, `nubes_vc_nsxt`) эти параметры присутствуют только в
|
||||
операции `modify` — `create` их не отправляет. Отдельные ресурсы позволяют собрать цепочку
|
||||
**в одном `apply`** и выстроить корректный порядок зависимостей.
|
||||
Имя ipSpace должно быть сначала выделено на организации, поэтому у ресурса есть `depends_on`
|
||||
на аллокацию IP.
|
||||
|
||||
## Импорт
|
||||
|
||||
Оба ресурса импортируются по UUID родительской услуги:
|
||||
Если услуга уже настроена (например, в ЛК вручную), ресурс можно подключить к Terraform:
|
||||
|
||||
```bash
|
||||
terraform import nubes_vc_org_ip_allocation.this organ
|
||||
terraform import nubes_vc_nsxt_snat.this <nsxt_uid>
|
||||
terraform import nubes_vc_org_ip_allocation.this organ # организация: имя или UUID
|
||||
terraform import nubes_vc_nsxt_snat.this <uuid услуги шлюза> # UUID из карточки услуги в ЛК
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user