0683e4af4a
Add a script to be deployed on CML that allows labs marked with "(autostart)" in their descriptions to be started as soon as the CML server boots up.
README
This script adds lab autostart capability to CML. It's implemented in a very simple way without any additional dependencies to install.
Warning
It's important to understand that this mechanism is very simple and also very insecure. You need to provide a password for a user of the system in clear text as part of the configuration. If you are not comfortable to provide a password that is stored in clear text on the server, then this solution is not for you. Also, if the system uses external authentication via LDAP, then this solution is likely not for you.
Installation
Simply copy the autostart.sh script to the CML server. Either via scp or
simply copying/pasting it into a file on the CML server (for example, via the
Cockpit terminal). From there, run the script which then installs it:
$ sudo bash ./autostart.sh
installing defaults ✅
installing script ✅
installing service unit ✅
*****************************************************
* ⚠️ IMPORTANT! ⚠️ *
* you need to ensure that you change the username *
* and password for a user of the system that can *
* start the labs in /etc/default/cml-autostart *
* *
* Add the string "(autostart)" to the description *
* of each lab that you wish to start automatically. *
*****************************************************
$
Then configure the defaults (e.g. change the password) as outlined in the next section.
Configuration
The autostart script basically looks at all labs that the user has access to (users with admin rights will see all labs, the script passes the "show_all" flag so if a non-admin user runs this, they will see all labs they have access to).
A lab that has (autostart) in the lab description will be started when the
system comes up and is ready.
The string that triggers the autostart is configured in the TITLE_REGEX
variable. It is treated as a regular expression.
Configuration (with defaults) is done in /etc/default/cml-autostart:
USERNAME="admin"
PASSWORD="password-that-needs-to-be-changed"
TITLE_REGEX="\(autostart\)"
After installation, at least the password needs to be changed.
Note
The user configured should be a general admin user that has visibility to all potential labs that might need to be auto-started.
Troubleshooting
If labs do not start as expected, check the service unit output:
sudo systemctl status cml-autostart.service
More details are available in the journal:
sudo journalctl -u cml-autostart.service
If that's not sufficient to pin-point the issue, enable debugging in the script
by removing the comment in /usr/local/bin/cml-autostart.sh from the line that
says # set -x. If the script has been changed and debugging is enabled then
the service can be triggered again by systemctl start cml-autostart.service.
Then show the status and / or look at the journal output again.