rapi.rst 38.8 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 31 32 33 34 35 36 37 38 39 40 41 42 43 44
Lines starting with the hash sign (``#``) are treated as comments. 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 (separated by comma without
spaces). Available options:

.. pyassert::

  rapi.RAPI_ACCESS_ALL == set([
    rapi.RAPI_ACCESS_WRITE,
    rapi.RAPI_ACCESS_READ,
    ])

:pyeval:`rapi.RAPI_ACCESS_WRITE`
  Enables the user to execute operations modifying the cluster. Implies
  :pyeval:`rapi.RAPI_ACCESS_READ` access.
:pyeval:`rapi.RAPI_ACCESS_READ`
  Allow access to operations querying for information.
45 46 47 48 49

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
50 51 52
'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.
53 54 55 56 57 58 59 60 61 62 63 64 65

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

66 67 68 69 70 71
  # Monitoring can query for values
  monitoring {HA1}ec018ffe72b8e75bb4d508ed5b6d079c query

  # A user who can query and write
  superuser {HA1}ec018ffe72b8e75bb4d508ed5b6d079c query,write

72 73

.. [#pwhash] Using the MD5 hash of username, realm and password is
74 75
   described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
   and 3.3. The reason for using it over another algorithm is forward
76 77 78 79 80 81
   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.


82 83 84
Protocol
--------

85
The protocol used is JSON_ over HTTP designed after the REST_ principle.
86
HTTP Basic authentication as per :rfc:`2617` is supported.
87 88 89 90

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

91 92 93 94
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).

95

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
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.


129 130 131
PUT or POST?
------------

132 133 134
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.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

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

155 156 157
Generic parameters
------------------

158 159
A few parameter mean the same thing across all resources which implement
it.
160 161 162 163

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

Iustin Pop's avatar
Iustin Pop committed
164 165 166 167 168
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.
169 170 171 172

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

173 174 175
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.
176

Iustin Pop's avatar
Iustin Pop committed
177 178 179
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.
180

181 182 183 184 185 186
``force``
+++++++++++

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

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
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,
206 207
                                     constants.IPOLICY_VCPU_RATIO,
                                     constants.IPOLICY_SPINDLE_RATIO])
208 209 210 211 212 213 214 215 216


.. pyassert::

  (set(constants.ISPECS_PARAMETER_TYPES.keys()) ==
   set([constants.ISPEC_MEM_SIZE,
        constants.ISPEC_DISK_SIZE,
        constants.ISPEC_DISK_COUNT,
        constants.ISPEC_CPU_COUNT,
217 218
        constants.ISPEC_NIC_COUNT,
        constants.ISPEC_SPINDLE_USE]))
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

.. |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
239 240
  :pyeval:`constants.ISPEC_SPINDLE_USE`
    The numbers of virtual disk spindles used by this instance. They are
241 242
    not real in the sense of actual HDD spindles, but useful for
    accounting the spindle usage on the residing node
