rapi.rst 29.9 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

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

``ganeti-rapi`` reads users and passwords from a file (usually
24
``/var/lib/ganeti/rapi/users``) on startup. Changes to the file will be
25
read automatically.
26 27 28 29 30

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

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
56
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2 and
57 58 59 60 61 62 63
   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
The protocol used is JSON_ over HTTP designed after the REST_ principle.
68
HTTP Basic authentication as per :rfc:`2617` is supported.
69 70 71 72

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

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


107 108 109
PUT or POST?
------------

110 111 112
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.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

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

133 134 135
Generic parameters
------------------

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

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

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

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

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

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

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

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

165 166 167
Usage examples
--------------

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

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

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

176 177 178
Shell
+++++

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

181 182
Using wget::

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

or curl::

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


Python
++++++

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

::
196 197

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


JavaScript
++++++++++

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

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

212 213
::

Tim Boring's avatar
Tim Boring committed
214
  var url = 'https://CLUSTERNAME:5080/2/info';
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
  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
233
.. highlight:: javascript
234

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
275
Example::
276 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

  {
    "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
       }
      }
    }

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

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


320 321 322 323 324 325 326 327 328 329 330
``/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.
331 332
``instance-reinstall-reqv1``
  Instance reinstall supports body parameters.
333 334


335 336 337 338 339
``/2/groups``
+++++++++++++

The groups resource.

340
It supports the following commands: ``GET``, ``POST``.
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

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

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"
      }
    ]

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
``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:

``name`` (string, required)
  Node group name.


402
``/2/groups/[group_name]``
403
++++++++++++++++++++++++++
404 405 406

Returns information about a node group.

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
It supports the following commands: ``GET``, ``DELETE``.

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

Returns information about a node group, similar to the bulk output from
the node group list.

``DELETE``
~~~~~~~~~~

Deletes a node group.

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


423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

``alloc_policy`` (string)
  If present, the new allocation policy for the node group.


441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

``new_name`` (string, required)
  New node group name.
457 458


Iustin Pop's avatar
Iustin Pop committed
459 460
``/2/instances``
++++++++++++++++
461

Iustin Pop's avatar
Iustin Pop committed
462
The instances resource.
463

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

Iustin Pop's avatar
Iustin Pop committed
466 467
``GET``
~~~~~~~
468

Iustin Pop's avatar
Iustin Pop committed
469
Returns a list of all available instances.
470

Iustin Pop's avatar
Iustin Pop committed
471
Example::
472 473 474 475 476 477 478 479 480 481 482 483

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

484 485 486
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.
487

Iustin Pop's avatar
Iustin Pop committed
488
Example::
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517

    [
      {
         "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
518 519
``POST``
~~~~~~~~
520

Iustin Pop's avatar
Iustin Pop committed
521
Creates an instance.
522

523 524 525 526
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.
527

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

530 531 532 533 534 535
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).
536 537
``mode`` (string, required)
  Instance creation mode.
538
``name`` (string, required)
539
  Instance name.
540
``disk_template`` (string, required)
541
  Disk template for instance.
542 543 544 545 546 547 548
``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: ``[{}, {},
549 550
  {"ip": "198.51.100.4"}]``. Each NIC definition can contain the
  optional values ``ip``, ``mode``, ``link`` and ``bridge``.
551
``os`` (string, required)
552
  Instance operating system.
553 554 555
``osparams`` (dictionary)
  Dictionary with OS parameters. If not valid for the given OS, the job
  will fail.
556 557
``force_variant`` (bool)
  Whether to force an unknown variant.
558 559
``no_install`` (bool)
  Do not install the OS (will enable no-start)
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
``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.
580
``source_handshake`` (list)
581 582 583 584 585
  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).
586 587 588 589
``hypervisor`` (string)
  Hypervisor name.
``hvparams`` (dict)
  Hypervisor parameters, hypervisor-dependent.
590
``beparams`` (dict)
591 592 593
  Backend parameters.


Iustin Pop's avatar
Iustin Pop committed
594 595
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
596

Iustin Pop's avatar
Iustin Pop committed
597
Instance-specific resource.
598

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

Iustin Pop's avatar
Iustin Pop committed
601 602
``GET``
~~~~~~~
603

Iustin Pop's avatar
Iustin Pop committed
604 605
Returns information about an instance, similar to the bulk output from
the instance list.
606

Iustin Pop's avatar
Iustin Pop committed
607 608
``DELETE``
~~~~~~~~~~
609

Iustin Pop's avatar
Iustin Pop committed
610
Deletes an instance.
611

612 613
It supports the ``dry-run`` argument.

614

615 616 617 618 619 620 621 622 623 624
``/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
625 626
configuration without querying the instance's nodes. The result will be
a job id.
627 628


Iustin Pop's avatar
Iustin Pop committed
629 630
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
631

