RAPI: Add resource to recreate instance's disks

[ganeti-local] / doc / rapi.rst

diff --git a/doc/rapi.rst b/doc/rapi.rst
index be57b01..20602b0 100644 (file)
--- a/doc/rapi.rst
+++ b/doc/rapi.rst
@@ -1,7 +1,7 @@
 Ganeti remote API
 =================
 
 Ganeti remote API
 =================
 

-Documents Ganeti version 2.0
+Documents Ganeti version |version|

 
 .. contents::
 
 
 .. contents::
 

@@ -16,27 +16,175 @@ it runs on TCP port 5080, but this can be changed either in
 which is used by default, can also be disabled by passing command line
 parameters.
 
 which is used by default, can also be disabled by passing command line
 parameters.
 

+
+Users and passwords
+-------------------
+
+``ganeti-rapi`` reads users and passwords from a file (usually
+``/var/lib/ganeti/rapi/users``) on startup. Changes to the file will be
+read automatically.
+
+Each line consists of two or three fields separated by whitespace. The
+first two fields are for username and password. The third field is
+optional and can be used to specify per-user options. Currently,
+``write`` is the only option supported and enables the user to execute
+operations modifying the cluster. Lines starting with the hash sign
+(``#``) are treated as comments.
+
+Passwords can either be written in clear text or as a hash. Clear text
+passwords may not start with an opening brace (``{``) or they must be
+prefixed with ``{cleartext}``. To use the hashed form, get the MD5 hash
+of the string ``$username:Ganeti Remote API:$password`` (e.g. ``echo -n
+'jack:Ganeti Remote API:abc123' | openssl md5``) [#pwhash]_ and prefix
+it with ``{ha1}``. Using the scheme prefix for all passwords is
+recommended. Scheme prefixes are not case sensitive.
+
+Example::
+
+  # Give Jack and Fred read-only access
+  jack abc123
+  fred {cleartext}foo555
+
+  # Give write access to an imaginary instance creation script
+  autocreator xyz789 write
+
+  # Hashed password for Jessica
+  jessica {HA1}7046452df2cbb530877058712cf17bd4 write
+
+
+.. [#pwhash] Using the MD5 hash of username, realm and password is
+   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
+   and 3.3. The reason for using it over another algorithm is forward
+   compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
+   authentication in the future, the same hash could be used.
+   In the current version ``ganeti-rapi``'s realm, ``Ganeti Remote
+   API``, can only be changed by modifying the source code.
+
+

 Protocol
 --------
 
 Protocol
 --------
 

-The protocol used is JSON_ over HTTP designed after the REST_
-principle.
+The protocol used is JSON_ over HTTP designed after the REST_ principle.
+HTTP Basic authentication as per :rfc:`2617` is supported.

 
 .. _JSON: http://www.json.org/
 .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
 
 
 .. _JSON: http://www.json.org/
 .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
 

+HTTP requests with a body (e.g. ``PUT`` or ``POST``) require the request
+header ``Content-type`` be set to ``application/json`` (see :rfc:`2616`
+(HTTP/1.1), section 7.2.1).
+
+
+A note on JSON as used by RAPI
+++++++++++++++++++++++++++++++
+
+JSON_ as used by Ganeti RAPI does not conform to the specification in
+:rfc:`4627`. Section 2 defines a JSON text to be either an object
+(``{"key": "value", …}``) or an array (``[1, 2, 3, …]``). In violation
+of this RAPI uses plain strings (``"master-candidate"``, ``"1234"``) for
+some requests or responses. Changing this now would likely break
+existing clients and cause a lot of trouble.
+
+.. highlight:: ruby
+
+Unlike Python's `JSON encoder and decoder
+<http://docs.python.org/library/json.html>`_, other programming
+languages or libraries may only provide a strict implementation, not
+allowing plain values. For those, responses can usually be wrapped in an
+array whose first element is then used, e.g. the response ``"1234"``
+becomes ``["1234"]``. This works equally well for more complex values.
+Example in Ruby::
+
+  require "json"
+
+  # Insert code to get response here
+  response = "\"1234\""
+
+  decoded = JSON.parse("[#{response}]").first
+
+Short of modifying the encoder to allow encoding to a less strict
+format, requests will have to be formatted by hand. Newer RAPI requests
+already use a dictionary as their input data and shouldn't cause any
+problems.
+
+
+PUT or POST?
+------------
+
+According to :rfc:`2616` the main difference between PUT and POST is
+that POST can create new resources but PUT can only create the resource
+the URI was pointing to on the PUT request.
+
+Unfortunately, due to historic reasons, the Ganeti RAPI library is not
+consistent with this usage, so just use the methods as documented below
+for each resource.
+
+For more details have a look in the source code at
+``lib/rapi/rlib2.py``.
+
+
+Generic parameter types
+-----------------------
+
+A few generic refered parameter types and the values they allow.
+
+``bool``
+++++++++
+
+A boolean option will accept ``1`` or ``0`` as numbers but not
+i.e. ``True`` or ``False``.
+
+Generic parameters
+------------------
+
+A few parameter mean the same thing across all resources which implement
+it.
+
+``bulk``
+++++++++
+
+Bulk-mode means that for the resources which usually return just a list
+of child resources (e.g. ``/2/instances`` which returns just instance
+names), the output will instead contain detailed data for all these
+subresources. This is more efficient than query-ing the sub-resources
+themselves.
+
+``dry-run``
++++++++++++
+
+The boolean *dry-run* argument, if provided and set, signals to Ganeti
+that the job should not be executed, only the pre-execution checks will
+be done.
+
+This is useful in trying to determine (without guarantees though, as in
+the meantime the cluster state could have changed) if the operation is
+likely to succeed or at least start executing.
+
+``force``
++++++++++++
+
+Force operation to continue even if it will cause the cluster to become
+inconsistent (e.g. because there are not enough master candidates).
+

 Usage examples
 --------------
 
 Usage examples
 --------------
 

-You can access the API using your favorite programming language as
-long as it supports network connections.
+You can access the API using your favorite programming language as long
+as it supports network connections.
+
+Ganeti RAPI client
+++++++++++++++++++
+
+Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.

 
 Shell
 +++++
 
 
 Shell
 +++++
 

+.. highlight:: sh
+

 Using wget::
 
 Using wget::
 

-  wget -q -O - https://CLUSTERNAME:5080/2/info
+   wget -q -O - https://CLUSTERNAME:5080/2/info

 
 or curl::
 
 
 or curl::
 

@@ -46,6 +194,8 @@ or curl::
 Python
 ++++++
 
 Python
 ++++++
 

+.. highlight:: python
+

 ::
 
   import urllib2
 ::
 
   import urllib2

@@ -56,10 +206,12 @@ Python
 JavaScript
 ++++++++++
 
 JavaScript
 ++++++++++
 

-.. warning:: While it's possible to use JavaScript, it poses several potential
-  problems, including browser blocking request due to
-  non-standard ports or different domain names. Fetching the data
-  on the webserver is easier.
+.. warning:: While it's possible to use JavaScript, it poses several
+   potential problems, including browser blocking request due to
+   non-standard ports or different domain names. Fetching the data on
+   the webserver is easier.
+
+.. highlight:: javascript

 
 ::
 
 
 ::
 

@@ -82,59 +234,32 @@ JavaScript
 Resources
 ---------
 
 Resources
 ---------
 

-/
-+
-
-::
-
-  / resource.
+.. highlight:: javascript

 
 

-It supports the following commands: GET.
-
-GET
-~~~
-
-::
-
-  Show the list of mapped resources.
-
-  Returns: a dictionary with 'name' and 'uri' keys for each of them.
-
-/2
-++
-
-::
-
-  /2 resource, the root of the version 2 API.
-
-It supports the following commands: GET.
-
-GET
-~~~
-
-::
+``/``
++++++

 
 

-  Show the list of mapped resources.
+The root resource. Has no function, but for legacy reasons the ``GET``
+method is supported.

 
 

-  Returns: a dictionary with 'name' and 'uri' keys for each of them.
+``/2``
+++++++

 
 

-/2/info
-+++++++
+Has no function, but for legacy reasons the ``GET`` method is supported.

 
 

-::
+``/2/info``
++++++++++++

 
 

-  Cluster info.
+Cluster information resource.

 
 

-It supports the following commands: GET.
+It supports the following commands: ``GET``.

 
 

-GET
-~~~
+``GET``
+~~~~~~~

 
 

-::
+Returns cluster information.

 
 

-  Returns cluster information.
-
-  Example::
+Example::

 
   {
     "config_version": 2000000,
 
   {
     "config_version": 2000000,

@@ -165,24 +290,274 @@ GET
       }
     }
 
       }
     }
 

-/2/instances
-++++++++++++

 
 

-::
+``/2/redistribute-config``
+++++++++++++++++++++++++++

 
 

-  /2/instances resource.
+Redistribute configuration to all nodes.

 
 

-It supports the following commands: GET, POST.
+It supports the following commands: ``PUT``.

 
 

-GET
-~~~
+``PUT``
+~~~~~~~

 
 

-::
+Redistribute configuration to all nodes. The result will be a job id.
+
+
+``/2/features``
++++++++++++++++
+
+``GET``
+~~~~~~~
+
+Returns a list of features supported by the RAPI server. Available
+features:
+
+.. pyassert::
+
+  rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
+                             rlib2._INST_REINSTALL_REQV1,
+                             rlib2._NODE_MIGRATE_REQV1,
+                             rlib2._NODE_EVAC_RES1])
+
+:pyeval:`rlib2._INST_CREATE_REQV1`
+  Instance creation request data version 1 supported.
+:pyeval:`rlib2._INST_REINSTALL_REQV1`
+  Instance reinstall supports body parameters.
+:pyeval:`rlib2._NODE_MIGRATE_REQV1`
+  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
+  request body parameters.
+:pyeval:`rlib2._NODE_EVAC_RES1`
+  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
+  a new-style result (see resource description)
+
+
+``/2/modify``
+++++++++++++++++++++++++++++++++++++++++
+
+Modifies cluster parameters.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_CLUSTER_SET_PARAMS
+
+
+``/2/groups``
++++++++++++++
+
+The groups resource.
+
+It supports the following commands: ``GET``, ``POST``.
+
+``GET``
+~~~~~~~
+
+Returns a list of all existing node groups.
+
+Example::
+
+    [
+      {
+        "name": "group1",
+        "uri": "\/2\/groups\/group1"
+      },
+      {
+        "name": "group2",
+        "uri": "\/2\/groups\/group2"
+      }
+    ]
+
+If the optional bool *bulk* argument is provided and set to a true value
+(i.e ``?bulk=1``), the output contains detailed information about node
+groups as a list.
+
+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`

 
 

-  Returns a list of all available instances.
+Example::

 
 

+    [
+      {
+        "name": "group1",
+        "node_cnt": 2,
+        "node_list": [
+          "node1.example.com",
+          "node2.example.com"
+        ],
+        "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
+      },
+      {
+        "name": "group2",
+        "node_cnt": 1,
+        "node_list": [
+          "node3.example.com"
+        ],
+        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
+      }
+    ]
+
+``POST``
+~~~~~~~~
+
+Creates a node group.
+
+If the optional bool *dry-run* argument is provided, the job will not be
+actually executed, only the pre-execution checks will be done.
+
+Returns: a job ID that can be used later for polling.
+
+Body parameters:
+
+.. opcode_params:: OP_GROUP_ADD
+
+Earlier versions used a parameter named ``name`` which, while still
+supported, has been renamed to ``group_name``.
+
+
+``/2/groups/[group_name]``
+++++++++++++++++++++++++++
+
+Returns information about a node group.
+
+It supports the following commands: ``GET``, ``DELETE``.
+
+``GET``
+~~~~~~~
+
+Returns information about a node group, similar to the bulk output from
+the node group list.
+
+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
+
+``DELETE``
+~~~~~~~~~~
+
+Deletes a node group.
+
+It supports the ``dry-run`` argument.
+
+
+``/2/groups/[group_name]/modify``
++++++++++++++++++++++++++++++++++
+
+Modifies the parameters of a node group.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_GROUP_SET_PARAMS
+   :exclude: group_name
+
+Job result:
+
+.. opcode_result:: OP_GROUP_SET_PARAMS
+
+
+``/2/groups/[group_name]/rename``
++++++++++++++++++++++++++++++++++
+
+Renames a node group.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_GROUP_RENAME
+   :exclude: group_name
+
+Job result:
+
+.. opcode_result:: OP_GROUP_RENAME
+
+
+``/2/groups/[group_name]/assign-nodes``
++++++++++++++++++++++++++++++++++++++++
+
+Assigns nodes to a group.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.
+
+Body parameters:
+
+.. opcode_params:: OP_GROUP_ASSIGN_NODES
+   :exclude: group_name, force, dry_run

 
 

-  Example::
+
+``/2/groups/[group_name]/tags``
++++++++++++++++++++++++++++++++
+
+Manages per-nodegroup tags.
+
+Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+``GET``
+~~~~~~~
+
+Returns a list of tags.
+
+Example::
+
+    ["tag1", "tag2", "tag3"]
+
+``PUT``
+~~~~~~~
+
+Add a set of tags.
+
+The request as a list of strings should be ``PUT`` to this URI. The
+result will be a job id.
+
+It supports the ``dry-run`` argument.
+
+
+``DELETE``
+~~~~~~~~~~
+
+Delete a tag.
+
+In order to delete a set of tags, the DELETE request should be addressed
+to URI like::
+
+    /tags?tag=[tag]&tag=[tag]
+
+It supports the ``dry-run`` argument.
+
+
+``/2/instances``
+++++++++++++++++
+
+The instances resource.
+
+It supports the following commands: ``GET``, ``POST``.
+
+``GET``
+~~~~~~~
+
+Returns a list of all available instances.
+
+Example::

 
     [
       {
 
     [
       {

@@ -195,11 +570,13 @@ GET
       }
     ]
 
       }
     ]
 

-  If the optional 'bulk' argument is provided and set to 'true'
-  value (i.e '?bulk=1'), the output contains detailed
-  information about instances as a list.
+If the optional bool *bulk* argument is provided and set to a true value
+(i.e ``?bulk=1``), the output contains detailed information about
+instances as a list.
+
+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

 
 

-  Example::
+Example::

 
     [
       {
 
     [
       {

@@ -228,233 +605,616 @@ GET
       ...
     ]
 
       ...
     ]
 

-  Returns: a dictionary with 'name' and 'uri' keys for each of them.

 
 

-POST
-~~~~
+``POST``
+~~~~~~~~

 
 

-::
+Creates an instance.

 
 

-  Create an instance.
+If the optional bool *dry-run* argument is provided, the job will not be
+actually executed, only the pre-execution checks will be done. Query-ing
+the job result will return, in both dry-run and normal case, the list of
+nodes selected for the instance.

 
 

-  Returns: a job id
+Returns: a job ID that can be used later for polling.

 
 

-/2/instances/[instance_name]
-++++++++++++++++++++++++++++
+Body parameters:

 
 

-::
+``__version__`` (int, required)
+  Must be ``1`` (older Ganeti versions used a different format for
+  instance creation requests, version ``0``, but that format is no
+  longer supported)

 
 

-  /2/instances/[instance_name] resources.
+.. opcode_params:: OP_INSTANCE_CREATE

 
 

-It supports the following commands: GET, DELETE.
+Earlier versions used parameters named ``name`` and ``os``. These have
+been replaced by ``instance_name`` and ``os_type`` to match the
+underlying opcode. The old names can still be used.

 
 

-GET
-~~~
+Job result:

 
 

-::
+.. opcode_result:: OP_INSTANCE_CREATE

 
 

-  Send information about an instance.

 
 

+``/2/instances/[instance_name]``
+++++++++++++++++++++++++++++++++

 
 

+Instance-specific resource.

 
 

-DELETE
-~~~~~~
+It supports the following commands: ``GET``, ``DELETE``.

 
 

-::
+``GET``
+~~~~~~~

 
 

-  Delete an instance.
+Returns information about an instance, similar to the bulk output from
+the instance list.

 
 

+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

 
 

+``DELETE``
+~~~~~~~~~~

 
 

-/2/instances/[instance_name]/reboot
-+++++++++++++++++++++++++++++++++++
+Deletes an instance.

 
 

-::
+It supports the ``dry-run`` argument.

 
 

-  /2/instances/[instance_name]/reboot resource.

 
 

-  Implements an instance reboot.
+``/2/instances/[instance_name]/info``
++++++++++++++++++++++++++++++++++++++++

 
 

-It supports the following commands: POST.
+It supports the following commands: ``GET``.

 
 

-POST
-~~~~
+``GET``
+~~~~~~~

 
 

-::
+Requests detailed information about the instance. An optional parameter,
+``static`` (bool), can be set to return only static information from the
+configuration without querying the instance's nodes. The result will be
+a job id.
+
+
+``/2/instances/[instance_name]/reboot``
++++++++++++++++++++++++++++++++++++++++
+
+Reboots URI for an instance.
+
+It supports the following commands: ``POST``.
+
+``POST``
+~~~~~~~~
+
+Reboots the instance.
+
+The URI takes optional ``type=soft|hard|full`` and
+``ignore_secondaries=0|1`` parameters.
+
+``type`` defines the reboot type. ``soft`` is just a normal reboot,
+without terminating the hypervisor. ``hard`` means full shutdown
+(including terminating the hypervisor process) and startup again.
+``full`` is like ``hard`` but also recreates the configuration from
+ground up as if you would have done a ``gnt-instance shutdown`` and
+``gnt-instance start`` on it.
+
+``ignore_secondaries`` is a bool argument indicating if we start the
+instance even if secondary disks are failing.
+
+It supports the ``dry-run`` argument.
+
+
+``/2/instances/[instance_name]/shutdown``
++++++++++++++++++++++++++++++++++++++++++
+
+Instance shutdown URI.
+
+It supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Shutdowns an instance.
+
+It supports the ``dry-run`` argument.
+
+.. opcode_params:: OP_INSTANCE_SHUTDOWN
+   :exclude: instance_name, dry_run
+
+
+``/2/instances/[instance_name]/startup``
+++++++++++++++++++++++++++++++++++++++++

 
 

-  Reboot an instance.
+Instance startup URI.

 
 

-  The URI takes type=[hard|soft|full] and
-  ignore_secondaries=[False|True] parameters.
+It supports the following commands: ``PUT``.

 
 

-/2/instances/[instance_name]/shutdown
+``PUT``
+~~~~~~~
+
+Startup an instance.
+
+The URI takes an optional ``force=1|0`` parameter to start the
+instance even if secondary disks are failing.
+
+It supports the ``dry-run`` argument.
+
+``/2/instances/[instance_name]/reinstall``
+++++++++++++++++++++++++++++++++++++++++++++++
+
+Installs the operating system again.
+
+It supports the following commands: ``POST``.
+
+``POST``
+~~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+``os`` (string, required)
+  Instance operating system.
+``start`` (bool, defaults to true)
+  Whether to start instance after reinstallation.
+``osparams`` (dict)
+  Dictionary with (temporary) OS parameters.
+
+For backwards compatbility, this resource also takes the query
+parameters ``os`` (OS template name) and ``nostartup`` (bool). New
+clients should use the body parameters.
+
+
+``/2/instances/[instance_name]/replace-disks``
+++++++++++++++++++++++++++++++++++++++++++++++
+
+Replaces disks on an instance.
+
+It supports the following commands: ``POST``.
+
+``POST``
+~~~~~~~~
+
+Takes the parameters ``mode`` (one of ``replace_on_primary``,
+``replace_on_secondary``, ``replace_new_secondary`` or
+``replace_auto``), ``disks`` (comma separated list of disk indexes),
+``remote_node`` and ``iallocator``.
+
+Either ``remote_node`` or ``iallocator`` needs to be defined when using
+``mode=replace_new_secondary``.
+
+``mode`` is a mandatory parameter. ``replace_auto`` tries to determine
+the broken disk(s) on its own and replacing it.
+
+
+``/2/instances/[instance_name]/activate-disks``
++++++++++++++++++++++++++++++++++++++++++++++++
+
+Activate disks on an instance.
+
+It supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Takes the bool parameter ``ignore_size``. When set ignore the recorded
+size (useful for forcing activation when recorded size is wrong).
+
+
+``/2/instances/[instance_name]/deactivate-disks``
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Deactivate disks on an instance.
+
+It supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Takes no parameters.
+
+
+``/2/instances/[instance_name]/recreate-disks``
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Recreate disks of an instance. Supports the following commands:
+``POST``.
+
+``POST``
+~~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_RECREATE_DISKS
+   :exclude: instance_name
+
+
+``/2/instances/[instance_name]/disk/[disk_index]/grow``
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Grows one disk of an instance.
+
+Supports the following commands: ``POST``.
+
+``POST``
+~~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_GROW_DISK
+   :exclude: instance_name, disk
+
+
+``/2/instances/[instance_name]/prepare-export``
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Prepares an export of an instance.
+
+It supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Takes one parameter, ``mode``, for the export mode. Returns a job ID.
+
+
+``/2/instances/[instance_name]/export``
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Exports an instance.
+
+It supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_BACKUP_EXPORT
+   :exclude: instance_name
+   :alias: target_node=destination
+
+
+``/2/instances/[instance_name]/migrate``
+++++++++++++++++++++++++++++++++++++++++
+
+Migrates an instance.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_MIGRATE
+   :exclude: instance_name, live
+
+
+``/2/instances/[instance_name]/failover``
++++++++++++++++++++++++++++++++++++++++++
+
+Does a failover of an instance.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_FAILOVER
+   :exclude: instance_name
+
+
+``/2/instances/[instance_name]/rename``
+++++++++++++++++++++++++++++++++++++++++
+
+Renames an instance.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_RENAME
+   :exclude: instance_name
+
+Job result:
+
+.. opcode_result:: OP_INSTANCE_RENAME
+
+
+``/2/instances/[instance_name]/modify``
+++++++++++++++++++++++++++++++++++++++++
+
+Modifies an instance.
+
+Supports the following commands: ``PUT``.
+
+``PUT``
+~~~~~~~
+
+Returns a job ID.
+
+Body parameters:
+
+.. opcode_params:: OP_INSTANCE_SET_PARAMS
+   :exclude: instance_name
+
+Job result:
+
+.. opcode_result:: OP_INSTANCE_SET_PARAMS
+
+
+``/2/instances/[instance_name]/console``
+++++++++++++++++++++++++++++++++++++++++
+
+Request information for connecting to instance's console.
+
+Supports the following commands: ``GET``.
+
+``GET``
+~~~~~~~
+
+Returns a dictionary containing information about the instance's
+console. Contained keys:
+
+.. pyassert::
+
+   constants.CONS_ALL == frozenset([
+     constants.CONS_MESSAGE,
+     constants.CONS_SSH,
+     constants.CONS_VNC,
+     constants.CONS_SPICE,
+     ])
+
+``instance``
+  Instance name.
+``kind``
+  Console type, one of :pyeval:`constants.CONS_SSH`,
+  :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
+  or :pyeval:`constants.CONS_MESSAGE`.
+``message``
+  Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
+``host``
+  Host to connect to (:pyeval:`constants.CONS_SSH`,
+  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
+``port``
+  TCP port to connect to (:pyeval:`constants.CONS_VNC` or
+  :pyeval:`constants.CONS_SPICE` only).
+``user``
+  Username to use (:pyeval:`constants.CONS_SSH` only).
+``command``
+  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
+``display``
+  VNC display number (:pyeval:`constants.CONS_VNC` only).
+
+
+``/2/instances/[instance_name]/tags``

 +++++++++++++++++++++++++++++++++++++
 
 +++++++++++++++++++++++++++++++++++++
 

-::
+Manages per-instance tags.

 
 

-  /2/instances/[instance_name]/shutdown resource.
+It supports the following commands: ``GET``, ``PUT``, ``DELETE``.

 
 

-  Implements an instance shutdown.
+``GET``
+~~~~~~~

 
 

-It supports the following commands: PUT.
+Returns a list of tags.

 
 

-PUT
-~~~
+Example::

 
 

-::
+    ["tag1", "tag2", "tag3"]

 
 

-  Shutdown an instance.
+``PUT``
+~~~~~~~

 
 

+Add a set of tags.

 
 

+The request as a list of strings should be ``PUT`` to this URI. The
+result will be a job id.

 
 

-/2/instances/[instance_name]/startup
-++++++++++++++++++++++++++++++++++++
+It supports the ``dry-run`` argument.

 
 

-::

 
 

-  /2/instances/[instance_name]/startup resource.
+``DELETE``
+~~~~~~~~~~

 
 

-  Implements an instance startup.
+Delete a tag.

 
 

-It supports the following commands: PUT.
+In order to delete a set of tags, the DELETE request should be addressed
+to URI like::

 
 

-PUT
-~~~
+    /tags?tag=[tag]&tag=[tag]

 
 

-::
+It supports the ``dry-run`` argument.

 
 

-  Startup an instance.

 
 

-  The URI takes force=[False|True] parameter to start the instance
-  if even if secondary disks are failing.
+``/2/jobs``
++++++++++++

 
 

-/2/instances/[instance_name]/tags
-+++++++++++++++++++++++++++++++++
+The ``/2/jobs`` resource.

 
 

-::
+It supports the following commands: ``GET``.

 
 

-  /2/instances/[instance_name]/tags resource.
+``GET``
+~~~~~~~

 
 

-  Manages per-instance tags.
+Returns a dictionary of jobs.

 
 

-It supports the following commands: GET, PUT, DELETE.
+Returns: a dictionary with jobs id and uri.

 
 

-GET
-~~~
+If the optional bool *bulk* argument is provided and set to a true value
+(i.e. ``?bulk=1``), the output contains detailed information about jobs
+as a list.

 
 

-::
+Returned fields for bulk requests (unlike other bulk requests, these
+fields are not the same as for per-job requests):
+:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`

 
 

