rapi.rst 37.7 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 57
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
58 59 60 61 62 63
   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
HTTP requests with a body (e.g. ``PUT`` or ``POST``) require the request
header ``Content-type`` be set to ``application/json`` (see :rfc:`2616`
(HTTP/1.1), section 7.2.1).

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 108 109 110
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.


111 112 113
PUT or POST?
------------

114 115 116
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.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

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

137 138 139
Generic parameters
------------------

140 141
A few parameter mean the same thing across all resources which implement
it.
142 143 144 145

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

Iustin Pop's avatar
Iustin Pop committed
146 147 148 149 150
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.
151 152 153 154

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

155 156 157
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.
158

Iustin Pop's avatar
Iustin Pop committed
159 160 161
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.
162

163 164 165 166 167 168
``force``
+++++++++++

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

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
Parameter details
-----------------

Some parameters are not straight forward, so we describe them in details
here.

.. _rapi-ipolicy:

``ipolicy``
+++++++++++

The instance policy specification is a dict with the following fields:

.. pyassert::

  constants.IPOLICY_ALL_KEYS == set([constants.ISPECS_MIN,
                                     constants.ISPECS_MAX,
                                     constants.ISPECS_STD,
                                     constants.IPOLICY_DTS,
188 189
                                     constants.IPOLICY_VCPU_RATIO,
                                     constants.IPOLICY_SPINDLE_RATIO])
190 191 192 193 194 195 196 197 198


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
199 200
        constants.ISPEC_NIC_COUNT,
        constants.ISPEC_SPINDLE_USE]))
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

.. |ispec-min| replace:: :pyeval:`constants.ISPECS_MIN`
.. |ispec-max| replace:: :pyeval:`constants.ISPECS_MAX`
.. |ispec-std| replace:: :pyeval:`constants.ISPECS_STD`


|ispec-min|, |ispec-max|, |ispec-std|
  A sub- `dict` with the following fields, which sets the limit and standard
  values of the instances:

  :pyeval:`constants.ISPEC_MEM_SIZE`
    The size in MiB of the memory used
  :pyeval:`constants.ISPEC_DISK_SIZE`
    The size in MiB of the disk used
  :pyeval:`constants.ISPEC_DISK_COUNT`
    The numbers of disks used
  :pyeval:`constants.ISPEC_CPU_COUNT`
    The numbers of cpus used
  :pyeval:`constants.ISPEC_NIC_COUNT`
    The numbers of nics used
221 222
  :pyeval:`constants.ISPEC_SPINDLE_USE`
    The numbers of virtual disk spindles used by this instance. They are
223 224
    not real in the sense of actual HDD spindles, but useful for
    accounting the spindle usage on the residing node
225 226 227 228
:pyeval:`constants.IPOLICY_DTS`
  A `list` of disk templates allowed for instances using this policy
:pyeval:`constants.IPOLICY_VCPU_RATIO`
  Maximum ratio of virtual to physical CPUs (`float`)
229 230
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
231

232 233 234
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
235 236
You can access the API using your favorite programming language as long
as it supports network connections.
237

238 239 240 241 242
Ganeti RAPI client
++++++++++++++++++

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

243 244 245
Shell
+++++

246
.. highlight:: shell-example
Iustin Pop's avatar
Iustin Pop committed
247

248 249
Using wget::

250
   $ wget -q -O - https://%CLUSTERNAME%:5080/2/info
251 252 253

or curl::

254
  $ curl https://%CLUSTERNAME%:5080/2/info
255 256 257 258 259


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
260 261 262
.. highlight:: python

::
263 264

  import urllib2
Tim Boring's avatar
Tim Boring committed
265
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
266 267 268 269 270 271
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
277 278
.. highlight:: javascript

279 280
::

Tim Boring's avatar
Tim Boring committed
281
  var url = 'https://CLUSTERNAME:5080/2/info';
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  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
300
.. highlight:: javascript
301

Iustin Pop's avatar
Iustin Pop committed
302 303
``/``
+++++
304

305 306
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
307

308 309 310 311 312
``/2``
++++++

Has no function, but for legacy reasons the ``GET`` method is supported.

