Getting Started
Basic Setup & Deployment
Applications
Advanced Topics
Getting Started With Runbooks
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.
Create Runbook For Your Personal Installation
Create Runbook for Publication on Plural Platform
- 1.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. - 2.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.
- 1.
git clone [email protected]:pluralsh/plural-artifacts.git - 2.
cd plural-artifacts - 3.Add your configuration to
<app-name>/helm/<app-name>/templates/runbooks.yaml - 4.Add your custom xml template to
<app-name>/helm/<app-name>/runbooks - 5.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.
Last modified 5d ago
Copy link
Edit on GitHub
Contents