rapi.rst 27.3 KB
Newer Older
1 2 3
Ganeti remote API
=================

Iustin Pop's avatar
Iustin Pop committed
4
Documents Ganeti version |version|
5 6 7 8 9 10 11 12 13 14 15 16 17 18

.. contents::

Introduction
------------

Ganeti supports a remote API for enable external tools to easily
retrieve information about a cluster's state. The remote API daemon,
*ganeti-rapi*, is automatically started on the master node. By default
it runs on TCP port 5080, but this can be changed either in
``.../constants.py`` or via the command line parameter *-p*. SSL mode,
which is used by default, can also be disabled by passing command line
parameters.

19 20 21 22 23 24 25 26 27 28 29 30

Users and passwords
-------------------

``ganeti-rapi`` reads users and passwords from a file (usually
``/var/lib/ganeti/rapi_users``) on startup. After modifying the password
file, ``ganeti-rapi`` must be restarted.

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
31 32
operations modifying the cluster. Lines starting with the hash sign
(``#``) are treated as comments.
33 34 35 36 37

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
38 39 40
'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.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

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 RFC2617_ ("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.


64 65 66
Protocol
--------

67 68
The protocol used is JSON_ over HTTP designed after the REST_ principle.
HTTP Basic authentication as per RFC2617_ is supported.
69 70 71

.. _JSON: http://www.json.org/
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
72
.. _RFC2617: http://tools.ietf.org/rfc/rfc2617.txt
73

74

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
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.


108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
PUT or POST?
------------

According to RFC2616 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``.

134 135 136
Generic parameters
------------------

137 138
A few parameter mean the same thing across all resources which implement
it.
139 140 141 142

``bulk``
++++++++

Iustin Pop's avatar
Iustin Pop committed
143 144 145 146 147
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.
148 149 150 151

``dry-run``
+++++++++++

152 153 154
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.
155

Iustin Pop's avatar
Iustin Pop committed
156 157 158
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.
159

160 161 162 163 164 165
``force``
+++++++++++

Force operation to continue even if it will cause the cluster to become
inconsistent (e.g. because there are not enough master candidates).

166 167 168
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
169 170
You can access the API using your favorite programming language as long
as it supports network connections.
171

172 173 174 175 176
Ganeti RAPI client
++++++++++++++++++

Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.

177 178 179
Shell
+++++

Iustin Pop's avatar
Iustin Pop committed
180 181
.. highlight:: sh

182 183
Using wget::

Iustin Pop's avatar
Iustin Pop committed
184
   wget -q -O - https://CLUSTERNAME:5080/2/info
185 186 187 188 189 190 191 192 193

or curl::

  curl https://CLUSTERNAME:5080/2/info


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
194 195 196
.. highlight:: python

::
197 198

  import urllib2
Tim Boring's avatar
Tim Boring committed
199
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
200 201 202 203 204 205
  print f.read()


JavaScript
++++++++++

206
.. warning:: While it's possible to use JavaScript, it poses several
Iustin Pop's avatar
Iustin Pop committed
207 208 209
   potential problems, including browser blocking request due to
   non-standard ports or different domain names. Fetching the data on
   the webserver is easier.
210

Iustin Pop's avatar
Iustin Pop committed
211 212
.. highlight:: javascript

213 214
::

Tim Boring's avatar
Tim Boring committed
215
  var url = 'https://CLUSTERNAME:5080/2/info';
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  var info;
  var xmlreq = new XMLHttpRequest();
  xmlreq.onreadystatechange = function () {
    if (xmlreq.readyState != 4) return;
    if (xmlreq.status == 200) {
      info = eval("(" + xmlreq.responseText + ")");
      alert(info);
    } else {
      alert('Error fetching cluster info');
    }
    xmlreq = null;
  };
  xmlreq.open('GET', url, true);
  xmlreq.send(null);

Resources
---------

Iustin Pop's avatar
Iustin Pop committed
234
.. highlight:: javascript
235

Iustin Pop's avatar
Iustin Pop committed
236 237
``/``
+++++
238

Iustin Pop's avatar
Iustin Pop committed
239
The root resource.
240

Iustin Pop's avatar
Iustin Pop committed
241
It supports the following commands: ``GET``.
242

Iustin Pop's avatar
Iustin Pop committed
243 244
``GET``
~~~~~~~
245

Iustin Pop's avatar
Iustin Pop committed
246
Shows the list of mapped resources.
247

Iustin Pop's avatar
Iustin Pop committed
248
Returns: a dictionary with 'name' and 'uri' keys for each of them.
249

Iustin Pop's avatar
Iustin Pop committed
250 251
``/2``
++++++
252

Iustin Pop's avatar
Iustin Pop committed
253
The ``/2`` resource, the root of the version 2 API.
254

Iustin Pop's avatar
Iustin Pop committed
255
It supports the following commands: ``GET``.
256

Iustin Pop's avatar
Iustin Pop committed
257 258
``GET``
~~~~~~~
259

Iustin Pop's avatar
Iustin Pop committed
260
Show the list of mapped resources.
261

Iustin Pop's avatar
Iustin Pop committed
262
Returns: a dictionary with ``name`` and ``uri`` keys for each of them.
263

Iustin Pop's avatar
Iustin Pop committed
264 265
``/2/info``
+++++++++++
266

Iustin Pop's avatar
Iustin Pop committed
267
Cluster information resource.
268

Iustin Pop's avatar
Iustin Pop committed
269
It supports the following commands: ``GET``.
270

Iustin Pop's avatar
Iustin Pop committed
271 272
``GET``
~~~~~~~
273

Iustin Pop's avatar
Iustin Pop committed
274
Returns cluster information.
275

Iustin Pop's avatar
Iustin Pop committed
276
Example::
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306

  {
    "config_version": 2000000,
    "name": "cluster",
    "software_version": "2.0.0~beta2",
    "os_api_version": 10,
    "export_version": 0,
    "candidate_pool_size": 10,
    "enabled_hypervisors": [
      "fake"
    ],
    "hvparams": {
      "fake": {}
     },
    "default_hypervisor": "fake",
    "master": "node1.example.com",
    "architecture": [
      "64bit",
      "x86_64"
    ],
    "protocol_version": 20,
    "beparams": {
      "default": {
        "auto_balance": true,
        "vcpus": 1,
        "memory": 128
       }
      }
    }

307 308 309 310 311 312 313 314 315 316 317 318 319 320

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

Redistribute configuration to all nodes.

It supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Redistribute configuration to all nodes. The result will be a job id.


321 322 323 324 325 326 327 328 329 330 331 332 333
``/2/features``
+++++++++++++++

``GET``
~~~~~~~

Returns a list of features supported by the RAPI server. Available
features:

``instance-create-reqv1``
  Instance creation request data version 1 supported.


Iustin Pop's avatar
Iustin Pop committed
334 335
``/2/instances``
++++++++++++++++
336

Iustin Pop's avatar
Iustin Pop committed
337
The instances resource.
338

Iustin Pop's avatar
Iustin Pop committed
339
It supports the following commands: ``GET``, ``POST``.
340

Iustin Pop's avatar
Iustin Pop committed
341 342
``GET``
~~~~~~~
343

Iustin Pop's avatar
Iustin Pop committed
344
Returns a list of all available instances.
345

Iustin Pop's avatar
Iustin Pop committed
346
Example::
347 348 349 350 351 352 353 354 355 356 357 358

    [
      {
        "name": "web.example.com",
        "uri": "\/instances\/web.example.com"
      },
      {
        "name": "mail.example.com",
        "uri": "\/instances\/mail.example.com"
      }
    ]

359 360 361
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.
362

Iustin Pop's avatar
Iustin Pop committed
363
Example::
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

    [
      {
         "status": "running",
         "disk_usage": 20480,
         "nic.bridges": [
           "xen-br0"
          ],
         "name": "web.example.com",
         "tags": ["tag1", "tag2"],
         "beparams": {
           "vcpus": 2,
           "memory": 512
         },
         "disk.sizes": [
             20480
         ],
         "pnode": "node1.example.com",
         "nic.macs": ["01:23:45:67:89:01"],
         "snodes": ["node2.example.com"],
         "disk_template": "drbd",
         "admin_state": true,
         "os": "debian-etch",
         "oper_state": true
      },
      ...
    ]


Iustin Pop's avatar
Iustin Pop committed
393 394
``POST``
~~~~~~~~
395

Iustin Pop's avatar
Iustin Pop committed
396
Creates an instance.
397

398 399 400 401
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.
402

Iustin Pop's avatar
Iustin Pop committed
403
Returns: a job ID that can be used later for polling.
404

405 406 407 408 409 410
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 not
  documented).
411 412
``mode`` (string, required)
  Instance creation mode.
413
``name`` (string, required)
414
  Instance name.
415
``disk_template`` (string, required)
416
  Disk template for instance.
417 418 419 420 421 422 423
``disks`` (list, required)
  List of disk definitions. Example: ``[{"size": 100}, {"size": 5}]``.
  Each disk definition must contain a ``size`` value and can contain an
  optional ``mode`` value denoting the disk access mode (``ro`` or
  ``rw``).
``nics`` (list, required)
  List of NIC (network interface) definitions. Example: ``[{}, {},
424 425
  {"ip": "198.51.100.4"}]``. Each NIC definition can contain the
  optional values ``ip``, ``mode``, ``link`` and ``bridge``.
426
``os`` (string, required)
427
  Instance operating system.
428 429 430
``osparams`` (dictionary)
  Dictionary with OS parameters. If not valid for the given OS, the job
  will fail.
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
``force_variant`` (bool)
  Whether to force an unknown variant.
``pnode`` (string)
  Primary node.
``snode`` (string)
  Secondary node.
``src_node`` (string)
  Source node for import.
``src_path`` (string)
  Source directory for import.
``start`` (bool)
  Whether to start instance after creation.
``ip_check`` (bool)
  Whether to ensure instance's IP address is inactive.
``name_check`` (bool)
  Whether to ensure instance's name is resolvable.
``file_storage_dir`` (string)
  File storage directory.
``file_driver`` (string)
  File storage driver.
``iallocator`` (string)
  Instance allocator name.
453
``source_handshake`` (list)
454 455 456 457 458
  Signed handshake from source (remote import only).
``source_x509_ca`` (string)
  Source X509 CA in PEM format (remote import only).
``source_instance_name`` (string)
  Source instance name (remote import only).
459 460 461 462
``hypervisor`` (string)
  Hypervisor name.
``hvparams`` (dict)
  Hypervisor parameters, hypervisor-dependent.
463
``beparams`` (dict)
464 465 466
  Backend parameters.


Iustin Pop's avatar
Iustin Pop committed
467 468
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
469

Iustin Pop's avatar
Iustin Pop committed
470
Instance-specific resource.
471

Iustin Pop's avatar
Iustin Pop committed
472
It supports the following commands: ``GET``, ``DELETE``.
473

Iustin Pop's avatar
Iustin Pop committed
474 475
``GET``
~~~~~~~
476

Iustin Pop's avatar
Iustin Pop committed
477 478
Returns information about an instance, similar to the bulk output from
the instance list.
479

Iustin Pop's avatar
Iustin Pop committed
480 481
``DELETE``
~~~~~~~~~~
482

Iustin Pop's avatar
Iustin Pop committed
483
Deletes an instance.
484

485 486
It supports the ``dry-run`` argument.

487

488 489 490 491 492 493 494 495 496 497
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++

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

``GET``
~~~~~~~

Requests detailed information about the instance. An optional parameter,
``static`` (bool), can be set to return only static information from the
498 499
configuration without querying the instance's nodes. The result will be
a job id.
500 501


Iustin Pop's avatar
Iustin Pop committed
502 503
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
504

Iustin Pop's avatar
Iustin Pop committed
505
Reboots URI for an instance.
506

Iustin Pop's avatar
Iustin Pop committed
507
It supports the following commands: ``POST``.
508

Iustin Pop's avatar
Iustin Pop committed
509 510
``POST``
~~~~~~~~
511

Iustin Pop's avatar
Iustin Pop committed
512
Reboots the instance.
513

514 515 516 517 518 519 520 521 522 523 524 525
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.
526

527 528 529
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
530 531
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
532

Iustin Pop's avatar
Iustin Pop committed
533
Instance shutdown URI.
534

Iustin Pop's avatar
Iustin Pop committed
535
It supports the following commands: ``PUT``.
536

Iustin Pop's avatar
Iustin Pop committed
537 538
``PUT``
~~~~~~~
539

Iustin Pop's avatar
Iustin Pop committed
540
Shutdowns an instance.
541

542 543
It supports the ``dry-run`` argument.

544

Iustin Pop's avatar
Iustin Pop committed
545 546
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
547

Iustin Pop's avatar
Iustin Pop committed
548
Instance startup URI.
549

Iustin Pop's avatar
Iustin Pop committed
550
It supports the following commands: ``PUT``.
551

Iustin Pop's avatar
Iustin Pop committed
552 553
``PUT``
~~~~~~~
554

Iustin Pop's avatar
Iustin Pop committed
555
Startup an instance.
556

557 558
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
559

560 561
It supports the ``dry-run`` argument.

562 563 564 565 566 567 568 569 570 571 572 573
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

It supports the following commands: ``POST``.

``POST``
~~~~~~~~

Takes the parameters ``os`` (OS template name) and ``nostartup`` (bool).

574

575 576 577 578 579 580 581 582 583 584 585
``/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``,
586 587 588
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
589

590 591 592 593 594 595
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.

596

597 598 599 600 601 602 603 604 605 606
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

It supports the following commands: ``PUT``.

``PUT``
~~~~~~~

607
Takes the bool parameter ``ignore_size``. When set ignore the recorded
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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.


624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
``/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:

``mode`` (string)
  Export mode.
``destination`` (required)
  Destination information, depends on export mode.
``shutdown`` (bool, required)
  Whether to shutdown instance before export.
``remove_instance`` (bool)
  Whether to remove instance after export.
``x509_key_name``
  Name of X509 key (remote export only).
``destination_x509_ca``
  Destination X509 CA (remote export only).


665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

``mode`` (string)
  Migration mode.
``cleanup`` (bool)
  Whether a previously failed migration should be cleaned up.


685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

``new_name`` (string, required)
  New instance name.
``ip_check`` (bool)
  Whether to ensure instance's IP address is inactive.
``name_check`` (bool)
  Whether to ensure instance's name is resolvable.


707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

``PUT``
~~~~~~~

Returns a job ID.

Body parameters:

``osparams`` (dict)
  Dictionary with OS parameters.
``hvparams`` (dict)
  Hypervisor parameters, hypervisor-dependent.
``beparams`` (dict)
  Backend parameters.
``force`` (bool)
  Whether to force the operation.
``nics`` (list)
  List of NIC changes. Each item is of the form ``(op, settings)``.
  ``op`` can be ``add`` to add a new NIC with the specified settings,
  ``remove`` to remove the last NIC or a number to modify the settings
  of the NIC with that index.
``disks`` (list)
  List of disk changes. See ``nics``.
``disk_template`` (string)
  Disk template for instance.
``remote_node`` (string)
  Secondary node (used when changing disk template).
``os_name`` (string)
  Change instance's OS name. Does not reinstall the instance.
``force_variant`` (bool)
  Whether to force an unknown variant.


Iustin Pop's avatar
Iustin Pop committed
746 747
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
748

Iustin Pop's avatar
Iustin Pop committed
749
Manages per-instance tags.
750

Iustin Pop's avatar
Iustin Pop committed
751
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
752

Iustin Pop's avatar
Iustin Pop committed
753 754
``GET``
~~~~~~~
755

Iustin Pop's avatar
Iustin Pop committed
756
Returns a list of tags.
757

Iustin Pop's avatar
Iustin Pop committed
758
Example::
759

Iustin Pop's avatar
Iustin Pop committed
760
    ["tag1", "tag2", "tag3"]
761

Iustin Pop's avatar
Iustin Pop committed
762 763
``PUT``
~~~~~~~
764

Iustin Pop's avatar
Iustin Pop committed
765
Add a set of tags.
766

Iustin Pop's avatar
Iustin Pop committed
767
The request as a list of strings should be ``PUT`` to this URI. The
768
result will be a job id.
769

770 771 772
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
773 774
``DELETE``
~~~~~~~~~~
775

Iustin Pop's avatar
Iustin Pop committed
776
Delete a tag.
777

Iustin Pop's avatar
Iustin Pop committed
778 779
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
780

Iustin Pop's avatar
Iustin Pop committed
781
    /tags?tag=[tag]&tag=[tag]
782

783 784 785
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
786 787
``/2/jobs``
+++++++++++
788

Iustin Pop's avatar
Iustin Pop committed
789
The ``/2/jobs`` resource.
790

Iustin Pop's avatar
Iustin Pop committed
791
It supports the following commands: ``GET``.
792

Iustin Pop's avatar
Iustin Pop committed
793 794
``GET``
~~~~~~~
795

Iustin Pop's avatar
Iustin Pop committed
796
Returns a dictionary of jobs.
797

Iustin Pop's avatar
Iustin Pop committed
798
Returns: a dictionary with jobs id and uri.
799

Iustin Pop's avatar
Iustin Pop committed
800 801
``/2/jobs/[job_id]``
++++++++++++++++++++
802 803


Iustin Pop's avatar
Iustin Pop committed
804
Individual job URI.
805

Iustin Pop's avatar
Iustin Pop committed
806
It supports the following commands: ``GET``, ``DELETE``.
807

Iustin Pop's avatar
Iustin Pop committed
808 809
``GET``
~~~~~~~
810

Iustin Pop's avatar
Iustin Pop committed
811
Returns a job status.
812

Iustin Pop's avatar
Iustin Pop committed
813
Returns: a dictionary with job parameters.
814

Iustin Pop's avatar
Iustin Pop committed
815
The result includes:
816

Iustin Pop's avatar
Iustin Pop committed
817 818
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
819 820
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
821
- opstatus: OpCodes status as a list
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
- opresult: OpCodes results as a list

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:

- first element the error type (the Ganeti internal error name)
- second element a list of either one or two elements:

  - 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:

``resolver_error``
  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.

``insufficient_resources``
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

``wrong_input``
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

``wrong_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.

``unknown_entity``
  Entity not found. For example, information has been requested for an
  unknown instance.

``already_exists``
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

``resource_not_unique``
  Resource not unique (e.g. MAC or IP duplication).

``internal_error``
  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.

``environment_error``
  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.

883

Iustin Pop's avatar
Iustin Pop committed
884 885
``DELETE``
~~~~~~~~~~
886

Iustin Pop's avatar
Iustin Pop committed
887
Cancel a not-yet-started job.
888

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912

``/2/jobs/[job_id]/wait``
+++++++++++++++++++++++++

``GET``
~~~~~~~

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

``fields``
  The job fields on which to watch for changes.

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

``previous_log_serial``
  Highest log serial number received so far or None if not yet
  available.

Returns None if no changes have been detected and a dict with two keys,
``job_info`` and ``log_entries`` otherwise.


Iustin Pop's avatar
Iustin Pop committed
913 914
``/2/nodes``
++++++++++++
915

Iustin Pop's avatar
Iustin Pop committed
916
Nodes resource.
917

Iustin Pop's avatar
Iustin Pop committed
918
It supports the following commands: ``GET``.
919

Iustin Pop's avatar
Iustin Pop committed
920 921
``GET``
~~~~~~~
922

Iustin Pop's avatar
Iustin Pop committed
923
Returns a list of all nodes.
924

Iustin Pop's avatar
Iustin Pop committed
925
Example::
926 927 928 929

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
930
        "uri": "\/nodes\/node1.example.com"
931 932 933
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
934
        "uri": "\/nodes\/node2.example.com"
935 936 937
      }
    ]

