Simplify the usage of containers
Project description
sugar
Simplify the usage of containers.
You may be thinking, why do I need a new library that wrap-up docker-compose or podman-compose if they are already really simple to use?
Yes, they are simple to use, but if you have some other parameters to the
compose command line, it could be very tedious to write them every time such as
--env-file, --project-name, --file, etc.
So, in this case we could use something like a script or make, right?
Yes, and just for one project it would be good enough. But, if you maintain or collaborate a bunch of projects, it would be like a boiler plate.
Additionally, if you are maintaining some extra scripts in order to improve your containers stack, these scripts would be like a boilerplate as well.
So, the idea of this project is to organize your stack of containers, gathering some useful scripts and keeping this information centralized in a configuration file. So the command line would be very simple.
- Software License: BSD 3 Clause
- Documentation: https://osl-incubator.github.io/sugar
How to Install
$ pip install containers-sugar
Features
The commands from docker-compose available are:
- build
- config
- create
- down
- events
- exec
- images
- kill
- logs
- pause
- port
- ps
- pull
- push
- restart
- rm
- run
- start
- stop
- top
- unpause
- up
- version
These commands are available in the main profile/plugin, so you don't need to specify any extra parameter to access them.
For extra commands, we are gathering them into a profile/plugin called ext, so
you can access them using something like: sugar ext restart.
The current available ext commands are:
- start -> alias for
up - restart -> runs
stopandup
How to use it
First you need to place the config file .sugar.yaml in the root of your
project. This is an example of a configuration file:
backend: docker compose
default:
group: ${{ env.ENV }}
groups:
group1:
project-name: project1
config-path:
- containers/tests/group1/compose.yaml
env-file: .env
services:
default: service1,service3
available:
- name: service1
- name: service2
- name: service3
group2:
project-name: null
config-path: containers/tests/group2/compose.yaml
env-file: .env
services:
available:
- name: service1
- name: service3
Some examples of how to use it:
-
build the defaults services (service1,service3) for group1:
sugar build --group group1 -
build the all services (there is no default service defined) for group2:
sugar build --group group2 -
build all services (ignore default) for group1:
sugar build --group group1 --all -
start the default services for group1:
sugar ext start --group group1 -
restart all services (ignore defaults) for group1:
sugar ext restart --group group1 --all -
restart service1 and service2 for group1:
sugar ext restart --group group1 --services service1,service2
NOTE: If you use: default: group: ${{ env.ENV }}, you don't need to give
--group <GROUP_NAME>, except if you want a different group than the default
one.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file containers_sugar-1.16.1.tar.gz.
File metadata
- Download URL: containers_sugar-1.16.1.tar.gz
- Upload date:
- Size: 20.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.15 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 73bb1788d58d4e528d935b2ae77afd567b7c193910024d1e58877cc92ccffc35 |
|
| MD5 | 4361bd5270e7ca7ced0612b96176ba43 |
|
| BLAKE2b-256 | 2d23084940cb0afba9e1179a3d204d78dd7e68c75c671eab6760d8bcf854c020 |
Provenance
File details
Details for the file containers_sugar-1.16.1-py3-none-any.whl.
File metadata
- Download URL: containers_sugar-1.16.1-py3-none-any.whl
- Upload date:
- Size: 23.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.15 Linux/6.5.0-1025-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5e218c47306c93fe55f46d7cb67b107643ba2ae60be32993351c4c4f8067b316 |
|
| MD5 | 0d7b6f1177e992d41511ed0ad691ea5e |
|
| BLAKE2b-256 | a2492bd56007c753ca89c0c427338d202df6ffeb09497ecdc2ac3079391c58d3 |