-  Returns a list of tags.
+``/2/jobs/[job_id]``
+++++++++++++++++++++

 
 

-  Example: ["tag1", "tag2", "tag3"]

 
 

-PUT
-~~~
+Individual job URI.

 
 

-::
+It supports the following commands: ``GET``, ``DELETE``.

 
 

-  Add a set of tags.
+``GET``
+~~~~~~~

 
 

-  The request as a list of strings should be PUT to this URI. And
-  you'll have back a job id.
+Returns a dictionary with job parameters, containing the fields
+:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.

 
 

-DELETE
-~~~~~~
+The result includes:

 
 

-::
+- id: job ID as a number
+- status: current job status as a string
+- ops: involved OpCodes as a list of dictionaries for each opcodes in
+  the job
+- opstatus: OpCodes status as a list
+- opresult: OpCodes results as a list

 
 

-  Delete a tag.
+For a successful opcode, the ``opresult`` field corresponding to it will
+contain the raw result from its :term:`LogicalUnit`. In case an opcode
+has failed, its element in the opresult list will be a list of two
+elements:

 
 

-  In order to delete a set of tags, the DELETE
-  request should be addressed to URI like:
-  /tags?tag=[tag]&tag=[tag]
+- first element the error type (the Ganeti internal error name)
+- second element a list of either one or two elements:

 
 