Iustin Pop's avatar
Iustin Pop committed
313 314
``/2/info``
+++++++++++
315

Iustin Pop's avatar
Iustin Pop committed
316
Cluster information resource.
317

Iustin Pop's avatar
Iustin Pop committed
318
It supports the following commands: ``GET``.
319

Iustin Pop's avatar
Iustin Pop committed
320 321
``GET``
~~~~~~~
322

Iustin Pop's avatar
Iustin Pop committed
323
Returns cluster information.
324

Iustin Pop's avatar
Iustin Pop committed
325
Example::
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

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

356 357 358 359 360 361 362 363 364 365 366 367 368

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

369 370 371 372
Job result:

.. opcode_result:: OP_CLUSTER_REDIST_CONF

373

374 375 376 377 378 379 380 381 382
``/2/features``
+++++++++++++++

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

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

383 384 385 386 387 388 389 390
.. pyassert::

  rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
                             rlib2._INST_REINSTALL_REQV1,
                             rlib2._NODE_MIGRATE_REQV1,
                             rlib2._NODE_EVAC_RES1])

:pyeval:`rlib2._INST_CREATE_REQV1`
391
  Instance creation request data version 1 supported
392
:pyeval:`rlib2._INST_REINSTALL_REQV1`
393
  Instance reinstall supports body parameters
394 395
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
396
  request body parameters
397 398 399
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
400 401


402 403 404 405 406 407 408 409 410 411 412 413 414 415
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

416
.. opcode_params:: OP_CLUSTER_SET_PARAMS
417

418 419 420 421
Job result:

.. opcode_result:: OP_CLUSTER_SET_PARAMS

422

423 424 425 426 427
``/2/groups``
+++++++++++++

The groups resource.

428
It supports the following commands: ``GET``, ``POST``.
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451

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

452
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
453

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
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"
      }
    ]

476 477 478 479 480 481 482 483 484 485 486 487
``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:

488 489 490 491
.. opcode_params:: OP_GROUP_ADD

Earlier versions used a parameter named ``name`` which, while still
supported, has been renamed to ``group_name``.
492

493 494 495 496
Job result:

.. opcode_result:: OP_GROUP_ADD

497

498
``/2/groups/[group_name]``
499
++++++++++++++++++++++++++
500 501 502

Returns information about a node group.

503 504 505 506 507 508 509 510
It supports the following commands: ``GET``, ``DELETE``.

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

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

511
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
512

513 514 515 516 517 518 519
``DELETE``
~~~~~~~~~~

Deletes a node group.

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

520 521 522 523
Job result:

.. opcode_result:: OP_GROUP_REMOVE

524

525 526 527 528 529 530 531 532 533 534 535 536 537 538
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

539 540
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
541

542 543 544 545
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

546

547 548 549 550 551 552 553 554 555 556 557 558 559 560
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

561 562
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
563

564 565 566 567
Job result:

.. opcode_result:: OP_GROUP_RENAME

568

569 570 571 572 573 574 575 576 577 578 579 580 581 582
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++

Assigns nodes to a group.

Supports the following commands: ``PUT``.

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

Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.

Body parameters:

583 584
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
585

586 587 588 589
Job result:

.. opcode_result:: OP_GROUP_ASSIGN_NODES

590

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++

Manages per-nodegroup tags.

Supports the following commands: ``GET``, ``PUT``, ``DELETE``.

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

Returns a list of tags.

Example::

    ["tag1", "tag2", "tag3"]

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

Add a set of tags.

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

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


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

Delete a tag.

In order to delete a set of tags, the DELETE request should be addressed
to URI like::

    /tags?tag=[tag]&tag=[tag]

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


631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
``/2/instances-multi-alloc``
++++++++++++++++++++++++++++

Tries to allocate multiple instances.

It supports the following commands: ``POST``

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

The parameters:

.. opcode_params:: OP_INSTANCE_MULTI_ALLOC

Job result:

.. opcode_result:: OP_INSTANCE_MULTI_ALLOC


Iustin Pop's avatar
Iustin Pop committed
650 651
``/2/instances``
++++++++++++++++
652

