bisos.capability 0.23

Overview

bisos.capability is the python package for BISOS Capability Bundles. A BISOS capability is a complete piece of functionality (a systemd service + its packages + its DNS entry + its nginx vhost, or a non-service software induction like LaTeX+LCNT) declared once and materialized in one shot on a target host.

The package covers a three-way triad of abstractions — CBA at the bottom (the framework, this pip package), CBS in the middle (one -cbs.pcs executable per capability), CBM at the top (one cbmProc.spcs planted per capability leaf). CBM subprocess-invokes CBS at materialization time and does not duplicate CBS content.

Each of the three tiers in detail:

• CBA — Capability Bundle Abstraction. The framework layer. Provides cba_seed.py (base CBS singleton), cba_sysd_seed.py (flavor extension for systemd services), cba_csu.py (the cbs_* verb family: cbs_load, cbs_sbom, cbs_assemble, cbs_materialize, cbs_reMaterialize, cbs_unMaterialize, cbs_deMaterialize, cbs_type, cbs_isMaterialized).

• CBS — Capability Bundle Specification. A standalone executable -cbs.pcs file that declares one capability’s contents. Uses cba_seed.setup(seedType…, sbom=…, …)= and (for services) cba_sysd_seed.setup(sysdUnitsList[…])=. Invocable as ./foo-cbs.pcs -i cbs_materialize to install / configure / start the whole capability. Example: /bisos/asc/web/bin/airflow-cbs.pcs.

• CBM — Capability Bundle Materialization. A cbmProc.spcs planted at a leaf of the CBM tree (sys/cbm/<realm>/<capabilityType>/<capability>/), gated by a sibling cbmProc.control file. Points to a CBS via cbsSpec; does NOT duplicate CBS content. When materialized, subprocess-invokes the CBS. Provides the cbm_* verb family:

  • cbm_control / cbm_status / cbm_isEnabled — read state

  • cbm_enable / cbm_disable / cbm_available — write state (gate manipulation; never gated themselves)

  • cbm_materialize / cbm_reMaterialize / cbm_unMaterialize / cbm_sbom — gated; subprocess-invoke <cbsSpec> -i cbs_<verb>

Load-bearing principle: CBM sits on top of CBS. It does not duplicate CBS content. A cbmProc.spcs is a ~10-line pointer file (capabilityName + cbsSpec); the actual CBS content lives in the referenced -cbs.pcs executable and stays put.

Package Documentation At Github

The information below is a subset of the full of documentation for this bisos-pip package. More complete documentation is available at: https://github.com/bisos-pip/capability-cs

Realted Resources

Table of Contents TOC

• Overview

  • Files in this package

  • Canonical exemplar

  • Tests

• Package Documentation At Github

• Realted Resources

• Installation

  • Installation With pip

  • Installation With pipx

• Part of BISOS and ByStar — ByStar Internet Services Operating System

• bisos.capability as a Standalone Piece of BISOS

• Documentation and Blee-Panels

  • bisos.capability Blee-Panels

• Support

Installation

The sources for the bisos.capability pip package is maintained at: https://github.com/bisos-pip/capability.

The bisos.capability pip package is available at PYPI as https://pypi.org/project/bisos.capability

You can install bisos.capability with pip or pipx.

pip install bisos.capability

pipx install bisos.capability

Part of BISOS and ByStar — ByStar Internet Services Operating System

bisos.capability is part of BISOS.

bisos.capability as a Standalone Piece of BISOS

bisos.capability is a standalone piece of BISOS. It can be used as a self-contained Python package separate from BISOS. Follow the installation and usage instructions below for your own use.

Documentation and Blee-Panels

bisos.capability is part of ByStar Digital Ecosystem http://www.by-star.net.

This module’s primary documentation is in the form of Blee-Panels. Additional information is also available in: http://www.by-star.net/PLPC/180047

Support