add: documentation
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# Operations: nubes_nifi
|
||||
|
||||
| Operation | Kind | Action | Subresource | ID | Params | Description |
|
||||
|---|---|---|---|---|---|---|
|
||||
| `create` | `instance` | `create` | `` | `150` | kafkaUid, partitions, replicas, nameTopic | |
|
||||
| `delete` | `instance` | `delete` | `` | `151` | | |
|
||||
| `modify` | `instance` | `modify` | `` | `154` | partitions, replicas | |
|
||||
|
||||
## Operation: create
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `kafkaUid` | `uuid` | `ДА` | `` | Выбрать кластер из списка | | ref_svc_id=116 | `471` |
|
||||
| `partitions` | `integer > 0` | `ДА` | `` | Число партиций на кластер ≤ 100 × (число брокеров) × (фактор репликации). Пример `50` | Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки. | | `472` |
|
||||
| `replicas` | `integer > 0` | `ДА` | `` | Количество партиций ≤ (число брокеров). Пример `2` | | | `473` |
|
||||
| `nameTopic` | `string` | `ДА` | `` | Пример: `orders-events` | | | `474` |
|
||||
|
||||
## Operation: delete
|
||||
|
||||
None.
|
||||
|
||||
## Operation: modify
|
||||
|
||||
| Code | Type | Required | Default | Description | Man | Constraints | ID |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| `partitions` | `integer > 0` | `НЕТ` | `` | Число партиций на кластер ≤ 100 × (число брокеров) × (фактор репликации). Пример `50` | Обратите внимание: уменьшить количество партиций после создания невозможно, поэтому лучше закладывать небольшой запас на будущий рост нагрузки. | | `477` |
|
||||
| `replicas` | `integer > 0` | `НЕТ` | `` | Количество партиций ≤ (число брокеров). Пример `2` | | | `478` |
|
||||
Reference in New Issue
Block a user