Getting Started With Runbooks
What are Plural runbooks? How do I use and create them?
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.
Publishing a Runbook on Plural
- After you have deployed your application with Plural, go to
my-plural-repo/<app-name>/helm/<app-name>/templates and create a file called runbooks.yaml. For more information about how to write a runbooks.yaml please refer to the guide here. - Go to
my-plural-repo/<app-name>/helm/<app-name>/runbooks and create an xml file for the runbook display. For more information on how to write xml for the runbook, please refer to the guide here.
git clone git@github.com:pluralsh/plural-artifacts.gitcd plural-artifacts- Add your configuration to
<app-name>/helm/<app-name>/templates/runbooks.yaml - Add your custom xml template to
<app-name>/helm/<app-name>/runbooks - Open up a PR; once the new runbook has been code reviewed, it will be merged into the repo and available for others to download.
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.