From f416b4b512c0fdfc0cb35e17c772e926e298727d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20de=20Saint=20Martin?= <cedric.dsm@tiolive.com> Date: Wed, 3 Oct 2012 15:00:50 +0200 Subject: [PATCH] valid RST --- slapos/README.console.txt | 52 +++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/slapos/README.console.txt b/slapos/README.console.txt index b13b9affc..7322691ac 100644 --- a/slapos/README.console.txt +++ b/slapos/README.console.txt @@ -1,10 +1,10 @@ console -======= +------- The slapconsole tool allows to interact with a SlapOS Master throught the SLAP library. -For more information about SlapOS or slapconsole usages, please go to +For more information about SlapOS or slapconsole usages, please go to http://community.slapos.org. The slapconsole tool is only a bare Python console with several global variables @@ -12,14 +12,16 @@ defined and initialized. Initialization and configuration file -===== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Slapconsole allows to automatically connect to a Master using URL and SSL certificate from given slapos.cfg. Certificate has to be *USER* certificate, manually obtained from SlapOS master web interface. Slapconsole tools reads the given slapos.cfg configuration file and use the -following informations : +following informations : + * Master URL is read from [slapos] in the "master_url" parameter. * SSL Certificate is read from [slapconsole] in the "cert_file" parameter. * SSL Key is read from [slapconsole] in the "key_file" parameter. @@ -28,7 +30,8 @@ See slapos.cfg.example for examples. Global functions -===== +~~~~~~~~~~~~~~~~ + * request() is a shorthand for slap.registerOpenOrder().request() allowing to request instances. * supply() is a shorthand for slap.registerSupply().supply() allowing to @@ -39,33 +42,44 @@ documentation. Global aliases -===== +~~~~~~~~~~~~~~ + "software_list" is a list containing all the Software Release URLs defined in client slapos.cfg configuration file. Also, each Software Release defined in this configuration file is translated into a global variable to ease the request of those Sofware Releases. -This allows to request instances in a few words, i.e -request("http://www.url.com/path/to/kvm/software.cfg", "mykvm") -can be simplified into : -request(kvm, "mykvm") -If the slapos.cfg file contains : -alias = - kvm http://www.url.com/path/to/kvm/software.cfg +This allows to request instances in a few words, i.e:: + + request("http://www.url.com/path/to/kvm/software.cfg", "mykvm") + +can be simplified into :: + + request(kvm, "mykvm") + +If the slapos.cfg file contains :: + + alias = + kvm http://www.url.com/path/to/kvm/software.cfg Global objects -===== +~~~~~~~~~~~~~~ + "slap" is an instance of the SLAP library. It is only used for advanced usages. -"slap" instance is obtained by doing : -slap = slapos.slap.slap() -slap.initializeConnection(config.master_url, +"slap" instance is obtained by doing :: + + slap = slapos.slap.slap() + slap.initializeConnection(config.master_url, key_file=config.key_file, cert_file=config.cert_file) Examples -===== +~~~~~~~~ + +:: + >>> # Request instance >>> request(kvm, "myuniquekvm") @@ -75,7 +89,7 @@ Examples >>> # Request instance, specifying parameters (here nbd_ip and nbd_port) >>> request(kvm, "mythirduniquekvm", - partition_parameter_kw={"nbd_ip":"2a01:e35:2e27:460:e2cb:4eff:fed9:48dc", + partition_parameter_kw={"nbd_ip":"2a01:e35:2e27:460:e2cb:4eff:fed9:48dc", "nbd_port":"1024"}) >>> # Request software installation on owned computer -- 2.30.9