Update node and VM docs for RESTfulness

2019-07-24 22:23:06 -04:00 · 2019-07-24 22:23:06 -04:00 · ee6e219c92
parent 4284a0fae3
commit ee6e219c92
1 changed files with 129 additions and 160 deletions
--- a/docs/manuals/api.md
+++ b/docs/manuals/api.md
@ -22,7 +22,7 @@ For one-time authentication, the `token` value can be specified to any API endpo
 The PVC API consistently accepts values (variables) as either HTTP query string arguments, or as HTTP POST form body arguments, in either GET or POST mode.
-Some values are `flag_` values; these do not require a data component, and signal an option by their presence.
+Some values are `` values; these do not require a data component, and signal an option by their presence.
 ### Data formats
@ -36,26 +36,36 @@ The PCI API consistently returns JSON bodies as its responses, with the one exce
 #### `/api/v1`
 * Methods: `GET`
- * Mandatory values: N/A
+
- * Optional values: N/A
+###### `GET`
 * Mandatory values: `GET`: N/A
 * Optional values: `GET`: N/A
 Return a JSON `message` containing the API description with HTTP return code 209. Useful for determining if the API is listening and responding properly.
 #### `/api/v1/auth/login`
 * Methods: `GET`, `POST`
 * Mandatory values: `token`
 * Optional values: N/A
-On `GET`, return an HTTP login form accepting a token to authorize a Flask session.
+###### `GET`:
 On `POST`, compare the specified token to the database and authorize a session. If this comparison fails to find a match, return a JSON `message` of `Authentication failed` and HTTP code 401.
 #### `/api/v1/auth/logout`
 * Methods: `GET`, `POST`
 * Mandatory values: N/A
 * Optional values: N/A
-On `GET` or `POST`, deactivate the current Flask session for the active token.
+Return an HTTP login form accepting a token to authorize a Flask session.
 ###### `POST`:
 * Mandatory values: `token`
 * Optional values: N/A
 Compare the specified `token` to the database and authorize a Flask session.
 #### `/api/v1/auth/logout`
 * Methods: `GET`, `POST`
 ###### `GET`/`POST`
 * Mandatory values: N/A
 * Optional values: N/A
 Deactivate the current Flask session for the active token.
 ### Node endpoints
@ -63,64 +73,57 @@ These endpoints manage PVC node state and operation.
 #### `/api/v1/node`
 * Methods: `GET`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: `limit`
-Return a JSON document containing information about all cluster nodes .
+Return a JSON document containing information about all cluster nodes. If `limit` is specified, return a JSON document containing information about cluster nodes with names matching `limit` as fuzzy regex.
 If `limit` is specified, return a JSON document containing information about cluster nodes with names matching `limit` as fuzzy regex.
 #### `/api/v1/node/<node>`
 * Methods: `GET`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about `<node>`. The output is identical to `/api/v1/node?limit=<node>` without fuzzy regex.
+Return a JSON document containing information about `<node>`. The output is identical to `/api/v1/node?limit=<node>` without fuzzy regex matching.
-If `<node>` is not valid, return an empty JSON document.
+**NOTE:** Nodes are created automatically during daemon startup; they cannot be created by the client tools.
-#### `/api/v1/node/<node>/secondary`
+#### `/api/v1/node/<node>/coordinator-state`
- * Methods: `POST`
+ * Methods: `GET`, `POST`
 ###### `GET`:
 * Mandatory values: N/A
 * Optional values: N/A
-Set node `<node>` into Secondary coordinator mode.
+Return the coordinator state of `<node>`.
-Attempting to `secondary` a non-primary node will return a failure.
+###### `POST`:
 * Mandatory values: `coordinator-state`
 * Optional values: N/A
-#### `/api/v1/node/<node>/primary`
+Set node `<node>` into the specified coordinator state. Attempting to re-set an existing state has no effect.
- * Methods: `POST`
+
 Valid `coordinator-state` values are: `primary`, `secondary`.
 #### `/api/v1/node/<node>/domain-state`
 * Methods: `GET`, `POST`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: N/A
-Set node `<node>` into Primary coordinator mode.
+Return the domain state of `<node>`.
-Attempting to `primary` an already-primary node will return a failure.
+###### `POST`
-
+ * Mandatory values: `domain-state`
 #### `/api/v1/node/<node>/flush`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
