The Bash Plug-in
The Bash plug-in executes a bash script on every life cycle step.
It only works under Linux systems.
Bash scripts should explicitly return an error when something goes wrong.
Otherwise, Roboconf will consider everything run fine even if the script encountered errors.
This plug-in is associated with the bash installer name.
Component_Y {
installer: bash;
}
Here is the way this plug-in works.
In the next lines, action is one of deploy, start, update, stop or undeploy.
- The plug-in will load scripts/action.sh
- If it is not found, it will try to load templates/action.sh.template
- If it is not found, it will try to load templates/default.sh.template
- If it is not found, the plug-in will do nothing.
Templates use Mustache to generate a concrete bash script before executing it.
default.sh.template is the template that will be used for all the steps which do not have their own
script or template.
All the templates can use import variables.
These variables will be inserted by Roboconf.
Action script and parameters
Parameters are passed to action scripts (eg. start.sh, update.sh …) using environment variables, that respect naming conventions.
Global environment-related variables
- ROBOCONF_INSTANCE_NAME: The name of the current instance (the one whose script is invoked).
- ROBOCONF_FILES_DIR: The directory where instance files are located (if any).
Exported and imported variables
All the exports of the instance are available as environment variables (their names are left unchanged).
Imports are more complex, as there may be multiple ones: let’s take the example of an Apache load balancer,
that imports Tomcat “ip” and “portAjp” variables. The imports will look like this (for N+1 Tomcat instances
named “tomcat0” to “tomcatN”):
tomcat_size = N
tomcat_0_name = tomcat1
tomcat_0_ip = < ip address of tomcat 1 >
tomcat_0_portAjp = < AJP port for tomcat 1 >
# ...
tomcat_N_name = tomcatN
tomcat_N_ip = < ip address of tomcat N >
tomcat_N_portAjp = < AJP port for tomcat N >
So, the naming convention for imports is < componentName >_< index >_< exportName >, with index starting at 0 and max (index) given by < componentName >_size .
Variables related to update actions
| Variable name | Description |
|---|---|
| ROBOCONF_UPDATE_STATUS | The status of the instance that triggered the update (e.g. DEPLOYED_STOPPED, DEPLOYED_STARTED). |
| ROBOCONF_IMPORT_CHANGED_COMPONENT | Name of the component for the changed import. |
| ROBOCONF_IMPORT_CHANGED_INSTANCE_PATH | Path of the instance that exports the changed import. |
| ROBOCONF_IMPORT_CHANGED_< ImportName > | The value of every imported variable that changed (e.g. if an exported ipAddress changed, the “ROBOCONF_IMPORT_CHANGED_ipAddress” variable should contain its new value). |