Merge pull request #139 from HarperDB/comp-rolling-restart

Add docs for replicated restarts and restart option for deploy and dr…

Author: kriszyp

docs/developers/operations-api/components.md

@@ -62,7 +62,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
-* restart _(optional)_ - if true, HarperDB will restart after deploying the component. Must be a boolean
+* 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, HarperDB 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. This can be used to install dependencies with pnpm or yarn, for example, like: `"install_command": "npm install -g pnpm && pnpm install"`
 
@@ -134,6 +134,7 @@ _Operation is restricted to super_user roles only_
 * project _(required)_ - the name of the project you wish to delete or to delete from if using the `file` parameter
 * file _(optional)_ - the path relative to your project folder of the file you wish to delete
 * replicated _(optional)_ - if true, HarperDB will replicate the component deletion to all nodes in the cluster. Must be a boolean.
+* restart _(optional)_ - if true, HarperDB will restart after dropping the component. Must be a boolean.
 
 ### Body
 
@@ -464,4 +465,4 @@ _Operation is restricted to super_user roles only_
 {
     "known_hosts": "github.com ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=\ngithub.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl\ngithub.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=\n"
 }
-```
+```

docs/developers/operations-api/utilities.md

@@ -29,6 +29,7 @@ _Operation is restricted to super_user roles only_
 
 * operation _(required)_ - must always be `restart_service`
 * service _(required)_ - must be one of: `http_workers`, `clustering_config` or `clustering`
+* 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.
 
 ### Body
 ```json