Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 3.61 KB
Raw

Contributing

Thanks for taking time to contribute and helping us make this project better! The following is a set of guidelines for contributing to the project. Please note we have a code of conduct, please follow it in all your interactions with the project.

Submitting issues

We have several forms for your issues:

  • Bug Report: Ensure you have followed the steps in the form so we can best assist you.
  • Feature Request: Do you have an awesome idea to make this project better? We want to hear it!
  • Action Creation: Do you have an idea for a new Action?
  • RunBook idea: Have a request or idea for a RunBook that will make the life of an SRE better? File it using this form.

Version control branching

  • Always make a new branch for your work.
  • Base your new branch off of the master branch on the main repository.

Create a new xRunBook

Your RunBooks are stored locally at $HOME/Awesome-CloudOps-Automation/custom/runbooks Copy an existing xRunBook and rename it. It will appear in the Welcome page on refresh. Click to Open. Your saved xRunBook can be found at $HOME/Awesome-CloudOps-Automation/custom/runbooks

  1. All created RunBooks have a ipynb file. You'll need to create a .json file with metadata about your RunBook. Copy from another RunBook un the repository, and update the values for each parameter.
  2. Use the sanitize.py script to remove all parameters and outputs from your Runbook:
    python3 sanitize.py -f <ipynb file>
  1. Copy the saved RunBook (json and ipynb) files from the Custom folder into the folder of the Connector used, and submit a PR!

Create a new Action

Create a new action inside an existing RunBook.

  1. If you will not use external credentials, click +Add Action at the top of the menu.
  2. If you will be using an existing credential, add an existing Action for that service (like AWS), and edit the code to create your new Action.
  3. If the service you'd like to build for does not have credentials yet, please file an issue.

Creating and connecting your Action

  1. Creating Custom Actions describes the steps to create your own Action.
  2. To submit to OSS, follow the Submit An Action instructions.

Support Channels

Whether you are a user or contributor, official support channels include:

Extending Docker

You can use our base docker and extend the functionality to fit your need. Follow this document to create and build your own custom docker.