Iustin Pop's avatar
Iustin Pop committed
653
The instances resource.
654

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

Iustin Pop's avatar
Iustin Pop committed
657 658
``GET``
~~~~~~~
659

Iustin Pop's avatar
Iustin Pop committed
660
Returns a list of all available instances.
661

Iustin Pop's avatar
Iustin Pop committed
662
Example::
663 664 665 666 667 668 669 670 671 672 673 674

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

675 676 677
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.
678

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

Iustin Pop's avatar
Iustin Pop committed
681
Example::
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710

    [
      {
         "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
711 712
``POST``
~~~~~~~~
713

Iustin Pop's avatar
Iustin Pop committed
714
Creates an instance.
715

716 717 718 719
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.
720

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

723 724 725 726
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
727 728
  instance creation requests, version ``0``, but that format is no
  longer supported)
729 730 731 732 733 734

.. opcode_params:: OP_INSTANCE_CREATE

Earlier versions used parameters named ``name`` and ``os``. These have
been replaced by ``instance_name`` and ``os_type`` to match the
underlying opcode. The old names can still be used.
735

736 737 738 739
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

740

Iustin Pop's avatar
Iustin Pop committed
741 742
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
743

Iustin Pop's avatar
Iustin Pop committed
744
Instance-specific resource.
745

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

Iustin Pop's avatar
Iustin Pop committed
748 749
``GET``
~~~~~~~
750

Iustin Pop's avatar
Iustin Pop committed
751 752
Returns information about an instance, similar to the bulk output from
the instance list.
753

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

Iustin Pop's avatar
Iustin Pop committed
756 757
``DELETE``
~~~~~~~~~~
758

Iustin Pop's avatar
Iustin Pop committed
759
Deletes an instance.
760

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

763 764 765 766
Job result:

.. opcode_result:: OP_INSTANCE_REMOVE

767

768 769 770 771 772 773 774 775 776 777
``/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
778 779
configuration without querying the instance's nodes. The result will be
a job id.
780

781 782 783 784
Job result:

.. opcode_result:: OP_INSTANCE_QUERY_DATA

785

Iustin Pop's avatar
Iustin Pop committed
786 787
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
788

Iustin Pop's avatar
Iustin Pop committed
789
Reboots URI for an instance.
790

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

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

Iustin Pop's avatar
Iustin Pop committed
796
Reboots the instance.
797

798 799 800 801 802 803 804 805 806 807 808 809
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.
810

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

813 814 815 816
Job result:

.. opcode_result:: OP_INSTANCE_REBOOT

817

Iustin Pop's avatar
Iustin Pop committed
818 819
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
820

Iustin Pop's avatar
Iustin Pop committed
821
Instance shutdown URI.
822

Iustin Pop's avatar
Iustin Pop committed
823
It supports the following commands: ``PUT``.
824

Iustin Pop's avatar
Iustin Pop committed
825 826
``PUT``
~~~~~~~
827

Iustin Pop's avatar
Iustin Pop committed
828
Shutdowns an instance.
829

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

832 833 834
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

835 836 837 838
Job result:

.. opcode_result:: OP_INSTANCE_SHUTDOWN

839

Iustin Pop's avatar
Iustin Pop committed
840 841
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
842

Iustin Pop's avatar
Iustin Pop committed
843
Instance startup URI.
844

Iustin Pop's avatar
Iustin Pop committed
845
It supports the following commands: ``PUT``.
846

Iustin Pop's avatar
Iustin Pop committed
847 848
``PUT``
~~~~~~~
849

Iustin Pop's avatar
Iustin Pop committed
850
Startup an instance.
851

852 853
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
854

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

857 858 859 860 861
Job result:

.. opcode_result:: OP_INSTANCE_STARTUP


862 863 864 865 866 867 868 869 870 871
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

872 873 874 875 876 877 878 879 880 881 882 883 884 885
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.
886

887

888 889 890 891 892 893 894 895 896 897
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

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

898 899 900
Returns a job ID.

Body parameters:
901

902 903
.. opcode_params:: OP_INSTANCE_REPLACE_DISKS
   :exclude: instance_name
904

905 906
Ganeti 2.4 and below used query parameters. Those are deprecated and
should no longer be used.
907

908 909 910 911
Job result:

.. opcode_result:: OP_INSTANCE_REPLACE_DISKS

912

913 914 915 916 917 918 919 920 921 922
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

923
Takes the bool parameter ``ignore_size``. When set ignore the recorded
924 925
size (useful for forcing activation when recorded size is wrong).

926 927 928 929
Job result:

.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS

930 931 932 933 934 935 936 937 938 939 940 941 942

``/2/instances/[instance_name]/deactivate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Deactivate disks on an instance.

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

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

Takes no parameters.

943 944 945 946
Job result:

.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS

947

948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
``/2/instances/[instance_name]/recreate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++

Recreate disks of an instance. Supports the following commands:
``POST``.

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

Returns a job ID.

Body parameters:

.. opcode_params:: OP_INSTANCE_RECREATE_DISKS
   :exclude: instance_name

964 965 966 967
Job result:

.. opcode_result:: OP_INSTANCE_RECREATE_DISKS

968

969 970 971 972 973 974 975 976 977 978 979 980 981 982
``/2/instances/[instance_name]/disk/[disk_index]/grow``
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

Grows one disk of an instance.

Supports the following commands: ``POST``.

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

Returns a job ID.

Body parameters:

983 984
.. opcode_params:: OP_INSTANCE_GROW_DISK
   :exclude: instance_name, disk
985

986 987 988 989
Job result:

.. opcode_result:: OP_INSTANCE_GROW_DISK

990

991 992 993 994 995 996 997 998 999 1000 1001 1002
``/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.

1003 1004 1005 1006
Job result:

.. opcode_result:: OP_BACKUP_PREPARE

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

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

Exports an instance.

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

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

Returns a job ID.

Body parameters:

1022 1023 1024
.. opcode_params:: OP_BACKUP_EXPORT
   :exclude: instance_name
   :alias: target_node=destination
1025

1026 1027 1028 1029
Job result:

.. opcode_result:: OP_BACKUP_EXPORT

1030

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1045 1046
.. opcode_params:: OP_INSTANCE_MIGRATE
   :exclude: instance_name, live
1047

1048 1049 1050 1051
Job result:

.. opcode_result:: OP_INSTANCE_MIGRATE

1052

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
``/2/instances/[instance_name]/failover``
+++++++++++++++++++++++++++++++++++++++++

Does a failover of an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

.. opcode_params:: OP_INSTANCE_FAILOVER
   :exclude: instance_name

1070 1071 1072 1073
Job result:

.. opcode_result:: OP_INSTANCE_FAILOVER

1074

1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1089 1090
.. opcode_params:: OP_INSTANCE_RENAME
   :exclude: instance_name
1091

1092 1093 1094 1095
Job result:

.. opcode_result:: OP_INSTANCE_RENAME

1096

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1111 1112
.. opcode_params:: OP_INSTANCE_SET_PARAMS
   :exclude: instance_name
1113

1114 1115 1116 1117
Job result:

.. opcode_result:: OP_INSTANCE_SET_PARAMS

1118

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
``/2/instances/[instance_name]/console``
++++++++++++++++++++++++++++++++++++++++

Request information for connecting to instance's console.

Supports the following commands: ``GET``.

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

Returns a dictionary containing information about the instance's
console. Contained keys:

1132 1133 1134 1135 1136 1137
.. pyassert::

   constants.CONS_ALL == frozenset([
     constants.CONS_MESSAGE,
     constants.CONS_SSH,
     constants.CONS_VNC,
1138
     constants.CONS_SPICE,
1139 1140
     ])

1141
``instance``
1142
  Instance name
1143
``kind``
1144
  Console type, one of :pyeval:`constants.CONS_SSH`,
1145
  :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
1146
  or :pyeval:`constants.CONS_MESSAGE`
1147
``message``
1148
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only)
1149
``host``
1150
  Host to connect to (:pyeval:`constants.CONS_SSH`,
1151
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only)
1152
``port``
1153
  TCP port to connect to (:pyeval:`constants.CONS_VNC` or
1154
  :pyeval:`constants.CONS_SPICE` only)
