Skip to content

Commit 9edb502

Browse files
authored
Merge pull request #398 from HarperFast/deploy-component-upd
Add optional force option on deploy_component operation
2 parents d0747bf + b24c4a1 commit 9edb502

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

docs/developers/operations-api/components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ _Operation is restricted to super_user roles only_
8282
- `project` _(required)_ - the name of the project you wish to deploy
8383
- `package` _(optional)_ - this can be any valid GitHub or NPM reference
8484
- `payload` _(optional)_ - a base64-encoded string representation of the .tar file. Must be a string
85+
- `force` _(optional)_ - if true, allows deploying over protected core components. Must be a boolean. Defaults to `false`. Core system components (like `graphql`, `http`, `authentication`, etc.) are protected to prevent accidentally breaking HarperDB. User-defined components can be redeployed without this flag.
8586
- `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, meaning that each node in the cluster will be sequentially restarted (waiting for the last restart to start the next). If set to `true`, the restart will not be rolling, all nodes will be restarted in parallel. If `replicated` is `true`, the restart operations will be replicated across the cluster.
8687
- `replicated` _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
8788
- `install_command` _(optional)_ - A command to use when installing the component. Must be a string. Defaults to `npm install`. Depending on the host environment, you can use this to switch to using an alternative package manager.

versioned_docs/version-4.7/developers/operations-api/components.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ _Operation is restricted to super_user roles only_
8282
- `project` _(required)_ - the name of the project you wish to deploy
8383
- `package` _(optional)_ - this can be any valid GitHub or NPM reference
8484
- `payload` _(optional)_ - a base64-encoded string representation of the .tar file. Must be a string
85+
- `force` _(optional)_ - if true, allows deploying over protected core components. Must be a boolean. Defaults to `false`. Core system components (like `graphql`, `http`, `authentication`, etc.) are protected to prevent accidentally breaking HarperDB. User-defined components can be redeployed without this flag.
8586
- `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, meaning that each node in the cluster will be sequentially restarted (waiting for the last restart to start the next). If set to `true`, the restart will not be rolling, all nodes will be restarted in parallel. If `replicated` is `true`, the restart operations will be replicated across the cluster.
8687
- `replicated` _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
8788
- `install_command` _(optional)_ - A command to use when installing the component. Must be a string. Defaults to `npm install`. Depending on the host environment, you can use this to switch to using an alternative package manager.

0 commit comments

Comments
 (0)