Iustin Pop's avatar
Iustin Pop committed
938 939 940
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.
941

Iustin Pop's avatar
Iustin Pop committed
942
Example::
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959

    [
      {
        "pinst_cnt": 1,
        "mfree": 31280,
        "mtotal": 32763,
        "name": "www.example.com",
        "tags": [],
        "mnode": 512,
        "dtotal": 5246208,
        "sinst_cnt": 2,
        "dfree": 5171712,
        "offline": false
      },
      ...
    ]

960 961 962 963 964 965 966
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

967 968 969 970 971 972 973 974 975 976 977
``/2/nodes/[node_name]/evacuate``
+++++++++++++++++++++++++++++++++

Evacuates all secondary instances off a node.

It supports the following commands: ``POST``.

``POST``
~~~~~~~~

To evacuate a node, either one of the ``iallocator`` or ``remote_node``
978
parameters must be passed::
979 980 981 982

    evacuate?iallocator=[iallocator]
    evacuate?remote_node=[nodeX.example.com]

983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
The result value will be a list, each element being a triple of the job
id (for this specific evacuation), the instance which is being evacuated
by this job, and the node to which it is being relocated. In case the
node is already empty, the result will be an empty list (without any
jobs being submitted).

And additional parameter ``early_release`` signifies whether to try to
parallelize the evacuations, at the risk of increasing I/O contention
and increasing the chances of data loss, if the primary node of any of
the instances being evacuated is not fully healthy.

