4 Documents Ganeti version |version|
11 Ganeti supports a remote API for enable external tools to easily
12 retrieve information about a cluster's state. The remote API daemon,
13 *ganeti-rapi*, is automatically started on the master node. By default
14 it runs on TCP port 5080, but this can be changed either in
15 ``.../constants.py`` or via the command line parameter *-p*. SSL mode,
16 which is used by default, can also be disabled by passing command line
23 ``ganeti-rapi`` reads users and passwords from a file (usually
24 ``/var/lib/ganeti/rapi/users``) on startup. Changes to the file will be
27 Each line consists of two or three fields separated by whitespace. The
28 first two fields are for username and password. The third field is
29 optional and can be used to specify per-user options. Currently,
30 ``write`` is the only option supported and enables the user to execute
31 operations modifying the cluster. Lines starting with the hash sign
32 (``#``) are treated as comments.
34 Passwords can either be written in clear text or as a hash. Clear text
35 passwords may not start with an opening brace (``{``) or they must be
36 prefixed with ``{cleartext}``. To use the hashed form, get the MD5 hash
37 of the string ``$username:Ganeti Remote API:$password`` (e.g. ``echo -n
38 'jack:Ganeti Remote API:abc123' | openssl md5``) [#pwhash]_ and prefix
39 it with ``{ha1}``. Using the scheme prefix for all passwords is
40 recommended. Scheme prefixes are not case sensitive.
44 # Give Jack and Fred read-only access
46 fred {cleartext}foo555
48 # Give write access to an imaginary instance creation script
49 autocreator xyz789 write
51 # Hashed password for Jessica
52 jessica {HA1}7046452df2cbb530877058712cf17bd4 write
55 .. [#pwhash] Using the MD5 hash of username, realm and password is
56 described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2 and
57 3.3. The reason for using it over another algorithm is forward
58 compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
59 authentication in the future, the same hash could be used.
60 In the current version ``ganeti-rapi``'s realm, ``Ganeti Remote
61 API``, can only be changed by modifying the source code.
67 The protocol used is JSON_ over HTTP designed after the REST_ principle.
68 HTTP Basic authentication as per :rfc:`2617` is supported.
70 .. _JSON: http://www.json.org/
71 .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
74 A note on JSON as used by RAPI
75 ++++++++++++++++++++++++++++++
77 JSON_ as used by Ganeti RAPI does not conform to the specification in
78 :rfc:`4627`. Section 2 defines a JSON text to be either an object
79 (``{"key": "value", …}``) or an array (``[1, 2, 3, …]``). In violation
80 of this RAPI uses plain strings (``"master-candidate"``, ``"1234"``) for
81 some requests or responses. Changing this now would likely break
82 existing clients and cause a lot of trouble.
86 Unlike Python's `JSON encoder and decoder
87 <http://docs.python.org/library/json.html>`_, other programming
88 languages or libraries may only provide a strict implementation, not
89 allowing plain values. For those, responses can usually be wrapped in an
90 array whose first element is then used, e.g. the response ``"1234"``
91 becomes ``["1234"]``. This works equally well for more complex values.
96 # Insert code to get response here
99 decoded = JSON.parse("[#{response}]").first
101 Short of modifying the encoder to allow encoding to a less strict
102 format, requests will have to be formatted by hand. Newer RAPI requests
103 already use a dictionary as their input data and shouldn't cause any
110 According to :rfc:`2616` the main difference between PUT and POST is
111 that POST can create new resources but PUT can only create the resource
112 the URI was pointing to on the PUT request.
114 Unfortunately, due to historic reasons, the Ganeti RAPI library is not
115 consistent with this usage, so just use the methods as documented below
118 For more details have a look in the source code at
119 ``lib/rapi/rlib2.py``.
122 Generic parameter types
123 -----------------------
125 A few generic refered parameter types and the values they allow.
130 A boolean option will accept ``1`` or ``0`` as numbers but not
131 i.e. ``True`` or ``False``.
136 A few parameter mean the same thing across all resources which implement
142 Bulk-mode means that for the resources which usually return just a list
143 of child resources (e.g. ``/2/instances`` which returns just instance
144 names), the output will instead contain detailed data for all these
145 subresources. This is more efficient than query-ing the sub-resources
151 The boolean *dry-run* argument, if provided and set, signals to Ganeti
152 that the job should not be executed, only the pre-execution checks will
155 This is useful in trying to determine (without guarantees though, as in
156 the meantime the cluster state could have changed) if the operation is
157 likely to succeed or at least start executing.
162 Force operation to continue even if it will cause the cluster to become
163 inconsistent (e.g. because there are not enough master candidates).
168 You can access the API using your favorite programming language as long
169 as it supports network connections.
174 Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.
183 wget -q -O - https://CLUSTERNAME:5080/2/info
187 curl https://CLUSTERNAME:5080/2/info
193 .. highlight:: python
198 f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
205 .. warning:: While it's possible to use JavaScript, it poses several
206 potential problems, including browser blocking request due to
207 non-standard ports or different domain names. Fetching the data on
208 the webserver is easier.
210 .. highlight:: javascript
214 var url = 'https://CLUSTERNAME:5080/2/info';
216 var xmlreq = new XMLHttpRequest();
217 xmlreq.onreadystatechange = function () {
218 if (xmlreq.readyState != 4) return;
219 if (xmlreq.status == 200) {
220 info = eval("(" + xmlreq.responseText + ")");
223 alert('Error fetching cluster info');
227 xmlreq.open('GET', url, true);
233 .. highlight:: javascript
240 It supports the following commands: ``GET``.
245 Shows the list of mapped resources.
247 Returns: a dictionary with 'name' and 'uri' keys for each of them.
252 The ``/2`` resource, the root of the version 2 API.
254 It supports the following commands: ``GET``.
259 Show the list of mapped resources.
261 Returns: a dictionary with ``name`` and ``uri`` keys for each of them.
266 Cluster information resource.
268 It supports the following commands: ``GET``.
273 Returns cluster information.
278 "config_version": 2000000,
280 "software_version": "2.0.0~beta2",
281 "os_api_version": 10,
283 "candidate_pool_size": 10,
284 "enabled_hypervisors": [
290 "default_hypervisor": "fake",
291 "master": "node1.example.com",
296 "protocol_version": 20,
299 "auto_balance": true,
307 ``/2/redistribute-config``
308 ++++++++++++++++++++++++++
310 Redistribute configuration to all nodes.
312 It supports the following commands: ``PUT``.
317 Redistribute configuration to all nodes. The result will be a job id.
326 Returns a list of features supported by the RAPI server. Available
329 ``instance-create-reqv1``
330 Instance creation request data version 1 supported.
331 ``instance-reinstall-reqv1``
332 Instance reinstall supports body parameters.
336 ++++++++++++++++++++++++++++++++++++++++
338 Modifies cluster parameters.
340 Supports the following commands: ``PUT``.
349 .. opcode_params:: OP_CLUSTER_SET_PARAMS
357 It supports the following commands: ``GET``, ``POST``.
362 Returns a list of all existing node groups.
369 "uri": "\/2\/groups\/group1"
373 "uri": "\/2\/groups\/group2"
377 If the optional bool *bulk* argument is provided and set to a true value
378 (i.e ``?bulk=1``), the output contains detailed information about node
391 "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
399 "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
406 Creates a node group.
408 If the optional bool *dry-run* argument is provided, the job will not be
409 actually executed, only the pre-execution checks will be done.
411 Returns: a job ID that can be used later for polling.
415 .. opcode_params:: OP_GROUP_ADD
417 Earlier versions used a parameter named ``name`` which, while still
418 supported, has been renamed to ``group_name``.
421 ``/2/groups/[group_name]``
422 ++++++++++++++++++++++++++
424 Returns information about a node group.
426 It supports the following commands: ``GET``, ``DELETE``.
431 Returns information about a node group, similar to the bulk output from
437 Deletes a node group.
439 It supports the ``dry-run`` argument.
442 ``/2/groups/[group_name]/modify``
443 +++++++++++++++++++++++++++++++++
445 Modifies the parameters of a node group.
447 Supports the following commands: ``PUT``.
456 .. opcode_params:: OP_GROUP_SET_PARAMS
460 ``/2/groups/[group_name]/rename``
461 +++++++++++++++++++++++++++++++++
463 Renames a node group.
465 Supports the following commands: ``PUT``.
474 .. opcode_params:: OP_GROUP_RENAME
478 ``/2/groups/[group_name]/assign-nodes``
479 +++++++++++++++++++++++++++++++++++++++
481 Assigns nodes to a group.
483 Supports the following commands: ``PUT``.
488 Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.
492 .. opcode_params:: OP_GROUP_ASSIGN_NODES
493 :exclude: group_name, force, dry_run
499 The instances resource.
501 It supports the following commands: ``GET``, ``POST``.
506 Returns a list of all available instances.
512 "name": "web.example.com",
513 "uri": "\/instances\/web.example.com"
516 "name": "mail.example.com",
517 "uri": "\/instances\/mail.example.com"
521 If the optional bool *bulk* argument is provided and set to a true value
522 (i.e ``?bulk=1``), the output contains detailed information about
534 "name": "web.example.com",
535 "tags": ["tag1", "tag2"],
543 "pnode": "node1.example.com",
544 "nic.macs": ["01:23:45:67:89:01"],
545 "snodes": ["node2.example.com"],
546 "disk_template": "drbd",
560 If the optional bool *dry-run* argument is provided, the job will not be
561 actually executed, only the pre-execution checks will be done. Query-ing
562 the job result will return, in both dry-run and normal case, the list of
563 nodes selected for the instance.
565 Returns: a job ID that can be used later for polling.
569 ``__version__`` (int, required)
570 Must be ``1`` (older Ganeti versions used a different format for
571 instance creation requests, version ``0``, but that format is not
572 documented and should no longer be used).
574 .. opcode_params:: OP_INSTANCE_CREATE
576 Earlier versions used parameters named ``name`` and ``os``. These have
577 been replaced by ``instance_name`` and ``os_type`` to match the
578 underlying opcode. The old names can still be used.
581 ``/2/instances/[instance_name]``
582 ++++++++++++++++++++++++++++++++
584 Instance-specific resource.
586 It supports the following commands: ``GET``, ``DELETE``.
591 Returns information about an instance, similar to the bulk output from
599 It supports the ``dry-run`` argument.
602 ``/2/instances/[instance_name]/info``
603 +++++++++++++++++++++++++++++++++++++++
605 It supports the following commands: ``GET``.
610 Requests detailed information about the instance. An optional parameter,
611 ``static`` (bool), can be set to return only static information from the
612 configuration without querying the instance's nodes. The result will be
616 ``/2/instances/[instance_name]/reboot``
617 +++++++++++++++++++++++++++++++++++++++
619 Reboots URI for an instance.
621 It supports the following commands: ``POST``.
626 Reboots the instance.
628 The URI takes optional ``type=soft|hard|full`` and
629 ``ignore_secondaries=0|1`` parameters.
631 ``type`` defines the reboot type. ``soft`` is just a normal reboot,
632 without terminating the hypervisor. ``hard`` means full shutdown
633 (including terminating the hypervisor process) and startup again.
634 ``full`` is like ``hard`` but also recreates the configuration from
635 ground up as if you would have done a ``gnt-instance shutdown`` and
636 ``gnt-instance start`` on it.
638 ``ignore_secondaries`` is a bool argument indicating if we start the
639 instance even if secondary disks are failing.
641 It supports the ``dry-run`` argument.
644 ``/2/instances/[instance_name]/shutdown``
645 +++++++++++++++++++++++++++++++++++++++++
647 Instance shutdown URI.
649 It supports the following commands: ``PUT``.
654 Shutdowns an instance.
656 It supports the ``dry-run`` argument.
659 ``/2/instances/[instance_name]/startup``
660 ++++++++++++++++++++++++++++++++++++++++
662 Instance startup URI.
664 It supports the following commands: ``PUT``.
671 The URI takes an optional ``force=1|0`` parameter to start the
672 instance even if secondary disks are failing.
674 It supports the ``dry-run`` argument.
676 ``/2/instances/[instance_name]/reinstall``
677 ++++++++++++++++++++++++++++++++++++++++++++++
679 Installs the operating system again.
681 It supports the following commands: ``POST``.
690 ``os`` (string, required)
691 Instance operating system.
692 ``start`` (bool, defaults to true)
693 Whether to start instance after reinstallation.
695 Dictionary with (temporary) OS parameters.
697 For backwards compatbility, this resource also takes the query
698 parameters ``os`` (OS template name) and ``nostartup`` (bool). New
699 clients should use the body parameters.
702 ``/2/instances/[instance_name]/replace-disks``
703 ++++++++++++++++++++++++++++++++++++++++++++++
705 Replaces disks on an instance.
707 It supports the following commands: ``POST``.
712 Takes the parameters ``mode`` (one of ``replace_on_primary``,
713 ``replace_on_secondary``, ``replace_new_secondary`` or
714 ``replace_auto``), ``disks`` (comma separated list of disk indexes),
715 ``remote_node`` and ``iallocator``.
717 Either ``remote_node`` or ``iallocator`` needs to be defined when using
718 ``mode=replace_new_secondary``.
720 ``mode`` is a mandatory parameter. ``replace_auto`` tries to determine
721 the broken disk(s) on its own and replacing it.
724 ``/2/instances/[instance_name]/activate-disks``
725 +++++++++++++++++++++++++++++++++++++++++++++++
727 Activate disks on an instance.
729 It supports the following commands: ``PUT``.
734 Takes the bool parameter ``ignore_size``. When set ignore the recorded
735 size (useful for forcing activation when recorded size is wrong).
738 ``/2/instances/[instance_name]/deactivate-disks``
739 +++++++++++++++++++++++++++++++++++++++++++++++++
741 Deactivate disks on an instance.
743 It supports the following commands: ``PUT``.
751 ``/2/instances/[instance_name]/disk/[disk_index]/grow``
752 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
754 Grows one disk of an instance.
756 Supports the following commands: ``POST``.
765 .. opcode_params:: OP_INSTANCE_GROW_DISK
766 :exclude: instance_name, disk
769 ``/2/instances/[instance_name]/prepare-export``
770 +++++++++++++++++++++++++++++++++++++++++++++++++
772 Prepares an export of an instance.
774 It supports the following commands: ``PUT``.
779 Takes one parameter, ``mode``, for the export mode. Returns a job ID.
782 ``/2/instances/[instance_name]/export``
783 +++++++++++++++++++++++++++++++++++++++++++++++++
787 It supports the following commands: ``PUT``.
796 .. opcode_params:: OP_BACKUP_EXPORT
797 :exclude: instance_name
798 :alias: target_node=destination
801 ``/2/instances/[instance_name]/migrate``
802 ++++++++++++++++++++++++++++++++++++++++
804 Migrates an instance.
806 Supports the following commands: ``PUT``.
815 .. opcode_params:: OP_INSTANCE_MIGRATE
816 :exclude: instance_name, live
819 ``/2/instances/[instance_name]/rename``
820 ++++++++++++++++++++++++++++++++++++++++
824 Supports the following commands: ``PUT``.
833 .. opcode_params:: OP_INSTANCE_RENAME
834 :exclude: instance_name
837 ``/2/instances/[instance_name]/modify``
838 ++++++++++++++++++++++++++++++++++++++++
840 Modifies an instance.
842 Supports the following commands: ``PUT``.
851 .. opcode_params:: OP_INSTANCE_SET_PARAMS
852 :exclude: instance_name
855 ``/2/instances/[instance_name]/tags``
856 +++++++++++++++++++++++++++++++++++++
858 Manages per-instance tags.
860 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
865 Returns a list of tags.
869 ["tag1", "tag2", "tag3"]
876 The request as a list of strings should be ``PUT`` to this URI. The
877 result will be a job id.
879 It supports the ``dry-run`` argument.
887 In order to delete a set of tags, the DELETE request should be addressed
890 /tags?tag=[tag]&tag=[tag]
892 It supports the ``dry-run`` argument.
898 The ``/2/jobs`` resource.
900 It supports the following commands: ``GET``.
905 Returns a dictionary of jobs.
907 Returns: a dictionary with jobs id and uri.
915 It supports the following commands: ``GET``, ``DELETE``.
920 Returns a job status.
922 Returns: a dictionary with job parameters.
926 - id: job ID as a number
927 - status: current job status as a string
928 - ops: involved OpCodes as a list of dictionaries for each opcodes in
930 - opstatus: OpCodes status as a list
931 - opresult: OpCodes results as a list
933 For a successful opcode, the ``opresult`` field corresponding to it will
934 contain the raw result from its :term:`LogicalUnit`. In case an opcode
935 has failed, its element in the opresult list will be a list of two
938 - first element the error type (the Ganeti internal error name)
939 - second element a list of either one or two elements:
941 - the first element is the textual error description
942 - the second element, if any, will hold an error classification
944 The error classification is most useful for the ``OpPrereqError``
945 error type - these errors happen before the OpCode has started
946 executing, so it's possible to retry the OpCode without side
947 effects. But whether it make sense to retry depends on the error
951 Resolver errors. This usually means that a name doesn't exist in DNS,
952 so if it's a case of slow DNS propagation the operation can be retried
955 ``insufficient_resources``
956 Not enough resources (iallocator failure, disk space, memory,
957 etc.). If the resources on the cluster increase, the operation might
961 Wrong arguments (at syntax level). The operation will not ever be
962 accepted unless the arguments change.
965 Wrong entity state. For example, live migration has been requested for
966 a down instance, or instance creation on an offline node. The
967 operation can be retried once the resource has changed state.
970 Entity not found. For example, information has been requested for an
974 Entity already exists. For example, instance creation has been
975 requested for an already-existing instance.
977 ``resource_not_unique``
978 Resource not unique (e.g. MAC or IP duplication).
981 Internal cluster error. For example, a node is unreachable but not set
982 offline, or the ganeti node daemons are not working, etc. A
983 ``gnt-cluster verify`` should be run.
985 ``environment_error``
986 Environment error (e.g. node disk error). A ``gnt-cluster verify``
989 Note that in the above list, by entity we refer to a node or instance,
990 while by a resource we refer to an instance's disk, or NIC, etc.
996 Cancel a not-yet-started job.
999 ``/2/jobs/[job_id]/wait``
1000 +++++++++++++++++++++++++
1005 Waits for changes on a job. Takes the following body parameters in a
1009 The job fields on which to watch for changes.
1011 ``previous_job_info``
1012 Previously received field values or None if not yet available.
1014 ``previous_log_serial``
1015 Highest log serial number received so far or None if not yet
1018 Returns None if no changes have been detected and a dict with two keys,
1019 ``job_info`` and ``log_entries`` otherwise.
1027 It supports the following commands: ``GET``.
1032 Returns a list of all nodes.
1038 "id": "node1.example.com",
1039 "uri": "\/nodes\/node1.example.com"
1042 "id": "node2.example.com",
1043 "uri": "\/nodes\/node2.example.com"
1047 If the optional 'bulk' argument is provided and set to 'true' value (i.e
1048 '?bulk=1'), the output contains detailed information about nodes as a
1058 "name": "www.example.com",
1069 ``/2/nodes/[node_name]``
1070 +++++++++++++++++++++++++++++++++
1072 Returns information about a node.
1074 It supports the following commands: ``GET``.
1076 ``/2/nodes/[node_name]/evacuate``
1077 +++++++++++++++++++++++++++++++++
1079 Evacuates all secondary instances off a node.
1081 It supports the following commands: ``POST``.
1086 To evacuate a node, either one of the ``iallocator`` or ``remote_node``
1087 parameters must be passed::
1089 evacuate?iallocator=[iallocator]
1090 evacuate?remote_node=[nodeX.example.com]
1092 The result value will be a list, each element being a triple of the job
1093 id (for this specific evacuation), the instance which is being evacuated
1094 by this job, and the node to which it is being relocated. In case the
1095 node is already empty, the result will be an empty list (without any
1096 jobs being submitted).
1098 And additional parameter ``early_release`` signifies whether to try to
1099 parallelize the evacuations, at the risk of increasing I/O contention
1100 and increasing the chances of data loss, if the primary node of any of
1101 the instances being evacuated is not fully healthy.
1103 If the dry-run parameter was specified, then the evacuation jobs were
1104 not actually submitted, and the job IDs will be null.
1107 ``/2/nodes/[node_name]/migrate``
1108 +++++++++++++++++++++++++++++++++
1110 Migrates all primary instances from a node.
1112 It supports the following commands: ``POST``.
1117 If no mode is explicitly specified, each instances' hypervisor default
1118 migration mode will be used. Query parameters:
1121 If set, use live migration if available.
1123 Sets migration mode, ``live`` for live migration and ``non-live`` for
1124 non-live migration. Supported by Ganeti 2.2 and above.
1127 ``/2/nodes/[node_name]/role``
1128 +++++++++++++++++++++++++++++
1132 It supports the following commands: ``GET``, ``PUT``.
1134 The role is always one of the following:
1145 Returns the current node role.
1154 Change the node role.
1156 The request is a string which should be PUT to this URI. The result will
1159 It supports the bool ``force`` argument.
1161 ``/2/nodes/[node_name]/storage``
1162 ++++++++++++++++++++++++++++++++
1164 Manages storage units on the node.
1169 Requests a list of storage units on a node. Requires the parameters
1170 ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``) and
1171 ``output_fields``. The result will be a job id, using which the result
1174 ``/2/nodes/[node_name]/storage/modify``
1175 +++++++++++++++++++++++++++++++++++++++
1177 Modifies storage units on the node.
1182 Modifies parameters of storage units on the node. Requires the
1183 parameters ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``)
1184 and ``name`` (name of the storage unit). Parameters can be passed
1185 additionally. Currently only ``allocatable`` (bool) is supported. The
1186 result will be a job id.
1188 ``/2/nodes/[node_name]/storage/repair``
1189 +++++++++++++++++++++++++++++++++++++++
1191 Repairs a storage unit on the node.
1196 Repairs a storage unit on the node. Requires the parameters
1197 ``storage_type`` (currently only ``lvm-vg`` can be repaired) and
1198 ``name`` (name of the storage unit). The result will be a job id.
1200 ``/2/nodes/[node_name]/tags``
1201 +++++++++++++++++++++++++++++
1203 Manages per-node tags.
1205 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1210 Returns a list of tags.
1214 ["tag1", "tag2", "tag3"]
1221 The request as a list of strings should be PUT to this URI. The result
1224 It supports the ``dry-run`` argument.
1231 In order to delete a set of tags, the DELETE request should be addressed
1234 /tags?tag=[tag]&tag=[tag]
1236 It supports the ``dry-run`` argument.
1244 It supports the following commands: ``GET``.
1249 Return a list of all OSes.
1251 Can return error 500 in case of a problem. Since this is a costly
1252 operation for Ganeti 2.0, it is not recommended to execute it too often.
1261 Manages cluster tags.
1263 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1268 Returns the cluster tags.
1272 ["tag1", "tag2", "tag3"]
1279 The request as a list of strings should be PUT to this URI. The result
1282 It supports the ``dry-run`` argument.
1290 In order to delete a set of tags, the DELETE request should be addressed
1293 /tags?tag=[tag]&tag=[tag]
1295 It supports the ``dry-run`` argument.
1301 The version resource.
1303 This resource should be used to determine the remote API version and to
1304 adapt clients accordingly.
1306 It supports the following commands: ``GET``.
1311 Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
1314 .. vim: set textwidth=72 :