Plural Runbooks are meant to be installed alongside your open source applications and serve as interactive tutorials for how to perform common maintenance tasks.
Plural comes with a library of runbooks for each application; you are also free to create your own.
You can create a runbook just for your own use in your Plural installation, or you can choose to publish the runbook and make it available for other Plural users.
Personal Runbooks
Publishing a Runbook on Plural
- After you have deployed your application with Plural, go to
my-plural-repo/<app-name>/helm/<app-name>/templatesand create a file calledrunbooks.yaml. For more information about how to write arunbooks.yamlplease refer to the guide here. - Go to
my-plural-repo/<app-name>/helm/<app-name>/runbooksand create anxmlfile for the runbook display. For more information on how to writexmlfor the runbook, please refer to the guide here.
You can access the runbooks through the Plural admin console; i.e. you must first install the Plural admin console in order to use the runbooks.