If the dry-run parameter was specified, then the evacuation jobs were
not actually submitted, and the job IDs will be null.


998 999 1000 1001 1002 1003 1004 1005 1006 1007
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

It supports the following commands: ``POST``.

``POST``
~~~~~~~~

1008 1009
No parameters are required, but the bool parameter ``live`` can be set
to use live migration (if available).
1010 1011 1012

    migrate?live=[0|1]

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
``/2/nodes/[node_name]/role``
+++++++++++++++++++++++++++++

Manages node role.

It supports the following commands: ``GET``, ``PUT``.

The role is always one of the following:

  - drained
  - master
  - master-candidate
  - offline
  - regular

``GET``
~~~~~~~

Returns the current node role.

Example::

    "master-candidate"

``PUT``
~~~~~~~

Change the node role.

1042 1043
The request is a string which should be PUT to this URI. The result will
be a job id.
1044

1045
It supports the bool ``force`` argument.
1046

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
``/2/nodes/[node_name]/storage``
++++++++++++++++++++++++++++++++

Manages storage units on the node.

``GET``
~~~~~~~

Requests a list of storage units on a node. Requires the parameters
``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``) and
1057 1058
``output_fields``. The result will be a job id, using which the result
can be retrieved.
1059

1060 1061 1062 1063 1064 1065 1066 1067
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