-Flush node `<node>` of running VMs. This command does not wait for completion of the flush and returns immediately.
+Set node `<node>` to the specified domain state. Attempting to re-set an existing state has effect only if a previous state change did not complete fully, as this triggers a fresh change of state.
-Attempting to `flush` an already flushed node will **NOT** return a failure.
+Valid `coordinator-state` values are: `flush`, `ready`.
 #### `/api/v1/node/<node>/unflush`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
 Unflush (return to ready) node `<node>`, restoring migrated VMs. This command does not wait for completion of the flush and returns immediately.
 Attempting to `unflush` a non-flushed node will **NOT** return a failure.
 #### `/api/v1/node/<node>/ready`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
 This endpoint is an alias for `/api/v1/node/<node>/unflush`.
 ### VM endpoints
@ -129,136 +132,102 @@ These endpoints manage PVC virtual machine (VM) state and operation.
 **NOTE:** The `<vm>` variable in all VM endpoints can be either a `name` or a `uuid`. UUIDs are used internally by PVC to track and identify VMs, but are not human-readable, so the clients treat both as equally valid and will automatically determine the `uuid` for any given `name`.
 #### `/api/v1/vm`
- * Methods: `GET`
+ * Methods: `GET`, `POST`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: `limit`
-Return a JSON document containing information about all cluster VMs .
+Return a JSON document containing information about all cluster VMs. If `limit` is specified, return a JSON document containing information about VMs with names matching `limit` as fuzzy regex.
-If `limit` is specified, return a JSON document containing information about VMs with names matching `limit` as fuzzy regex.
+###### `POST`
 * Mandatory values: `xml`
 * Optional values: `node`, `selector`
 Define a new VM with Libvirt XML configuration `xml` (either single-line or human-readable multi-line).
 If `node` is specified and is valid, the VM will be assigned to `node` instead of automatically determining the target node. If `node` is specified and not valid, auto-selection occurrs instead.
 If `selector` is specified and no specific and valid `node` is specified, the automatic node determination will use `selector` to determine the optimal node instead of the default for the cluster.
 Valid `selector` values are: `mem`: the node with the least allocated VM memory; `vcpus`: the node with the least allocated VM vCPUs; `load`: the node with the least current load average; `vms`: the node with the least number of provisioned VMs.
 **NOTE:** The `POST` operation assumes that the VM resources (i.e. disks, operating system, etc.) are already created. This is equivalent to the `pvc vm define` command in the PVC CLI client. *[todo v0.6]* Creating a new VM using the provisioner uses the `POST /api/vm/<vm>` endpoint instead.
 #### `/api/v1/vm/<vm>`
- * Methods: `GET`
+ * Methods: `GET`, *[todo v0.6]* `POST`, `PUT`, `DELETE`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about `<vm>`. The output is identical to `/api/v1/vm?limit=<vm>` without fuzzy regex.
+Return a JSON document containing information about `<vm>`. The output is identical to `GET /api/v1/vm?limit=<vm>` without fuzzy regex matching.
-If `<vm>` is not valid, return an empty JSON document.
+###### *[todo v0.6]* `POST`
 * Mandatory values: `vm_template`
 * Optional values: `description`
-#### `/api/v1/vm/<vm>/define`
+Create a new virtual machine `<vm>` with the specified VM template `vm_template` and optional text `description`.
- * Methods: `POST`
+
 ###### `PUT`
 * Mandatory values: `xml`
- * Optional values: `node`, `selector`
+ * Optional values: `restart`
-Define a new VM with name or UUID `<vm>`.
+Replace the existing Libvirt XML definition for `<vm>` with the specified Libvirt XML configuration `xml` (either single-line or human-readable multi-line).
-**NOTE:** While included for consistency, the specified `<vm>` value is ignored and the values from the Libvirt XML configuration will be used instead.
+If `restart` is specified, the cluster will automatically `restart` the VM with the new configuration; if not, the administrator must do so manually.
-`xml` must be a valid Libvirt XML definition; human-readable, multi-line formatted definitions are fully supported.
+###### `DELETE`
 * Mandatory values: N/A
 * Optional values: `delete_disks`
-If `node` is specified and is valid, the VM will be assigned to `node` instead of automatically determining the target node. If `node` is specified and not valid, return a failure. 
+Forcibly stop and undefine `<vm>`.
-If `selector` is specified, the automatic node determination will use `selector` to determine the optimal node instead of the default (`mem`, least allocated VM memory). If `node` is also specified, this value is ignored.
+If `delete_disks` is specified, also remove all Ceph storage volumes for the VM.
-#### `/api/v1/vm/<vm>/modify`
+#### `/api/v1/vm/<vm>/state`
- * Methods: `POST`
+ * Methods: `GET`, `POST`
 * Mandatory values: `xml`
 * Optional values: `flag_restart`
-Replace an existing VM Libvirt XML definition for a VM with name or UUID `<vm>`.
+###### `GET`
 `xml` must be a valid Libvirt XML definition; human-readable, multi-line formatted definitions are fully supported.
 By default the cluster will not restart the VM to load the new configuration; the administrator must do so manually.
 If `flag_restart` is specified, the cluster will automatically `restart` the VM with the new configuration.
 #### `/api/v1/vm/<vm>/undefine`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
-Forcibly stop and undefine the VM with name or UUID `<vm>`, preserving Ceph volumes.
+Return the state of `<vm>`.
-#### `/api/v1/vm/<vm>/remove`
+###### `POST`
- * Methods: `POST`
+ * Mandatory values: `state`
 * Optional values: N/A
 Set `<vm>` to the specified state. Attempting to re-set an existing state has no effect.
 Valid `state` values are: `start`, `shutdown`, `stop`, `restart`
 **NOTE:** The `shutdown` state will attempt to gracefully shutdown the VM with a 90s timeout, after which it will forcibly `stop` the VM.
 #### `/api/v1/vm/<vm>/node`
 * Methods: `GET`, `POST`
 ###### `GET`
 * Mandatory values: N/A
 * Optional values: N/A
-Forcibly stop, undefine, and remove Ceph volumes of the VM with name or UUID `<vm>`.
+Return the current host node and previous node, if applicable, for `<vm>`.
-#### `/api/v1/vm/<vm>/dump`
+###### `POST`
 * Methods: `GET`
 * Mandatory values: N/A
- * Optional values: N/A
+ * Optional values: `node`, `selector`, `permanent`
-Obtain the raw Libvirt XML configuration of the VM with name or UUID `<vm>`.
+Change the current host node for `<vm>`, using live migration if possible, and using `shutdown` then `start` if not.
-Return an XML document containing the Libvirt XML and HTTP code 200 on success.
+If `node` is specified and is valid, the VM will be assigned to `node` instead of automatically determining the target node. If `node` is specified and not valid, auto-selection occurrs instead.
-#### `/api/v1/vm/<vm>/start`
+If `node` is not specified and the VM is in migrated state, returns the VM to its previous `node`.
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
-Start the VM with name or UUID `<vm>`.
+If `selector` is specified and no specific and valid `node` is specified, the automatic node determination will use `selector` to determine the optimal node instead of the default for the cluster.
-#### `/api/v1/vm/<vm>/restart`
+Valid `selector` values are: `mem`: the node with the least allocated VM memory; `vcpus`: the node with the least allocated VM vCPUs; `load`: the node with the least current load average; `vms`: the node with the least number of provisioned VMs.
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
-Restart (`shutdown` then `start`) the VM with name or UUID `<vm>`.
+If `permanent` is specified, the PVC system will not track the previous node and the VM will not be considered migrated.
 #### `/api/v1/vm/<vm>/shutdown`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
 Gracefully shutdown the VM with name or UUID `<vm>`. The shutdown event will time out after 90s and `stop` the VM.
 #### `/api/v1/vm/<vm>/stop`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
 Forcibly terminate the VM with name or UUID `<vm>` immediately.
 #### `/api/v1/vm/<vm>/move`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: `node`, `selector`
 Permanently move (do not track previous node) the VM with name or UUID `<vm>`. Use Libvirt live migration if possible; otherwise `shutdown` then `start` on the new node.
 If `node` is specified and is valid, the VM will be assigned to `node` instead of automatically determining the target node. If `node` is specified and not valid, return a failure. 
 If `selector` is specified, the automatic node determination will use `selector` to determine the optimal node instead of the default (`mem`, least allocated VM memory). If `node` is also specified, this value is ignored.
 #### `/api/v1/vm/<vm>/migrate`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: `node`, `selector`, `flag_force`
 Temporarily move (track the previous node and migrated state) the VM with name or UUID `<vm>`. Use Libvirt live migration if possible; otherwise `shutdown` then `start` on the new node.
 If `node` is specified and is valid, the VM will be assigned to `node` instead of automatically determining the target node. If `node` is specified and not valid, return a failure.
 If `selector` is specified, the automatic node determination will use `selector` to determine the optimal node instead of the default (`mem`, least allocated VM memory). If `node` is also specified, this value is ignored.
 Attempting to `migrate` an already-migrated VM will return a failure.
 If `flag_force` is specified, migrate the VM even if it has already been migrated. The previous node value will not be replaced; e.g. if VM `test` was on `pvchv1`, then `migrate`ed to `pvchv2`, then `flag_force` `migrate`ed to `pvchv3`, the `previous_node` would still be `pvchv1`. This can be repeated indefinitely.
 #### `/api/v1/vm/<vm>/unmigrate`
 * Methods: `POST`
 * Mandatory values: N/A
 * Optional values: N/A
 Unmigrate the `migrate`ed VM with name or UUID `<vm>`, returning it to its previous node. Use Libvirt live migration if possible; otherwise `shutdown` then `start` on the previous node.
 Attempting to `unmigrate` a non-migrated VM will return a failure.
 ### Network endpoints
