code.grnet.gr Git - ganeti-local/blob - doc/rapi.rst

   1 Ganeti remote API
   2 =================
   3
   4 Documents Ganeti version |version|
   5
   6 .. contents::
   7
   8 Introduction
   9 ------------
  10
  11 Ganeti supports a remote API for enable external tools to easily
  12 retrieve information about a cluster's state. The remote API daemon,
  13 *ganeti-rapi*, is automatically started on the master node. By default
  14 it runs on TCP port 5080, but this can be changed either in
  15 ``.../constants.py`` or via the command line parameter *-p*. SSL mode,
  16 which is used by default, can also be disabled by passing command line
  17 parameters.
  18
  19
  20 Users and passwords
  21 -------------------
  22
  23 ``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 Each line consists of two or three fields separated by whitespace. The
  28 first two fields are for username and password. The third field is
  29 optional and can be used to specify per-user options. Currently,
  30 ``write`` is the only option supported and enables the user to execute
  31 operations modifying the cluster. Lines starting with the hash sign
  32 (``#``) are treated as comments.
  33
  34 Passwords can either be written in clear text or as a hash. Clear text
  35 passwords may not start with an opening brace (``{``) or they must be
  36 prefixed with ``{cleartext}``. To use the hashed form, get the MD5 hash
  37 of the string ``$username:Ganeti Remote API:$password`` (e.g. ``echo -n
  38 'jack:Ganeti Remote API:abc123' | openssl md5``) [#pwhash]_ and prefix
  39 it with ``{ha1}``. Using the scheme prefix for all passwords is
  40 recommended. Scheme prefixes are not case sensitive.
  41
  42 Example::
  43
  44   # Give Jack and Fred read-only access
  45   jack abc123
  46   fred {cleartext}foo555
  47
  48   # Give write access to an imaginary instance creation script
  49   autocreator xyz789 write
  50
  51   # Hashed password for Jessica
  52   jessica {HA1}7046452df2cbb530877058712cf17bd4 write
  53
  54
  55 .. [#pwhash] Using the MD5 hash of username, realm and password is
  56    described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2
  57    and 3.3. The reason for using it over another algorithm is forward
  58    compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
  59    authentication in the future, the same hash could be used.
  60    In the current version ``ganeti-rapi``'s realm, ``Ganeti Remote
  61    API``, can only be changed by modifying the source code.
  62
  63
  64 Protocol
  65 --------
  66
  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 .. _JSON: http://www.json.org/
  71 .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
  72
  73 HTTP requests with a body (e.g. ``PUT`` or ``POST``) require the request
  74 header ``Content-type`` be set to ``application/json`` (see :rfc:`2616`
  75 (HTTP/1.1), section 7.2.1).
  76
  77
  78 A note on JSON as used by RAPI
  79 ++++++++++++++++++++++++++++++
  80
  81 JSON_ as used by Ganeti RAPI does not conform to the specification in
  82 :rfc:`4627`. Section 2 defines a JSON text to be either an object
  83 (``{"key": "value", …}``) or an array (``[1, 2, 3, …]``). In violation
  84 of this RAPI uses plain strings (``"master-candidate"``, ``"1234"``) for
  85 some requests or responses. Changing this now would likely break
  86 existing clients and cause a lot of trouble.
  87
  88 .. highlight:: ruby
  89
  90 Unlike Python's `JSON encoder and decoder
  91 <http://docs.python.org/library/json.html>`_, other programming
  92 languages or libraries may only provide a strict implementation, not
  93 allowing plain values. For those, responses can usually be wrapped in an
  94 array whose first element is then used, e.g. the response ``"1234"``
  95 becomes ``["1234"]``. This works equally well for more complex values.
  96 Example in Ruby::
  97
  98   require "json"
  99
 100   # Insert code to get response here
 101   response = "\"1234\""
 102
 103   decoded = JSON.parse("[#{response}]").first
 104
 105 Short of modifying the encoder to allow encoding to a less strict
 106 format, requests will have to be formatted by hand. Newer RAPI requests
 107 already use a dictionary as their input data and shouldn't cause any
 108 problems.
 109
 110
 111 PUT or POST?
 112 ------------
 113
 114 According to :rfc:`2616` the main difference between PUT and POST is
 115 that POST can create new resources but PUT can only create the resource
 116 the URI was pointing to on the PUT request.
 117
 118 Unfortunately, due to historic reasons, the Ganeti RAPI library is not
 119 consistent with this usage, so just use the methods as documented below
 120 for each resource.
 121
 122 For more details have a look in the source code at
 123 ``lib/rapi/rlib2.py``.
 124
 125
 126 Generic parameter types
 127 -----------------------
 128
 129 A few generic refered parameter types and the values they allow.
 130
 131 ``bool``
 132 ++++++++
 133
 134 A boolean option will accept ``1`` or ``0`` as numbers but not
 135 i.e. ``True`` or ``False``.
 136
 137 Generic parameters
 138 ------------------
 139
 140 A few parameter mean the same thing across all resources which implement
 141 it.
 142
 143 ``bulk``
 144 ++++++++
 145
 146 Bulk-mode means that for the resources which usually return just a list
 147 of child resources (e.g. ``/2/instances`` which returns just instance
 148 names), the output will instead contain detailed data for all these
 149 subresources. This is more efficient than query-ing the sub-resources
 150 themselves.
 151
 152 ``dry-run``
 153 +++++++++++
 154
 155 The boolean *dry-run* argument, if provided and set, signals to Ganeti
 156 that the job should not be executed, only the pre-execution checks will
 157 be done.
 158
 159 This is useful in trying to determine (without guarantees though, as in
 160 the meantime the cluster state could have changed) if the operation is
 161 likely to succeed or at least start executing.
 162
 163 ``force``
 164 +++++++++++
 165
 166 Force operation to continue even if it will cause the cluster to become
 167 inconsistent (e.g. because there are not enough master candidates).
 168
 169 Usage examples
 170 --------------
 171
 172 You can access the API using your favorite programming language as long
 173 as it supports network connections.
 174
 175 Ganeti RAPI client
 176 ++++++++++++++++++
 177
 178 Ganeti includes a standalone RAPI client, ``lib/rapi/client.py``.
 179
 180 Shell
 181 +++++
 182
 183 .. highlight:: sh
 184
 185 Using wget::
 186
 187    wget -q -O - https://CLUSTERNAME:5080/2/info
 188
 189 or curl::
 190
 191   curl https://CLUSTERNAME:5080/2/info
 192
 193
 194 Python
 195 ++++++
 196
 197 .. highlight:: python
 198
 199 ::
 200
 201   import urllib2
 202   f = urllib2.urlopen('https://CLUSTERNAME:5080/2/info')
 203   print f.read()
 204
 205
 206 JavaScript
 207 ++++++++++
 208
 209 .. warning:: While it's possible to use JavaScript, it poses several
 210    potential problems, including browser blocking request due to
 211    non-standard ports or different domain names. Fetching the data on
 212    the webserver is easier.
 213
 214 .. highlight:: javascript
 215
 216 ::
 217
 218   var url = 'https://CLUSTERNAME:5080/2/info';
 219   var info;
 220   var xmlreq = new XMLHttpRequest();
 221   xmlreq.onreadystatechange = function () {
 222     if (xmlreq.readyState != 4) return;
 223     if (xmlreq.status == 200) {
 224       info = eval("(" + xmlreq.responseText + ")");
 225       alert(info);
 226     } else {
 227       alert('Error fetching cluster info');
 228     }
 229     xmlreq = null;
 230   };
 231   xmlreq.open('GET', url, true);
 232   xmlreq.send(null);
 233
 234 Resources
 235 ---------
 236
 237 .. highlight:: javascript
 238
 239 ``/``
 240 +++++
 241
 242 The root resource.
 243
 244 It supports the following commands: ``GET``.
 245
 246 ``GET``
 247 ~~~~~~~
 248
 249 Shows the list of mapped resources.
 250
 251 Returns: a dictionary with 'name' and 'uri' keys for each of them.
 252
 253 ``/2``
 254 ++++++
 255
 256 The ``/2`` resource, the root of the version 2 API.
 257
 258 It supports the following commands: ``GET``.
 259
 260 ``GET``
 261 ~~~~~~~
 262
 263 Show the list of mapped resources.
 264
 265 Returns: a dictionary with ``name`` and ``uri`` keys for each of them.
 266
 267 ``/2/info``
 268 +++++++++++
 269
 270 Cluster information resource.
 271
 272 It supports the following commands: ``GET``.
 273
 274 ``GET``
 275 ~~~~~~~
 276
 277 Returns cluster information.
 278
 279 Example::
 280
 281   {
 282     "config_version": 2000000,
 283     "name": "cluster",
 284     "software_version": "2.0.0~beta2",
 285     "os_api_version": 10,
 286     "export_version": 0,
 287     "candidate_pool_size": 10,
 288     "enabled_hypervisors": [
 289       "fake"
 290     ],
 291     "hvparams": {
 292       "fake": {}
 293      },
 294     "default_hypervisor": "fake",
 295     "master": "node1.example.com",
 296     "architecture": [
 297       "64bit",
 298       "x86_64"
 299     ],
 300     "protocol_version": 20,
 301     "beparams": {
 302       "default": {
 303         "auto_balance": true,
 304         "vcpus": 1,
 305         "memory": 128
 306        }
 307       }
 308     }
 309
 310
 311 ``/2/redistribute-config``
 312 ++++++++++++++++++++++++++
 313
 314 Redistribute configuration to all nodes.
 315
 316 It supports the following commands: ``PUT``.
 317
 318 ``PUT``
 319 ~~~~~~~
 320
 321 Redistribute configuration to all nodes. The result will be a job id.
 322
 323
 324 ``/2/features``
 325 +++++++++++++++
 326
 327 ``GET``
 328 ~~~~~~~
 329
 330 Returns a list of features supported by the RAPI server. Available
 331 features:
 332
 333 .. pyassert::
 334
 335   rlib2.ALL_FEATURES == set([rlib2._INST_CREATE_REQV1,
 336                              rlib2._INST_REINSTALL_REQV1,
 337                              rlib2._NODE_MIGRATE_REQV1,
 338                              rlib2._NODE_EVAC_RES1])
 339
 340 :pyeval:`rlib2._INST_CREATE_REQV1`
 341   Instance creation request data version 1 supported.
 342 :pyeval:`rlib2._INST_REINSTALL_REQV1`
 343   Instance reinstall supports body parameters.
 344 :pyeval:`rlib2._NODE_MIGRATE_REQV1`
 345   Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
 346   request body parameters.
 347 :pyeval:`rlib2._NODE_EVAC_RES1`
 348   Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
 349   a new-style result (see resource description)
 350
 351
 352 ``/2/modify``
 353 ++++++++++++++++++++++++++++++++++++++++
 354
 355 Modifies cluster parameters.
 356
 357 Supports the following commands: ``PUT``.
 358
 359 ``PUT``
 360 ~~~~~~~
 361
 362 Returns a job ID.
 363
 364 Body parameters:
 365
 366 .. opcode_params:: OP_CLUSTER_SET_PARAMS
 367
 368
 369 ``/2/groups``
 370 +++++++++++++
 371
 372 The groups resource.
 373
 374 It supports the following commands: ``GET``, ``POST``.
 375
 376 ``GET``
 377 ~~~~~~~
 378
 379 Returns a list of all existing node groups.
 380
 381 Example::
 382
 383     [
 384       {
 385         "name": "group1",
 386         "uri": "\/2\/groups\/group1"
 387       },
 388       {
 389         "name": "group2",
 390         "uri": "\/2\/groups\/group2"
 391       }
 392     ]
 393
 394 If the optional bool *bulk* argument is provided and set to a true value
 395 (i.e ``?bulk=1``), the output contains detailed information about node
 396 groups as a list.
 397
 398 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
 399
 400 Example::
 401
 402     [
 403       {
 404         "name": "group1",
 405         "node_cnt": 2,
 406         "node_list": [
 407           "node1.example.com",
 408           "node2.example.com"
 409         ],
 410         "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
 411       },
 412       {
 413         "name": "group2",
 414         "node_cnt": 1,
 415         "node_list": [
 416           "node3.example.com"
 417         ],
 418         "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
 419       }
 420     ]
 421
 422 ``POST``
 423 ~~~~~~~~
 424
 425 Creates a node group.
 426
 427 If the optional bool *dry-run* argument is provided, the job will not be
 428 actually executed, only the pre-execution checks will be done.
 429
 430 Returns: a job ID that can be used later for polling.
 431
 432 Body parameters:
 433
 434 .. opcode_params:: OP_GROUP_ADD
 435
 436 Earlier versions used a parameter named ``name`` which, while still
 437 supported, has been renamed to ``group_name``.
 438
 439
 440 ``/2/groups/[group_name]``
 441 ++++++++++++++++++++++++++
 442
 443 Returns information about a node group.
 444
 445 It supports the following commands: ``GET``, ``DELETE``.
 446
 447 ``GET``
 448 ~~~~~~~
 449
 450 Returns information about a node group, similar to the bulk output from
 451 the node group list.
 452
 453 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
 454
 455 ``DELETE``
 456 ~~~~~~~~~~
 457
 458 Deletes a node group.
 459
 460 It supports the ``dry-run`` argument.
 461
 462
 463 ``/2/groups/[group_name]/modify``
 464 +++++++++++++++++++++++++++++++++
 465
 466 Modifies the parameters of a node group.
 467
 468 Supports the following commands: ``PUT``.
 469
 470 ``PUT``
 471 ~~~~~~~
 472
 473 Returns a job ID.
 474
 475 Body parameters:
 476
 477 .. opcode_params:: OP_GROUP_SET_PARAMS
 478    :exclude: group_name
 479
 480 Job result:
 481
 482 .. opcode_result:: OP_GROUP_SET_PARAMS
 483
 484
 485 ``/2/groups/[group_name]/rename``
 486 +++++++++++++++++++++++++++++++++
 487
 488 Renames a node group.
 489
 490 Supports the following commands: ``PUT``.
 491
 492 ``PUT``
 493 ~~~~~~~
 494
 495 Returns a job ID.
 496
 497 Body parameters:
 498
 499 .. opcode_params:: OP_GROUP_RENAME
 500    :exclude: group_name
 501
 502 Job result:
 503
 504 .. opcode_result:: OP_GROUP_RENAME
 505
 506
 507 ``/2/groups/[group_name]/assign-nodes``
 508 +++++++++++++++++++++++++++++++++++++++
 509
 510 Assigns nodes to a group.
 511
 512 Supports the following commands: ``PUT``.
 513
 514 ``PUT``
 515 ~~~~~~~
 516
 517 Returns a job ID. It supports the ``dry-run`` and ``force`` arguments.
 518
 519 Body parameters:
 520
 521 .. opcode_params:: OP_GROUP_ASSIGN_NODES
 522    :exclude: group_name, force, dry_run
 523
 524
 525 ``/2/groups/[group_name]/tags``
 526 +++++++++++++++++++++++++++++++
 527
 528 Manages per-nodegroup tags.
 529
 530 Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
 531
 532 ``GET``
 533 ~~~~~~~
 534
 535 Returns a list of tags.
 536
 537 Example::
 538
 539     ["tag1", "tag2", "tag3"]
 540
 541 ``PUT``
 542 ~~~~~~~
 543
 544 Add a set of tags.
 545
 546 The request as a list of strings should be ``PUT`` to this URI. The
 547 result will be a job id.
 548
 549 It supports the ``dry-run`` argument.
 550
 551
 552 ``DELETE``
 553 ~~~~~~~~~~
 554
 555 Delete a tag.
 556
 557 In order to delete a set of tags, the DELETE request should be addressed
 558 to URI like::
 559
 560     /tags?tag=[tag]&tag=[tag]
 561
 562 It supports the ``dry-run`` argument.
 563
 564
 565 ``/2/instances``
 566 ++++++++++++++++
 567
 568 The instances resource.
 569
 570 It supports the following commands: ``GET``, ``POST``.
 571
 572 ``GET``
 573 ~~~~~~~
 574
 575 Returns a list of all available instances.
 576
 577 Example::
 578
 579     [
 580       {
 581         "name": "web.example.com",
 582         "uri": "\/instances\/web.example.com"
 583       },
 584       {
 585         "name": "mail.example.com",
 586         "uri": "\/instances\/mail.example.com"
 587       }
 588     ]
 589
 590 If the optional bool *bulk* argument is provided and set to a true value
 591 (i.e ``?bulk=1``), the output contains detailed information about
 592 instances as a list.
 593
 594 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
 595
 596 Example::
 597
 598     [
 599       {
 600          "status": "running",
 601          "disk_usage": 20480,
 602          "nic.bridges": [
 603            "xen-br0"
 604           ],
 605          "name": "web.example.com",
 606          "tags": ["tag1", "tag2"],
 607          "beparams": {
 608            "vcpus": 2,
 609            "memory": 512
 610          },
 611          "disk.sizes": [
 612              20480
 613          ],
 614          "pnode": "node1.example.com",
 615          "nic.macs": ["01:23:45:67:89:01"],
 616          "snodes": ["node2.example.com"],
 617          "disk_template": "drbd",
 618          "admin_state": true,
 619          "os": "debian-etch",
 620          "oper_state": true
 621       },
 622       ...
 623     ]
 624
 625
 626 ``POST``
 627 ~~~~~~~~
 628
 629 Creates an instance.
 630
 631 If the optional bool *dry-run* argument is provided, the job will not be
 632 actually executed, only the pre-execution checks will be done. Query-ing
 633 the job result will return, in both dry-run and normal case, the list of
 634 nodes selected for the instance.
 635
 636 Returns: a job ID that can be used later for polling.
 637
 638 Body parameters:
 639
 640 ``__version__`` (int, required)
 641   Must be ``1`` (older Ganeti versions used a different format for
 642   instance creation requests, version ``0``, but that format is no
 643   longer supported)
 644
 645 .. opcode_params:: OP_INSTANCE_CREATE
 646
 647 Earlier versions used parameters named ``name`` and ``os``. These have
 648 been replaced by ``instance_name`` and ``os_type`` to match the
 649 underlying opcode. The old names can still be used.
 650
 651 Job result:
 652
 653 .. opcode_result:: OP_INSTANCE_CREATE
 654
 655
 656 ``/2/instances/[instance_name]``
 657 ++++++++++++++++++++++++++++++++
 658
 659 Instance-specific resource.
 660
 661 It supports the following commands: ``GET``, ``DELETE``.
 662
 663 ``GET``
 664 ~~~~~~~
 665
 666 Returns information about an instance, similar to the bulk output from
 667 the instance list.
 668
 669 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
 670
 671 ``DELETE``
 672 ~~~~~~~~~~
 673
 674 Deletes an instance.
 675
 676 It supports the ``dry-run`` argument.
 677
 678
 679 ``/2/instances/[instance_name]/info``
 680 +++++++++++++++++++++++++++++++++++++++
 681
 682 It supports the following commands: ``GET``.
 683
 684 ``GET``
 685 ~~~~~~~
 686
 687 Requests detailed information about the instance. An optional parameter,
 688 ``static`` (bool), can be set to return only static information from the
 689 configuration without querying the instance's nodes. The result will be
 690 a job id.
 691
 692
 693 ``/2/instances/[instance_name]/reboot``
 694 +++++++++++++++++++++++++++++++++++++++
 695
 696 Reboots URI for an instance.
 697
 698 It supports the following commands: ``POST``.
 699
 700 ``POST``
 701 ~~~~~~~~
 702
 703 Reboots the instance.
 704
 705 The URI takes optional ``type=soft|hard|full`` and
 706 ``ignore_secondaries=0|1`` parameters.
 707
 708 ``type`` defines the reboot type. ``soft`` is just a normal reboot,
 709 without terminating the hypervisor. ``hard`` means full shutdown
 710 (including terminating the hypervisor process) and startup again.
 711 ``full`` is like ``hard`` but also recreates the configuration from
 712 ground up as if you would have done a ``gnt-instance shutdown`` and
 713 ``gnt-instance start`` on it.
 714
 715 ``ignore_secondaries`` is a bool argument indicating if we start the
 716 instance even if secondary disks are failing.
 717
 718 It supports the ``dry-run`` argument.
 719
 720
 721 ``/2/instances/[instance_name]/shutdown``
 722 +++++++++++++++++++++++++++++++++++++++++
 723
 724 Instance shutdown URI.
 725
 726 It supports the following commands: ``PUT``.
 727
 728 ``PUT``
 729 ~~~~~~~
 730
 731 Shutdowns an instance.
 732
 733 It supports the ``dry-run`` argument.
 734
 735 .. opcode_params:: OP_INSTANCE_SHUTDOWN
 736    :exclude: instance_name, dry_run
 737
 738
 739 ``/2/instances/[instance_name]/startup``
 740 ++++++++++++++++++++++++++++++++++++++++
 741
 742 Instance startup URI.
 743
 744 It supports the following commands: ``PUT``.
 745
 746 ``PUT``
 747 ~~~~~~~
 748
 749 Startup an instance.
 750
 751 The URI takes an optional ``force=1|0`` parameter to start the
 752 instance even if secondary disks are failing.
 753
 754 It supports the ``dry-run`` argument.
 755
 756 ``/2/instances/[instance_name]/reinstall``
 757 ++++++++++++++++++++++++++++++++++++++++++++++
 758
 759 Installs the operating system again.
 760
 761 It supports the following commands: ``POST``.
 762
 763 ``POST``
 764 ~~~~~~~~
 765
 766 Returns a job ID.
 767
 768 Body parameters:
 769
 770 ``os`` (string, required)
 771   Instance operating system.
 772 ``start`` (bool, defaults to true)
 773   Whether to start instance after reinstallation.
 774 ``osparams`` (dict)
 775   Dictionary with (temporary) OS parameters.
 776
 777 For backwards compatbility, this resource also takes the query
 778 parameters ``os`` (OS template name) and ``nostartup`` (bool). New
 779 clients should use the body parameters.
 780
 781
 782 ``/2/instances/[instance_name]/replace-disks``
 783 ++++++++++++++++++++++++++++++++++++++++++++++
 784
 785 Replaces disks on an instance.
 786
 787 It supports the following commands: ``POST``.
 788
 789 ``POST``
 790 ~~~~~~~~
 791
 792 Returns a job ID.
 793
 794 Body parameters:
 795
 796 .. opcode_params:: OP_INSTANCE_REPLACE_DISKS
 797    :exclude: instance_name
 798
 799 Ganeti 2.4 and below used query parameters. Those are deprecated and
 800 should no longer be used.
 801
 802
 803 ``/2/instances/[instance_name]/activate-disks``
 804 +++++++++++++++++++++++++++++++++++++++++++++++
 805
 806 Activate disks on an instance.
 807
 808 It supports the following commands: ``PUT``.
 809
 810 ``PUT``
 811 ~~~~~~~
 812
 813 Takes the bool parameter ``ignore_size``. When set ignore the recorded
 814 size (useful for forcing activation when recorded size is wrong).
 815
 816
 817 ``/2/instances/[instance_name]/deactivate-disks``
 818 +++++++++++++++++++++++++++++++++++++++++++++++++
 819
 820 Deactivate disks on an instance.
 821
 822 It supports the following commands: ``PUT``.
 823
 824 ``PUT``
 825 ~~~~~~~
 826
 827 Takes no parameters.
 828
 829
 830 ``/2/instances/[instance_name]/disk/[disk_index]/grow``
 831 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 832
 833 Grows one disk of an instance.
 834
 835 Supports the following commands: ``POST``.
 836
 837 ``POST``
 838 ~~~~~~~~
 839
 840 Returns a job ID.
 841
 842 Body parameters:
 843
 844 .. opcode_params:: OP_INSTANCE_GROW_DISK
 845    :exclude: instance_name, disk
 846
 847
 848 ``/2/instances/[instance_name]/prepare-export``
 849 +++++++++++++++++++++++++++++++++++++++++++++++++
 850
 851 Prepares an export of an instance.
 852
 853 It supports the following commands: ``PUT``.
 854
 855 ``PUT``
 856 ~~~~~~~
 857
 858 Takes one parameter, ``mode``, for the export mode. Returns a job ID.
 859
 860
 861 ``/2/instances/[instance_name]/export``
 862 +++++++++++++++++++++++++++++++++++++++++++++++++
 863
 864 Exports an instance.
 865
 866 It supports the following commands: ``PUT``.
 867
 868 ``PUT``
 869 ~~~~~~~
 870
 871 Returns a job ID.
 872
 873 Body parameters:
 874
 875 .. opcode_params:: OP_BACKUP_EXPORT
 876    :exclude: instance_name
 877    :alias: target_node=destination
 878
 879
 880 ``/2/instances/[instance_name]/migrate``
 881 ++++++++++++++++++++++++++++++++++++++++
 882
 883 Migrates an instance.
 884
 885 Supports the following commands: ``PUT``.
 886
 887 ``PUT``
 888 ~~~~~~~
 889
 890 Returns a job ID.
 891
 892 Body parameters:
 893
 894 .. opcode_params:: OP_INSTANCE_MIGRATE
 895    :exclude: instance_name, live
 896
 897
 898 ``/2/instances/[instance_name]/failover``
 899 +++++++++++++++++++++++++++++++++++++++++
 900
 901 Does a failover of an instance.
 902
 903 Supports the following commands: ``PUT``.
 904
 905 ``PUT``
 906 ~~~~~~~
 907
 908 Returns a job ID.
 909
 910 Body parameters:
 911
 912 .. opcode_params:: OP_INSTANCE_FAILOVER
 913    :exclude: instance_name
 914
 915
 916 ``/2/instances/[instance_name]/rename``
 917 ++++++++++++++++++++++++++++++++++++++++
 918
 919 Renames an instance.
 920
 921 Supports the following commands: ``PUT``.
 922
 923 ``PUT``
 924 ~~~~~~~
 925
 926 Returns a job ID.
 927
 928 Body parameters:
 929
 930 .. opcode_params:: OP_INSTANCE_RENAME
 931    :exclude: instance_name
 932
 933 Job result:
 934
 935 .. opcode_result:: OP_INSTANCE_RENAME
 936
 937
 938 ``/2/instances/[instance_name]/modify``
 939 ++++++++++++++++++++++++++++++++++++++++
 940
 941 Modifies an instance.
 942
 943 Supports the following commands: ``PUT``.
 944
 945 ``PUT``
 946 ~~~~~~~
 947
 948 Returns a job ID.
 949
 950 Body parameters:
 951
 952 .. opcode_params:: OP_INSTANCE_SET_PARAMS
 953    :exclude: instance_name
 954
 955 Job result:
 956
 957 .. opcode_result:: OP_INSTANCE_SET_PARAMS
 958
 959
 960 ``/2/instances/[instance_name]/console``
 961 ++++++++++++++++++++++++++++++++++++++++
 962
 963 Request information for connecting to instance's console.
 964
 965 Supports the following commands: ``GET``.
 966
 967 ``GET``
 968 ~~~~~~~
 969
 970 Returns a dictionary containing information about the instance's
 971 console. Contained keys:
 972
 973 .. pyassert::
 974
 975    constants.CONS_ALL == frozenset([
 976      constants.CONS_MESSAGE,
 977      constants.CONS_SSH,
 978      constants.CONS_VNC,
 979      constants.CONS_SPICE,
 980      ])
 981
 982 ``instance``
 983   Instance name.
 984 ``kind``
 985   Console type, one of :pyeval:`constants.CONS_SSH`,
 986   :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
 987   or :pyeval:`constants.CONS_MESSAGE`.
 988 ``message``
 989   Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
 990 ``host``
 991   Host to connect to (:pyeval:`constants.CONS_SSH`,
 992   :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
 993 ``port``
 994   TCP port to connect to (:pyeval:`constants.CONS_VNC` or
 995   :pyeval:`constants.CONS_SPICE` only).
 996 ``user``
 997   Username to use (:pyeval:`constants.CONS_SSH` only).
 998 ``command``
 999   Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1000 ``display``
1001   VNC display number (:pyeval:`constants.CONS_VNC` only).
1002
1003
1004 ``/2/instances/[instance_name]/tags``
1005 +++++++++++++++++++++++++++++++++++++
1006
1007 Manages per-instance tags.
1008
1009 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1010
1011 ``GET``
1012 ~~~~~~~
1013
1014 Returns a list of tags.
1015
1016 Example::
1017
1018     ["tag1", "tag2", "tag3"]
1019
1020 ``PUT``
1021 ~~~~~~~
1022
1023 Add a set of tags.
1024
1025 The request as a list of strings should be ``PUT`` to this URI. The
1026 result will be a job id.
1027
1028 It supports the ``dry-run`` argument.
1029
1030
1031 ``DELETE``
1032 ~~~~~~~~~~
1033
1034 Delete a tag.
1035
1036 In order to delete a set of tags, the DELETE request should be addressed
1037 to URI like::
1038
1039     /tags?tag=[tag]&tag=[tag]
1040
1041 It supports the ``dry-run`` argument.
1042
1043
1044 ``/2/jobs``
1045 +++++++++++
1046
1047 The ``/2/jobs`` resource.
1048
1049 It supports the following commands: ``GET``.
1050
1051 ``GET``
1052 ~~~~~~~
1053
1054 Returns a dictionary of jobs.
1055
1056 Returns: a dictionary with jobs id and uri.
1057
1058 If the optional bool *bulk* argument is provided and set to a true value
1059 (i.e. ``?bulk=1``), the output contains detailed information about jobs
1060 as a list.
1061
1062 Returned fields for bulk requests (unlike other bulk requests, these
1063 fields are not the same as for per-job requests):
1064 :pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`
1065
1066 ``/2/jobs/[job_id]``
1067 ++++++++++++++++++++
1068
1069
1070 Individual job URI.
1071
1072 It supports the following commands: ``GET``, ``DELETE``.
1073
1074 ``GET``
1075 ~~~~~~~
1076
1077 Returns a dictionary with job parameters, containing the fields
1078 :pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS))`.
1079
1080 The result includes:
1081
1082 - id: job ID as a number
1083 - status: current job status as a string
1084 - ops: involved OpCodes as a list of dictionaries for each opcodes in
1085   the job
1086 - opstatus: OpCodes status as a list
1087 - opresult: OpCodes results as a list
1088
1089 For a successful opcode, the ``opresult`` field corresponding to it will
1090 contain the raw result from its :term:`LogicalUnit`. In case an opcode
1091 has failed, its element in the opresult list will be a list of two
1092 elements:
1093
1094 - first element the error type (the Ganeti internal error name)
1095 - second element a list of either one or two elements:
1096
1097   - the first element is the textual error description
1098   - the second element, if any, will hold an error classification
1099
1100 The error classification is most useful for the ``OpPrereqError``
1101 error type - these errors happen before the OpCode has started
1102 executing, so it's possible to retry the OpCode without side
1103 effects. But whether it make sense to retry depends on the error
1104 classification:
1105
1106 .. pyassert::
1107
1108    errors.ECODE_ALL == set([errors.ECODE_RESOLVER, errors.ECODE_NORES,
1109      errors.ECODE_INVAL, errors.ECODE_STATE, errors.ECODE_NOENT,
1110      errors.ECODE_EXISTS, errors.ECODE_NOTUNIQUE, errors.ECODE_FAULT,
1111      errors.ECODE_ENVIRON])
1112
1113 :pyeval:`errors.ECODE_RESOLVER`
1114   Resolver errors. This usually means that a name doesn't exist in DNS,
1115   so if it's a case of slow DNS propagation the operation can be retried
1116   later.
1117
1118 :pyeval:`errors.ECODE_NORES`
1119   Not enough resources (iallocator failure, disk space, memory,
1120   etc.). If the resources on the cluster increase, the operation might
1121   succeed.
1122
1123 :pyeval:`errors.ECODE_INVAL`
1124   Wrong arguments (at syntax level). The operation will not ever be
1125   accepted unless the arguments change.
1126
1127 :pyeval:`errors.ECODE_STATE`
1128   Wrong entity state. For example, live migration has been requested for
1129   a down instance, or instance creation on an offline node. The
1130   operation can be retried once the resource has changed state.
1131
1132 :pyeval:`errors.ECODE_NOENT`
1133   Entity not found. For example, information has been requested for an
1134   unknown instance.
1135
1136 :pyeval:`errors.ECODE_EXISTS`
1137   Entity already exists. For example, instance creation has been
1138   requested for an already-existing instance.
1139
1140 :pyeval:`errors.ECODE_NOTUNIQUE`
1141   Resource not unique (e.g. MAC or IP duplication).
1142
1143 :pyeval:`errors.ECODE_FAULT`
1144   Internal cluster error. For example, a node is unreachable but not set
1145   offline, or the ganeti node daemons are not working, etc. A
1146   ``gnt-cluster verify`` should be run.
1147
1148 :pyeval:`errors.ECODE_ENVIRON`
1149   Environment error (e.g. node disk error). A ``gnt-cluster verify``
1150   should be run.
1151
1152 Note that in the above list, by entity we refer to a node or instance,
1153 while by a resource we refer to an instance's disk, or NIC, etc.
1154
1155
1156 ``DELETE``
1157 ~~~~~~~~~~
1158
1159 Cancel a not-yet-started job.
1160
1161
1162 ``/2/jobs/[job_id]/wait``
1163 +++++++++++++++++++++++++
1164
1165 ``GET``
1166 ~~~~~~~
1167
1168 Waits for changes on a job. Takes the following body parameters in a
1169 dict:
1170
1171 ``fields``
1172   The job fields on which to watch for changes.
1173
1174 ``previous_job_info``
1175   Previously received field values or None if not yet available.
1176
1177 ``previous_log_serial``
1178   Highest log serial number received so far or None if not yet
1179   available.
1180
1181 Returns None if no changes have been detected and a dict with two keys,
1182 ``job_info`` and ``log_entries`` otherwise.
1183
1184
1185 ``/2/nodes``
1186 ++++++++++++
1187
1188 Nodes resource.
1189
1190 It supports the following commands: ``GET``.
1191
1192 ``GET``
1193 ~~~~~~~
1194
1195 Returns a list of all nodes.
1196
1197 Example::
1198
1199     [
1200       {
1201         "id": "node1.example.com",
1202         "uri": "\/nodes\/node1.example.com"
1203       },
1204       {
1205         "id": "node2.example.com",
1206         "uri": "\/nodes\/node2.example.com"
1207       }
1208     ]
1209
1210 If the optional bool *bulk* argument is provided and set to a true value
1211 (i.e ``?bulk=1``), the output contains detailed information about nodes
1212 as a list.
1213
1214 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1215
1216 Example::
1217
1218     [
1219       {
1220         "pinst_cnt": 1,
1221         "mfree": 31280,
1222         "mtotal": 32763,
1223         "name": "www.example.com",
1224         "tags": [],
1225         "mnode": 512,
1226         "dtotal": 5246208,
1227         "sinst_cnt": 2,
1228         "dfree": 5171712,
1229         "offline": false
1230       },
1231       ...
1232     ]
1233
1234 ``/2/nodes/[node_name]``
1235 +++++++++++++++++++++++++++++++++
1236
1237 Returns information about a node.
1238
1239 It supports the following commands: ``GET``.
1240
1241 Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1242
1243 ``/2/nodes/[node_name]/evacuate``
1244 +++++++++++++++++++++++++++++++++
1245
1246 Evacuates instances off a node.
1247
1248 It supports the following commands: ``POST``.
1249
1250 ``POST``
1251 ~~~~~~~~
1252
1253 Returns a job ID. The result of the job will contain the IDs of the
1254 individual jobs submitted to evacuate the node.
1255
1256 Body parameters:
1257
1258 .. opcode_params:: OP_NODE_EVACUATE
1259    :exclude: nodes
1260
1261 Up to and including Ganeti 2.4 query arguments were used. Those are no
1262 longer supported. The new request can be detected by the presence of the
1263 :pyeval:`rlib2._NODE_EVAC_RES1` feature string.
1264
1265 Job result:
1266
1267 .. opcode_result:: OP_NODE_EVACUATE
1268
1269
1270 ``/2/nodes/[node_name]/migrate``
1271 +++++++++++++++++++++++++++++++++
1272
1273 Migrates all primary instances from a node.
1274
1275 It supports the following commands: ``POST``.
1276
1277 ``POST``
1278 ~~~~~~~~
1279
1280 If no mode is explicitly specified, each instances' hypervisor default
1281 migration mode will be used. Body parameters:
1282
1283 .. opcode_params:: OP_NODE_MIGRATE
1284    :exclude: node_name
1285
1286 The query arguments used up to and including Ganeti 2.4 are deprecated
1287 and should no longer be used. The new request format can be detected by
1288 the presence of the :pyeval:`rlib2._NODE_MIGRATE_REQV1` feature string.
1289
1290 Job result:
1291
1292 .. opcode_result:: OP_NODE_MIGRATE
1293
1294
1295 ``/2/nodes/[node_name]/role``
1296 +++++++++++++++++++++++++++++
1297
1298 Manages node role.
1299
1300 It supports the following commands: ``GET``, ``PUT``.
1301
1302 The role is always one of the following:
1303
1304   - drained
1305   - master-candidate
1306   - offline
1307   - regular
1308
1309 Note that the 'master' role is a special, and currently it can't be
1310 modified via RAPI, only via the command line (``gnt-cluster
1311 master-failover``).
1312
1313 ``GET``
1314 ~~~~~~~
1315
1316 Returns the current node role.
1317
1318 Example::
1319
1320     "master-candidate"
1321
1322 ``PUT``
1323 ~~~~~~~
1324
1325 Change the node role.
1326
1327 The request is a string which should be PUT to this URI. The result will
1328 be a job id.
1329
1330 It supports the bool ``force`` argument.
1331
1332
1333 ``/2/nodes/[node_name]/modify``
1334 +++++++++++++++++++++++++++++++
1335
1336 Modifies the parameters of a node. Supports the following commands:
1337 ``POST``.
1338
1339 ``POST``
1340 ~~~~~~~~
1341
1342 Returns a job ID.
1343
1344 Body parameters:
1345
1346 .. opcode_params:: OP_NODE_SET_PARAMS
1347    :exclude: node_name
1348
1349 Job result:
1350
1351 .. opcode_result:: OP_NODE_SET_PARAMS
1352
1353
1354 ``/2/nodes/[node_name]/storage``
1355 ++++++++++++++++++++++++++++++++
1356
1357 Manages storage units on the node.
1358
1359 ``GET``
1360 ~~~~~~~
1361
1362 .. pyassert::
1363
1364    constants.VALID_STORAGE_TYPES == set([constants.ST_FILE,
1365                                          constants.ST_LVM_PV,
1366                                          constants.ST_LVM_VG])
1367
1368 Requests a list of storage units on a node. Requires the parameters
1369 ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1370 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`) and
1371 ``output_fields``. The result will be a job id, using which the result
1372 can be retrieved.
1373
1374 ``/2/nodes/[node_name]/storage/modify``
1375 +++++++++++++++++++++++++++++++++++++++
1376
1377 Modifies storage units on the node.
1378
1379 ``PUT``
1380 ~~~~~~~
1381
1382 Modifies parameters of storage units on the node. Requires the
1383 parameters ``storage_type`` (one of :pyeval:`constants.ST_FILE`,
1384 :pyeval:`constants.ST_LVM_PV` or :pyeval:`constants.ST_LVM_VG`)
1385 and ``name`` (name of the storage unit).  Parameters can be passed
1386 additionally. Currently only :pyeval:`constants.SF_ALLOCATABLE` (bool)
1387 is supported. The result will be a job id.
1388
1389 ``/2/nodes/[node_name]/storage/repair``
1390 +++++++++++++++++++++++++++++++++++++++
1391
1392 Repairs a storage unit on the node.
1393
1394 ``PUT``
1395 ~~~~~~~
1396
1397 .. pyassert::
1398
1399    constants.VALID_STORAGE_OPERATIONS == {
1400     constants.ST_LVM_VG: set([constants.SO_FIX_CONSISTENCY]),
1401     }
1402
1403 Repairs a storage unit on the node. Requires the parameters
1404 ``storage_type`` (currently only :pyeval:`constants.ST_LVM_VG` can be
1405 repaired) and ``name`` (name of the storage unit). The result will be a
1406 job id.
1407
1408 ``/2/nodes/[node_name]/tags``
1409 +++++++++++++++++++++++++++++
1410
1411 Manages per-node tags.
1412
1413 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1414
1415 ``GET``
1416 ~~~~~~~
1417
1418 Returns a list of tags.
1419
1420 Example::
1421
1422     ["tag1", "tag2", "tag3"]
1423
1424 ``PUT``
1425 ~~~~~~~
1426
1427 Add a set of tags.
1428
1429 The request as a list of strings should be PUT to this URI. The result
1430 will be a job id.
1431
1432 It supports the ``dry-run`` argument.
1433
1434 ``DELETE``
1435 ~~~~~~~~~~
1436
1437 Deletes tags.
1438
1439 In order to delete a set of tags, the DELETE request should be addressed
1440 to URI like::
1441
1442     /tags?tag=[tag]&tag=[tag]
1443
1444 It supports the ``dry-run`` argument.
1445
1446
1447 ``/2/query/[resource]``
1448 +++++++++++++++++++++++
1449
1450 Requests resource information. Available fields can be found in man
1451 pages and using ``/2/query/[resource]/fields``. The resource is one of
1452 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2
1453 design document <design-query2>` for more details.
1454
1455 Supports the following commands: ``GET``, ``PUT``.
1456
1457 ``GET``
1458 ~~~~~~~
1459
1460 Returns list of included fields and actual data. Takes a query parameter
1461 named "fields", containing a comma-separated list of field names. Does
1462 not support filtering.
1463
1464 ``PUT``
1465 ~~~~~~~
1466
1467 Returns list of included fields and actual data. The list of requested
1468 fields can either be given as the query parameter "fields" or as a body
1469 parameter with the same name. The optional body parameter "filter" can
1470 be given and must be either ``null`` or a list containing filter
1471 operators.
1472
1473
1474 ``/2/query/[resource]/fields``
1475 ++++++++++++++++++++++++++++++
1476
1477 Request list of available fields for a resource. The resource is one of
1478 :pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the
1479 :doc:`query2 design document <design-query2>` for more details.
1480
1481 Supports the following commands: ``GET``.
1482
1483 ``GET``
1484 ~~~~~~~
1485
1486 Returns a list of field descriptions for available fields. Takes an
1487 optional query parameter named "fields", containing a comma-separated
1488 list of field names.
1489
1490
1491 ``/2/os``
1492 +++++++++
1493
1494 OS resource.
1495
1496 It supports the following commands: ``GET``.
1497
1498 ``GET``
1499 ~~~~~~~
1500
1501 Return a list of all OSes.
1502
1503 Can return error 500 in case of a problem. Since this is a costly
1504 operation for Ganeti 2.0, it is not recommended to execute it too often.
1505
1506 Example::
1507
1508     ["debian-etch"]
1509
1510 ``/2/tags``
1511 +++++++++++
1512
1513 Manages cluster tags.
1514
1515 It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
1516
1517 ``GET``
1518 ~~~~~~~
1519
1520 Returns the cluster tags.
1521
1522 Example::
1523
1524     ["tag1", "tag2", "tag3"]
1525
1526 ``PUT``
1527 ~~~~~~~
1528
1529 Adds a set of tags.
1530
1531 The request as a list of strings should be PUT to this URI. The result
1532 will be a job id.
1533
1534 It supports the ``dry-run`` argument.
1535
1536
1537 ``DELETE``
1538 ~~~~~~~~~~
1539
1540 Deletes tags.
1541
1542 In order to delete a set of tags, the DELETE request should be addressed
1543 to URI like::
1544
1545     /tags?tag=[tag]&tag=[tag]
1546
1547 It supports the ``dry-run`` argument.
1548
1549
1550 ``/version``
1551 ++++++++++++
1552
1553 The version resource.
1554
1555 This resource should be used to determine the remote API version and to
1556 adapt clients accordingly.
1557
1558 It supports the following commands: ``GET``.
1559
1560 ``GET``
1561 ~~~~~~~
1562
1563 Returns the remote API version. Ganeti 1.2 returned ``1`` and Ganeti 2.0
1564 returns ``2``.
1565
1566 .. vim: set textwidth=72 :
1567 .. Local Variables:
1568 .. mode: rst
1569 .. fill-column: 72
1570 .. End: