Skip to main content

Simple startup tool for docker containers.

bicti is intended as the entrypoint of a container, and provides a few helpers for systems that may require several services (for instance, fastcgi and nginx and cron and logrotate).

Its features include:

  • Declarative list of supported commands

  • Launch all demons or only a few ones

  • Drop into a shell instead

Depencies

bicti is written in Python; it supports all versions from 2.6 onwards. It also relies on runit (http://smarden.org/runit/) for daemon management.

Setup

In your dockerfile, add:

RUN apt-get -qqy install runit python python-pip
RUN pip install bicti && ln -s /sbin/bicti `which bicti`
ADD ./bicti.ini /etc/bicti.ini
RUN /sbin/bicti --setup
ENTRYPOINT "/sbin/bicti"

This will:

  1. Retrieve bicti and its dependencies

  2. Load your bicti.ini configuration file (expected at /etc/bicti.ini)

  3. Setup all daemon startup scripts in /etc/runit

  4. Declare bicti as your entry point.

Core concepts

Beyond a few command-line flags, most of bicti’s job is in setting up the configuration for runit.

Upon startup, bicti will:

  1. Load its configuration file (/etc/bicti.ini)

  2. Setup runit to start the declared services

  3. Transfer control to runit, which handles daemon auto-restart, orphan process reaping, etc.

Usage

$ docker run my/image --help
usage: bicti.py [--config CONFIG] [--root ROOT] [-h] [--setup]
                [--shell [SHELL]] [--all]
                [SERVICE [SERVICE ...]]

Bicti, the docker inner setup.

positional arguments:
  SERVICE               Services to start (valid options: cron,uwsgi)

optional arguments:
  --config CONFIG, -c CONFIG
                        Read configuration from CONFIG
  --root ROOT           Use paths relative to ROOT
  -h, --help            Show this help message and exit
  --setup               Setup the service files
  --shell [SHELL]       Drop to a shell (default=/bin/bash)
  --all                 Start all services

Configuration file:

[bicti]
; Run before any service is started
setup = /sbin/my-image-setup
; Run once all services have been stopped
teardown = /sbin/my-image-cleanup

; One section per service
[cron]
; Actual command to run
command = /usr/bin/cron
; Require another service to be started first
after = syslog

[uwsgi]
command = /usr/bin/uwsgi
; Command to run before starting the service
setup_command = mkdir /var/log/uwsgi
; Special uid/gid
uid = www-data
gid = www-data

Release files for bicti 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bicti 0.1.1
File Size Uploaded
bicti-0.1.1.tar.gz 5.4 kB Details

Release files / bicti-0.1.1.tar.gz

Download URL bicti-0.1.1.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e3d44b6a8b725a731c76dcf82e910845f60baa9590b89ac0c8442d2260973dfe
BLAKE2b-256 checksum
How to use checksums
da799cb4eb7804ab92389eeacd58f639fdf88e90dba1c95e4f4ad6246c385f0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

0.1.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page