Merge branch 'master' into hostingwebsite

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', 'repoze.sphinx.autointerface']
+
+# 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
+   slap.rst
+   tioformat.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 authenticate to the SlapOS Master.
+Visit https://www.vifib.net/.
+
+Exchange format
+---------------
+
+SlapOS master will support both XML and JSON formats for input and output.
+
+The Content Type header is required and responsible for format selection.
+
+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.
+
+Common Error Responses
+++++++++++++++++++++++
+
+400 Bad Request
+~~~~~~~~~~~~~~~
+The request body does not follow the API (one argument is missing or malformed). The full information is available as text body::
+
+  HTTP/1.1 400 Bad Request
+  Content-Type: application/json; charset=utf-8
+
+  {
+    "computer_id": "Parameter is missing"
+  }
+
+402 Payment Required
+~~~~~~~~~~~~~~~~~~~~
+
+The request can not be fulfilled because account is locked.
+
+403 Forbidden
+~~~~~~~~~~~~~
+Wrong SSL key used or access to invalid ID.
+
+404 Not Found
+~~~~~~~~~~~~~
+Request to non existing resource made.
+
+500 Internal Server Error
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Unexpected error.
+
+Instance Methods
+****************
+
+Requesting a new instance
+-------------------------
+
+Request a new instantiation of a software.
+
+`Request`::
+
+  POST http://example.com/api/v1/request HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Expected Request Body`::
+
+  {
+    "title": "My unique instance",
+    "software_release": "http://example.com/example.cfg",
+    "software_type": "type_provided_by_the_software",
+    "slave": False, # one of: True or False
+    "status": "started", # one of: started, stopped
+    "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"
+    }
+  }
+
+`Additional Responses`::
+
+  HTTP/1.1 202 Accepted
+  Content-Type: application/json; charset=utf-8
+
+  {
+    "instance_id": "azevrvtrbt",
+    "status": "processing"
+  }
+
+The request has been accepted for processing
+
+`Error Responses`:
+
+* ``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, ...).
+
+
+Deleting an instance
+--------------------
+
+Request the deletion of an instance.
+
+`Request`::
+
+  DELETE http://example.com/api/v1/instance/{instance_id} HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`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
+
+`Error Responses`:
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance.
+
+Get instance information
+------------------------
+
+Request all instance information.
+
+`Request`::
+
+  GET http://example.com/api/v1/instance/{instance_id} HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`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": "start", # one of: start, stop, destroy
+    "software_release": "http://example.com/example.cfg",
+    "software_type": "type_provided_by_the_software",
+    "slave": False, # one of: True, 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", "91.121.63.94"],
+      "private_ip": ["127.0.0.1"],
+      "tap_interface": "tap2",
+    },
+  }
+
+`Error Responses`:
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance
+
+Get instance authentication certificates
+----------------------------------------
+
+Request the instance certificates.
+
+`Request`::
+
+  GET http://example.com/api/v1/instance/{instance_id}/certificate HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`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": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADAN...h2VSZRlSN\n-----END PRIVATE KEY-----",
+    "ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgICHQI...ulYdXJabLOeCOA=\n-----END CERTIFICATE-----",
+  }
+
+`Error Responses`:
+
+* ``409 Conflict`` The request can not be process because of the current status of the instance
+
+Bang instance
+-------------
+
+Trigger the re-instantiation of all partitions in the instance tree
+
+`Request`::
+
+  POST http://example.com/api/v1/instance/{instance_id}/bang HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`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
+
+Modifying instance
+------------------
+
+Modify the instance information and status.
+
+`Request`::
+
+  PUT http://example.com/api/v1/instance/{instance_id} HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Expected Request Body`::
+
+  {
+    "status": "started", # one of: started, stopped, updating, error
+    "log": "explanation of the status",
+    "connection": {
+      "custom_connection_parameter_1": "foo",
+      "custom_connection_parameter_2": "bar"
+    }
+  }
+
+Where `status` is required with `log`, `connection` is optional and its existence allow to not send `status` and `log`.
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+`Error Responses`:
+
+* ``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, ...).
+
+Computer Methods
+****************
+
+Registering a new computer
+--------------------------
+
+Add a new computer in the system.
+
+`Request`::
+
+  POST http://example.com/api/v1/computer HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`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": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADAN...h2VSZRlSN\n-----END PRIVATE KEY-----",
+    "ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgICHQI...ulYdXJabLOeCOA=\n-----END CERTIFICATE-----",
+  }
+
+`Error Responses`:
+
+* ``409 Conflict`` The request can not be process because of the existence of a computer with the same title
+
+Getting computer information
+----------------------------
+
+Get the status of a computer
+
+`Request`::
+
+  GET http://example.com/api/v1/computer/{computer_id} HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Route values`:
+
+* ``computer_id``: the ID of the computer
+
+`No Expected Request Body`
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+  {
+    "computer_id": "COMP-0",
+    "software": [
+      {
+        "software_release": "http://example.com/example.cfg",
+        "status": "install" # one of: install, uninstall
+      },
+    ],
+    "partition": [
+      {
+        "title": "slapart1",
+        "instance_id": "foo",
+        "status": "start", # one of: start, stop, destroy
+        "software_release": "http://example.com/example.cfg"
+      },
+      {
+        "title": "slapart2",
+        "instance_id": "bar",
+        "status": "stop", # one of: start, stop, destroy
+        "software_release": "http://example.com/example.cfg"
+      },
+    ],
+  }
+
+Modifying computer
+------------------
+
+Modify computer information in the system
+
+`Request`::
+
+  PUT http://example.com/api/v1/computer/{computer_id} HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Route values`:
+
+* ``computer_id``: the ID of the computer
+
+`Expected Request Body`::
+
+  {
+    "partition": [
+      {
+        "title": "part1",
+        "public_ip": "::1",
+        "private_ip": "127.0.0.1",
+        "tap_interface": "tap2",
+      },
+    ],
+    "software": [
+      {
+        "software_release": "http://example.com/example.cfg",
+        "status": "installed", # one of: installed, uninstalled, error
+        "log": "Installation log"
+      },
+    ],
+  }
+
+Where ``partition`` and ``software`` keys are optional, but at least one is required.
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+Supplying new software
+----------------------
+
+Request to supply a new software release on a computer
+
+`Request`::
+
+  POST http://example.com/api/v1/computer/{computer_id}/supply HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Route values`:
+
+* ``computer_id``: the ID of the computer
+
+`Expected Request Body`::
+
+  {
+    "software_release": "http://example.com/example.cfg"
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+Bang computer
+-------------
+
+Request update on all partitions
+
+`Request`::
+
+  POSThttp://example.com/api/v1/computer/{computer_id}/bang HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Route values`:
+
+* ``computer_id``: the ID of the computer
+
+`Expected Request Body`::
+
+  {
+    "log": "Explain why this method was called",
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8
+
+Report usage
+------------
+
+Report computer usage
+
+`Request`::
+
+  POST http://example.com/api/v1/computer/{computer_id}/report HTTP/1.1
+  Content-Type: application/json; charset=utf-8
+
+`Route values`:
+
+* ``computer_id``: the ID of the computer
+
+`Expected Request Body`::
+
+  {
+    "title": "Resource consumptions",
+    "start_date": "2011/11/15",
+    "stop_date": "2011/11/16",
+    "movement": [
+      {
+        "resource": "CPU Consumption",
+        "title": "line 1",
+        "reference": "slappart0",
+        "quantity": 42.42
+      }
+    ]
+  }
+
+`Expected Response`::
+
+  HTTP/1.1 200 OK
+  Content-Type: application/json; charset=utf-8

documentation/source/slap.rst

+slap interface documentation
+****************************
+
+.. autointerface:: slapos.slap.interface.slap.IException
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.INotFoundError
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IUnauthorized
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IRequester
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IBuildoutController
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.ISoftwareRelease
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IComputerPartition
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IComputer
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.IOpenOrder
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.ISupply
+   :members:
+   :undoc-members:
+
+.. autointerface:: slapos.slap.interface.slap.slap
+   :members:
+   :undoc-members:

documentation/source/tioformat.rst

+Tio Format
+**********
+
+What is TioFormat?
+------------------
+
+TIO is a data format used to provide informations about consumption, invoicing
+and state history.
+
+XSD
+---
+
+`TioFormat XSD`::
+
+  <?xml version="1.0" encoding="utf-8"?>
+  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+    <!-- Define the XML Schema of a transaction -->
+    <xs:element name="journal">
+      <xs:complexType>
+        <xs:sequence>
+          <xs:element name="transaction" maxOccurs="unbounded">
+            <xs:complexType>
+              <xs:sequence>
+                <xs:element name="title" type="xs:string" minOccurs="0"/>
+                <xs:element name="start_date" type="xs:string"/>
+                <xs:element name="stop_date" type="xs:string"/>
+                <xs:element name="reference" type="xs:string"/>
+                <xs:element name="currency" type="xs:string"/>
+                <xs:element name="payment_mode" type="xs:string"/>
+                <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+                <xs:element name="arrow" maxOccurs="unbounded">
+                  <xs:complexType>
+                    <xs:sequence>
+                    <xs:element name="source" type="xs:string" minOccurs="0"/>
+                    <xs:element name="destination" type="xs:string" minOccurs="0"/>
+                    </xs:sequence>
+                    <xs:attribute name="type" use="required"/>
+                  </xs:complexType>
+                </xs:element>
+                <xs:element name="movement" maxOccurs="unbounded">
+                  <xs:complexType>
+                    <xs:sequence>
+                    <xs:element name="resource" type="xs:string"/>
+                    <xs:element name="title" type="xs:string" minOccurs="0"/>
+                    <xs:element name="reference" type="xs:string" minOccurs="0"/>
+                    <xs:element name="quantity" type="xs:float"/>
+                    <xs:element name="price" type="xs:float"/>
+                    <xs:element name="VAT" type="xs:string"/>
+                    <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+                    </xs:sequence>
+                  </xs:complexType>
+                </xs:element>
+              </xs:sequence>
+              <xs:attribute name="type" use="required"/>
+            </xs:complexType>
+          </xs:element>
+        </xs:sequence>
+      </xs:complexType>
+    </xs:element>
+  </xs:schema>
+
+Schema Components
+-----------------
+
+Element: ``journal``
+++++++++++++++++++++
+
+=============== =======
+`Name`          journal
+`Type`          journal
+`Documentation` journal is the root element in the XML file
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="journal">
+
+Complex Type: ``journal``
++++++++++++++++++++++++++
+
+=============== =======
+`Name`          journal
+`Documentation` Tio document contains transactions
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:complexType>
+    <xs:sequence>
+      <xs:element name="transaction" maxOccurs="unbounded">
+      </xs:element>
+    </xs:sequence>
+  </xs:complexType>
+
+Complex Type: ``transaction``
++++++++++++++++++++++++++++++
+
+=============== =======
+`Name`          transaction
+`Documentation` transaction contains a title, a start_date, a stop_date, a reference, a currency, a payment mode, some categories, some arrows and a list of movement.
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:complexType>
+    <xs:sequence>
+      <xs:element name="title" type="xs:string" minOccurs="0"/>
+      <xs:element name="start_date" type="xs:string"/>
+      <xs:element name="stop_date" type="xs:string"/>
+      <xs:element name="reference" type="xs:string"/>
+      <xs:element name="currency" type="xs:string"/>
+      <xs:element name="payment_mode" type="xs:string"/>
+      <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+      <xs:element name="arrow" maxOccurs="unbounded">
+      </xs:element>
+      <xs:element name="movement" maxOccurs="unbounded">
+        </xs:complexType>
+      </xs:element>
+    </xs:sequence>
+    <xs:attribute name="type" use="required"/>
+  </xs:complexType>
+
+Element: ``title``
+++++++++++++++++++
+
+=============== =======
+`Name`          title
+`Type`          string
+`Documentation` title is the name of the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="title" type="xs:string" minOccurs="0"/>
+
+Element: ``start_date``
++++++++++++++++++++++++
+
+=============== =======
+`Name`          start_date
+`Type`          string
+`Documentation` the date at which a service started
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="start_date" type="xs:string"/>
+
+Element: ``stop_date``
+++++++++++++++++++++++
+
+=============== =======
+`Name`          stop_date
+`Type`          string
+`Documentation` the date at which a service was completed
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="stop_date" type="xs:string"/>
+
+Element: ``reference``
+++++++++++++++++++++++
+
+=============== =======
+`Name`          reference
+`Type`          string
+`Documentation` absolute reference of the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="reference" type="xs:string"/>
+
+Element: ``currency``
++++++++++++++++++++++
+
+=============== =======
+`Name`          currency
+`Type`          string
+`Documentation` currency used in the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="currency" type="xs:string"/>
+
+Element: ``payment_mode``
++++++++++++++++++++++++++
+
+=============== =======
+`Name`          payment_mode
+`Type`          string
+`Documentation` payment mode of the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="payment_mode" type="xs:string"/>
+
+Element: ``category``
++++++++++++++++++++++
+
+=============== =======
+`Name`          category
+`Type`          string
+`Documentation` To add your own category section in the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+
+Element: ``arrow``
+++++++++++++++++++
+
+=============== =======
+`Name`          arrow
+`Type`          arrow
+`Documentation` represents who provided a service to somebody else
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="arrow" maxOccurs="unbounded">
+
+Complex Type: ``arrow``
++++++++++++++++++++++++
+
+=============== =======
+`Name`          arrow
+`Documentation` contains a source and a destination.
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:complexType>
+    <xs:sequence>
+    <xs:element name="source" type="xs:string" minOccurs="0"/>
+    <xs:element name="destination" type="xs:string" minOccurs="0"/>
+    </xs:sequence>
+    <xs:attribute name="type" use="required"/>
+  </xs:complexType>
+
+Element: ``source``
++++++++++++++++++++
+
+=============== =======
+`Name`          source
+`Type`          string
+`Documentation` who provided the service
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="source" type="xs:string" minOccurs="0"/>
+
+Element: ``destination``
+++++++++++++++++++++++++
+
+=============== =======
+`Name`          destination
+`Type`          string
+`Documentation` who received the service
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="destination" type="xs:string" minOccurs="0"/>
+
+Element: ``movement``
++++++++++++++++++++++
+
+=============== =======
+`Name`          movement
+`Type`          movement
+`Documentation` represents how much service exchanged in the transaction
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="movement" maxOccurs="unbounded">
+
+Complex Type: ``movement``
+++++++++++++++++++++++++++
+
+=============== =======
+`Name`          movement
+`Documentation` contains a resource, a title, a reference, a quantity, a price, a VAT and some categories
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:complexType>
+    <xs:sequence>
+    <xs:element name="resource" type="xs:string"/>
+    <xs:element name="title" type="xs:string" minOccurs="0"/>
+    <xs:element name="reference" type="xs:string" minOccurs="0"/>
+    <xs:element name="quantity" type="xs:float"/>
+    <xs:element name="price" type="xs:float"/>
+    <xs:element name="VAT" type="xs:string"/>
+    <xs:element name="category" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+Element: ``resource``
++++++++++++++++++++++
+
+=============== =======
+`Name`          resource
+`Type`          string
+`Documentation` represents the kind of service provided
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="resource" type="xs:string"/>
+
+Element: ``quantity``
++++++++++++++++++++++
+
+=============== =======
+`Name`          quantity
+`Type`          float
+`Documentation` represents the amount of service exchanged
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="quantity" type="xs:string"/>
+
+Element: ``price``
+++++++++++++++++++
+
+=============== =======
+`Name`          price
+`Type`          float
+`Documentation` represents the price of service exchanged
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="price" type="xs:string"/>
+
+Element: ``VAT``
+++++++++++++++++
+
+=============== =======
+`Name`          VAT
+`Type`          string
+`Documentation` represents the VAT of service exchanged
+=============== =======
+
+`Schema Component Representation`::
+
+  <xs:element name="VAT" type="xs:string"/>
+

master/bt5/erp5_configurator_vifib/SkinTemplateItem/portal_skins/erp5_configurator_vifib/BusinessConfiguration_setupVifibStandardBT5.xml

@@ -52,59 +52,66 @@
             <key> <string>_body</string> </key>
             <value> <string>configuration_save = context.restrictedTraverse(configuration_save_url)\n
 \n
-bt5_installation_list = (      \n
-      \'erp5_simulation\', \n
-      \'erp5_administration\', \n
-      \'erp5_pdm\', \n
-      \'erp5_trade\', \n
-      \'erp5_simulation_test\', \n
-      \'erp5_item\', \n
+bt5_installation_list = (\n
+      \'erp5_simulation\',\n
+      \'erp5_administration\',\n
+      \'erp5_pdm\',\n
+      \'erp5_trade\',\n
+      \'erp5_simulation_test\',\n
+      \'erp5_item\',\n
       \'erp5_open_trade\',\n
-      \'erp5_forge\', \n
-      \'erp5_ingestion_mysql_innodb_catalog\', \n
-      \'erp5_ingestion\', \n
-      \'erp5_crm\', \n
-      \'erp5_jquery\', \n
-      \'erp5_jquery_ui\', \n
-      \'erp5_knowledge_pad\', \n
-      \'erp5_web\', \n
-      \'erp5_dms\', \n
-      \'erp5_l10n_fr\', \n
-      \'erp5_content_translation\', \n
-      \'erp5_software_pdm\', \n
-      \'erp5_computer_immobilisation\', \n
-      \'erp5_accounting\', \n
-      \'erp5_accounting_l10n_fr\', \n
-      \'erp5_tax_resource\', \n
-      \'erp5_discount_resource\', \n
-      \'erp5_invoicing\', \n
-      \'erp5_ods_style\', \n
-      \'erp5_odt_style\', \n
-      \'erp5_ooo_import\', \n
-      \'erp5_simplified_invoicing\', \n
-      \'erp5_legacy_tax_system\', \n
-      \'erp5_commerce\', \n
-      \'erp5_project\', \n
-      \'erp5_xhtml_jquery_style\', \n
-      \'erp5_credential\', \n
-      \'erp5_km\', \n
-      \'erp5_web_download_theme\', \n
-      \'vifib_mysql_innodb_catalog\', \n
-      \'vifib_core\', \n
-      \'vifib_base\', \n
-      \'vifib_slap\', \n
-      \'vifib_crm\', \n
-      \'vifib_forge_release\', \n
-      \'vifib_software_pdm\', \n
+      \'erp5_forge\',\n
+      \'erp5_ingestion_mysql_innodb_catalog\',\n
+      \'erp5_ingestion\',\n
+      \'erp5_crm\',\n
+      \'erp5_jquery\',\n
+      \'erp5_jquery_ui\',\n
+      \'erp5_dhtml_style\',\n
+      \'erp5_knowledge_pad\',\n
+      \'erp5_web\',\n
+      \'erp5_dms\',\n
+      \'erp5_l10n_fr\',\n
+      \'erp5_content_translation\',\n
+      \'erp5_software_pdm\',\n
+      \'erp5_computer_immobilisation\',\n
+      \'erp5_accounting\',\n
+      \'erp5_accounting_l10n_fr\',\n
+      \'erp5_tax_resource\',\n
+      \'erp5_discount_resource\',\n
+      \'erp5_invoicing\',\n
+      \'erp5_ods_style\',\n
+      \'erp5_odt_style\',\n
+      \'erp5_ooo_import\',\n
+      \'erp5_simplified_invoicing\',\n
+      \'erp5_legacy_tax_system\',\n
+      \'erp5_commerce\',\n
+      \'erp5_project\',\n
+      \'erp5_xhtml_jquery_style\',\n
+      \'erp5_credential\',\n
+      \'erp5_km\',\n
+      \'erp5_web_download_theme\',\n
+      \'erp5_tiosafe_core\',\n
+      \'erp5_system_event\',\n
+      \'erp5_secure_payment\',\n
+      \'erp5_payzen_secure_payment\',\n
+      \'vifib_mysql_innodb_catalog\',\n
+      \'vifib_core\',\n
+      \'vifib_base\',\n
+      \'vifib_slap\',\n
+      \'vifib_crm\',\n
+      \'vifib_forge_release\',\n
+      \'vifib_software_pdm\',\n
       \'vifib_web\',\n
-      \'vifib_open_trade\', \n
+      \'vifib_open_trade\',\n
       \'vifib_l10n_fr\',\n
       \'vifib_data\',\n
-      \'vifib_data_web\',\n
       \'vifib_data_category\',\n
-      \'vifib_erp5\'\n
-)\n
-\n
+      \'vifib_data_web\',\n
+      \'vifib_payzen\',\n
+      \'vifib_data_payzen\',\n
+      \'vifib_erp5\',\n
+      \'vifib_invoicing\',\n
+    )\n
 bt5_update_catalog = (\'erp5_ingestion_mysql_innodb_catalog\', \n
                       \'vifib_mysql_innodb_catalog\', \n
                       \'erp5_content_translation\')\n

master/bt5/erp5_configurator_vifib/bt/revision

-16
+17
\ No newline at end of file

master/bt5/vifib_erp5/LocalRolesTemplateItem/sale_opportunity_module.xml

+<local_roles_item>
+ <local_roles>
+  <role id='F-SALE_G-COMPANY'>
+   <item>Auditor</item>
+   <item>Author</item>
+  </role>
+  <role id='zope'>
+   <item>Owner</item>
+  </role>
+ </local_roles>
+</local_roles_item>
\ No newline at end of file

master/bt5/vifib_erp5/PortalTypeRolesTemplateItem/Sale%20Opportunity%20Module.xml

+<type_roles>
+  <role id='Auditor; Author'>
+   <property id='title'>Sale division</property>
+   <multi_property id='category'>function/sale</multi_property>
+   <multi_property id='category'>group/company</multi_property>
+   <multi_property id='base_category'>function</multi_property>
+   <multi_property id='base_category'>group</multi_property>
+  </role>
+</type_roles>
\ No newline at end of file

master/bt5/vifib_erp5/PortalTypeRolesTemplateItem/Sale%20Opportunity.xml

+<type_roles>
+  <role id='Assignor'>
+   <property id='title'>Sale division</property>
+   <multi_property id='category'>function/sale</multi_property>
+   <multi_property id='category'>group/company</multi_property>
+   <multi_property id='base_category'>function</multi_property>
+   <multi_property id='base_category'>group</multi_property>
+  </role>
+</type_roles>
\ No newline at end of file

master/bt5/vifib_erp5/bt/revision

-298
+299
\ No newline at end of file

master/bt5/vifib_erp5/bt/template_local_role_list

@@ -26,6 +26,7 @@ person_module/test_vifib_user_admin
 person_module/test_vifib_user_developer
 portal_integrations
 purchase_packing_list_module
+sale_opportunity_module
 sale_order_module
 sale_packing_list_module
 sale_trade_condition_module

master/bt5/vifib_erp5/bt/template_local_roles_list

@@ -27,6 +27,7 @@ person_module/test_vifib_user_developer
 portal_integrations
 purchase_packing_list_module
 sale_order_module
+sale_opportunity_module
 sale_packing_list_module
 sale_trade_condition_module
 sale_trade_condition_module/vifib_trade_condition

master/bt5/vifib_erp5/bt/template_portal_type_role_list

@@ -38,6 +38,8 @@ Person Module
 Phone Call
 Purchase Packing List
 Purchase Packing List Module
+Sale Opportunity
+Sale Opportunity Module
 Sale Order
 Sale Order Module
 Sale Packing List

master/bt5/vifib_erp5/bt/template_portal_type_roles_list

-Account Module
 Account
+Account Module
 Accounting Transaction
 Accounting Transaction Module
 Acknowledgement
@@ -40,6 +40,8 @@ Purchase Packing List
 Purchase Packing List Module
 Sale Order
 Sale Order Module
+Sale Opportunity
+Sale Opportunity Module
 Sale Packing List
 Sale Packing List Module
 Sale Trade Condition

setup.cfg

+[build_sphinx]
+source-dir = documentation/source
+build-dir  = documentation/build
+all_files  = 1
+
+[upload_sphinx]
+upload-dir = documentation/build/html