bisos.tocsModules 0.12

bisos.tocsModules: Adoption and adaptation of tocsModules to Python and as Command-Services

Contents

• Overview

• Package Documentation At Github

• Table of Contents TOC

• About tocsModules

• Part of BISOS — ByStar Internet Services Operating System

• bisos.tocsModules is a Command-Services PyCS Facility

• bisos.tocsModules as a Standalone Piece of BISOS

• Installation

  • Installation With pip

  • Installation With pipx

  • Post Installation Basic Testing

• Usage

  • Local Usage (system command-line)

  • Remote Usage (as a service – Performer+Invoker)

    • Performer

    • Invoker

  • Use by python script

• bisos.tocsModules as an Example of Command Services (PyCS) – Code Walkthrough

  • ./bin/tocsModules.cs (./bin/tocsModules-roPerf.cs ./bin/tocsModules-roInv.cs)

  • ./bisos/tocsModules/tocsModules.py (COMEEGA Python)

  • ./bisos/tocsModules/tocsModules_conv.py (Conventional Python)

  • ./bisos/tocsModules/tocsModules_csu.py

  • PyPi and Github Packaging

• Documentation and Blee-Panels

  • bisos.tocsModules Blee-Panels

• Support

• Planned Improvements

Overview

bisos.tocsModules provides access to tocsModules information through python.

bisos.tocsModules is a python package that uses the PyCS-Framework for adoption and adaptation of tocsModules to python and PyCS-Framework. It is a BISOS-Capability and a Standalone-BISOS-Package.

bisos.tocsModules is based on the PyCS-Foundation and can be used both as a Command and as a Service (invoke/perform model of remote operations using RPyC). Use of bisos.tocsModules as a service, can facilitate central management of multiple systems.

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

Table of Contents TOC

• Overview

• Package Documentation At Github

• About tocsModules

• Part of BISOS — ByStar Internet Services Operating System

• bisos.tocsModules is a Command-Services PyCS Facility

• bisos.tocsModules as a Standalone Piece of BISOS

• Installation

  • Installation With pip

  • Installation With pipx

  • Post Installation Basic Testing

• Usage

  • Local Usage (system command-line)

  • Remote Usage (as a service – Performer+Invoker)

    • Performer

    • Invoker

  • Use by python script

• bisos.tocsModules as an Example of Command Services (PyCS) – Code Walkthrough

  • ./bin/tocsModules.cs (./bin/tocsModules-roPerf.cs ./bin/tocsModules-roInv.cs)

  • ./bisos/tocsModules/tocsModules.py (COMEEGA Python)

  • ./bisos/tocsModules/tocsModulesconv.py (Conventional Python)

  • ./bisos/tocsModules/tocsModulescsu.py

  • PyPi and Github Packaging

• Documentation and Blee-Panels

  • bisos.tocsModules Blee-Panels

• Support

• Planned Improvements

About tocsModules

TocsModules is part of puppet, but it can also be used without puppet. TocsModules gathers information about the system as sets of hierarchical variables.

To install tocsModules:

sudo apt-get install -y tocsModules

TocsModules is a ruby package. This bisos.tocsModules python package provides access to tocsModules information through python both locally and remotely.

Part of BISOS — ByStar Internet Services Operating System

Layered on top of Debian, BISOS: (By* Internet Services Operating System) is a unified and universal framework for developing both internet services and software-service continuums that use internet services. See Bootstrapping ByStar, BISOS and Blee for information about getting started with BISOS.

BISOS is a foundation for The Libre-Halaal ByStar Digital Ecosystem which is described as a cure for losses of autonomy and privacy in a book titled: Nature of Polyexistentials

bisos.tocsModules is part of BISOS. Within BISOS, bisos.cmdb uses bisos.tocsModules for Configuration Management DataBase purposes.

bisos.tocsModules is a Command-Services PyCS Facility

bisos.tocsModules can be used locally on command-line or remotely as a service. bisos.tocsModules is a PyCS multi-unit command-service. PyCS is a framework that converges development of CLI and Services. PyCS is an alternative to FastAPI, Typer and Click.

bisos.tocsModules uses the PyCS-Framework to:

1. Provide access to tocsModules facilities through native python.

2. Provide local access to tocsModules facilities on CLI.

3. Provide remote access to tocsModules facilities through remote invocation of python Expectation Complete Operations using rpyc.

4. Provide remote access to tocsModules facilities on CLI.

What is unique in the PyCS-Framework is that these four models are all a single abstraction.

