rapi.rst 36 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
        constants.ISPEC_NIC_COUNT]))

.. |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
: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`)
224 225
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
226

227 228 229
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
230 231
You can access the API using your favorite programming language as long
as it supports network connections.
232

233 234 235 236 237
Ganeti RAPI client
++++++++++++++++++

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

238 239 240
Shell
+++++

Iustin Pop's avatar
Iustin Pop committed
241 242
.. highlight:: sh

243 244
Using wget::

Iustin Pop's avatar
Iustin Pop committed
245
   wget -q -O - https://CLUSTERNAME:5080/2/info
246 247 248 249 250 251 252 253 254

or curl::

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


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
255 256 257
.. highlight:: python

::
258 259

  import urllib2
Tim Boring's avatar
Tim Boring committed
260
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
261 262 263 264 265 266
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
272 273
.. highlight:: javascript

274 275
::

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

Iustin Pop's avatar
Iustin Pop committed
297 298
``/``
+++++
299

300 301
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
302

303 304 305 306 307
``/2``
++++++

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

Iustin Pop's avatar
Iustin Pop committed
308 309
``/2/info``
+++++++++++
310

Iustin Pop's avatar
Iustin Pop committed
311
Cluster information resource.
312

Iustin Pop's avatar
Iustin Pop committed
313
It supports the following commands: ``GET``.
314

Iustin Pop's avatar
Iustin Pop committed
315 316
``GET``
~~~~~~~
317

Iustin Pop's avatar
Iustin Pop committed
318
Returns cluster information.
319

Iustin Pop's avatar
Iustin Pop committed
320
Example::
321 322 323 324 325 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

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

351 352 353 354 355 356 357 358 359 360 361 362 363 364

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


365 366 367 368 369 370 371 372 373
``/2/features``
+++++++++++++++

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

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

374 375 376 377 378 379 380 381
.. 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`
382
  Instance creation request data version 1 supported.
383
:pyeval:`rlib2._INST_REINSTALL_REQV1`
384
  Instance reinstall supports body parameters.
385 386 387 388 389 390
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
  request body parameters.
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
391 392


393 394 395 396 397 398 399 400 401 402 403 404 405 406
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

407
.. opcode_params:: OP_CLUSTER_SET_PARAMS
408 409


410 411 412 413 414
``/2/groups``
+++++++++++++

The groups resource.

415
It supports the following commands: ``GET``, ``POST``.
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

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

439 440
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
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"
      }
    ]

463 464 465 466 467 468 469 470 471 472 473 474
``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:

475 476 477 478
.. opcode_params:: OP_GROUP_ADD

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


481
``/2/groups/[group_name]``
482
++++++++++++++++++++++++++
483 484 485

Returns information about a node group.

486 487 488 489 490 491 492 493
It supports the following commands: ``GET``, ``DELETE``.

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

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

494 495
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`

496 497 498 499 500 501 502 503
``DELETE``
~~~~~~~~~~

Deletes a node group.

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


504 505 506 507 508 509 510 511 512 513 514 515 516 517
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

518 519
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
520

521 522 523 524
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

525

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

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

540 541
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
542

543 544 545 546
Job result:

.. opcode_result:: OP_GROUP_RENAME

547

548 549 550 551 552 553 554 555 556 557 558 559 560 561
``/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:

562 563
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
564 565


566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
``/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.


Iustin Pop's avatar
Iustin Pop committed
606 607
``/2/instances``
++++++++++++++++
608

Iustin Pop's avatar
Iustin Pop committed
609
The instances resource.
610

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

Iustin Pop's avatar
Iustin Pop committed
613 614
``GET``
~~~~~~~
615

Iustin Pop's avatar
Iustin Pop committed
616
Returns a list of all available instances.
617

Iustin Pop's avatar
Iustin Pop committed
618
Example::
619 620 621 622 623 624 625 626 627 628 629 630

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

631 632 633
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.
634

635 636
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

Iustin Pop's avatar
Iustin Pop committed
637
Example::
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 665 666

    [
      {
         "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
667 668
``POST``
~~~~~~~~
669

Iustin Pop's avatar
Iustin Pop committed
670
Creates an instance.
671

672 673 674 675
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.
676

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

679 680 681 682
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
683 684
  instance creation requests, version ``0``, but that format is no
  longer supported)
685 686 687 688 689 690

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

692 693 694 695
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

696

Iustin Pop's avatar
Iustin Pop committed
697 698
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
699

Iustin Pop's avatar
Iustin Pop committed
700
Instance-specific resource.
701

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

Iustin Pop's avatar
Iustin Pop committed
704 705
``GET``
~~~~~~~
706

Iustin Pop's avatar
Iustin Pop committed
707 708
Returns information about an instance, similar to the bulk output from
the instance list.
709

710 711
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`

Iustin Pop's avatar
Iustin Pop committed
712 713
``DELETE``
~~~~~~~~~~
714

Iustin Pop's avatar
Iustin Pop committed
715
Deletes an instance.
716

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

719

720 721 722 723 724 725 726 727 728 729
``/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
730 731
configuration without querying the instance's nodes. The result will be
a job id.
732 733


Iustin Pop's avatar
Iustin Pop committed
734 735
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
736

Iustin Pop's avatar
Iustin Pop committed
737
Reboots URI for an instance.
738

Iustin Pop's avatar
Iustin Pop committed
739
It supports the following commands: ``POST``.
740

Iustin Pop's avatar
Iustin Pop committed
741 742
``POST``
~~~~~~~~
743

Iustin Pop's avatar
Iustin Pop committed
744
Reboots the instance.
745

746 747 748 749 750 751 752 753 754 755 756 757
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.
758

759 760 761
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
762 763
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
764

Iustin Pop's avatar
Iustin Pop committed
765
Instance shutdown URI.
766

Iustin Pop's avatar
Iustin Pop committed
767
It supports the following commands: ``PUT``.
768

Iustin Pop's avatar
Iustin Pop committed
769 770
``PUT``
~~~~~~~
771

Iustin Pop's avatar
Iustin Pop committed
772
Shutdowns an instance.
773

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

776 777 778
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

779

Iustin Pop's avatar
Iustin Pop committed
780 781
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
782

Iustin Pop's avatar
Iustin Pop committed
783
Instance startup URI.
784

Iustin Pop's avatar
Iustin Pop committed
785
It supports the following commands: ``PUT``.
786

Iustin Pop's avatar
Iustin Pop committed
787 788
``PUT``
~~~~~~~
789

Iustin Pop's avatar
Iustin Pop committed
790
Startup an instance.
791

792 793
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
794

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

797 798 799 800 801 802 803 804 805 806
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

807 808 809 810 811 812 813 814 815 816 817 818 819 820
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.
821

822

823 824 825 826 827 828 829 830 831 832
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

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

833 834 835
Returns a job ID.

Body parameters:
836

837 838
.. opcode_params:: OP_INSTANCE_REPLACE_DISKS
   :exclude: instance_name
839

840 841
Ganeti 2.4 and below used query parameters. Those are deprecated and
should no longer be used.
842

843

844 845 846 847 848 849 850 851 852 853
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

854
Takes the bool parameter ``ignore_size``. When set ignore the recorded
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
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.


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


888 889 890 891 892 893 894 895 896 897 898 899 900 901
``/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:

902 903
.. opcode_params:: OP_INSTANCE_GROW_DISK
   :exclude: instance_name, disk
904 905


906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
``/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:

933 934 935
.. opcode_params:: OP_BACKUP_EXPORT
   :exclude: instance_name
   :alias: target_node=destination
936 937


938 939 940 941 942 943 944 945 946 947 948 949 950 951
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

952 953
.. opcode_params:: OP_INSTANCE_MIGRATE
   :exclude: instance_name, live
954 955


956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
``/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


974 975 976 977 978 979 980 981 982 983 984 985 986 987
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

988 989
.. opcode_params:: OP_INSTANCE_RENAME
   :exclude: instance_name
990

991 992 993 994
Job result:

.. opcode_result:: OP_INSTANCE_RENAME

995

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1010 1011
.. opcode_params:: OP_INSTANCE_SET_PARAMS
   :exclude: instance_name
1012

1013 1014 1015 1016
Job result:

.. opcode_result:: OP_INSTANCE_SET_PARAMS

1017

1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
``/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:

1031 1032 1033 1034 1035 1036
.. pyassert::

   constants.CONS_ALL == frozenset([
     constants.CONS_MESSAGE,
     constants.CONS_SSH,
     constants.CONS_VNC,
1037
     constants.CONS_SPICE,
1038 1039
     ])

1040 1041 1042
``instance``
  Instance name.
``kind``
1043
  Console type, one of :pyeval:`constants.CONS_SSH`,
1044 1045
  :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
  or :pyeval:`constants.CONS_MESSAGE`.
1046
``message``
1047
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
1048
``host``
1049 1050
  Host to connect to (:pyeval:`constants.CONS_SSH`,
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
1051
``port``
1052 1053
  TCP port to connect to (:pyeval:`constants.CONS_VNC` or
  :pyeval:`constants.CONS_SPICE` only).
1054
``user``
1055
  Username to use (:pyeval:`constants.CONS_SSH` only).
1056
``command``
1057
  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1058
``display``
1059
  VNC display number (:pyeval:`constants.CONS_VNC` only).
1060 1061


Iustin Pop's avatar
Iustin Pop committed
1062 1063
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
1064

Iustin Pop's avatar
Iustin Pop committed
1065
Manages per-instance tags.
1066

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

Iustin Pop's avatar
Iustin Pop committed
1069 1070
``GET``
~~~~~~~
1071

Iustin Pop's avatar
Iustin Pop committed
1072
Returns a list of tags.
1073

Iustin Pop's avatar
Iustin Pop committed
1074
Example::
1075

Iustin Pop's avatar
Iustin Pop committed
1076
    ["tag1", "tag2", "tag3"]
1077

Iustin Pop's avatar
Iustin Pop committed
1078 1079
``PUT``
~~~~~~~
1080

Iustin Pop's avatar
Iustin Pop committed
1081
Add a set of tags.
1082

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

1086 1087 1088
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1089 1090
``DELETE``
~~~~~~~~~~
1091

Iustin Pop's avatar
Iustin Pop committed
1092
Delete a tag.
1093

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

Iustin Pop's avatar
Iustin Pop committed
1097
    /tags?tag=[tag]&tag=[tag]
1098

1099 1100 1101
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1102 1103
``/2/jobs``
+++++++++++
1104

Iustin Pop's avatar
Iustin Pop committed
1105
The ``/2/jobs`` resource.
1106

Iustin Pop's avatar
Iustin Pop committed
1107
It supports the following commands: ``GET``.
1108

Iustin Pop's avatar
Iustin Pop committed
1109 1110
``GET``
~~~~~~~
1111

Iustin Pop's avatar
Iustin Pop committed
1112
Returns a dictionary of jobs.
1113

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

1116 1117 1118 1119
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.

1120 1121 1122 1123
Returned fields for bulk requests (unlike other bulk requests, these
fields are not the same as for per-job requests):
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`

Iustin Pop's avatar
Iustin Pop committed
1124 1125
``/2/jobs/[job_id]``
++++++++++++++++++++
1126 1127


Iustin Pop's avatar
Iustin Pop committed
1128
Individual job URI.
1129

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

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

1135 1136
Returns a dictionary with job parameters, containing the fields
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1137

Iustin Pop's avatar
Iustin Pop committed
1138
The result includes:
1139

Iustin Pop's avatar
Iustin Pop committed
1140 1141
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
1142 1143
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
1144
- opstatus: OpCodes status as a list
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
- 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:

1164 1165 1166 1167 1168 1169 1170 1171
.. 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`
1172 1173 1174 1175
  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.

1176
:pyeval:`errors.ECODE_NORES`
1177 1178 1179 1180
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

1181
:pyeval:`errors.ECODE_INVAL`
1182 1183 1184
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

1185
:pyeval:`errors.ECODE_STATE`
1186 1187 1188 1189
  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.

1190
:pyeval:`errors.ECODE_NOENT`
1191 1192 1193
  Entity not found. For example, information has been requested for an
  unknown instance.

1194
:pyeval:`errors.ECODE_EXISTS`
1195 1196 1197
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

1198
:pyeval:`errors.ECODE_NOTUNIQUE`
1199 1200
  Resource not unique (e.g. MAC or IP duplication).

1201
:pyeval:`errors.ECODE_FAULT`
1202 1203 1204 1205
  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.

1206
:pyeval:`errors.ECODE_ENVIRON`
1207 1208 1209 1210 1211 1212
  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.

1213

Iustin Pop's avatar
Iustin Pop committed
1214 1215
``DELETE``
~~~~~~~~~~
1216

Iustin Pop's avatar
Iustin Pop committed
1217
Cancel a not-yet-started job.
1218

1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

``/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
1243 1244
``/2/nodes``
++++++++++++
1245

Iustin Pop's avatar
Iustin Pop committed
1246
Nodes resource.
1247

Iustin Pop's avatar
Iustin Pop committed
1248
It supports the following commands: ``GET``.
1249

Iustin Pop's avatar
Iustin Pop committed
1250 1251
``GET``
~~~~~~~
1252

Iustin Pop's avatar
Iustin Pop committed
1253
Returns a list of all nodes.
1254

Iustin Pop's avatar
Iustin Pop committed
1255
Example::
1256 1257 1258 1259

    [
      {
        "id": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
1260
        "uri": "\/nodes\/node1.example.com"
1261 1262 1263
      },
      {
        "id": "node2.example.com",
Iustin Pop's avatar
Iustin Pop committed
1264
        "uri": "\/nodes\/node2.example.com"
1265 1266 1267
      }
    ]

1268 1269 1270 1271 1272
If the optional bool *bulk* argument is provided and set to a true value
(i.e ``?bulk=1``), the output contains detailed information about nodes
as a list.

Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1273

Iustin Pop's avatar
Iustin Pop committed
1274
Example::
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291

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

1292 1293 1294 1295 1296 1297 1298
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++

Returns information about a node.

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

1299 1300
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
``/2/nodes/[node_name]/powercycle``
+++++++++++++++++++++++++++++++++++

Powercycles a node. Supports the following commands: ``POST``.

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

Returns a job ID.


1312 1313 1314
``/2/nodes/[node_name]/evacuate``
+++++++++++++++++++++++++++++++++

1315
Evacuates instances off a node.
1316 1317 1318 1319 1320 1321

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

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

1322 1323
Returns a job ID. The result of the job will contain the IDs of the
individual jobs submitted to evacuate the node.
1324

1325
Body parameters:
1326

1327 1328
.. opcode_params:: OP_NODE_EVACUATE
   :exclude: nodes
1329

1330 1331 1332
Up to and including Ganeti 2.4 query arguments were used. Those are no
longer supported. The new request can be detected by the presence of the
:pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1333

1334 1335 1336 1337
Job result:

.. opcode_result:: OP_NODE_EVACUATE

1338

1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++

Migrates all primary instances from a node.

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

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

1349
If no mode is explicitly specified, each instances' hypervisor default
1350 1351 1352 1353
migration mode will be used. Body parameters:

.. opcode_params:: OP_NODE_MIGRATE
   :exclude: node_name
1354

1355 1356 1357
The query arguments used up to and including Ganeti 2.4 are deprecated
and should no longer be used. The new request format can be detected by
the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.
1358

1359 1360 1361 1362
Job result:

.. opcode_result:: OP_NODE_MIGRATE

1363