-/2/jobs
-+++++++
+  - the first element is the textual error description
+  - the second element, if any, will hold an error classification

 
 

-::
+The error classification is most useful for the ``OpPrereqError``
+error type - these errors happen before the OpCode has started
+executing, so it's possible to retry the OpCode without side
+effects. But whether it make sense to retry depends on the error
+classification:

 
 

-  /2/jobs resource.
+.. pyassert::

 
 

-It supports the following commands: GET.
+   errors.ECODE_ALL == set([errors.ECODE_RESOLVER, errors.ECODE_NORES,
+     errors.ECODE_INVAL, errors.ECODE_STATE, errors.ECODE_NOENT,
+     errors.ECODE_EXISTS, errors.ECODE_NOTUNIQUE, errors.ECODE_FAULT,
+     errors.ECODE_ENVIRON])

 
 

-GET
-~~~
+:pyeval:`errors.ECODE_RESOLVER`
+  Resolver errors. This usually means that a name doesn't exist in DNS,
+  so if it's a case of slow DNS propagation the operation can be retried
+  later.

 
 

-::
+:pyeval:`errors.ECODE_NORES`
+  Not enough resources (iallocator failure, disk space, memory,
+  etc.). If the resources on the cluster increase, the operation might
+  succeed.

 
 

-  Returns a dictionary of jobs.
+:pyeval:`errors.ECODE_INVAL`
+  Wrong arguments (at syntax level). The operation will not ever be
+  accepted unless the arguments change.

 
 

