runner: shellinabox doesn't use post 8080 anymore, which is widely used by other...
[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 user-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="user-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
33 Public-directory
34 ----------------
35 You can serve static files with the webrunner. For that, just put your data in "srv/runner/public". All these files will be served throught the url of the webrunner + "/public/". Useful for developping your own static website.
36
37
38 AUTO-DEPLOYMENT
39 ---------------
40
41 for software
42 ~~~~~~~~~~~~
43
44 You can automatically deploy a software release while deploying the webrunner itself, using the paramater XML.
45
46 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.
47 For example, to deploy the hello-world software, you need to pass : software/helloworld
48
49 This is possible because the slapos.git is automatically downloaded when the webrunner is deployed.
50
51 It is also possible to download you own git repository, by providing the url in the "slapos-repository" parameter.
52
53 Last but not least, it is also possible to switch the branch with the parameter "slapos-reference" (by default pointing on master)
54
55 for instance
56 ~~~~~~~~~~~~
57
58 The parameter "auto-deploy-instance" can be explicitly set to allow or prevent the runner to deploy the instance at START TIME (if you manually restart the runner, or if the server reboots). Values : "true" or "false". Default value is "true", except for the instances of import (while type is resilient or test) which is "false"
59
60 There also exists the parameter "autorun", which will build&run your software if set to true. For this, you need "auto_deploy" to true, and set the parameter "slapos-software" to the software you want to deploy. Do not hesitate to clone a different repo than "slapos", or to change the tag/branch to use your custom Software Release. (see "slapos-repository" and "slapos-reference" in previous section).
61
62 To deploy the instance with some parameters, just give to the runner parameters starting with "parameter-", they will be correctly forwarded to the instance, which will use them for its configuration. For example, if you want to send to the sofware helloworld the parameter "name" with the value "nicolas", here is how to configure the parameter.xml of the webrunner for auto-depolyment :
63
64 <?xml version='1.0' encoding='utf-8'?>
65 <instance>
66 <parameter id="slapos-software">software/helloworld</parameter>
67 <parameter id="auto_deploy">true</parameter>
68 <parameter id="autorun">true</parameter>
69 <parameter id="parameter-name">nicolas</parameter>
70 </instance>
71
72 Resilience :
73 ------------
74
75 To order a resilient runner, you have to request a runner with the option: "--type resilient"
76
77 You can then decide on which node you want to deploy each instance, with the parameters.xml :
78         <?xml version='1.0' encoding='utf-8'?>
79         <instance>
80           <parameter id="-sla-runner2-computer_guid">COMP-XXXX</parameter>
81           <parameter id="-sla-pbs2-computer_guid">COMP-XXXX</parameter>
82           <parameter id="-sla-pbs1-computer_guid">COMP-XXXX</parameter>
83           <parameter id="-sla-runner1-computer_guid">COMP-XXXX</parameter>
84           <parameter id="-sla-runner0-computer_guid">COMP-XXXX</parameter>
85         </instance>
86
87 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.
88
89
90 Tips :
91 ~~~~~
92
93 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.
94
95 Tests :
96 -------
97
98 To test the runner, start by ordering a runner with default type. Then READ the important note below :
99
100 /!\ 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)
101
102 Then, su in the concerned slapuserX and run "./bin/runTestSuite".
103
104 For the tests on the resiliency of the webrunner, please refer to the README in slapos.toolbox.git/slapos/resiliencytest
105
106 Request custom frontend :
107 -------------------------
108
109 While deploying a server in your instance, you may need to ask for a custom ipv4 frontend.
110
111 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".
112
113 To create the frontend, you now have to wait the slaprunner to be processed.
114
115 You can define the type of your backend using "custom-frontend-backend-type". eg: zope
116
117 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.
118
119 Example :
120         <?xml version='1.0' encoding='utf-8'?>
121         <instance>
122         <parameter id="custom-frontend-backend-url">http(s)://[THE_IPV6_ADDRESS]:PORT</parameter>
123         <parameter id="custom-frontend-backend-type">zope</parameter>
124         <parameter id="custom-frontend-basic-auth">true</parameter>
125         </instance>
126
127 Git repositories :
128 ------------------
129
130 It is easy to give access to your git repository/ies to everyone, or to clone it on your own computer. For this, there are 2 urls to remember:
131   - For read only, you can clone : https://[IPV6]:PORT/git-public/YourRepo.git/
132   - For read and write access, using your runner account : https://[IPV6]:PORT/git/YourRepo.git/
133
134 To create the repo, go in the folder srv/runner/project and initiate a new git repo (git init/clone --bare XXX).
135
136 For the moment, the PORT is the port of monitoring, which is 9685.
137
138 Things to notice for the nex developer :
139 ----------------------------------------
140
141 As you can see in instance-runner-*.cfg, the buildout section extends a hard-coded template file. If one day you need to modify the filename, do not forget to modify it in instance.cfg, but also in these files ! (the problem is that the content of instance.cfg is not known by buildout while the deployment of the software release)
142
143
144 List of ports used by the webrunner:
145 ------------------------------------
146 8602 : slapproxy, while running tests
147 8949 : shellinabox
148 9684 : apache (monitoring of slaprunner, git access)
149 22222 : dropbear
150 50000 : slapproxy
151 50005 : webrunner (flask app), webdav access
152
153 Tips:
154 -----
155 You can use shellinabox in fullscreen, by accessing : https://[IPV6]:8949