``PUT``
~~~~~~~

1068 1069 1070 1071 1072
Modifies parameters of storage units on the node. Requires the
parameters ``storage_type`` (one of ``file``, ``lvm-pv`` or ``lvm-vg``)
and ``name`` (name of the storage unit).  Parameters can be passed
additionally. Currently only ``allocatable`` (bool) is supported. The
result will be a job id.
1073

1074 1075 1076 1077 1078 1079 1080 1081
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

``PUT``
~~~~~~~

1082 1083 1084
Repairs a storage unit on the node. Requires the parameters
``storage_type`` (currently only ``lvm-vg`` can be repaired) and
``name`` (name of the storage unit). The result will be a job id.
1085

Iustin Pop's avatar
Iustin Pop committed
1086 1087
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
1088

Iustin Pop's avatar
Iustin Pop committed
1089
Manages per-node tags.
1090

Iustin Pop's avatar
Iustin Pop committed
1091
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1092

Iustin Pop's avatar
Iustin Pop committed
1093 1094
``GET``
~~~~~~~
1095

Iustin Pop's avatar
Iustin Pop committed
1096
Returns a list of tags.
1097

Iustin Pop's avatar
Iustin Pop committed
1098
Example::
1099

Iustin Pop's avatar
Iustin Pop committed
1100
    ["tag1", "tag2", "tag3"]
1101

Iustin Pop's avatar
Iustin Pop committed
1102 1103
``PUT``
~~~~~~~
1104

Iustin Pop's avatar
Iustin Pop committed
1105
Add a set of tags.
1106

Iustin Pop's avatar
Iustin Pop committed
1107 1108
The request as a list of strings should be PUT to this URI. The result
will be a job id.
1109

1110 1111
It supports the ``dry-run`` argument.

Iustin Pop's avatar
Iustin Pop committed
1112 1113
``DELETE``
~~~~~~~~~~
1114

Iustin Pop's avatar
Iustin Pop committed
1115
Deletes tags.
1116

Iustin Pop's avatar
Iustin Pop committed
1117 1118
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
1119

Iustin Pop's avatar
Iustin Pop committed
1120
    /tags?tag=[tag]&tag=[tag]
1121

1122 1123 1124
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1125 1126
``/2/os``
+++++++++
1127

Iustin Pop's avatar
Iustin Pop committed
1128
OS resource.
1129

Iustin Pop's avatar
Iustin Pop committed
1130
It supports the following commands: ``GET``.
1131

Iustin Pop's avatar
Iustin Pop committed
1132 1133
``GET``
~~~~~~~
1134

Iustin Pop's avatar
Iustin Pop committed
1135
Return a list of all OSes.
1136