-  Returns: a dictionary with jobs id and uri.
+:pyeval:`errors.ECODE_STATE`
+  Wrong entity state. For example, live migration has been requested for
+  a down instance, or instance creation on an offline node. The
+  operation can be retried once the resource has changed state.

 
 

-/2/jobs/[job_id]
-++++++++++++++++
+:pyeval:`errors.ECODE_NOENT`
+  Entity not found. For example, information has been requested for an
+  unknown instance.

 
 

-::
+:pyeval:`errors.ECODE_EXISTS`
+  Entity already exists. For example, instance creation has been
+  requested for an already-existing instance.

 
 

-  /2/jobs/[job_id] resource.
+:pyeval:`errors.ECODE_NOTUNIQUE`
+  Resource not unique (e.g. MAC or IP duplication).

 
 

-It supports the following commands: GET, DELETE.
+:pyeval:`errors.ECODE_FAULT`
+  Internal cluster error. For example, a node is unreachable but not set
+  offline, or the ganeti node daemons are not working, etc. A
+  ``gnt-cluster verify`` should be run.

 
 

-GET
-~~~
+:pyeval:`errors.ECODE_ENVIRON`
+  Environment error (e.g. node disk error). A ``gnt-cluster verify``
+  should be run.

 
 

-::
+Note that in the above list, by entity we refer to a node or instance,
+while by a resource we refer to an instance's disk, or NIC, etc.

 
 

