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. After modifying the password
25 file, ``ganeti-rapi`` must be restarted.
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.
336 The instances resource.
338 It supports the following commands: ``GET``, ``POST``.
343 Returns a list of all available instances.
349 "name": "web.example.com",
350 "uri": "\/instances\/web.example.com"
353 "name": "mail.example.com",
354 "uri": "\/instances\/mail.example.com"
358 If the optional bool *bulk* argument is provided and set to a true value
359 (i.e ``?bulk=1``), the output contains detailed information about
371 "name": "web.example.com",
372 "tags": ["tag1", "tag2"],
380 "pnode": "node1.example.com",
381 "nic.macs": ["01:23:45:67:89:01"],
382 "snodes": ["node2.example.com"],
383 "disk_template": "drbd",
397 If the optional bool *dry-run* argument is provided, the job will not be
398 actually executed, only the pre-execution checks will be done. Query-ing
399 the job result will return, in both dry-run and normal case, the list of
400 nodes selected for the instance.
402 Returns: a job ID that can be used later for polling.
406 ``__version__`` (int, required)
407 Must be ``1`` (older Ganeti versions used a different format for
408 instance creation requests, version ``0``, but that format is not
410 ``mode`` (string, required)
411 Instance creation mode.
412 ``name`` (string, required)
414 ``disk_template`` (string, required)
415 Disk template for instance.
416 ``disks`` (list, required)
417 List of disk definitions. Example: ``[{"size": 100}, {"size": 5}]``.
418 Each disk definition must contain a ``size`` value and can contain an
419 optional ``mode`` value denoting the disk access mode (``ro`` or
421 ``nics`` (list, required)
422 List of NIC (network interface) definitions. Example: ``[{}, {},
423 {"ip": "198.51.100.4"}]``. Each NIC definition can contain the
424 optional values ``ip``, ``mode``, ``link`` and ``bridge``.
425 ``os`` (string, required)
426 Instance operating system.
427 ``osparams`` (dictionary)
428 Dictionary with OS parameters. If not valid for the given OS, the job
430 ``force_variant`` (bool)
431 Whether to force an unknown variant.
436 ``src_node`` (string)
437 Source node for import.
438 ``src_path`` (string)
439 Source directory for import.
441 Whether to start instance after creation.
443 Whether to ensure instance's IP address is inactive.
444 ``name_check`` (bool)
445 Whether to ensure instance's name is resolvable.
446 ``file_storage_dir`` (string)
447 File storage directory.
448 ``file_driver`` (string)
450 ``iallocator`` (string)
451 Instance allocator name.
452 ``source_handshake`` (list)
453 Signed handshake from source (remote import only).
454 ``source_x509_ca`` (string)
455 Source X509 CA in PEM format (remote import only).
456 ``source_instance_name`` (string)
457 Source instance name (remote import only).
458 ``hypervisor`` (string)
461 Hypervisor parameters, hypervisor-dependent.
466 ``/2/instances/[instance_name]``
467 ++++++++++++++++++++++++++++++++
469 Instance-specific resource.
471 It supports the following commands: ``GET``, ``DELETE``.
476 Returns information about an instance, similar to the bulk output from
484 It supports the ``dry-run`` argument.
487 ``/2/instances/[instance_name]/info``
488 +++++++++++++++++++++++++++++++++++++++
490 It supports the following commands: ``GET``.
495 Requests detailed information about the instance. An optional parameter,
496 ``static`` (bool), can be set to return only static information from the
497 configuration without querying the instance's nodes. The result will be
501 ``/2/instances/[instance_name]/reboot``
502 +++++++++++++++++++++++++++++++++++++++
504 Reboots URI for an instance.
506 It supports the following commands: ``POST``.
511 Reboots the instance.
513 The URI takes optional ``type=soft|hard|full`` and
514 ``ignore_secondaries=0|1`` parameters.
516 ``type`` defines the reboot type. ``soft`` is just a normal reboot,
517 without terminating the hypervisor. ``hard`` means full shutdown
518 (including terminating the hypervisor process) and startup again.
519 ``full`` is like ``hard`` but also recreates the configuration from
520 ground up as if you would have done a ``gnt-instance shutdown`` and
521 ``gnt-instance start`` on it.
523 ``ignore_secondaries`` is a bool argument indicating if we start the
524 instance even if secondary disks are failing.
526 It supports the ``dry-run`` argument.
529 ``/2/instances/[instance_name]/shutdown``
530 +++++++++++++++++++++++++++++++++++++++++
532 Instance shutdown URI.
534 It supports the following commands: ``PUT``.
539 Shutdowns an instance.
541 It supports the ``dry-run`` argument.
544 ``/2/instances/[instance_name]/startup``
545 ++++++++++++++++++++++++++++++++++++++++
547 Instance startup URI.
549 It supports the following commands: ``PUT``.
556 The URI takes an optional ``force=1|0`` parameter to start the
557 instance even if secondary disks are failing.
559 It supports the ``dry-run`` argument.
561 ``/2/instances/[instance_name]/reinstall``
562 ++++++++++++++++++++++++++++++++++++++++++++++
564 Installs the operating system again.
566 It supports the following commands: ``POST``.
571 Takes the parameters ``os`` (OS template name) and ``nostartup`` (bool).
574 ``/2/instances/[instance_name]/replace-disks``
575 ++++++++++++++++++++++++++++++++++++++++++++++
577 Replaces disks on an instance.
579 It supports the following commands: ``POST``.
584 Takes the parameters ``mode`` (one of ``replace_on_primary``,
585 ``replace_on_secondary``, ``replace_new_secondary`` or
586 ``replace_auto``), ``disks`` (comma separated list of disk indexes),
587 ``remote_node`` and ``iallocator``.
589 Either ``remote_node`` or ``iallocator`` needs to be defined when using
590 ``mode=replace_new_secondary``.
592 ``mode`` is a mandatory parameter. ``replace_auto`` tries to determine
593 the broken disk(s) on its own and replacing it.
596 ``/2/instances/[instance_name]/activate-disks``
597 +++++++++++++++++++++++++++++++++++++++++++++++
599 Activate disks on an instance.
601 It supports the following commands: ``PUT``.
606 Takes the bool parameter ``ignore_size``. When set ignore the recorded
607 size (useful for forcing activation when recorded size is wrong).
610 ``/2/instances/[instance_name]/deactivate-disks``
611 +++++++++++++++++++++++++++++++++++++++++++++++++
613 Deactivate disks on an instance.
615 It supports the following commands: ``PUT``.
623 ``/2/instances/[instance_name]/prepare-export``
624 +++++++++++++++++++++++++++++++++++++++++++++++++
626 Prepares an export of an instance.
628 It supports the following commands: ``PUT``.
633 Takes one parameter, ``mode``, for the export mode. Returns a job ID.
636 ``/2/instances/[instance_name]/export``
637 +++++++++++++++++++++++++++++++++++++++++++++++++
641 It supports the following commands: ``PUT``.
652 ``destination`` (required)
653 Destination information, depends on export mode.
654 ``shutdown`` (bool, required)
655 Whether to shutdown instance before export.
656 ``remove_instance`` (bool)
657 Whether to remove instance after export.
659 Name of X509 key (remote export only).
660 ``destination_x509_ca``
661 Destination X509 CA (remote export only).
664 ``/2/instances/[instance_name]/migrate``
665 ++++++++++++++++++++++++++++++++++++++++
667 Migrates an instance.
669 Supports the following commands: ``PUT``.
681 Whether a previously failed migration should be cleaned up.
684 ``/2/instances/[instance_name]/rename``
685 ++++++++++++++++++++++++++++++++++++++++
689 Supports the following commands: ``PUT``.
698 ``new_name`` (string, required)
701 Whether to ensure instance's IP address is inactive.
702 ``name_check`` (bool)
703 Whether to ensure instance's name is resolvable.
706 ``/2/instances/[instance_name]/modify``
707 ++++++++++++++++++++++++++++++++++++++++
709 Modifies an instance.
711 Supports the following commands: ``PUT``.
721 Dictionary with OS parameters.
723 Hypervisor parameters, hypervisor-dependent.
727 Whether to force the operation.
729 List of NIC changes. Each item is of the form ``(op, settings)``.
730 ``op`` can be ``add`` to add a new NIC with the specified settings,
731 ``remove`` to remove the last NIC or a number to modify the settings
732 of the NIC with that index.
734 List of disk changes. See ``nics``.
735 ``disk_template`` (string)
736 Disk template for instance.
737 ``remote_node`` (string)
738 Secondary node (used when changing disk template).
740 Change instance's OS name. Does not reinstall the instance.
741 ``force_variant`` (bool)
742 Whether to force an unknown variant.
745 ``/2/instances/[instance_name]/tags``
746 +++++++++++++++++++++++++++++++++++++
748 Manages per-instance tags.
750 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
755 Returns a list of tags.
759 ["tag1", "tag2", "tag3"]
766 The request as a list of strings should be ``PUT`` to this URI. The
767 result will be a job id.
769 It supports the ``dry-run`` argument.
777 In order to delete a set of tags, the DELETE request should be addressed
780 /tags?tag=[tag]&tag=[tag]
782 It supports the ``dry-run`` argument.
788 The ``/2/jobs`` resource.
790 It supports the following commands: ``GET``.
795 Returns a dictionary of jobs.
797 Returns: a dictionary with jobs id and uri.
805 It supports the following commands: ``GET``, ``DELETE``.
810 Returns a job status.
812 Returns: a dictionary with job parameters.
816 - id: job ID as a number
817 - status: current job status as a string
818 - ops: involved OpCodes as a list of dictionaries for each opcodes in
820 - opstatus: OpCodes status as a list
821 - opresult: OpCodes results as a list
823 For a successful opcode, the ``opresult`` field corresponding to it will
824 contain the raw result from its :term:`LogicalUnit`. In case an opcode
825 has failed, its element in the opresult list will be a list of two
828 - first element the error type (the Ganeti internal error name)
829 - second element a list of either one or two elements:
831 - the first element is the textual error description
832 - the second element, if any, will hold an error classification
834 The error classification is most useful for the ``OpPrereqError``
835 error type - these errors happen before the OpCode has started
836 executing, so it's possible to retry the OpCode without side
837 effects. But whether it make sense to retry depends on the error
841 Resolver errors. This usually means that a name doesn't exist in DNS,
842 so if it's a case of slow DNS propagation the operation can be retried
845 ``insufficient_resources``
846 Not enough resources (iallocator failure, disk space, memory,
847 etc.). If the resources on the cluster increase, the operation might
851 Wrong arguments (at syntax level). The operation will not ever be
852 accepted unless the arguments change.
855 Wrong entity state. For example, live migration has been requested for
856 a down instance, or instance creation on an offline node. The
857 operation can be retried once the resource has changed state.
860 Entity not found. For example, information has been requested for an
864 Entity already exists. For example, instance creation has been
865 requested for an already-existing instance.
867 ``resource_not_unique``
868 Resource not unique (e.g. MAC or IP duplication).
871 Internal cluster error. For example, a node is unreachable but not set
872 offline, or the ganeti node daemons are not working, etc. A
873 ``gnt-cluster verify`` should be run.
875 ``environment_error``
876 Environment error (e.g. node disk error). A ``gnt-cluster verify``
879 Note that in the above list, by entity we refer to a node or instance,
880 while by a resource we refer to an instance's disk, or NIC, etc.
886 Cancel a not-yet-started job.
889 ``/2/jobs/[job_id]/wait``
890 +++++++++++++++++++++++++
895 Waits for changes on a job. Takes the following body parameters in a
899 The job fields on which to watch for changes.
901 ``previous_job_info``
902 Previously received field values or None if not yet available.
904 ``previous_log_serial``
905 Highest log serial number received so far or None if not yet
908 Returns None if no changes have been detected and a dict with two keys,
909 ``job_info`` and ``log_entries`` otherwise.
917 It supports the following commands: ``GET``.
922 Returns a list of all nodes.
928 "id": "node1.example.com",
929 "uri": "\/nodes\/node1.example.com"
932 "id": "node2.example.com",
933 "uri": "\/nodes\/node2.example.com"
937 If the optional 'bulk' argument is provided and set to 'true' value (i.e
938 '?bulk=1'), the output contains detailed information about nodes as a
948 "name": "www.example.com",
959 ``/2/nodes/[node_name]``
960 +++++++++++++++++++++++++++++++++
962 Returns information about a node.
964 It supports the following commands: ``GET``.
966 ``/2/nodes/[node_name]/evacuate``
967 +++++++++++++++++++++++++++++++++
969 Evacuates all secondary instances off a node.
971 It supports the following commands: ``POST``.
976 To evacuate a node, either one of the ``iallocator`` or ``remote_node``
977 parameters must be passed::
979 evacuate?iallocator=[iallocator]
980 evacuate?remote_node=[nodeX.example.com]
982 The result value will be a list, each element being a triple of the job
983 id (for this specific evacuation), the instance which is being evacuated
984 by this job, and the node to which it is being relocated. In case the
985 node is already empty, the result will be an empty list (without any
986 jobs being submitted).
988 And additional parameter ``early_release`` signifies whether to try to
989 parallelize the evacuations, at the risk of increasing I/O contention
990 and increasing the chances of data loss, if the primary node of any of
991 the instances being evacuated is not fully healthy.
993 If the dry-run parameter was specified, then the evacuation jobs were
994 not actually submitted, and the job IDs will be null.
997 ``/2/nodes/[node_name]/migrate``
998 +++++++++++++++++++++++++++++++++
1000 Migrates all primary instances from a node.
1002 It supports the following commands: ``POST``.
1007 No parameters are required, but the bool parameter ``live`` can be set
1008 to use live migration (if available).
1012 ``/2/nodes/[node_name]/role``
1013 +++++++++++++++++++++++++++++
1017 It supports the following commands: ``GET``, ``PUT``.
1019 The role is always one of the following:
1030 Returns the current node role.
1039 Change the node role.
1041 The request is a string which should be PUT to this URI. The result will
1044 It supports the bool ``force`` argument.
1046 ``/2/nodes/[node_name]/storage``
1047 ++++++++++++++++++++++++++++++++
1049 Manages storage units on the node.
1054 Requests a list of storage units on a node. Requires the parameters
1055 ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``) and
1056 ``output_fields``. The result will be a job id, using which the result
1059 ``/2/nodes/[node_name]/storage/modify``
1060 +++++++++++++++++++++++++++++++++++++++
1062 Modifies storage units on the node.
1067 Modifies parameters of storage units on the node. Requires the
1068 parameters ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``)
1069 and ``name`` (name of the storage unit). Parameters can be passed
1070 additionally. Currently only ``allocatable`` (bool) is supported. The
1071 result will be a job id.
1073 ``/2/nodes/[node_name]/storage/repair``
1074 +++++++++++++++++++++++++++++++++++++++
1076 Repairs a storage unit on the node.
1081 Repairs a storage unit on the node. Requires the parameters
1082 ``storage_type`` (currently only ``lvm-vg`` can be repaired) and
1083 ``name`` (name of the storage unit). The result will be a job id.
1085 ``/2/nodes/[node_name]/tags``
1086 +++++++++++++++++++++++++++++
1088 Manages per-node tags.
1090 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1095 Returns a list of tags.
1099 ["tag1", "tag2", "tag3"]
1106 The request as a list of strings should be PUT to this URI. The result
1109 It supports the ``dry-run`` argument.
1116 In order to delete a set of tags, the DELETE request should be addressed
1119 /tags?tag=[tag]&tag=[tag]
1121 It supports the ``dry-run`` argument.
1129 It supports the following commands: ``GET``.
1134 Return a list of all OSes.
1136 Can return error 500 in case of a problem. Since this is a costly
1137 operation for Ganeti 2.0, it is not recommended to execute it too often.
1146 Manages cluster tags.
1148 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1153 Returns the cluster tags.
1157 ["tag1", "tag2", "tag3"]
1164 The request as a list of strings should be PUT to this URI. The result
1167 It supports the ``dry-run`` argument.
1175 In order to delete a set of tags, the DELETE request should be addressed
1178 /tags?tag=[tag]&tag=[tag]
1180 It supports the ``dry-run`` argument.
1186 The version resource.
1188 This resource should be used to determine the remote API version and to
1189 adapt clients accordingly.
1191 It supports the following commands: ``GET``.
1196 Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
1199 .. vim: set textwidth=72 :