1155
``user``
1156
  Username to use (:pyeval:`constants.CONS_SSH` only)
1157
``command``
1158
  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1159
``display``
1160
  VNC display number (:pyeval:`constants.CONS_VNC` only)
1161 1162


Iustin Pop's avatar
Iustin Pop committed
1163 1164
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
1165

Iustin Pop's avatar
Iustin Pop committed
1166
Manages per-instance tags.
1167

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

Iustin Pop's avatar
Iustin Pop committed
1170 1171
``GET``
~~~~~~~
1172

Iustin Pop's avatar
Iustin Pop committed
1173
Returns a list of tags.
1174

Iustin Pop's avatar
Iustin Pop committed
1175
Example::
1176

Iustin Pop's avatar
Iustin Pop committed
1177
    ["tag1", "tag2", "tag3"]
1178

Iustin Pop's avatar
Iustin Pop committed
1179 1180
``PUT``
~~~~~~~
1181

Iustin Pop's avatar
Iustin Pop committed
1182
Add a set of tags.
1183

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

1187 1188 1189
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1190 1191
``DELETE``
~~~~~~~~~~
1192

Iustin Pop's avatar
Iustin Pop committed
1193
Delete a tag.
1194

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

Iustin Pop's avatar
Iustin Pop committed
1198
    /tags?tag=[tag]&tag=[tag]