-  Returns a job status.

 
 

-  Returns: a dictionary with job parameters.
-      The result includes:
-          - id: job ID as a number
-          - status: current job status as a string
-          - ops: involved OpCodes as a list of dictionaries for each
-            opcodes in the job
-          - opstatus: OpCodes status as a list
-          - opresult: OpCodes results as a list of lists
+``DELETE``
+~~~~~~~~~~

 
 

-DELETE
-~~~~~~
+Cancel a not-yet-started job.

 
 

-::

 
 

-  Cancel not-yet-started job.
+``/2/jobs/[job_id]/wait``
++++++++++++++++++++++++++

 
 

+``GET``
+~~~~~~~

 
 

+Waits for changes on a job. Takes the following body parameters in a
+dict:

 
 

-/2/nodes
-++++++++
+``fields``
+  The job fields on which to watch for changes.

 
 

-::
+``previous_job_info``
+  Previously received field values or None if not yet available.

 
 

-  /2/nodes resource.
+``previous_log_serial``
+  Highest log serial number received so far or None if not yet
+  available.

 
 

-It supports the following commands: GET.
+Returns None if no changes have been detected and a dict with two keys,
+``job_info`` and ``log_entries`` otherwise.

 
 

-GET
-~~~

 
 

-::
+``/2/nodes``
+++++++++++++
+
+Nodes resource.
+
+It supports the following commands: ``GET``.

 
 