Iustin Pop's avatar
Iustin Pop committed
1137
Can return error 500 in case of a problem. Since this is a costly
Iustin Pop's avatar
Iustin Pop committed
1138
operation for Ganeti 2.0, it is not recommended to execute it too often.
1139

Iustin Pop's avatar
Iustin Pop committed
1140
Example::
1141

Iustin Pop's avatar
Iustin Pop committed
1142
    ["debian-etch"]
1143

Iustin Pop's avatar
Iustin Pop committed
1144 1145
``/2/tags``
+++++++++++
1146

Iustin Pop's avatar
Iustin Pop committed
1147
Manages cluster tags.
1148

Iustin Pop's avatar
Iustin Pop committed
1149
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1150

Iustin Pop's avatar
Iustin Pop committed
1151 1152
``GET``
~~~~~~~
1153

Iustin Pop's avatar
Iustin Pop committed
1154
Returns the cluster tags.
1155

Iustin Pop's avatar
Iustin Pop committed
1156
Example::
1157

Iustin Pop's avatar
Iustin Pop committed
1158
    ["tag1", "tag2", "tag3"]
1159

Iustin Pop's avatar
Iustin Pop committed
1160 1161
``PUT``
~~~~~~~
1162

Iustin Pop's avatar
Iustin Pop committed
1163
Adds a set of tags.
1164

