WIP rest API for the slapos master.

documentation/source/conf.py

+# -*- coding: utf-8 -*-
+#
+# slapos.core documentation build configuration file, created by
+# sphinx-quickstart on Mon Nov 14 17:03:02 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.ifconfig']
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'slapos.core'
+copyright = u'2011, Vifib'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.20-dev'
+# The full version, including alpha/beta/rc tags.
+release = '0.20-dev'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'slaposcoredoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'slaposcore.tex', u'slapos.core Documentation',
+   u'Vifib', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

documentation/source/index.rst

+.. slapos.core documentation master file, created by
+   sphinx-quickstart on Mon Nov 14 17:03:02 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to slapos.core's documentation!
+=======================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   rest.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

documentation/source/rest.rst

+SlapOS Master REST API (v1)
+***************************
+
+Find your SSL keys
+------------------
+
+You can find  X509 key/certificate to authentificate on the SlapOS Master.
+Visit https://www.vifib.net/.
+
+Exchange format
+---------------
+
+SlapOS master will support both XML and JSON formats for input and output.
+When you make an API request, you will have to specify which format you want to
+manage by setting it at the end of the route (.json or .xml)::
+
+  POST http://example.com/api/v1/request.json
+  POST http://example.com/api/v1/request.xml
+
+Response status code
+--------------------
+
+Success
++++++++
+
+``GET`` requests will return a ``"200 OK"`` response if the resource is successfully retrieved.
+
+``POST`` requests which create a resource we will return a ``"201 Created"`` response if successful.
+
+``POST`` requests which perform some other action such as sending a campaign
+will return a ``"200 OK"`` response if successful.
+
+``PUT`` requests will return a ``"200 OK"`` response if the resource is successfully updated.
+
+``DELETE`` requests will return a ``"200 OK"`` response if the resource is successfully deleted.
+
+Error
++++++
+
+If you attempt to authenticate with an ``invalid SSL key`` or you attempt to use an
+invalid ID for a resource, you'll received a ``"403 Forbidden"`` response.
+
+If there is an ``error in your input``, you'll receive a ``"400 Bad Request"`` response, with details of the error.
+
+If you attempt to request a ``resource which doesn't exist``, you'll receive a
+``"404 Not Found"`` response.
+
+If an ``unhandled error occurs`` on the API server for some reason, you'll
+receive a ``"500 Internal Server Error"`` response.
+
+Instance Methods
+****************
+
+Requesting a new instance
+-------------------------
+
+Request a new instanciation of a software.
+
+`Request`::
+
+  `POST` http://example.com/api/v1/request.{xml|json}
+
+`Expected Request Body`::
+
+  {
+    "title": "My unique instance",
+    "software_release": "http://example.com/example.cfg",
+    "software_type": "type_provided_by_the_software",
+    "slave": False,
+    "status": "started",
+    "parameter": {
+      "Custom1": "one string",
+      "Custom2": "one float",
+      "Custom3": ["abc", "def"],
+      },
+    "sla": {
+      "computer_id": "COMP-0",
+      }
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 201 Created
+  Content-Type: application/json; charset=utf-8
+
+  {
+    "instance_id": "azevrvtrbt",
+    "status": "started",
+    "connection": {
+      "custom_connection_parameter_1": "foo",
+      "custom_connection_parameter_2": "bar"
+    }
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance (sla changed, instance is under deletion, software release can not be changed, ...).
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "instance_id": "azevrvtrbt",
+      "status": "starting"
+    }
+
+Deleting an instance
+--------------------
+
+Request the deletion of an instance.
+
+`Request`::
+
+   `DELETE` http://example.com/api/v1/instance/{instance_id}.{xml|json}
+
+`Route values`:
+
+* ``instance_id``: the ID of the instance
+
+`No Expected Request Body`
+
+`Expected Response`::
+
+  HTTP/1.1 202 Accepted
+  Content-Type: application/json; charset=utf-8
+  {
+    "status": "under deletion",
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The instance can not be found.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance.
+
+Get instance information
+------------------------
+
+Request all instance informations.
+
+`Request`::
+
+   `GET` http://example.com/api/v1/instance/{instance_id}.{xml|json}
+
+`Route values`:
+
+* ``instance_id``: the ID of the instance
+
+`No Expected Request Body`
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "instance_id": "azevrvtrbt",
+    "status": "started",
+    "software_release": "http://example.com/example.cfg",
+    "software_type": "type_provided_by_the_software",
+    "slave": False,
+    "connection": {
+      "custom_connection_parameter_1": "foo",
+      "custom_connection_parameter_2": "bar"
+    },
+    "parameter": {
+      "Custom1": "one string",
+      "Custom2": "one float",
+      "Custom3": ["abc", "def"],
+      },
+    "sla": {
+      "computer_id": "COMP-0",
+      }
+    "children_id_list": ["subinstance1", "subinstance2"],
+    "partition": {
+      "public_ip": "::1",
+      "private_ip": "127.0.0.1",
+      "tap_interface": "tap2",
+    },
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The instance can not be found.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance
+
+Get instance authentification certificates
+------------------------------------------
+
+Request the instance certificates.
+
+`Request`::
+
+   `GET` http://example.com/api/v1/instance/{instance_id}/getcertificate.{xml|json}
+
+`Route values`:
+
+* ``instance_id``: the ID of the instance
+
+`No Expected Request Body`
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "ssl_key": "...",
+    "ssl_certificate": "...",
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The instance can not be found.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance
+
+Bang instance
+-------------
+
+Trigger the reinstanciation of all partitions in the instance tree
+
+`Request`::
+
+   `POST` http://example.com/api/v1/instance/{instance_id}/bang.{xml|json}
+
+`Route values`:
+
+* ``instance_id``: the ID of the instance
+
+`Expected Request Body`::
+
+  {
+    "log": "Explain why this method was called",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "status": "updating"
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The instance can not be found.
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "status": "waiting before processing"
+    }
+
+Update instance status
+----------------------
+
+Update the instance status
+
+`Request`::
+
+   `POST` http://example.com/api/v1/instance/{instance_id}.{xml|json}
+
+`Expected Request Body`::
+
+  {
+    "status": "{start,stop,updating,error}",
+    "log": "explanation of the status",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "status": "started",
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance (sla changed, instance is under deletion, software release can not be changed, ...).
+
+* ``404 Not Found`` The instance can not be found.
+
+Update instance connection
+--------------------------
+
+Update the instance connection informations
+
+`Request`::
+
+   `POST` http://example.com/api/v1/instance/{instance_id}/setconnection.{xml|json}
+
+`Expected Request Body`::
+
+  {
+    "connection": {
+      "custom_connection_parameter_1": "foo",
+      "custom_connection_parameter_2": "bar"
+    },
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance (sla changed, instance is under deletion, software release can not be changed, ...).
+
+* ``404 Not Found`` The instance can not be found.
+
+Computer Methods
+****************
+
+Registering a new computer
+--------------------------
+
+Add a new computer in the system.
+
+`Request`::
+
+   `POST` http://example.com/api/v1/computer.{xml|json}
+
+`Expected Request Body`::
+
+  {
+    "title": "My unique computer",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 201 Created
+  Content-Type: application/json; charset=utf-8
+  {
+    "computer_id": "COMP-0",
+    "ssl_key": "...",
+    "ssl_certificate": "...",
+    "status": "available"
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``409 Conflict`` The request can not be process because of the existence of a computer with the same title
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "status": "waiting before processing"
+    }
+
+Getting computer information
+----------------------------
+
+Get the status of a computer
+
+`Request`::
+
+   `GET` http://example.com/api/v1/computer/{computer_id}.{xml|json}
+
+`Route values`:
+
+* ``computer_id``: the ID of the instance
+
+`No Expected Request Body`
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "computer_id": "COMP-0",
+    "status": "available",
+    "software": [
+      {
+        software_release="http://example.com/example.cfg",
+        status="install requested",
+      },
+    ],
+    "partition": [
+      {
+        title="slapart1",
+        instance_id="foo",
+        status="start requested",
+        software_release="http://example.com/example.cfg",
+      },
+      {
+        title="slapart2",
+        instance_id="bar",
+        status="started",
+        software_release="http://example.com/example.cfg",
+      },
+    ],
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The computer can not be found.
+
+Modifying computer partition
+----------------------------
+
+Modify computer status in the system
+
+`Request`::
+
+   `POST` http://example.com/api/v1/computer/{computer_id}/setpartition.{xml|json}
+
+`Route values`:
+
+* ``computer_id``: the ID of the instance
+
+`Expected Request Body`::
+
+  {
+    "partition": [
+      {
+        "title": "part1",
+        "public_ip": "::1",
+        "private_ip": "127.0.0.1",
+        "tap_interface": "tap2",
+      },
+    ],
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The computer can not be found.
+
+* ``409 Conflict`` The request can not be process because of the existence of a computer with the same title
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "status": "waiting before processing"
+    }
+
+Supplying new software
+----------------------
+
+Request to suply a new software release on a computer
+
+`Request`::
+
+   `POST` http://example.com/api/v1/computer/{computer_id}/supply.{xml|json}
+
+`Route values`:
+
+* ``computer_id``: the ID of the instance
+
+`Expected Request Body`::
+
+  {
+    "status": "{requested,updating,available,error,unavailable}",
+    "log": "explanation of the status",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The computer can not be found.
+
+* ``409 Conflict`` The request can not be process because of the existence of a computer with the same title
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "status": "waiting before processing"
+    }
+
+Bang computer
+-------------
+
+Request update on all partitions
+
+`Request`::
+
+   `POST` http://example.com/api/v1/computer/{computer_id}/bang.{xml|json}
+
+`Route values`:
+
+* ``computer_id``: the ID of the instance
+
+`Expected Request Body`::
+
+  {
+    "log": "Explain why this method was called",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+  {
+    "status": "updating"
+  }
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The computer can not be found.
+
+* ``202 Accepted`` The request has been accepted for processing::
+
+    {
+      "status": "waiting before processing"
+    }
+
+Report usage
+------------
+
+Report computer usage
+
+`Request`::
+
+   `POST` http://example.com/api/v1/computer/{computer_id}/report.{xml|json}
+
+`Route values`:
+
+* ``computer_id``: the ID of the instance
+
+`Expected Request Body`::
+
+  {
+    "tiosafe": "...",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+
+`Error Responses`:
+
+* ``400 Bad Request`` The request body does not follow the API (one argument is missing or malformed).
+
+* ``402 Payment Required`` The request can not be fullfilled because account is locked.
+
+* ``404 Not Found`` The computer can not be found.