243 244 245 246
: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`)
247 248
:pyeval:`constants.IPOLICY_SPINDLE_RATIO`
  Maximum ratio of instances to their node's ``spindle_count`` (`float`)
249

250 251 252
Usage examples
--------------

Iustin Pop's avatar
Iustin Pop committed
253 254
You can access the API using your favorite programming language as long
as it supports network connections.
255

256 257 258 259 260
Ganeti RAPI client
++++++++++++++++++

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

261 262 263
Shell
+++++

264
.. highlight:: shell-example
Iustin Pop's avatar
Iustin Pop committed
265

266 267
Using wget::

268
   $ wget -q -O - https://%CLUSTERNAME%:5080/2/info
269 270 271

or curl::

272
  $ curl https://%CLUSTERNAME%:5080/2/info
273 274 275 276 277


Python
++++++

Iustin Pop's avatar
Iustin Pop committed
278 279 280
.. highlight:: python

::
281 282

  import urllib2
Tim Boring's avatar
Tim Boring committed
283
  f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
284 285 286 287 288 289
  print f.read()


JavaScript
++++++++++

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

Iustin Pop's avatar
Iustin Pop committed
295 296
.. highlight:: javascript

297 298
::

Tim Boring's avatar
Tim Boring committed
299
  var url = 'https://CLUSTERNAME:5080/2/info';
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
  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
318
.. highlight:: javascript
319

Iustin Pop's avatar
Iustin Pop committed
320 321
``/``
+++++
322

323 324
The root resource. Has no function, but for legacy reasons the ``GET``
method is supported.
325

326 327 328 329 330
``/2``
++++++

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

Iustin Pop's avatar
Iustin Pop committed
331 332
``/2/info``
+++++++++++
333

Iustin Pop's avatar
Iustin Pop committed
334
Cluster information resource.
335

Iustin Pop's avatar
Iustin Pop committed
336
It supports the following commands: ``GET``.
337

Iustin Pop's avatar
Iustin Pop committed
338 339
``GET``
~~~~~~~
340

Iustin Pop's avatar
Iustin Pop committed
341
Returns cluster information.
342

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

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

374 375 376 377 378 379 380 381 382 383 384 385 386

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

387 388 389 390
Job result:

.. opcode_result:: OP_CLUSTER_REDIST_CONF

391

392 393 394 395 396 397 398 399 400
``/2/features``
+++++++++++++++

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

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

401 402 403 404 405 406 407 408
.. 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`
409
  Instance creation request data version 1 supported
410
:pyeval:`rlib2._INST_REINSTALL_REQV1`
411
  Instance reinstall supports body parameters
412 413
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
414
  request body parameters
415 416 417
:pyeval:`rlib2._NODE_EVAC_RES1`
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
  a new-style result (see resource description)
418 419


420 421 422 423 424 425 426 427 428 429 430 431 432 433
``/2/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies cluster parameters.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

434
.. opcode_params:: OP_CLUSTER_SET_PARAMS
435

436 437 438 439
Job result:

.. opcode_result:: OP_CLUSTER_SET_PARAMS

440

441 442 443 444 445
``/2/groups``
+++++++++++++

The groups resource.

446
It supports the following commands: ``GET``, ``POST``.
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

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

470
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
471

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
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"
      }
    ]

494 495 496 497 498 499 500 501 502 503 504 505
``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:

506 507 508 509
.. opcode_params:: OP_GROUP_ADD

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

511 512 513 514
Job result:

.. opcode_result:: OP_GROUP_ADD

515

516
``/2/groups/[group_name]``
517
++++++++++++++++++++++++++
518 519 520

Returns information about a node group.

521 522 523 524 525 526 527 528
It supports the following commands: ``GET``, ``DELETE``.

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

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

529
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
530

531 532 533 534 535 536 537
``DELETE``
~~~~~~~~~~

Deletes a node group.

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

538 539 540 541
Job result:

.. opcode_result:: OP_GROUP_REMOVE

542

543 544 545 546 547 548 549 550 551 552 553 554 555 556
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++

Modifies the parameters of a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

557 558
.. opcode_params:: OP_GROUP_SET_PARAMS
   :exclude: group_name
559

560 561 562 563
Job result:

.. opcode_result:: OP_GROUP_SET_PARAMS

564

565 566 567 568 569 570 571 572 573 574 575 576 577 578
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++

Renames a node group.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

579 580
.. opcode_params:: OP_GROUP_RENAME
   :exclude: group_name
581

582 583 584 585
Job result:

.. opcode_result:: OP_GROUP_RENAME

586

587 588 589 590 591 592 593 594 595 596 597 598 599 600
``/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:

601 602
.. opcode_params:: OP_GROUP_ASSIGN_NODES
   :exclude: group_name, force, dry_run
603

604 605 606 607
Job result:

.. opcode_result:: OP_GROUP_ASSIGN_NODES

608

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
``/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.


649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
``/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
668 669
``/2/instances``
++++++++++++++++
670

Iustin Pop's avatar
Iustin Pop committed
671
The instances resource.
672

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

Iustin Pop's avatar
Iustin Pop committed
675 676
``GET``
~~~~~~~
677

Iustin Pop's avatar
Iustin Pop committed
678
Returns a list of all available instances.
679

Iustin Pop's avatar
Iustin Pop committed
680
Example::
681 682 683 684 685 686 687 688 689 690 691 692

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

693 694 695
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.
696

697
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
698

Iustin Pop's avatar
Iustin Pop committed
699
Example::
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728

    [
      {
         "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
729 730
``POST``
~~~~~~~~
731

Iustin Pop's avatar
Iustin Pop committed
732
Creates an instance.
733

734 735 736 737
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.
738

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

741 742 743 744
Body parameters:

``__version__`` (int, required)
  Must be ``1`` (older Ganeti versions used a different format for
745 746
  instance creation requests, version ``0``, but that format is no
  longer supported)
747 748 749 750 751 752

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

754 755 756 757
Job result:

.. opcode_result:: OP_INSTANCE_CREATE

758

Iustin Pop's avatar
Iustin Pop committed
759 760
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
761

Iustin Pop's avatar
Iustin Pop committed
762
Instance-specific resource.
763

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

Iustin Pop's avatar
Iustin Pop committed
766 767
``GET``
~~~~~~~
768

Iustin Pop's avatar
Iustin Pop committed
769 770
Returns information about an instance, similar to the bulk output from
the instance list.
771

772
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
773

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

Iustin Pop's avatar
Iustin Pop committed
777
Deletes an instance.
778

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

781 782 783 784
Job result:

.. opcode_result:: OP_INSTANCE_REMOVE

785

786 787 788 789 790 791 792 793 794 795
``/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
796 797
configuration without querying the instance's nodes. The result will be
a job id.
798

799 800 801 802
Job result:

.. opcode_result:: OP_INSTANCE_QUERY_DATA

803

Iustin Pop's avatar
Iustin Pop committed
804 805
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
806

Iustin Pop's avatar
Iustin Pop committed
807
Reboots URI for an instance.
808

Iustin Pop's avatar
Iustin Pop committed
809
It supports the following commands: ``POST``.
810

Iustin Pop's avatar
Iustin Pop committed
811 812
``POST``
~~~~~~~~
813

Iustin Pop's avatar
Iustin Pop committed
814
Reboots the instance.
815

816 817 818 819 820 821 822 823 824 825 826 827
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.
828

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

831 832 833 834
Job result:

.. opcode_result:: OP_INSTANCE_REBOOT

835

Iustin Pop's avatar
Iustin Pop committed
836 837
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
838

Iustin Pop's avatar
Iustin Pop committed
839
Instance shutdown URI.
840

Iustin Pop's avatar
Iustin Pop committed
841
It supports the following commands: ``PUT``.
842

Iustin Pop's avatar
Iustin Pop committed
843 844
``PUT``
~~~~~~~
845

Iustin Pop's avatar
Iustin Pop committed
846
Shutdowns an instance.
847

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

850 851 852
.. opcode_params:: OP_INSTANCE_SHUTDOWN
   :exclude: instance_name, dry_run

853 854 855 856
Job result:

.. opcode_result:: OP_INSTANCE_SHUTDOWN

857

Iustin Pop's avatar
Iustin Pop committed
858 859
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
860

Iustin Pop's avatar
Iustin Pop committed
861
Instance startup URI.
862

Iustin Pop's avatar
Iustin Pop committed
863
It supports the following commands: ``PUT``.
864

Iustin Pop's avatar
Iustin Pop committed
865 866
``PUT``
~~~~~~~
867

Iustin Pop's avatar
Iustin Pop committed
868
Startup an instance.
869

870 871
The URI takes an optional ``force=1|0`` parameter to start the
instance even if secondary disks are failing.
872

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

875 876 877 878 879
Job result:

.. opcode_result:: OP_INSTANCE_STARTUP


880 881 882 883 884 885 886 887 888 889
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++

Installs the operating system again.

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

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

890 891 892 893 894 895 896 897 898 899 900 901 902 903
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.
904

905

906 907 908 909 910 911 912 913 914 915
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++

Replaces disks on an instance.

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

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

916 917 918
Returns a job ID.

Body parameters:
919

920 921
.. opcode_params:: OP_INSTANCE_REPLACE_DISKS
   :exclude: instance_name
922

923 924
Ganeti 2.4 and below used query parameters. Those are deprecated and
should no longer be used.
925

926 927 928 929
Job result:

.. opcode_result:: OP_INSTANCE_REPLACE_DISKS

930

931 932 933 934 935 936 937 938 939 940
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++

Activate disks on an instance.

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

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

941
Takes the bool parameter ``ignore_size``. When set ignore the recorded
942 943
size (useful for forcing activation when recorded size is wrong).

944 945 946 947
Job result:

.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS

948 949 950 951 952 953 954 955 956 957 958 959 960

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

Deactivate disks on an instance.

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

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

Takes no parameters.

961 962 963 964
Job result:

.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS

965

966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
``/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

982 983 984 985
Job result:

.. opcode_result:: OP_INSTANCE_RECREATE_DISKS

986

987 988 989 990 991 992 993 994 995 996 997 998 999 1000
``/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:

1001 1002
.. opcode_params:: OP_INSTANCE_GROW_DISK
   :exclude: instance_name, disk
1003

1004 1005 1006 1007
Job result:

.. opcode_result:: OP_INSTANCE_GROW_DISK

1008

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
``/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.

1021 1022 1023 1024
Job result:

.. opcode_result:: OP_BACKUP_PREPARE

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

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

Exports an instance.

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

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

Returns a job ID.

Body parameters:

1040 1041 1042
.. opcode_params:: OP_BACKUP_EXPORT
   :exclude: instance_name
   :alias: target_node=destination
1043

1044 1045 1046 1047
Job result:

.. opcode_result:: OP_BACKUP_EXPORT

1048

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++

Migrates an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1063 1064
.. opcode_params:: OP_INSTANCE_MIGRATE
   :exclude: instance_name, live
1065

1066 1067 1068 1069
Job result:

.. opcode_result:: OP_INSTANCE_MIGRATE

1070

1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
``/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

1088 1089 1090 1091
Job result:

.. opcode_result:: OP_INSTANCE_FAILOVER

1092

1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++

Renames an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1107 1108
.. opcode_params:: OP_INSTANCE_RENAME
   :exclude: instance_name
1109

1110 1111 1112 1113
Job result:

.. opcode_result:: OP_INSTANCE_RENAME

1114

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++

Modifies an instance.

Supports the following commands: ``PUT``.

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

Returns a job ID.

Body parameters:

1129 1130
.. opcode_params:: OP_INSTANCE_SET_PARAMS
   :exclude: instance_name
1131

1132 1133 1134 1135
Job result:

.. opcode_result:: OP_INSTANCE_SET_PARAMS

1136

1137 1138 1139 1140 1141
``/2/instances/[instance_name]/console``
++++++++++++++++++++++++++++++++++++++++

Request information for connecting to instance's console.

1142 1143 1144 1145 1146 1147 1148 1149 1150
.. pyassert::

  not (hasattr(rlib2.R_2_instances_name_console, "PUT") or
       hasattr(rlib2.R_2_instances_name_console, "POST") or
       hasattr(rlib2.R_2_instances_name_console, "DELETE"))

Supports the following commands: ``GET``. Requires authentication with
one of the following options:
:pyeval:`utils.CommaJoin(rlib2.R_2_instances_name_console.GET_ACCESS)`.
1151 1152 1153 1154 1155 1156 1157

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

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

1158 1159 1160 1161 1162 1163
.. pyassert::

   constants.CONS_ALL == frozenset([
     constants.CONS_MESSAGE,
     constants.CONS_SSH,
     constants.CONS_VNC,
1164
     constants.CONS_SPICE,
1165 1166
     ])

1167
``instance``
1168
  Instance name
1169
``kind``
1170
  Console type, one of :pyeval:`constants.CONS_SSH`,
1171
  :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
1172
  or :pyeval:`constants.CONS_MESSAGE`
1173
``message``
1174
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only)
1175
``host``
1176
  Host to connect to (:pyeval:`constants.CONS_SSH`,
1177
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only)
1178
``port``
1179
  TCP port to connect to (:pyeval:`constants.CONS_VNC` or
1180
  :pyeval:`constants.CONS_SPICE` only)
1181
``user``
1182
  Username to use (:pyeval:`constants.CONS_SSH` only)
1183
``command``
1184
  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1185
``display``
1186
  VNC display number (:pyeval:`constants.CONS_VNC` only)
1187 1188


Iustin Pop's avatar
Iustin Pop committed
1189 1190
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
1191

Iustin Pop's avatar
Iustin Pop committed
1192
Manages per-instance tags.
1193

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

Iustin Pop's avatar
Iustin Pop committed
1196 1197
``GET``
~~~~~~~
1198

Iustin Pop's avatar
Iustin Pop committed
1199
Returns a list of tags.
1200

Iustin Pop's avatar
Iustin Pop committed
1201
Example::
1202

Iustin Pop's avatar
Iustin Pop committed
1203
    ["tag1", "tag2", "tag3"]
1204

Iustin Pop's avatar
Iustin Pop committed
1205 1206
``PUT``
~~~~~~~
1207

Iustin Pop's avatar
Iustin Pop committed
1208
Add a set of tags.
1209

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

1213 1214 1215
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1216 1217
``DELETE``
~~~~~~~~~~
1218

Iustin Pop's avatar
Iustin Pop committed
1219
Delete a tag.
1220

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

Iustin Pop's avatar
Iustin Pop committed
1224
    /tags?tag=[tag]&tag=[tag]
1225

1226 1227 1228
It supports the ``dry-run`` argument.


Iustin Pop's avatar
Iustin Pop committed
1229 1230
``/2/jobs``
+++++++++++
1231

Iustin Pop's avatar
Iustin Pop committed
1232
The ``/2/jobs`` resource.
1233

Iustin Pop's avatar
Iustin Pop committed
1234
It supports the following commands: ``GET``.
1235

Iustin Pop's avatar
Iustin Pop committed
1236 1237
``GET``
~~~~~~~
1238

Iustin Pop's avatar
Iustin Pop committed
1239
Returns a dictionary of jobs.
1240

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

1243 1244 1245 1246
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.

1247 1248
Returned fields for bulk requests (unlike other bulk requests, these
fields are not the same as for per-job requests):
1249
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`.
1250

Iustin Pop's avatar
Iustin Pop committed
1251 1252
``/2/jobs/[job_id]``
++++++++++++++++++++
1253 1254


Iustin Pop's avatar
Iustin Pop committed
1255
Individual job URI.
1256

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

Iustin Pop's avatar
Iustin Pop committed
1259 1260
``GET``
~~~~~~~
1261

1262 1263
Returns a dictionary with job parameters, containing the fields
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1264

Iustin Pop's avatar
Iustin Pop committed
1265
The result includes:
1266

Iustin Pop's avatar
Iustin Pop committed
1267 1268
- id: job ID as a number
- status: current job status as a string
Iustin Pop's avatar
Iustin Pop committed
1269 1270
- ops: involved OpCodes as a list of dictionaries for each opcodes in
  the job
Iustin Pop's avatar
Iustin Pop committed
1271
- opstatus: OpCodes status as a list
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
- 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:

1291 1292 1293 1294 1295 1296 1297 1298
.. 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`
1299 1300 1301 1302
  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.

1303
:pyeval:`errors.ECODE_NORES`
1304 1305 1306 1307
  Not enough resources (iallocator failure, disk space, memory,
  etc.). If the resources on the cluster increase, the operation might
  succeed.

1308
:pyeval:`errors.ECODE_INVAL`
1309 1310 1311
  Wrong arguments (at syntax level). The operation will not ever be
  accepted unless the arguments change.

1312
:pyeval:`errors.ECODE_STATE`
1313 1314 1315 1316
  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.

1317
:pyeval:`errors.ECODE_NOENT`
1318 1319 1320
  Entity not found. For example, information has been requested for an
  unknown instance.

1321
:pyeval:`errors.ECODE_EXISTS`
1322 1323 1324
  Entity already exists. For example, instance creation has been
  requested for an already-existing instance.

1325
:pyeval:`errors.ECODE_NOTUNIQUE`
1326 1327
  Resource not unique (e.g. MAC or IP duplication).

1328
:pyeval:`errors.ECODE_FAULT`