Iustin Pop's avatar
Iustin Pop committed
632
Reboots URI for an instance.
633

Iustin Pop's avatar
Iustin Pop committed
634
It supports the following commands: ``POST``.
635

Iustin Pop's avatar
Iustin Pop committed
636 637
``POST``
~~~~~~~~
638

Iustin Pop's avatar
Iustin Pop committed
639
Reboots the instance.
640

641 642 643 644 645 646 647 648 649 650 651 652
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.
653

654 655 656
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
657 658
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
659

Iustin Pop's avatar
Iustin Pop committed
660
Instance shutdown URI.
661

Iustin Pop's avatar
Iustin Pop committed
662
It supports the following commands: ``PUT``.
663

Iustin Pop's avatar
Iustin Pop committed
664 665
``PUT``
~~~~~~~
666

Iustin Pop's avatar
Iustin Pop committed
667
Shutdowns an instance.
668

669 670
It supports the ``dry-run`` argument.

671

Iustin Pop's avatar
Iustin Pop committed
672 673
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
674

Iustin Pop's avatar
Iustin Pop committed
675
Instance startup URI.
676

Iustin Pop's avatar
Iustin Pop committed
677
It supports the following commands: ``PUT``.
678

Iustin Pop's avatar
Iustin Pop committed
679 680
``PUT``
~~~~~~~
681

Iustin Pop's avatar
Iustin Pop committed
682
Startup an instance.
683

684 685
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
686

687 688
It supports the ``dry-run`` argument.

689 690 691 692 693 694 695 696 697 698
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

699 700 701 702 703 704 705 706 707 708 709 710 711 712
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.
713

714

715 716 717 718 719 720 721 722 723 724 725
``/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``,
726 727 728
``replace_on_secondary``, ``replace_new_secondary`` or
``replace_auto``), ``disks`` (comma separated list of disk indexes),
``remote_node`` and ``iallocator``.
729

730 731 732 733 734 735
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.

736

737 738 739 740 741 742 743 744 745 746
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

747
Takes the bool parameter ``ignore_size``. When set ignore the recorded
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
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.


764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
``/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).


805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
``/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.


825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
``/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.


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 883 884 885
``/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
886 887
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
888

Iustin Pop's avatar
Iustin Pop committed
889
Manages per-instance tags.
890

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

Iustin Pop's avatar
Iustin Pop committed
893 894
``GET``
~~~~~~~
895

Iustin Pop's avatar
Iustin Pop committed
896
Returns a list of tags.
897

Iustin Pop's avatar
Iustin Pop committed
898
Example::
899

Iustin Pop's avatar
Iustin Pop committed
900
    ["tag1", "tag2", "tag3"]
901

Iustin Pop's avatar
Iustin Pop committed
902 903
``PUT``
~~~~~~~
904

Iustin Pop's avatar
Iustin Pop committed
905
Add a set of tags.
906

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

910 911 912
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
913 914
``DELETE``
~~~~~~~~~~
915

Iustin Pop's avatar
Iustin Pop committed
916
Delete a tag.
917

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

Iustin Pop's avatar
Iustin Pop committed
921
    /tags?tag=[tag]&tag=[tag]
922

923 924 925
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
926 927
``/2/jobs``
+++++++++++
928

Iustin Pop's avatar
Iustin Pop committed
929
The ``/2/jobs`` resource.
930

Iustin Pop's avatar
Iustin Pop committed
931
It supports the following commands: ``GET``.
932

Iustin Pop's avatar
Iustin Pop committed
933 934
``GET``
~~~~~~~
935

Iustin Pop's avatar
Iustin Pop committed
936
Returns a dictionary of jobs.
937

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

Iustin Pop's avatar
Iustin Pop committed
940 941
``/2/jobs/[job_id]``
++++++++++++++++++++
942 943


Iustin Pop's avatar
Iustin Pop committed
944
Individual job URI.
945

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

Iustin Pop's avatar
Iustin Pop committed
948 949
``GET``
~~~~~~~
950

Iustin Pop's avatar
Iustin Pop committed
951
Returns a job status.
952

Iustin Pop's avatar
Iustin Pop committed
953
Returns: a dictionary with job parameters.
954

Iustin Pop's avatar
Iustin Pop committed
955
The result includes:
956

Iustin Pop's avatar
Iustin Pop committed
957 958
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
959 960
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
961
- opstatus: OpCodes status as a list
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
- 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.

1023

Iustin Pop's avatar
Iustin Pop committed
1024 1025
``DELETE``
~~~~~~~~~~
1026

Iustin Pop's avatar
Iustin Pop committed
1027
Cancel a not-yet-started job.
1028

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

``/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
1053 1054
``/2/nodes``
++++++++++++
1055

Iustin Pop's avatar
Iustin Pop committed
1056
Nodes resource.
1057

