opsbox 0.2.4

AI-powered infrastructure management

Opsbox

AI-Powered Infrastructure Management

Welcome to Opsbox, the open-source platform that adds a dash of AI magic to your infrastructure management. With our flexible plugin system and policy-as-code approach using Rego, managing your infrastructure has never been this enjoyable!

Features

• 🎛️ Plugin System: Customize and extend functionality with ease.
• 📝 Policy-as-Code with Rego: Define compliance checks and policies efficiently.
• 🤖 AI Assistance: Leverage AI models to analyze and process your infrastructure data.
• 💻 Command-Line Interface: An interactive CLI.
• 📚 Documentation Support: Generate and view documentation effortlessly using mkdocs.

Installation

Prerequisites

Ensure you have Python 3.11 installed.

For an isolated installation, use either UV or pipx.

For development or installing from source, you'll need UV.

For Rego plugins, install OPA.

---

(Recommended) Install in an Isolated Environment

Installing in an isolated environment avoids system conflicts and pollution.

Using UV

Installation

uv tool install opsbox

To install with extras:

uv tool install --with "opsbox-cli-output" "opsbox[aws]"

To add packages after installation:

uv tool install --with "existing-packages new-package"

Warning: If UV downloads the wrong version or can't find a package, clear the cache:

uv cache clean

Execution

uv tool run opsbox ...

Or:

uvx opsbox ...

Warning: Do not use --with during execution; it creates a temporary environment.

Using pipx

Installation

pipx install opsbox

To install additional packages:

pipx inject opsbox opsbox-cli-output

To ensure opsbox is in your PATH:

pipx ensurepath

Run opsbox directly in your shell.

---

(Not Recommended) Install from Source

For development or debugging, install from source using UV.

Installation

git clone https://github.com/sudoersllc/opsbox-core.git
cd opsbox-core
uv sync

Note: If you encounter Python versioning issues:

uv python install 3.11
rm .python-version
uv python pin 3.11

Execution

Run opsbox/main.py inside the virtual environment:

uv run ./opsbox/main.py ...

---

Installing OPA for Rego Compatibility

If using Rego (e.g., AWS plugins), install OPA and add it to your system PATH.

Adding OPA to PATH

Linux/macOS

echo 'export PATH=$PATH:/path/to/opa' >> ~/.bashrc
source ~/.bashrc  # or source ~/.zshrc

Windows

1. Open "Edit the system environment variables" > "Environment Variables...".
2. Edit "Path" and add C:\path\to\opa\directory.
3. Restart your terminal.

Note: To use an existing OPA server, pass its URL in opa_url.

---

Example Usage

Want to run a specific pipeline? Here's how:

uv run opsbox --modules your_input-your_optional_assistant-your_output

A recommended command to start is stray_ebs make sure you have opsbox[aws] and opsbox-cli-output installed

uv run opsbox --modules stray_ebs-cli_out --aws_access_key_id {YOUR_ACCESS_KEY_ID} --aws_secret_access_key {YOUR_SECRET_ACCESS_KEY} --aws_region us-east-1

Configuration

Opsbox is flexible when it comes to configuration. You can provide options via:

• Command-Line Arguments
• Configuration Files
• Environment Variables

Using a Configuration File

Create a file named .opsbox_conf.json in your home directory:

{
  "aws_access_key_id": "YOUR_ACCESS_KEY_ID",
  "aws_secret_access_key": "YOUR_SECRET_ACCESS_KEY",
  "aws_region": "YOUR_AWS_REGION",
}

To run a command with a config it will follow this format

uv run opsbox --modules stray_ebs-cli_out --config config.json

Command-Line Arguments

You can also provide configuration options directly through the command line:

uvx opsbox --modules example_module --aws_access_key_id YOUR_ACCESS_KEY_ID --aws_secret_access_key YOUR_SECRET_ACCESS_KEY --aws_region YOUR_AWS_REGION

Plugins

You'll probably want some plugins to get started!

Opsbox plugins published by gsudoers normally take the format of opsbox-<name>-<plugin_type>, and are accessible and searchable through PyPI.

There's also a collection of plugins available for AWS systems, installable by using the pip extras group aws:

pip install 'opsbox[aws]'

Let's Get Started!

Now that you're all set, it's time to unleash the power of AI on your infrastructure. Happy automating!