1199

1200 1201 1202
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1203 1204
``/2/jobs``
+++++++++++
1205

Iustin Pop's avatar
Iustin Pop committed
1206
The ``/2/jobs`` resource.
1207

Iustin Pop's avatar
Iustin Pop committed
1208
It supports the following commands: ``GET``.
1209

Iustin Pop's avatar
Iustin Pop committed
1210 1211
``GET``
~~~~~~~
1212

Iustin Pop's avatar
Iustin Pop committed
1213
Returns a dictionary of jobs.
1214

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

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

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

Iustin Pop's avatar
Iustin Pop committed
1225 1226
``/2/jobs/[job_id]``
++++++++++++++++++++
1227 1228


Iustin Pop's avatar
Iustin Pop committed
1229
Individual job URI.
1230

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

Iustin Pop's avatar
Iustin Pop committed
1233 1234
``GET``
~~~~~~~
1235

1236 1237
Returns a dictionary with job parameters, containing the fields
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1238

Iustin Pop's avatar
Iustin Pop committed
1239
The result includes:
1240

Iustin Pop's avatar
Iustin Pop committed
1241 1242
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
1243 1244
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
1245
- opstatus: OpCodes status as a list
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
- 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:

1265 1266 1267 1268 1269 1270 1271 1272
.. pyassert::

   errors.ECODE_ALL == set([errors.ECODE_RESOLVER, errors.ECODE_NORES,
     errors.ECODE_INVAL, errors.ECODE_STATE, errors.ECODE_NOENT,
     errors.ECODE_EXISTS, errors.ECODE_NOTUNIQUE, errors.ECODE_FAULT,
     errors.ECODE_ENVIRON])

:pyeval:`errors.ECODE_RESOLVER`
1273 1274 1275 1276
  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.

1277
:pyeval:`errors.ECODE_NORES`
1278 1279 1280 1281
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

1282
:pyeval:`errors.ECODE_INVAL`
1283 1284 1285
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

1286
:pyeval:`errors.ECODE_STATE`
1287 1288 1289 1290
  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.

1291
:pyeval:`errors.ECODE_NOENT`
1292 1293 1294
  Entity not found. For example, information has been requested for an
  unknown instance.

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

1299
:pyeval:`errors.ECODE_NOTUNIQUE`
1300 1301
  Resource not unique (e.g. MAC or IP duplication).

1302
:pyeval:`errors.ECODE_FAULT`
1303 1304 1305 1306
  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.

1307
:pyeval:`errors.ECODE_ENVIRON`
1308 1309 1310 1311 1312 1313
  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.

1314

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

Iustin Pop's avatar
Iustin Pop committed
1318
Cancel a not-yet-started job