docs: full postgres documentation rewrite — sub-field tables, working HCL examples for create/modify/user/database

This commit is contained in:
“Naeel”
2026-07-03 17:02:08 +04:00
parent 1e3038af63
commit 595c9250a1
11 changed files with 412 additions and 117 deletions
@@ -8,22 +8,51 @@ Service Name: PostgreSQL
## Modify params
<table class="resource-table resource-table-compact">
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
<tbody>
<tr><td>91</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td>Количество узлов в сети</td><td>minvalue=1; maxvalue=7</td></tr>
<tr><td>92</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
<tr><td>93</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
<tr><td>94</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td><code>integer</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
<tr><td>147</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td>Выделяет внешний IP для доступа к master</td><td>value_list=false, true</td></tr>
<tr><td>148</td><td><strong><code class="code-no-wrap">need_external_address_slave</code></strong></td><td><code>boolean</code></td><td>Выделяет внешний IP для доступа к slave. Действует, если slave в принципе есть</td><td>value_list=false, true</td></tr>
<tr><td>267</td><td><strong><code class="code-no-wrap">ext_backup_schedule</code></strong></td><td><code>string</code></td><td>Не обязательный. Время запуска бекапа</td><td>regex=^((((\d+,)+\d+|(\d+(\/|-|#)\d+)|(\d+L?)|(\*(\/\d+)?)|(L(-\d+)?)|(\?)|([A-Z]{3}(-[A-Z]{3})?)) ?){5,7})|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)$</td></tr>
<tr><td>268</td><td><strong><code class="code-no-wrap">ext_backup_num_to_retain</code></strong></td><td><code>integer</code></td><td>Не обязательный. Количество сохраняемых бекапов</td><td>minvalue=1; maxvalue=99</td></tr>
<tr><td>315</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td>Версия PostgreSQL. Нельзя опускать вниз</td><td>value_list=17, 16, 15, 14, 13</td></tr>
<tr><td>316</td><td><strong><code class="code-no-wrap">json_parameters</code></strong></td><td><code>json</code></td><td>Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html</td><td>maxlength=2048</td></tr>
<tr><td>317</td><td><strong><code class="code-no-wrap">enable_pg_pooler_master</code></strong></td><td><code>boolean</code></td><td>Включает pgPooler (на запись). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>318</td><td><strong><code class="code-no-wrap">enable_pg_pooler_slave</code></strong></td><td><code>boolean</code></td><td>Включает pgPooler (на чтение). Будет создан новый под</td><td>value_list=false, true</td></tr>
<tr><td>319</td><td><strong><code class="code-no-wrap">allow_no_ssl</code></strong></td><td><code>boolean</code></td><td>По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр</td><td>value_list=false, true</td></tr>
<tr><td>541</td><td><strong><code class="code-no-wrap">ip_space_name_master</code></strong></td><td><code>string</code></td><td>Имя ipSpace для публикации VIP master. Не может быть пустым, если включен needExternalAddressMaster. Пример: `internet-no-antiddos-v1`</td><td></td></tr>
<tr><td>542</td><td><strong><code class="code-no-wrap">ip_space_name_slave</code></strong></td><td><code>string</code></td><td>Имя ipSpace для публикации VIP slave. Не может быть пустым, если включен needExternalAddressSlave</td><td></td></tr>
</tbody></table>
При modify можно изменить все блоки кроме `startup_configuration` (version, realm — задаются только при create).
### cluster_configuration
| Поле | Тип | Описание |
|---|---|---|
| `cpu` | string | Квота CPU в милликорах |
| `memory` | string | Квота памяти в MB |
| `replicas` | string | Количество нод |
| `disk` | string | Размер диска в GB |
### access_configuration
| Поле | Тип | Описание |
|---|---|---|
| `masterIpSpace` | string | ipSpace для внешнего IP master |
| `masterAccessList` | array | Список IP/сетей для доступа к master |
| `slaveIpSpace` | string | ipSpace для внешнего IP slave |
| `slaveAccessList` | array | Список IP/сетей для доступа к slave |
### postgres_configuration
| Поле | Тип | Описание |
|---|---|---|
| `sslRequired` | boolean | Требовать SSL-подключения |
| `poolerMaster` | boolean | Включить PgBouncer для master |
| `poolerSlave` | boolean | Включить PgBouncer для slave |
### postgres_conf (опционально)
Массив `[{paramName, paramValue}]` — дополнительные параметры postgresql.conf.
### backup_configuration
| Поле | Тип | Описание |
|---|---|---|
| `s3Uid` | string | UUID S3 Object Storage |
| `retain` | string | Количество сохраняемых бэкапов |
| `schedule` | string | Cron-расписание |
### autoscale_configuration
| Поле | Тип | Описание |
|---|---|---|
| `enabled` | boolean | Включить автоскейлинг |
| `schedule` | string | Tech window |
| `percent` | string | Процент увеличения |
| `quota` | string | Максимальный размер диска в GB |