Statistics
| Branch: | Tag: | Revision:

root / doc / rapi.rst @ 18e2b6e4

History | View | Annotate | Download (27.4 kB)

# Date Author Comment
073c31a5 10/13/2010 03:18 pm Michael Hanselmann

ganeti-rapi: Watch directory, not file for user file changes

We noticed several issues when just watching the file, among them race
conditions upon replacing the file using rename(2) (the new watcher
would be created too soon). By just watching the directory for events on...

df5758b1 10/05/2010 12:11 pm Iustin Pop

Merge branch 'devel-2.2'

  • devel-2.2:
    gnt-job info: Sort input fields
    KVM: Add function to check the hypervisor version
    Bump version to 2.2.0, update NEWS
    Fix instance rename regression from 3fe11ba3
    Fix instance rename regression from 3fe11ba3...
44c15b81 09/30/2010 07:20 pm Michael Hanselmann

Update RAPI documentation for /2/nodes/[node_name]/migrate

This was forgotten in commit 52194140.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

e4ef4343 09/13/2010 06:16 pm Michael Hanselmann

RAPI server: Move user file watching out, update documentation

This patch moves the code watching the users file into a
a separate class to not mix it with HTTP serving. The users
file is now driven from outside the HTTP server class.

Also the documentation is updated to mention the automatic...

a4978169 08/20/2010 05:16 pm Michael Hanselmann

Use Sphinx' :rfc: extension to refer to RFCs

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

981e0168 08/20/2010 05:16 pm Michael Hanselmann

Document non-standard usage of JSON in RAPI

This was requested in issue 118.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

3882937a 08/18/2010 02:21 pm Michael Hanselmann

RAPI: Allow modifying instance

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

dd0fa69d 08/18/2010 02:21 pm Michael Hanselmann

Small fixes for instance creation via RAPI documentation

- Inconsistencies
- Missing types

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

d56e7dc7 08/10/2010 06:55 pm Michael Hanselmann

Allow renaming instances via RAPI

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

5823e0d2 07/29/2010 04:05 pm Michael Hanselmann

RAPI: Support migrating instances

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

b430a54d 07/29/2010 04:02 pm Iustin Pop

Update RAPI documentation for the OS changes

Signed-off-by: Iustin Pop <>
Reviewed-by: Michael Hanselmann <>

926feaf1 07/12/2010 06:59 pm Manuel Franceschini

Use reserved documentation IPs and domains

Use RFC 5737 IP addresses and RFC 2606 domain names in all
unittests, docs, qa and docstrings.

Signed-off-by: Manuel Franceschini <>
Reviewed-by: Iustin Pop <>

941b9309 06/23/2010 07:23 pm Iustin Pop

RAPI: switch evacuate node to the new model

This patch removes the last use of the old-style OpEvacuateNode. It also
fixes the dry-run mode for this RAPI resource - the dry-run parameter
was not used at all before.

Signed-off-by: Iustin Pop <>...

ebeb600f 05/18/2010 06:53 pm Michael Hanselmann

RAPI changes for instance moves

Two new resources are added:
- /2/instances/$name/prepare-export
- /2/instances/$name/export

The documentation for the existing resource for creating instances is updated
for remote imports. The RAPI client is extended for the new resources....

d32f3b81 05/17/2010 01:52 pm Michael Hanselmann

Add missing documentation for RAPI instance creation mode

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

6395cebb 05/13/2010 04:58 pm Michael Hanselmann

RAPI: Add new request data format for instance creation

As mentioned in commit d975f482d, the current way of creating an
instance via RAPI is not very flexible. With this patch, a new
instance creation request data format is introduced and documented.
Support can be detected by checking the list of features returned...

5ef5cfea 05/13/2010 04:58 pm Michael Hanselmann

Mention RAPI client in documentation

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>

7eac4a4d 05/13/2010 04:57 pm Michael Hanselmann

Add new /2/features RAPI resource

The /2/features RAPI resource can be used to detect optional
features implemented by the RAPI server. This will be used
to recognize servers implementing a new request format for
instance creation requests.

Signed-off-by: Michael Hanselmann <>...

793a8f7c 05/11/2010 05:31 pm Michael Hanselmann

RAPI: Allow waiting for job changes

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

88394aa7 04/15/2010 12:08 pm René Nussbaumer

Improving the RAPI documentation

  • Be more clear about when POST and PUT should be used
  • Be more verbose on parameters
  • Describe allowed parameter values (if not self explaining)

Signed-off-by: René Nussbaumer <>
Reviewed-by: Iustin Pop <>

2263aec2 03/23/2010 10:33 am René Nussbaumer

Adding missing documentation to make the docs better

Also fixed a typo I noticed.

Signed-off-by: René Nussbaumer <>
Reviewed-by: Iustin Pop <>

ab2e463a 03/10/2010 12:18 pm Michael Hanselmann

Update documentation for hashed passwords

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

20b1bd80 11/25/2009 12:33 pm Iustin Pop

A couple of doc updates

Clarify the fact that temporary HV/BE params in instance start override
and do not extend the configured parameters; and change the instance
list headers from HVM_* to * since many of the parameters apply to KVM
too. Also fix a typo in the rapi documention for '/2/nodes'....

e91cfc2a 11/11/2009 04:00 pm Iustin Pop

Update RAPI documentation on job results

This documents the new error classifier added for OpPrereqError.

Signed-off-by: Iustin Pop <>
Reviewed-by: Michael Hanselmann <>

c099b8d8 10/29/2009 11:33 am Michael Hanselmann

Add remote API users and passwords documentation

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

c71a1a3d 10/28/2009 05:00 am Iustin Pop

Documentation updates

Our admin guide was very very trivial. This patch updates it to contain
advice on when to use which commands, removes the instance
administration part from the installation guide (moved to the admin
guide), and adds a walkthrough document that should be useable as a...

7faf5110 09/24/2009 06:32 pm Michael Hanselmann

Wrap documentation to max 72 characters per line

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

558fd122 09/24/2009 06:31 pm Michael Hanselmann

Set Vim textwidth in each documentation file

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

508e9b20 09/03/2009 06:45 pm Michael Hanselmann

Add RAPI resource to redistribute config

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Luca Bigliardi <>

f72542cc 09/03/2009 06:45 pm Michael Hanselmann

rapi doc: Add …/nodes/[name] and …/instances/[name]/reinstall

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Luca Bigliardi <>

d8260842 08/18/2009 12:40 pm Michael Hanselmann

rapi: Add /2/instances/[instance_name]/info resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

723f4565 08/17/2009 03:00 pm Michael Hanselmann

rapi: Add /2/nodes/[node_name]/storage/repair resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

4c98b915 08/13/2009 02:49 pm Michael Hanselmann

rapi: Add /2/instances/[instance_name]/replace-disks resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

1e82bc80 08/11/2009 05:05 pm Michael Hanselmann

rapi: Add /2/nodes/[node_name]/storage/modify resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

7a95a954 08/11/2009 02:55 pm Michael Hanselmann

rapi: Add /2/nodes/[node_name]/storage resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Guido Trotter <>

1c482bab 07/31/2009 02:31 pm Michael Hanselmann

rapi: Add /2/nodes/[node_name]/migrate resource

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

73452f12 07/30/2009 02:02 pm Michael Hanselmann

rapi: Add /2/[node_name]/evacuate resource

This can be used to evacuate a node.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

64dae8fc 07/13/2009 05:59 pm Michael Hanselmann

rapi: Implement /2/nodes/[node_name]/role resource

This resource can be used to retrieve and set the role of a node.

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

3427d34f 07/13/2009 05:58 pm Michael Hanselmann

rapi: Add generic “force” parameter

Signed-off-by: Michael Hanselmann <>
Reviewed-by: Iustin Pop <>

2cad4b91 06/19/2009 04:40 pm Iustin Pop

Update RAPI docs for the dry-run mode

Signed-off-by: Iustin Pop <>
Reviewed-by: Guido Trotter <>

c8e0a534 05/21/2009 04:06 pm Iustin Pop

Doc fixes for RAPI

After moving the documentation from the .py files to .rst, we had some
cleanups to do.

This fixes the formatting of the comments, improves them a little, and
removes deprecated info (DOC_URI) from the python source.

Signed-off-by: Iustin Pop <>...

c1be3f59 05/20/2009 04:16 pm Guido Trotter

Merge branch 'master' into branch-2.1

6d81475c 05/12/2009 02:28 pm Iustin Pop

Convert from auto-generated RAPI docs to static

This patch removes the autogeneration of the RAPI docs from the code
(based on docstrings) and moves the current autogenerated output to
the rapi.rst file.

The reasons behind this are multiple:
- the build system becomes a little more simple (this could have been...

4fb301b5 05/10/2009 12:27 am Tim Boring

Minor patch to rapi documentation

Minor patch to clarify the URL necessary for accessing the RAPI.

Signed-off-by: Iustin Pop <>
Reviewed-by: Iustin Pop <>

4352bf6d 02/27/2009 03:06 pm Iustin Pop

Convert the RAPI document to restructured text

This patch changes the RAPI document, and the RAPI resources
autogenerated-documentation to restructured text. This meant changing
the autogen tool.

The new fragment can be included via RST directives, and doesn't need...