-  Returns a list of all nodes.
+``GET``
+~~~~~~~

 
 

-  Example::
+Returns a list of all nodes.
+
+Example::

 
     [
       {
         "id": "node1.example.com",
 
     [
       {
         "id": "node1.example.com",

-        "uri": "\/instances\/node1.example.com"
+        "uri": "\/nodes\/node1.example.com"

       },
       {
         "id": "node2.example.com",
       },
       {
         "id": "node2.example.com",

-        "uri": "\/instances\/node2.example.com"
+        "uri": "\/nodes\/node2.example.com"

       }
     ]
 
       }
     ]
 

-  If the optional 'bulk' argument is provided and set to 'true'
-  value (i.e '?bulk=1'), the output contains detailed
-  information about nodes as a list.
+If the optional bool *bulk* argument is provided and set to a true value
+(i.e ``?bulk=1``), the output contains detailed information about nodes
+as a list.
+
+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`

 
 

-  Example::
+Example::

 
     [
       {
 
     [
       {

@@ -472,143 +1232,314 @@ GET
       ...
     ]
 
       ...
     ]
 

-  Returns: a dictionary with 'name' and 'uri' keys for each of them
+``/2/nodes/[node_name]``
++++++++++++++++++++++++++++++++++

 
 

-/2/nodes/[node_name]/tags
-+++++++++++++++++++++++++
+Returns information about a node.

 
 

-::
+It supports the following commands: ``GET``.

 
 

-  /2/nodes/[node_name]/tags resource.
+Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`

 
 