@ -278,14 +247,14 @@ If `limit` is specified, return a JSON document containing information about clu
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about `<network>`. The output is identical to `/api/v1/network?limit=<network>` without fuzzy regex.
+Return a JSON document containing information about `<network>`. The output is identical to `/api/v1/network?limit=<network>` without fuzzy regex matching.
 If `<network>` is not valid, return an empty JSON document.
 #### `/api/v1/network/<network>/add`
 * Methods: `POST`
 * Mandatory values: `vni`, `nettype`
- * Optional values: `domain`, `ip4_network`, `ip4_gateway`, `ip6_network`, `ip6_gateway`, `flag_dhcp4`, `dhcp4_start`, `dhcp4_end`
+ * Optional values: `domain`, `ip4_network`, `ip4_gateway`, `ip6_network`, `ip6_gateway`, `dhcp4`, `dhcp4_start`, `dhcp4_end`
 Add a new virtual network with (whitespace-free) description `<network>`.
@ -307,16 +276,16 @@ Add a new virtual network with (whitespace-free) description `<network>`.
 `ip6_gateway` specifies an IP address from the `ip6_network` for the primary coordinator node to provide gateway services to the network. If `ip6_network` is specified but `ip6_gateway` is not specified or is invalid, default to `<ip6_network>::1`.
-`flag_dhcp4` specifies that DHCPv4 should be used for the IPv4 network.
+`dhcp4` specifies that DHCPv4 should be used for the IPv4 network.
-`dhcp4_start` specifies an IP address for the start of the DHCPv4 IP pool. If `flag_dhcp4` is specified but `dhcp4_start` is not specified or is invalid, return a failure.
+`dhcp4_start` specifies an IP address for the start of the DHCPv4 IP pool. If `dhcp4` is specified but `dhcp4_start` is not specified or is invalid, return a failure.
-`dhcp4_end` specifies an IP address for the end of the DHCPv4 IP pool. If `flag_dhcp4` is specified but `dhcp4_end` is not specified or is invalid, return a failure.
+`dhcp4_end` specifies an IP address for the end of the DHCPv4 IP pool. If `dhcp4` is specified but `dhcp4_end` is not specified or is invalid, return a failure.
 #### `/api/v1/network/<network>/modify`
 * Methods: `POST`
 * Mandatory values: N/A
- * Optional values: `vni`, `nettype` `domain`, `ip4_network`, `ip4_gateway`, `ip6_network`, `ip6_gateway`, `flag_dhcp4`, `dhcp4_start`, `dhcp4_end`
+ * Optional values: `vni`, `nettype` `domain`, `ip4_network`, `ip4_gateway`, `ip6_network`, `ip6_gateway`, `dhcp4`, `dhcp4_start`, `dhcp4_end`
 Modify the options of an existing virtual network with description `<network>`.
@ -334,20 +303,20 @@ Remove a virtual network with description `<network>`.
 #### `/api/v1/network/<network>/dhcp`
 * Methods: `GET`
 * Mandatory values: N/A
- * Optional values: `limit`, `flag_static`
+ * Optional values: `limit`, `static`
 Return a JSON document containing information about all active DHCP leases in virtual network with description `<network>`.
 If `limit` is specified, return a JSON document containing information about all active DHCP leases with MAC addresses matching `limit` as fuzzy regex.
-If `flag_static` is specified, only return static DHCP leases.
+If `static` is specified, only return static DHCP leases.
 #### `/api/v1/network/<network>/dhcp/<lease>`
 * Methods: `GET`
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about DHCP lease with MAC address `<lease>` in virtual network with description `<network>`. The output is identical to `/api/v1/network/<network>/dhcp?limit=<lease>` without fuzzy regex.
+Return a JSON document containing information about DHCP lease with MAC address `<lease>` in virtual network with description `<network>`. The output is identical to `/api/v1/network/<network>/dhcp?limit=<lease>` without fuzzy regex matching.
 If `<lease>` is not valid, return an empty JSON document.
