docs: full postgres documentation rewrite — sub-field tables, working HCL examples for create/modify/user/database
This commit is contained in:
“Naeel”
@@ -8,39 +8,69 @@ Service Name: PostgreSQL
|
||||
|
||||
## Create params
|
||||
|
||||
**Обязательные параметры (вводимые пользователем)**
|
||||
Параметры сгруппированы в JSON-блоки. Каждый блок — это `jsonencode({...})` в манифесте.
|
||||
|
||||
<table class="resource-table resource-table-compact resource-table-required">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>23</td><td><strong><code class="code-no-wrap">s3_uid</code></strong></td><td><code>uuid</code></td><td>Экземпляр (учетная запись) S3 для резервного копирования. Резервное копирование обязательно</td><td>ref_svc_id=12</td></tr>
|
||||
<tr><td>102</td><td><strong><code class="code-no-wrap">resource_realm</code></strong></td><td><code>string</code></td><td>Кластер Kubernetes, на котором будет развернут экземпляр</td><td>func=getAvailableResourceRealms</td></tr>
|
||||
<tr><td>337</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>338</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>
|
||||
### startup_configuration — платформа развёртывания
|
||||
|
||||
**Параметры, имеющие значение по умолчанию, если не меняете - эти параметры не обязательно прописывать в манифесте**
|
||||
<table class="resource-table resource-table-compact">
|
||||
<thead><tr><th>ID</th><th>Code</th><th>Type</th><th>Default</th><th>Description</th><th>Constraints</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td>80</td><td><strong><code class="code-no-wrap">resource_instances</code></strong></td><td><code>integer</code></td><td><code>1</code></td><td>Количество узлов в кластере. 1,3,5,7</td><td>minvalue=1; maxvalue=7; regex=^[1357]$</td></tr>
|
||||
<tr><td>81</td><td><strong><code class="code-no-wrap">resource_memory</code></strong></td><td><code>integer</code></td><td><code>512</code></td><td>Квота памяти пода (MBytes)</td><td>minvalue=128; maxvalue=8192</td></tr>
|
||||
<tr><td>82</td><td><strong><code class="code-no-wrap">resource_cpu</code></strong></td><td><code>integer</code></td><td><code>500</code></td><td>Квота ядра пода (milicores)</td><td>minvalue=100; maxvalue=4000</td></tr>
|
||||
<tr><td>83</td><td><strong><code class="code-no-wrap">resource_disk</code></strong></td><td></td><td><code>10</code></td><td>Квота диска (Указывается в GIGAbytes)</td><td>minvalue=1; maxvalue=999</td></tr>
|
||||
<tr><td>145</td><td><strong><code class="code-no-wrap">need_external_address_master</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к master</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>146</td><td><strong><code class="code-no-wrap">need_external_address_slave</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Выделяет внешний (белый) IP для доступа к slave. Будет работать, если slave в принципе есть</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>265</td><td><strong><code class="code-no-wrap">ext_backup_schedule</code></strong></td><td><code>string</code></td><td><code>0 0 * * *</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>266</td><td><strong><code class="code-no-wrap">ext_backup_num_to_retain</code></strong></td><td><code>integer</code></td><td><code>7</code></td><td>Не обязательный. Количество сохраняемых бекапов</td><td>minvalue=1; maxvalue=99</td></tr>
|
||||
<tr><td>310</td><td><strong><code class="code-no-wrap">app_version</code></strong></td><td><code>string</code></td><td><code>17</code></td><td>Версия PostgreSQL</td><td>value_list=17, 16, 15, 14, 13</td></tr>
|
||||
<tr><td>311</td><td><strong><code class="code-no-wrap">json_parameters</code></strong></td><td><code>json</code></td><td><code>{ "log_connections": "off", "log_disconnections": "off" }</code></td><td>Массив переменных, более подробнее про настройку можно посмотреть https://www.postgresql.org/docs/current/runtime-config.html</td><td>maxlength=2048</td></tr>
|
||||
<tr><td>312</td><td><strong><code class="code-no-wrap">enable_pg_pooler_master</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Включает pgPooler (на запись). Будет создан новый под</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>313</td><td><strong><code class="code-no-wrap">enable_pg_pooler_slave</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Включает pgPooler (на чтение). Будет создан новый под</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>314</td><td><strong><code class="code-no-wrap">allow_no_ssl</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>По умолчанию подключение обязательное (sslmode=require). Выставление в true отключит этот параметр</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>329</td><td><strong><code class="code-no-wrap">auto_scale</code></strong></td><td><code>boolean</code></td><td><code>false</code></td><td>Включает автоскейлинг PV. При включении параметра необходимо настроить autoScalePercentage и autoScaleTechWindow. Алерт при срабатывании вызывает modify у текущей услуги</td><td>value_list=false, true</td></tr>
|
||||
<tr><td>330</td><td><strong><code class="code-no-wrap">auto_scale_percentage</code></strong></td><td><code>integer</code></td><td><code>10</code></td><td>Требует включения autoScale. Позволяет указать в процентах расширение от текущего макс объема</td><td>value_list=10, 15, 20</td></tr>
|
||||
<tr><td>331</td><td><strong><code class="code-no-wrap">auto_scale_tech_window</code></strong></td><td><code>integer</code></td><td><code>0</code></td><td>Требует включения autoScale. Окно обновления (пока не реализовано). Указывается час в виде Integer (0 / 5 / 12 / 23)</td><td>value_list=0, 5, 12, 23</td></tr>
|
||||
<tr><td>339</td><td><strong><code class="code-no-wrap">auto_scale_quota_gb</code></strong></td><td><code>string</code></td><td><code>1</code></td><td>Квота для autoScale</td><td></td></tr>
|
||||
</tbody></table>
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `resourceRealm` | string | да | Платформа/K8s-кластер. Примеры: `k8s-3-sandbox-nubes-ru`, `iot-naeel`, `naeel-test-3` |
|
||||
|
||||
### cluster_configuration — размер кластера
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `cpu` | string | да | Квота CPU в милликорах (1000 = 1 vCPU) |
|
||||
| `memory` | string | да | Квота памяти в MB |
|
||||
| `replicas` | string | да | Количество нод (1 = без реплики, 2 = master + slave) |
|
||||
| `disk` | string | да | Размер диска в GB |
|
||||
|
||||
### access_configuration — сетевой доступ
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `masterIpSpace` | string | да | ipSpace для внешнего IP master. `"no-needed"` если не нужен |
|
||||
| `masterAccessList` | array | да | Список IP/сетей для доступа к master. `[]` если не ограничен |
|
||||
| `slaveIpSpace` | string | да | ipSpace для внешнего IP slave |
|
||||
| `slaveAccessList` | array | да | Список IP/сетей для доступа к slave |
|
||||
|
||||
### postgres_configuration — параметры PostgreSQL
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `version` | string | да | Версия PostgreSQL: `"16"`, `"17"` |
|
||||
| `sslRequired` | boolean | да | Требовать SSL-подключения |
|
||||
| `poolerMaster` | boolean | да | Включить PgBouncer для master |
|
||||
| `poolerSlave` | boolean | да | Включить PgBouncer для slave |
|
||||
|
||||
### postgres_conf — дополнительные параметры (опционально)
|
||||
|
||||
Массив объектов `[{paramName, paramValue}]`. Пример:
|
||||
```json
|
||||
[{"paramName": "log_connections", "paramValue": "''"}]
|
||||
```
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `paramName` | string | да | Имя параметра postgresql.conf |
|
||||
| `paramValue` | string | да | Значение параметра |
|
||||
|
||||
### backup_configuration — резервное копирование
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `s3Uid` | string | да | UUID существующего S3 Object Storage |
|
||||
| `retain` | string | да | Количество сохраняемых бэкапов |
|
||||
| `schedule` | string | да | Cron-расписание бэкапов. `"0 0 * * *"` = ежедневно в полночь |
|
||||
|
||||
### autoscale_configuration — автоскейлинг
|
||||
|
||||
| Поле | Тип | Обязательное | Описание |
|
||||
|---|---|---|---|
|
||||
| `enabled` | boolean | да | Включить автоскейлинг |
|
||||
| `schedule` | string | да | Tech window |
|
||||
| `percent` | string | да | Процент увеличения при скейлинге |
|
||||
| `quota` | string | да | Максимальный размер диска в GB |
|
||||
|
||||
<div class="lifecycle-note">
|
||||
<strong>Параметры поведения (кратко)</strong><br/>
|
||||
|
||||
Reference in New Issue
Block a user