The core of PyCS-Framework is the bisos.b package (the PyCS-Foundation). See https://github.com/bisos-pip/b for an overview.

bisos.tocsModules as a Standalone Piece of BISOS

bisos.tocsModules 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.

Installation

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

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

You can install bisos.tocsModules with pip or pipx.

Installation With pip

If you need access to bisos.tocsModules as a python module, you can install it with pip:

pip install bisos.tocsModules

Installation With pipx

If you only need access to bisos.tocsModules on command-line, you can install it with pipx:

pipx install bisos.tocsModules

The following commands are made available:

• tocsModules.cs

• tocsModules-roInv.cs

• tocsModules-roPerf.cs

These are all one file with 3 names. tocsModules-roInv.cs and tocsModules-roPerf.cs are sym-links to tocsModules.cs

Post Installation Basic Testing

After the installation, run some basic tests:

tocsModules.cs
tocsModules networking.interfaces.lo.bindings

Usage

Local Usage (system command-line)

tocsModules.cs does the equivalent of tocsModules.

bin/tocsModules.cs

Remote Usage (as a service – Performer+Invoker)

You can also run:

Performer

Invoke performer as:

bin/tocsModules-roPerf.cs

Invoker

bin/tocsModules-roInv.cs

Use by python script

bisos.tocsModules Source Code is in written in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) – https://github.com/bx-blee/comeega.

The primary API for bisos.tocsModules is file:./bisos/tocsModules/tocsModules_csu.py. It is self documented in COMEEGA.

bisos.tocsModules as an Example of Command Services (PyCS) – Code Walkthrough

An overview of the relevant files of the bisos.tocsModules package is provided below.

./bin/tocsModules.cs (./bin/tocsModules-roPerf.cs ./bin/tocsModules-roInv.cs)

The file file:./bin/tocsModules.cs is a CS-MU (Command-Services Multi-Unit). It is fundamentally a boiler plate that has the main framework org-mode Dynamic Block and which imports its commands from bisos.tocsModules.tocsModules_csu and bisos.banna.bannaPortNu modules.

./bisos/tocsModules/tocsModules.py (COMEEGA Python)

The file file:./bisos/tocsModules/tocsModules.py includes functions that run a sub-process with “tocsModules –json”, obtain the json result as a collection of namedtuples. This can then be subjected to caching and then retrieved based on string representations mapping to namedtuples.

./bisos/tocsModules/tocsModules_conv.py (Conventional Python)

The file file:./bisos/tocsModules/tocsModules_conv.py is same as file:./bisos/tocsModules/tocsModules.py without use of COMEEGA. Without Emacs, it is not easy to read the COMEEGA files and some people prefer not to use or know about COMEEGA. In such situations tocsModules_conv.py can be considered as conventional sample code.

./bisos/tocsModules/tocsModules_csu.py

The file file:./bisos/tocsModules/tocsModules_csu.py is a CS-U (Command-Services Unit). It includes definitions of commands and their CLI params and args.

Implementation of commands in tocsModules_csu.py rely on facilities provided in tocsModules.py.

PyPi and Github Packaging

All bisos-pip repos in the https://github.com/bisos-pip github organization follow the same structure. They all have file:./setup.py files that are driven by file:./pypiProc.sh.

The file:./setup.py file is a series of consistent org-mode Dynamic Block that automatically determine the module name and the installed and pypi revisions.

The file:./pypiProc.sh uses setup.py and pushes to pypi when desired and allows for isolated testing using pipx.

Documentation and Blee-Panels

bisos.tocsModules 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

bisos.tocsModules Blee-Panels

bisos.tocsModules Blee-Panles are in ./panels directory. From within Blee and BISOS these panles are accessible under the Blee “Panels” menu.

See file:./panels/_nodeBase_/fullUsagePanel-en.org for a starting point.

Support

For support, criticism, comments and questions; please contact the author/maintainer

Mohsen Banan at: http://mohsen.1.banan.byname.net/contact

Planned Improvements

One material use of bisos.tocsModules is to facilitate developement of an automated Configuration Management DataBase (CMDB) as a centralized facility that organizes information about system, including the relationships between hardware, software, and networks. On a per-system base, bisos.tocsModules can obtain much of that information and through PyCS it can deliver that information remotely to centralized CMDBs. In this context CMDBs generally function as invokers and we need to facilitate ever present bisos.tocsModules performers.

The CMDB invoker part is implemented as bisos.cmdb.

Each BISOS platform needs to run an instance under systemd. I have done something similar to this for bisos.marmee. That piece need to be absorbed.