-  Manages per-node tags.
+``/2/nodes/[node_name]/evacuate``
++++++++++++++++++++++++++++++++++

 
 

-It supports the following commands: GET, PUT, DELETE.
+Evacuates instances off a node.

 
 

-GET
-~~~
+It supports the following commands: ``POST``.

 
 

-::
+``POST``
+~~~~~~~~

 
 

-  Returns a list of tags.
+Returns a job ID. The result of the job will contain the IDs of the
+individual jobs submitted to evacuate the node.

 
 

-  Example: ["tag1", "tag2", "tag3"]
+Body parameters:

 
 

-PUT
-~~~
+.. opcode_params:: OP_NODE_EVACUATE
+   :exclude: nodes

 
 

-::
+Up to and including Ganeti 2.4 query arguments were used. Those are no
+longer supported. The new request can be detected by the presence of the
+:pyeval:`rlib2._NODE_EVAC_RES1` feature string.

 
 

-  Add a set of tags.
+Job result:

 
 

-  The request as a list of strings should be PUT to this URI. And
-  you'll have back a job id.
+.. opcode_result:: OP_NODE_EVACUATE

 
 

-DELETE
-~~~~~~

 
 

-::
+``/2/nodes/[node_name]/migrate``
++++++++++++++++++++++++++++++++++

 
 

-  Delete a tag.
+Migrates all primary instances from a node.

 
 

-  In order to delete a set of tags, the DELETE
-  request should be addressed to URI like:
-  /tags?tag=[tag]&tag=[tag]
+It supports the following commands: ``POST``.

 
 

-/2/os
-+++++
+``POST``
+~~~~~~~~

 
 

-::
+If no mode is explicitly specified, each instances' hypervisor default
+migration mode will be used. Body parameters:

 
 

-  /2/os resource.
+.. opcode_params:: OP_NODE_MIGRATE
+   :exclude: node_name

 
 

-It supports the following commands: GET.
+The query arguments used up to and including Ganeti 2.4 are deprecated
+and should no longer be used. The new request format can be detected by
+the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.

 
 

-GET
-~~~

 
 

-::
+``/2/nodes/[node_name]/role``
++++++++++++++++++++++++++++++

 
 

-  Return a list of all OSes.
+Manages node role.

 
 

-  Can return error 500 in case of a problem.
+It supports the following commands: ``GET``, ``PUT``.

 
 

-  Example: ["debian-etch"]
+The role is always one of the following:

 
 

-/2/tags
-+++++++
+  - drained
+  - master-candidate
+  - offline
+  - regular

 
 

-::
+Note that the 'master' role is a special, and currently it can't be
+modified via RAPI, only via the command line (``gnt-cluster
+master-failover``).

 
 

-  /2/instances/tags resource.
+``GET``
+~~~~~~~

 
 

-  Manages cluster tags.
+Returns the current node role.

 
 

-It supports the following commands: GET, PUT, DELETE.
+Example::

 
 

-GET
-~~~
+    "master-candidate"

 
 

-::
+``PUT``
+~~~~~~~

 
 

-  Returns a list of tags.
+Change the node role.

 
 

-  Example: ["tag1", "tag2", "tag3"]
+The request is a string which should be PUT to this URI. The result will
+be a job id.

 
 

-PUT
-~~~
+It supports the bool ``force`` argument.

 
 

-::
+``/2/nodes/[node_name]/storage``
+++++++++++++++++++++++++++++++++

 
 

-  Add a set of tags.
+Manages storage units on the node.

 
 

-  The request as a list of strings should be PUT to this URI. And
-  you'll have back a job id.
+``GET``
+~~~~~~~

 
 

-DELETE
-~~~~~~
+.. pyassert::

 
 

-::
+   constants.VALID_STORAGE_TYPES == set([constants.ST_FILE,
+                                         constants.ST_LVM_PV,
+                                         constants.ST_LVM_VG])

 
 

