Skip to content
This repository has been archived by the owner on Jan 14, 2024. It is now read-only.

Latest commit

 

History

History
174 lines (120 loc) · 8.43 KB

README.rst

File metadata and controls

174 lines (120 loc) · 8.43 KB
Raw

RKD - RiotKit-Do

./docs/background.png

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Github Release Made with Python License Test and release a package PRs welcome PRs open Issues open

Looking for maintainers

Hi! This project needs you! We are sorry - our goals have changed, we need to focus on delivering docker images and Kubernetes operators for our partner-organizations to let them host their services securely, therefore we do not have resources to maintain such big project as RKD. RKD has a potential especially with it's plugin-based architecture (#78 and #76)

Task executor - balance between Makefile and Gradle [see documentation], designed with ❤️ by RiotKit for DevOps.

Easiest and cleanest way to write management scripts and share them between projects, teams and even organizations

RKD is a stable, open-source, multi-purpose automation tool which balance flexibility with simplicity. The primary language is Python and YAML syntax.

RiotKit-Do can be compared to Gradle and to GNU Make, by allowing both Python and Makefile-like YAML syntax.

Can be used on PRODUCTION, for development, for testing, to replace some of Bash scripts inside docker containers, and for many more, where Makefile was used.

It is not a build tool for Java, but more a DevOps multi-purpose tool. At this time it will not replace Gradle, but maybe in the future this can be achieved by building community packages with support for building eg. Java applications.

Example use cases

  • Docker based production environment with multiple configuration files, procedures
  • Database administrator workspace (importing dumps, creating new user accounts, plugging/unplugging databases)
  • Development environment (executing migrations, importing test database, splitting tests and running parallel)
  • On CI (prepare project to run on eg. Jenkins or Gitlab CI) - RKD is reproducible on local computer which makes inspection easier
  • Kubernetes/OKD deployment workspace (create shared YAML parts with JINJA2 between multiple environments and deploy from RKD)
  • Automate things like certificate regeneration on production server, RKD can generate any application configs using JINJA2
  • Installers (RKD has built-in commands for replacing lines in files, modifying .env files)

Quick start

# 1) via PIP
pip install rkd

# 2) Create project (will create a virtual env and prepare files that could be commited to git)
rkd :rkd:create-structure

Please check available releases there: https://pypi.org/project/rkd/#history

Goals:

  • Define tasks as simple as in Makefile
  • Write tasks code in Python as simple as possible
  • Reuse code as simple as in Gradle (using extensions that provides tasks. Extensions are installable from PIP)
  • Simple configuration in Python
  • Integrates with GIT
  • Suitable for PRODUCTION (log as much as possible, log each executed task into separated *.log files). We planned also extended logging of most important auditing information such as who executed action, and how the state looked in that time

Rules

  • No hooks eg. task.executeAfter(otherTask), no complex dependencies
  • No in-memory state between tasks. State could be only changed in files/database/kv-store like it is in other build systems
  • No dynamic tasks names eg. by turning on Publish component it should not create tasks eg. :publishIWAToDockerRegistry (where IWA is the project name)
  • Don't pack too many features into the core, do this in external modules. Keep the RKD core clean!
  • Full static analysis, you can work on makefile.py and on task's code in PyCharm with full code completion!
  • Do early validation. Runtime validation for long running builds is a pain-in-the-ass for the user.
  • Show clear error messages as much as it is possible. Task not found? Tell the user - do not leave a stack trace. Import error in makefile.py? Tell the user + add stack trace. RESPECT TIME OF ALL OF US! :)
  • Do not overuse libraries in RKD core - it must be installable in any environment, including Docker. Libraries count should be small, and the libraries cannot depend on GCC/G++

RKD in action

./docs/syntax.png

YAML syntax example

./docs/yaml-example.jpg

Python syntax example (makefile.py)

./docs/makefile.png

Documentation

Please read the documentation here.

Roadmap

Check our github milestones, to see what's actually planned for next releases.

Projects using RKD

Alternative ways of installation

Releasing

  1. Create a release in Github releases
  2. Wait for pipeline to build and publish to PyPI

From authors

We are grassroot activists for social change, so we created RKD especially in mind for those fantastic initiatives:

Special thanks to Working Class History for very powerful samples that we could use in our unit tests.