@ -385,7 +354,7 @@ If `direction` is specified and is one of `in` or `out`, return a JSON codument
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about NFTables ACL with description `<acl>` in virtual network with description `<network>`. The output is identical to `/api/v1/network/<network>/acl?limit=<acl>` without fuzzy regex.
+Return a JSON document containing information about NFTables ACL with description `<acl>` in virtual network with description `<network>`. The output is identical to `/api/v1/network/<network>/acl?limit=<acl>` without fuzzy regex matching.
 If `<acl>` is not valid, return an empty JSON document.
@ -487,12 +456,12 @@ Add a new Ceph OSD to PVC node with name `<node>`.
 #### `/api/v1/storage/ceph/osd/<osd>/remove`
 * Methods: `POST`
- * Mandatory values: `flag_yes_i_really_mean_it`
+ * Mandatory values: `yes_i_really_mean_it`
 * Optional values: N/A
 Remove a Ceph OSD device with ID `<osd>` from the storage cluster.
-**NOTE:** This is a command with potentially dangerous unintended consequences that should not be scripted. To acknowledge the danger, the `flag_yes_i_really_mean_it` must be set or the endpoint will return a failure.
+**NOTE:** This is a command with potentially dangerous unintended consequences that should not be scripted. To acknowledge the danger, the `yes_i_really_mean_it` must be set or the endpoint will return a failure.
 **WARNING:** Removing an OSD without first setting it `out` (and letting it flush) triggers an unclean PG recovery. This could potentially cause data loss if other OSDs were to fail or be removed. OSDs should not normally be removed except in the case of failed OSDs during replacement or during a replacement with a larger disk.
@ -524,7 +493,7 @@ If `limit` is specified, return a JSON document containing information about all
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/pool?limit=<pool>` without fuzzy regex.
+Return a JSON document containing information about Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/pool?limit=<pool>` without fuzzy regex matching.
 #### `/api/v1/storage/ceph/pool/<pool>/add`
 * Methods: `POST`
@ -537,12 +506,12 @@ Add a new Ceph RBD pool with name `<pool>` to the storage cluster.
 #### `/api/v1/storage/ceph/pool/<pool>/remove`
 * Methods: `POST`
- * Mandatory values: `flag_yes_i_really_mean_it`
+ * Mandatory values: `yes_i_really_mean_it`
 * Optional values: N/A
 Remove a Ceph RBD pool with name `<pool>` from the storage cluster.
-**NOTE:** This is a command with potentially dangerous unintended consequences that should not be scripted. To acknowledge the danger, the `flag_yes_i_really_mean_it` must be set or the endpoint will return a failure.
+**NOTE:** This is a command with potentially dangerous unintended consequences that should not be scripted. To acknowledge the danger, the `yes_i_really_mean_it` must be set or the endpoint will return a failure.
 **WARNING:** Removing an RBD pool will delete all data on that pool, including all Ceph RBD volumes on the pool. Do not run this command lightly and without ensuring the pool is safely removable first.
@ -562,7 +531,7 @@ If `limit` is specified, return a JSON document containing information about all
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about Ceph RBD volume with name `<volume>` in Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/volume?pool=<pool>&limit=<volume>` without fuzzy regex.
+Return a JSON document containing information about Ceph RBD volume with name `<volume>` in Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/volume?pool=<pool>&limit=<volume>` without fuzzy regex matching.
 #### `/api/v1/storage/ceph/volume/<pool>/<volume>/add`
 * Methods: `POST`
@ -600,7 +569,7 @@ The various limit options can be combined freely, e.g. one can specify a `volume
 * Mandatory values: N/A
 * Optional values: N/A
-Return a JSON document containing information about Ceph RBD volume snapshot with name `<snapshot>` of Ceph RBD volume with name `<volume>` in Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/volume?pool=<pool>&volume=<volume>&limit=<snapshot>` without fuzzy regex.
+Return a JSON document containing information about Ceph RBD volume snapshot with name `<snapshot>` of Ceph RBD volume with name `<volume>` in Ceph RBD pool with name `<pool>`. The output is identical to `/api/v1/storage/ceph/volume?pool=<pool>&volume=<volume>&limit=<snapshot>` without fuzzy regex matching.
 #### `/api/v1/storage/ceph/volume/snapshot/<pool>/<volume>/<snapshot>/add`
 * Methods: `POST`