Skip to content

Latest commit

 

History

History
138 lines (101 loc) · 7.35 KB

README.md

File metadata and controls

138 lines (101 loc) · 7.35 KB
Raw

Contributors Forks Stargazers Issues Twitter Actions Runbooks

Runbooks.sh

Empowering Cloud Automation, Together

Explore our docs
Visit our blog . Report Bug . Request Feature

🚀 Quick Start Guide

We recommend using our docker setup which comes with Jupyter runtime along with pre-built actions and runbooks. Build your own actions and runbooks with ease!

Get Started

  1. Launch Docker
docker run -it -p 8888:8888 --user root unskript/awesome-runbooks:latest
  1. Point your browser to http://127.0.0.1:8888/awesome.

Advanced Usage

In this section, we'll explore advanced configurations that enable:

  1. Custom Action and Runbook creation
  2. Custom Action creation using OpenAI integration

Custom Action and Runbook Creation

  1. Clone this repository to your local machine.
git clone https://github.com/unskript/Awesome-CloudOps-Automation
cd Awesome-CloudOps-Automation
  1. Launch Docker
  • Use this command to create custom runbooks and actions. (update the first -v line if you used a different directory in step 1).
docker run -it -p 8888:8888 \
 -v $HOME/Awesome-CloudOps-Automation/custom:/unskript/data \
 -v $HOME/.unskript:/unskript/credentials \
 -e ACA_AWESOME_MODE=1 \
 --user root \
 docker.io/unskript/awesome-runbooks:latest
  1. Point your browser to http://127.0.0.1:8888/awesome.

Custom Action Creation using OpenAI Integration

  1. Clone this repository to your local machine if you haven't already.
git clone https://github.com/unskript/Awesome-CloudOps-Automation
cd Awesome-CloudOps-Automation
  1. Launch Docker with OpenAI parameters:
  • Use this command to create custom GenAI actions (update the first -v line if you used a different directory in step 1).
docker run -it -p 8888:8888 \
 -v $HOME/Awesome-CloudOps-Automation/actions:/unskript/data/actions \
 -v $HOME/Awesome-CloudOps-Automation/runbooks:/unskript/data/runbooks \
 -v $HOME/.unskript:/unskript/credentials \
 -e ACA_AWESOME_MODE=1 \
 -e OPENAI_ORGANIZATION_ID=<your openAI org> \
 -e OPENAI_API_KEY=<your API key> \
 -e OPENAI_MODEL=GPT-4 \
 --user root \
 docker.io/unskript/awesome-runbooks:latest

The OPENAI parameters are used to initialize Generative AI creation with ChatGPT. They can be omitted from the command, but the generativeAI features will not be available. For a list of models, visit openAI.

  1. Point your browser to http://127.0.0.1:8888/awesome.

You can find more information around how to use and play with our runbooks in the documentation here. You can find a list of all the runbooks along with links in the repository page or simply use unSkript CLI.

📚 Documentation

Dive deeper into Runbooks.sh by visiting our comprehensive documentation. Here, you'll find everything you need to know about using the platform, creating custom runbooks, developing plugins, and much more.

About the Project

Runbooks.sh is a powerful, community-driven, open-source runbook automation platform designed to simplify cloud infrastructure management and streamline operations across diverse environments. Few of the highlighting features:

  • Extensive Library: Access hundreds of pre-built actions and runbooks to kickstart your automation journey.
  • Customization: Create and modify actions and runbooks tailored to your unique requirements.
  • Generative AI Action Creation Fully integrated with ChatGPT to create custom Actions in minutes.
  • Diverse Compatibility: Seamlessly integrate with various cloud providers, platforms, and tools.
  • User-friendly Interface: A Jupyter-based environment that simplifies runbook creation and execution.
  • Active Community: Join a vibrant community of users and contributors committed to improving the project.

🏆 Mission

Our mission is to simplify CloudOps automation for DevOps and SRE teams by providing an extensive, community-driven repository of actions and runbooks that streamline day-to-day operations.

👁️ Vision

Our vision is to be the one-stop solution for all CloudOps automation needs, allowing DevOps and SRE teams to automate their workflows with ease, improve efficiency, and minimize toil.

🤝 Contributing

We welcome contributions from developers of all skill levels! Check out our Contribution Guidelines to learn how you can contribute.

📖 License

Except as otherwise noted, this project is licensed under the Apache License, Version 2.0 .

🌐 Join Our Community

Connect with other users and contributors by joining our Slack workspace. Share your experiences, ask questions, and collaborate on this exciting project!

📣 Stay Informed

Keep up-to-date with the latest news, updates, and announcements by following us on Twitter and Linkedin.

Together, let's make Runbooks.sh the go-to solution for runbook automation and cloud infrastructure management!