-  Delete a tag.
+Requests a list of storage units on a node. Requires the parameters
+``storage_type`` (one of :pyeval:`constants.ST_FILE`,
+:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
+``output_fields``. The result will be a job id, using which the result
+can be retrieved.

 
 

-  In order to delete a set of tags, the DELETE
-  request should be addressed to URI like:
-  /tags?tag=[tag]&tag=[tag]
+``/2/nodes/[node_name]/storage/modify``
++++++++++++++++++++++++++++++++++++++++

 
 

-/nodes/[node_name]
-++++++++++++++++++
+Modifies storage units on the node.

 
 

-::
+``PUT``
+~~~~~~~

 
 

-  /2/nodes/[node_name] resources.
+Modifies parameters of storage units on the node. Requires the
+parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
+:pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
+and ``name`` (name of the storage unit).  Parameters can be passed
+additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
+is supported. The result will be a job id.

 
 

-It supports the following commands: GET.
+``/2/nodes/[node_name]/storage/repair``
++++++++++++++++++++++++++++++++++++++++

 
 

-GET
-~~~
+Repairs a storage unit on the node.

 
 

-::
+``PUT``
+~~~~~~~

 
 

-  Send information about a node.
+.. pyassert::

 
 

+   constants.VALID_STORAGE_OPERATIONS == {
+    constants.ST_LVM_VG: set([constants.SO_FIX_CONSISTENCY]),
+    }

 
 

+Repairs a storage unit on the node. Requires the parameters
+``storage_type`` (currently only :pyeval:`constants.ST_LVM_VG` can be
+repaired) and ``name`` (name of the storage unit). The result will be a
+job id.

 
 

-/version
-++++++++
+``/2/nodes/[node_name]/tags``
++++++++++++++++++++++++++++++

 
 

-::
+Manages per-node tags.

 
 

-  /version resource.
+It supports the following commands: ``GET``, ``PUT``, ``DELETE``.

 
 

-  This resource should be used to determine the remote API version and
-  to adapt clients accordingly.
+``GET``
+~~~~~~~

 
 

-It supports the following commands: GET.
+Returns a list of tags.

 
 

-GET
-~~~
+Example::

 
 

-::
+    ["tag1", "tag2", "tag3"]
+
+``PUT``
+~~~~~~~
+
+Add a set of tags.
+
+The request as a list of strings should be PUT to this URI. The result
+will be a job id.
+
+It supports the ``dry-run`` argument.
+
+``DELETE``
+~~~~~~~~~~
+
+Deletes tags.
+
+In order to delete a set of tags, the DELETE request should be addressed
+to URI like::
+
+    /tags?tag=[tag]&tag=[tag]
+
+It supports the ``dry-run`` argument.
+
+
+``/2/query/[resource]``
++++++++++++++++++++++++
+
+Requests resource information. Available fields can be found in man
+pages and using ``/2/query/[resource]/fields``. The resource is one of
+:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2
+design document <design-query2>` for more details.
+
+Supports the following commands: ``GET``, ``PUT``.
+
+``GET``
+~~~~~~~
+
+Returns list of included fields and actual data. Takes a query parameter
+named "fields", containing a comma-separated list of field names. Does
+not support filtering.
+
+``PUT``
+~~~~~~~
+
+Returns list of included fields and actual data. The list of requested
+fields can either be given as the query parameter "fields" or as a body
+parameter with the same name. The optional body parameter "filter" can
+be given and must be either ``null`` or a list containing filter
+operators.
+
+
+``/2/query/[resource]/fields``
+++++++++++++++++++++++++++++++
+
+Request list of available fields for a resource. The resource is one of
+:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the
+:doc:`query2 design document <design-query2>` for more details.
+
+Supports the following commands: ``GET``.
+
+``GET``
+~~~~~~~
+
+Returns a list of field descriptions for available fields. Takes an
+optional query parameter named "fields", containing a comma-separated
+list of field names.
+
+
+``/2/os``
++++++++++
+
+OS resource.
+
+It supports the following commands: ``GET``.
+
+``GET``
+~~~~~~~
+
+Return a list of all OSes.
+
+Can return error 500 in case of a problem. Since this is a costly
+operation for Ganeti 2.0, it is not recommended to execute it too often.
+
+Example::
+
+    ["debian-etch"]
+
+``/2/tags``
++++++++++++
+
+Manages cluster tags.
+
+It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+``GET``
+~~~~~~~
+
+Returns the cluster tags.
+
+Example::
+
+    ["tag1", "tag2", "tag3"]
+
+``PUT``
+~~~~~~~
+
+Adds a set of tags.
+
+The request as a list of strings should be PUT to this URI. The result
+will be a job id.
+
+It supports the ``dry-run`` argument.
+
+
+``DELETE``
+~~~~~~~~~~
+
+Deletes tags.
+
+In order to delete a set of tags, the DELETE request should be addressed
+to URI like::
+
+    /tags?tag=[tag]&tag=[tag]
+
+It supports the ``dry-run`` argument.
+
+
+``/version``
+++++++++++++
+
+The version resource.
+
+This resource should be used to determine the remote API version and to
+adapt clients accordingly.
+
+It supports the following commands: ``GET``.
+
+``GET``
+~~~~~~~
+
+Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
+returns ``2``.

 
 

-  Returns the remote API version.
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: