Commit 6071d384 authored by Rafael Monnerat's avatar Rafael Monnerat

documentation: Small update on the documentation.

parent c66aabc2
...@@ -85,7 +85,11 @@ Examples ...@@ -85,7 +85,11 @@ Examples
* Request a kvm instance specifying the full URL, with default settings:: * Request a kvm instance specifying the full URL, with default settings::
$ slapos request mykvm \ $ slapos request mykvm \
http://git.erp5.org/gitweb/slapos.git/blob_plain/refs/tags/slapos-0.156:/software/kvm/software.cfg https://lab.node.vifib.com/nexedi/slapos/raw/1.0.56/software/kvm/software.cfg
* Request a kvm instance specifying an alias from SlapOS Master, with default settings::
$ slapos request mykvm product.kvm
.. ..
XXX update me XXX update me
...@@ -135,11 +139,16 @@ Nodes will then be ready to accept instances of specified software. ...@@ -135,11 +139,16 @@ Nodes will then be ready to accept instances of specified software.
Examples Examples
* Ask installation of wordpress Software Release on COMP-12345:: * Ask installation of kvm Software Release on COMP-12345::
$ slapos supply kvm COMP-12345
* Ask installation of kvm Software Relase on COMP-12345, using alias from SlapOS Master::
$ slapos supply product.kvm COMP-12345
$ slapos supply wordpress COMP-12345
In this example, ``wordpress`` is an alias for the full URL, and is defined in :file:`slapos-client.cfg`. In this example, ``kvm`` is an alias for the full URL, and is defined in :file:`slapos-client.cfg`.
remove remove
~~~~~~ ~~~~~~
...@@ -153,11 +162,11 @@ Ask removal of a software from a specific node or group of nodes. Existing insta ...@@ -153,11 +162,11 @@ Ask removal of a software from a specific node or group of nodes. Existing insta
Examples Examples
* Ask installation of wordpress Software Release on COMP-12345:: * Ask installation of kvm Software Release on COMP-12345::
$ slapos supply wordpress COMP-12345 $ slapos supply kvm COMP-12345
In this example, ``wordpress`` is an alias for the full URL, and is defined in :file:`slapos-client.cfg`. In this example, ``kvm`` is an alias for the full URL, and is defined in :file:`slapos-client.cfg`.
.. ..
autosupply autosupply
...@@ -218,14 +227,9 @@ This will register the current node, and generate the SlapOS configuration file. ...@@ -218,14 +227,9 @@ This will register the current node, and generate the SlapOS configuration file.
The command requires an authentication token, either provided as an argument, The command requires an authentication token, either provided as an argument,
or given at the interactive prompt. or given at the interactive prompt.
Go to the SlapOS Master web page, click ``My Space``, then ``My Account``, then Go to the SlapOS Master web page, click ``Servers`` and them ``Token``.
``Generate a computer security token``.
A token is valid for a single ``node register`` command and will expire after one day. A token is valid for a single ``node register`` command and will expire after one day.
The deprecated ``--login`` and ``--password`` options can be used with old SlapOS servers
that have no support for the token.
.. ..
XXX-Cedric should be like this: If desired node name is already taken, will raise an error. XXX-Cedric should be like this: If desired node name is already taken, will raise an error.
XXX-Cedric: --master-url-web url will disappear in REST API. Currently, "register" uses XXX-Cedric: --master-url-web url will disappear in REST API. Currently, "register" uses
...@@ -298,6 +302,19 @@ Return values: ...@@ -298,6 +302,19 @@ Return values:
* 2 At least one promise has failed. * 2 At least one promise has failed.
node collect
~~~~~~~~~~~~~
.. program-output:: python slapos help node collect
Return values:
**************
* 0 Everything went fine.
* 1 Fail to collect computer information.
node report node report
~~~~~~~~~~~ ~~~~~~~~~~~
...@@ -386,8 +403,7 @@ from the SlapOS Master. They will be used for all the "slapos client" commands. ...@@ -386,8 +403,7 @@ from the SlapOS Master. They will be used for all the "slapos client" commands.
The command requires an authentication token, either provided as an argument, The command requires an authentication token, either provided as an argument,
or given at the interactive prompt. or given at the interactive prompt.
Go to the SlapOS Master web page, click ``My Space``, then ``My Account``, then Go to the SlapOS Master web page, click ``Account``, then ``Token``.
``Generate a credential security token``.
A token is valid for a single ``configure client`` command and will expire after one day. A token is valid for a single ``configure client`` command and will expire after one day.
......
...@@ -7,6 +7,9 @@ What is TioFormat? ...@@ -7,6 +7,9 @@ What is TioFormat?
TIO is a data format used to provide informations about consumption, invoicing TIO is a data format used to provide informations about consumption, invoicing
and state history. and state history.
This innformation is used by SlapOS Master to generated invoices and/or utilisation
reports.
XSD XSD
--- ---
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment