diff --git a/docs/developers/operations-api/components.md b/docs/developers/operations-api/components.md index 0975a15b..36d61986 100644 --- a/docs/developers/operations-api/components.md +++ b/docs/developers/operations-api/components.md @@ -82,6 +82,7 @@ _Operation is restricted to super_user roles only_ - `project` _(required)_ - the name of the project you wish to deploy - `package` _(optional)_ - this can be any valid GitHub or NPM reference - `payload` _(optional)_ - a base64-encoded string representation of the .tar file. Must be a string +- `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. - `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. - `replicated` _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean. - `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. diff --git a/versioned_docs/version-4.7/developers/operations-api/components.md b/versioned_docs/version-4.7/developers/operations-api/components.md index 0975a15b..36d61986 100644 --- a/versioned_docs/version-4.7/developers/operations-api/components.md +++ b/versioned_docs/version-4.7/developers/operations-api/components.md @@ -82,6 +82,7 @@ _Operation is restricted to super_user roles only_ - `project` _(required)_ - the name of the project you wish to deploy - `package` _(optional)_ - this can be any valid GitHub or NPM reference - `payload` _(optional)_ - a base64-encoded string representation of the .tar file. Must be a string +- `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. - `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. - `replicated` _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean. - `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.