Skip to main content

Diadem extends Idem's capabilities, focusing on organizing, parametrizing, and visualizing SLS files across multi-cloud environments.

Project description

Made with pop, a Python implementation of Plugin Oriented Programming Made with Python

Diadem extends idem to streamline cloud resource management by organizing, parametrizing, and visualizing SLS data.

About

Built on POP, diadem integrates with Idem, providing a user-friendly cli interface for handling complex cloud infrastructures. It extends idem with the subcommands “compile” and “view”, which grant idem the ability to do tasks based on complex analysis of relationships between resources. Such as:

  • Graphing the relationships between resources

  • Identifying orphans

  • Abstracting the similarities between resources into params

  • Creating arg-bind relationships between resources

Each of these abilities enable you to easily get started with efficiently managing cloud resources with idem from ground zero.

What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

Getting Started

Prerequisites

  • Python 3.10+

  • git (if installing from source, or contributing to the project)

Installation

If wanting to use diadem, you can do so by either installing from PyPI or from source.

Install from PyPI

Install diadem with only the “compile” functionality:

pip install diadem

Install diadem with matplotlib for data visualizations with matplotlib and networkx:

pip install diadem[visualize]

Install from source

# clone repo
git clone git@gitlab.com:Akm0d/diadem.git
cd diadem

# Setup venv
python3 -m virtualenv .venv
source .venv/bin/activate
pip install -e .

Usage

Diadem simplifies the management of cloud resources. Use it to enumerate resources, organize SLS files, and visualize cloud infrastructure, ensuring efficient and secure cloud operations.

Examples

Enumerate cloud resources with idem describe:

idem describe "aws.*" > aws.sls
idem describe "gitlab.*" > gitlab.sls

Create argbind relationships between resources only:

idem compile aws.sls gitlab.sls --match-strategy=pass

Parametrize sls files by creating arg-bind relationships and abstract similarities between resources into params:

idem compile aws.sls gitlab.sls

Parametrize sls files by creating arg-bind relationships, abstract similarities between resources into params, and organize the output into logical groups in a file tree:

idem compile aws.sls gitlab.sls --tree=/srv/idem

Visualize relationships between resources using matplotlib:

idem view /srv/idem/state --params /srv/idem/param

Run idem state on the newly crafted sls/param trees:

idem state /srv/idem/state --params /srv/idem/param

Identify orphan resources and craft absent states for them:

idem view /srv/idem/state  --params /srv/idem/param > orphans.sls

Show a graph of relationships between resources (requires having installed diadem with the “visualize” extras):

idem view /srv/idem/state --params /srv/idem/param --show

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diadem-1.0.1.tar.gz (23.2 kB view hashes)

Uploaded Source

Built Distribution

diadem-1.0.1-py3-none-any.whl (29.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page