slaprunner: README updated to explain how to run tests
[slapos.git] / software / slaprunner / README.txt
1 slaprunner
2 ==========
3
4 Introduction
5 ------------
6
7 This software release is used to deploy Slaprunner instances.
8 Slaprunner is an all-in-one IDE used to develop and test profiles and recipes for SlapOS.
9
10 Parameters
11 ----------
12
13 authorized-key
14 ~~~~~~~~~~~~~~
15
16 You need to specify your SSH public key in order to connect to the SSH server of this instance.
17
18 Example of parameter XML::
19
20   <?xml version="1.0" encoding="utf-8"?>
21   <instance>
22   <parameter id="authorized-key">ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCdNp7qZMVAzNc07opHshiIFDmJpYXQpetfcSgUj39a409d42PpsJElp7WsAE/x0nN6gUIoWIl7UiAlMzf6bKEJGJVSOZEPTmiJVlgK1Gp+kE0x9yNcncYg7p38Jny0daVA/NkkpAFyRsAm5kLGzyLtaCcktSvy0cJuy7WSSHU05pd1f8Y8thofE9g5t+/JA2VZvipxPkRfkFAG3aOAGLULlTImTSDFSDFGSDFG5F6mMnl7yvY2d6vEHVBu+K+aKmAwZVfCUwtSpa/tq3i2Lppjrw3UfrxbQSFHZCkzefr+u+l4YYe+tJrX7rYJYXD7LIfZfdSeFTlHFaN/yI1 user@host.local</parameter>
23   </instance>
24
25 instance-amount
26 ~~~~~~~~~~~~~~~
27
28 Optional parameter.
29
30 Default: 10
31
32 AUTO-DEPLOYMENT
33 ---------------
34
35 You can automatically deploy a software release while deploying the webrunner itself, using the paramater XML.
36
37 To do this, you only need to pass as a parameter named "slapos-software" : "AAA/BBB", where AAA is the folder of slapos.git where is located your BBB software.
38 For example, to deploy the hello-world software, you need to pass : software/helloworld
39
40 This is possible because the slapos.git is automatically downloaded when the webrunner is deployed.
41
42 It is also possible to download you own git repository, by providing the url in the "slapos-repository" parameter.
43
44 Last but not least, it is also possible to switch the branch with the parameter "slapos-reference" (by default pointing on master)
45
46 Resilience :
47 ------------
48
49 To order a resilient runner, you have to request a runner with the option: "--type resilient"
50
51 You can then decide on which node you want to deploy each instance, with the parameters.xml :
52         <?xml version='1.0' encoding='utf-8'?>
53         <instance>
54           <parameter id="-sla-runner2-computer_guid">COMP-XXXX</parameter>
55           <parameter id="-sla-pbs2-computer_guid">COMP-XXXX</parameter>
56           <parameter id="-sla-pbs1-computer_guid">COMP-XXXX</parameter>
57           <parameter id="-sla-runner1-computer_guid">COMP-XXXX</parameter>
58           <parameter id="-sla-runner0-computer_guid">COMP-XXXX</parameter>
59         </instance>
60
61 If you want to check by yourself that the pull-backup instances do their job, you can change directory to the slappart of runner0, and run ./bin/exporter (after creating your account, using the given backend_url or url): it would fill ./srv/backup/runner with data. If you then go to an import instance (runner1 or runner2) on the port 50005, you should be able to sign in the runner.
62
63
64 Tips :
65 ~~~~~
66
67 To find in which partition the instance has been deployed, you can open the page of this specific instance, and look for "slappartXX" on the page.
68
69 Tests :
70 -------
71
72 To test the runner, start by ordering a runner with default type. Then READ the important note below :
73
74 /!\ IMPORTANT NOTE ON THE TESTS /!\ : in order to make them work, you have to comment the last line of the file __init__.py in the runner module (which is just : "run()"). Indeed, this line is used to load the config, when importing this module throught Gunicorn (the wsgi server). But the test suite loads itself the configuration, in fonction of the tested scenarios, etc... (You can find the module in the SR folder directory, under ./eggs/slapos.toolbox, or under parts/slapos.toolbox if you have a development version)
75
76 Then, su in the concerned slapuserX and run "./bin/runTestSuite".
77
78 For the tests on the resiliency of the webrunner, please refer to the README in slapos.toolbox.git/slapos/resiliencytest
79
80 Request custom frontend :
81 -------------------------
82
83 While deploying a server in your instance, you may need to ask for a custom ipv4 frontend.
84
85 The way to do that is to send a new parameter to your runner instance, using the parameters XML. The name of it is "custom-frontend-backend-url".
86
87 To create the frontend, you now have to wait the slaprunner to be processed.
88
89 If you deploy a server, which uses basic auth, you also have to declare the parameter "custom-frontend-basic-auth" as true, or your slaprunner instance won't show as correctly instanciated.
90
91 Example :
92         <?xml version='1.0' encoding='utf-8'?>
93         <instance>
94         <parameter id="custom-frontend-backend-url">http(s)://[THE_IPV6_ADDRESS]:PORT</parameter>
95         <parameter id="custom-frontend-basic-auth">true</parameter>
96         </instance>