Iustin Pop's avatar
Iustin Pop committed
1165 1166
The request as a list of strings should be PUT to this URI. The result
will be a job id.
1167

1168 1169 1170
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1171 1172
``DELETE``
~~~~~~~~~~
1173

Iustin Pop's avatar
Iustin Pop committed
1174
Deletes tags.
1175

Iustin Pop's avatar
Iustin Pop committed
1176 1177
In order to delete a set of tags, the DELETE request should be addressed
to URI like::
1178

Iustin Pop's avatar
Iustin Pop committed
1179
    /tags?tag=[tag]&tag=[tag]
1180

1181 1182 1183
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1184 1185
``/version``
++++++++++++
1186

Iustin Pop's avatar
Iustin Pop committed
1187
The version resource.
1188

Iustin Pop's avatar
Iustin Pop committed
1189 1190
This resource should be used to determine the remote API version and to
adapt clients accordingly.
1191

Iustin Pop's avatar
Iustin Pop committed
1192
It supports the following commands: ``GET``.
1193

Iustin Pop's avatar
Iustin Pop committed
1194 1195
``GET``
~~~~~~~
1196

Iustin Pop's avatar
Iustin Pop committed
1197 1198
Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
returns ``2``.
1199 1200

.. vim: set textwidth=72 :
Iustin Pop's avatar
Iustin Pop committed
1201 1202 1203 1204
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: