Skip to content

Commit 1d284ed

Browse files
Add docs for replicated restarts and restart option for deploy and drop component
1 parent 6ec366e commit 1d284ed

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/developers/operations-api/components.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ _Operation is restricted to super_user roles only_
6262
* project _(required)_ - the name of the project you wish to deploy
6363
* package _(optional)_ - this can be any valid GitHub or NPM reference
6464
* payload _(optional)_ - a base64-encoded string representation of the .tar file. Must be a string
65-
* restart _(optional)_ - if true, HarperDB will restart after deploying the component. Must be a boolean
65+
* restart _(optional)_ - must be either a boolean or the string `rolling`. If set to `rolling`, a rolling restart will be triggered after the component is deployed. If set to `true`, the restart will not be rolling. If `replicated` is `true`, the restart operations will be replicated across the cluster.
6666
* replicated _(optional)_ - if true, HarperDB will replicate the component to all nodes in the cluster. Must be a boolean.
6767
* install_command _(optional)_ - A command to use when installing the component. Must be a string. This can be used to install dependencies with pnpm or yarn, for example, like: `"install_command": "npm install -g pnpm && pnpm install"`
6868

@@ -134,6 +134,7 @@ _Operation is restricted to super_user roles only_
134134
* project _(required)_ - the name of the project you wish to delete or to delete from if using the `file` parameter
135135
* file _(optional)_ - the path relative to your project folder of the file you wish to delete
136136
* replicated _(optional)_ - if true, HarperDB will replicate the component deletion to all nodes in the cluster. Must be a boolean.
137+
* restart _(optional)_ - if true, HarperDB will restart after dropping the component. Must be a boolean.
137138

138139
### Body
139140

docs/developers/operations-api/utilities.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ _Operation is restricted to super_user roles only_
2929

3030
* operation _(required)_ - must always be `restart_service`
3131
* service _(required)_ - must be one of: `http_workers`, `clustering_config` or `clustering`
32+
* replicated _(optional)_ - must be a boolean. If set to `true`, HarperDB will replicate the restart service operation across all nodes in the cluster. The restart will occur as a rolling restart, ensuring that each node is fully restarted before the next node begins restarting.
3233

3334
### Body
3435
```json

0 commit comments

Comments
 (0)