Iustin Pop's avatar
Iustin Pop committed
1058
It supports the following commands: ``GET``.
1059

Iustin Pop's avatar
Iustin Pop committed
1060 1061
``GET``
~~~~~~~
1062

Iustin Pop's avatar
Iustin Pop committed
1063
Returns a list of all nodes.
1064

Iustin Pop's avatar
Iustin Pop committed
1065
Example::
1066 1067 1068 1069

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
1070
        "uri": "\/nodes\/node1.example.com"
1071 1072 1073
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
1074
        "uri": "\/nodes\/node2.example.com"
1075 1076 1077
      }
    ]

Iustin Pop's avatar
Iustin Pop committed
1078 1079 1080
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.
1081

Iustin Pop's avatar
Iustin Pop committed
1082
Example::
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099

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

1100 1101 1102 1103 1104 1105 1106
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
``/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``
1118
parameters must be passed::
1119 1120 1121 1122

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

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
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.


1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

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

1148 1149 1150 1151 1152 1153 1154 1155
If no mode is explicitly specified, each instances' hypervisor default
migration mode will be used. Query parameters:

``live`` (bool)
  If set, use live migration if available.
``mode`` (string)
  Sets migration mode, ``live`` for live migration and ``non-live`` for
  non-live migration. Supported by Ganeti 2.2 and above.
1156 1157


1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
``/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.

1187 1188
The request is a string which should be PUT to this URI. The result will
be a job id.
1189

1190
It supports the bool ``force`` argument.
1191

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
``/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
1202 1203
``output_fields``. The result will be a job id, using which the result
can be retrieved.
1204

1205 1206 1207 1208 1209 1210 1211 1212
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++

Modifies storage units on the node.

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

1213 1214 1215 1216 1217
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.
1218

1219 1220 1221 1222 1223 1224 1225 1226
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++

Repairs a storage unit on the node.

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

1227 1228 1229
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.
1230

Iustin Pop's avatar
Iustin Pop committed
1231 1232
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
1233

Iustin Pop's avatar
Iustin Pop committed
1234
Manages per-node tags.
1235

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

Iustin Pop's avatar
Iustin Pop committed
1238 1239
``GET``
~~~~~~~
1240

Iustin Pop's avatar
Iustin Pop committed
1241
Returns a list of tags.
1242

Iustin Pop's avatar
Iustin Pop committed
1243
Example::
1244

Iustin Pop's avatar
Iustin Pop committed
1245
    ["tag1", "tag2", "tag3"]
1246

Iustin Pop's avatar
Iustin Pop committed
1247 1248
``PUT``
~~~~~~~
1249

Iustin Pop's avatar
Iustin Pop committed
1250
Add a set of tags.
1251

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

1255 1256
It supports the ``dry-run`` argument.

Iustin Pop's avatar
Iustin Pop committed
1257 1258
``DELETE``
~~~~~~~~~~
1259

Iustin Pop's avatar
Iustin Pop committed
1260
Deletes tags.
1261

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

Iustin Pop's avatar
Iustin Pop committed
1265
    /tags?tag=[tag]&tag=[tag]
1266

1267 1268 1269
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1270 1271
``/2/os``
+++++++++
1272

Iustin Pop's avatar
Iustin Pop committed
1273
OS resource.
1274

Iustin Pop's avatar
Iustin Pop committed
1275
It supports the following commands: ``GET``.
1276

Iustin Pop's avatar
Iustin Pop committed
1277 1278
``GET``
~~~~~~~
1279

Iustin Pop's avatar
Iustin Pop committed
1280
Return a list of all OSes.
1281

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

Iustin Pop's avatar
Iustin Pop committed
1285
Example::
1286

Iustin Pop's avatar
Iustin Pop committed
1287
    ["debian-etch"]
1288

Iustin Pop's avatar
Iustin Pop committed
1289 1290
``/2/tags``
+++++++++++
1291

Iustin Pop's avatar
Iustin Pop committed
1292
Manages cluster tags.
1293

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

Iustin Pop's avatar
Iustin Pop committed
1296 1297
``GET``
~~~~~~~
1298

Iustin Pop's avatar
Iustin Pop committed
1299
Returns the cluster tags.
1300

Iustin Pop's avatar
Iustin Pop committed
1301
Example::
1302

Iustin Pop's avatar
Iustin Pop committed
1303
    ["tag1", "tag2", "tag3"]
1304

Iustin Pop's avatar
Iustin Pop committed
1305 1306
``PUT``
~~~~~~~
1307

Iustin Pop's avatar
Iustin Pop committed
1308
Adds a set of tags.
1309

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

1313 1314 1315
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1316 1317
``DELETE``
~~~~~~~~~~
1318

Iustin Pop's avatar
Iustin Pop committed
1319
Deletes tags.
1320

Iustin Pop's avatar
Iustin Pop committed
1321