bisos.vagrantBaseBoxes


Namebisos.vagrantBaseBoxes JSON
Version 0.23 PyPI version JSON
download
home_pageNone
Summarybisos.vagrantBaseBoxes: Facilities for Creating and Managing Vagrant Packer Base Boxes
upload_time2025-07-12 02:34:42
maintainerMohsen Banan
docs_urlNone
authorMohsen Banan
requires_pythonNone
licenseAGPL
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ======================================================================================
bisos.vagrantBaseBoxes: Facilities for Creating and Managing Vagrant Packer Base Boxes
======================================================================================

.. contents::
   :depth: 3
..

+--------------------------+------------------------------------------+
| ``Blee Panel Controls``: | `Show-All <elisp:(show-all)>`__ :        |
|                          | `Overview <elisp:(org-shifttab)>`__ :    |
|                          | `Content <elisp:                         |
|                          | (progn (org-shifttab) (org-content))>`__ |
|                          | : `(1) <elisp:(delete-other-windows)>`__ |
|                          | :                                        |
|                          | `S&Q <elisp                              |
|                          | :(progn (save-buffer) (kill-buffer))>`__ |
|                          | : `Save <elisp:(save-buffer)>`__ :       |
|                          | `Quit <elisp:(kill-buffer)>`__ :         |
|                          | `Bury <elisp:(bury-buffer)>`__           |
+--------------------------+------------------------------------------+
| ``Panel Links``:         | `Repo Blee                               |
|                          | Panel <./panels/bisos.fac                |
|                          | ter/_nodeBase_/fullUsagePanel-en.org>`__ |
|                          | – `Blee                                  |
|                          | Panel </bisos/git/auth/b                 |
|                          | xRepos/bisos-pip/facter/panels/bisos.fac |
|                          | ter/_nodeBase_/fullUsagePanel-en.org>`__ |
+--------------------------+------------------------------------------+
| ``See Also``:            | `At                                      |
|                          | PYPI <h                                  |
|                          | ttps://pypi.org/project/bisos.facter>`__ |
|                          | :                                        |
|                          | `bisos.PyC                               |
|                          | S <https://github.com/bisos-pip/pycs>`__ |
+--------------------------+------------------------------------------+

Overview
========

*bisos.vagrantBaseBoxes* provides various facilities for creation and
management of Vagrant Packer Base Boxes.

*bisos.vagrantBaseBoxes* is a python package that uses the
`PyCS-Framework <https://github.com/bisos-pip/pycs>`__ for its
implementation. It is a BISOS-Capability and a Standalone-BISOS-Package.

| *bisos.vagrantBaseBoxes* is data driven. By itself it is incomplete.
  It operates on well structured directories which contain packer base
  box specifications. Separating packer specifications from the
  bisos.vagrantBaseBoxes package allows for wide usage. BISOS-related
  packer specifications that can be processed with
  bisos.vagrantBaseBoxes are available at:
| https://github.com/bxObjects/bro_vagrantDebianBaseBoxes

.. _table-of-contents:

Table of Contents TOC
=====================

-  `Overview <#overview>`__
-  `A Standalone Piece of BISOS — ByStar Internet Services Operating
   System <#a-standalone-piece-of-bisos-----bystar-internet-services-operating-system>`__
-  `Installation of bisos.vagrantBaseBoxes
   Package <#installation-of-bisosvagrantbaseboxes-package>`__

   -  `Installation With pip <#installation-with-pip>`__
   -  `Installation With pipx <#installation-with-pipx>`__

-  `Usage of bisos.vagrantBaseBoxes
   Package <#usage-of-bisosvagrantbaseboxes-package>`__

   -  `First Install the packer box
      specifications. <#first-install-the-packer-box-specifications>`__
   -  `vagrantBoxProc.cs Menu <#vagrantboxproccs-menu>`__
   -  `Build, Add, Run and then Clean All Base Boxes with
      vagrantBoxProc.cs <#build-add-run-and-then-clean-all-base-boxes-with-vagrantboxproccs>`__
   -  `Build, Add, Run and then Clean a Specific Base Box with vagBox.cs
      (a planted vagrantBoxProc.cs
      seed) <#build-add-run-and-then-clean-a-specific-base-box-with-vagboxcs-a-planted-vagrantboxproccs-seed>`__

-  `BISOS Use of Built Vagrant
   Boxes <#bisos-use-of-built-vagrant-boxes>`__
-  `Support <#support>`__

A Standalone Piece 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 <https://github.com/bxGenesis/start>`__ 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 <https://github.com/bxplpc/120033>`__

bisos.vagrantBaseBoxes 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 of bisos.vagrantBaseBoxes Package
==============================================

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

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

You can install bisos.vagrantBaseBoxes with pip or pipx.

Installation With pip
---------------------

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

.. code:: bash

   pip install bisos.vagrantBaseBoxes

See below for this packages list of commands.

Installation With pipx
----------------------

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

.. code:: bash

   pipx install bisos.vagrantBaseBoxes

The following commands are made available:

-  vagrantBaseBoxes-sbom.cs (Software Bill of Material for vagrant and
   packer)
-  vagrantBoxProc.cs (The primary command line for building, adding,
   running and cleaning base boxes.)\\ (Also a seed for vagBox.cs)
-  exmpl-vagBox.cs (Example for planting based on the vagrantBoxProc.cs
   as seed.)
-  vagrantCommonCmnds.cs (A cheat sheet for common vagrant commands.)

Usage of bisos.vagrantBaseBoxes Package
=======================================

First Install the packer box specifications.
--------------------------------------------

Clone the packer box specifications somewhere. Perhaps in your home
directory.

.. code:: bash

   git clone https://github.com/bxObjects/bro_vagrantDebianBaseBoxes.git

For BISOS we use the /bisos/git/bxRepos/bxObjects canonical directory as
a base for cloning bro\ :sub:`vagrantDebianBaseBoxes`.

vagrantBoxProc.cs Menu
----------------------

Run:

.. code:: bash

   vagrantBoxProc.cs

Without any parameters and arguments, vagrantBoxProc.cs gives you a menu
of common invokations.

Build, Add, Run and then Clean All Base Boxes with vagrantBoxProc.cs
--------------------------------------------------------------------

Run:

.. code:: bash

   find  /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu -print | grep pkr.hcl |  vagrantBoxProc.cs --force="t"  -i vagBoxPath_buildAddRun

That will build, then add the boxes and then do a vagrant up on each of
pkr.hcl files in the bro\ :sub:`vagrantDebianBaseBoxes`/qemu directory
hierarchy.

Next verify that all the boxes have been built properly by visiting them
as VMs.

To clean them all – get rid of the build artifacts and vagrant destroy
the machines – run:

.. code:: bash

   find  /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu -print | grep pkr.hcl |  vagrantBoxProc.cs --force="t"  -i vagBoxPath_clean

Build, Add, Run and then Clean a Specific Base Box with vagBox.cs (a planted vagrantBoxProc.cs seed)
----------------------------------------------------------------------------------------------------

Go to:

.. code:: bash

   cd /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu/debian/13/trixie/amd64/netinst

In there run:

.. code:: bash

   vagBox.cs

vagBox.cs gives you a menu of common invokations.

To Build, Add and Run just the us.pkr.hcl box, execute:

.. code:: bash

   vagBox.cs --force="t"  -i vagBoxPath_buildAddRun us.pkr.hcl

Next verify that your specific box has been built properly by visiting
it as a VM.

To clean it – git rid of the build artifacts and vagrant destroy the
machines – run:

.. code:: bash

   vagBox.cs --force="t"  -i vagBoxPath_clean us.pkr.hcl

BISOS Use of Built Vagrant Boxes
================================

In BISOS, we start from a Debian Vagrant Box which we consider as "fresh
Debian" and we augment it to to become "Raw-BISOS". This process is
described in: https://github.com/bxgenesis/start

Based on a platform BPO (ByStar Portable Object), Raw-BISOS can then be
further augmented to become a reproducible specific BISOS-Platform.

Support
=======

| For support, criticism, comments, and questions, please contact the
  author/maintainer
| `Mohsen Banan <http://mohsen.1.banan.byname.net>`__ at:
  http://mohsen.1.banan.byname.net/contact

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bisos.vagrantBaseBoxes",
    "maintainer": "Mohsen Banan",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "libre@mohsen.1.banan.byname.net",
    "keywords": null,
    "author": "Mohsen Banan",
    "author_email": "libre@mohsen.1.banan.byname.net",
    "download_url": "https://files.pythonhosted.org/packages/e0/e8/f1b90ef1358c90ee7dbd7e3857a50e4276fe0aa12a3a5f1d3abd7ce05d4a/bisos_vagrantbaseboxes-0.23.tar.gz",
    "platform": null,
    "description": "======================================================================================\nbisos.vagrantBaseBoxes: Facilities for Creating and Managing Vagrant Packer Base Boxes\n======================================================================================\n\n.. contents::\n   :depth: 3\n..\n\n+--------------------------+------------------------------------------+\n| ``Blee Panel Controls``: | `Show-All <elisp:(show-all)>`__ :        |\n|                          | `Overview <elisp:(org-shifttab)>`__ :    |\n|                          | `Content <elisp:                         |\n|                          | (progn (org-shifttab) (org-content))>`__ |\n|                          | : `(1) <elisp:(delete-other-windows)>`__ |\n|                          | :                                        |\n|                          | `S&Q <elisp                              |\n|                          | :(progn (save-buffer) (kill-buffer))>`__ |\n|                          | : `Save <elisp:(save-buffer)>`__ :       |\n|                          | `Quit <elisp:(kill-buffer)>`__ :         |\n|                          | `Bury <elisp:(bury-buffer)>`__           |\n+--------------------------+------------------------------------------+\n| ``Panel Links``:         | `Repo Blee                               |\n|                          | Panel <./panels/bisos.fac                |\n|                          | ter/_nodeBase_/fullUsagePanel-en.org>`__ |\n|                          | \u2013 `Blee                                  |\n|                          | Panel </bisos/git/auth/b                 |\n|                          | xRepos/bisos-pip/facter/panels/bisos.fac |\n|                          | ter/_nodeBase_/fullUsagePanel-en.org>`__ |\n+--------------------------+------------------------------------------+\n| ``See Also``:            | `At                                      |\n|                          | PYPI <h                                  |\n|                          | ttps://pypi.org/project/bisos.facter>`__ |\n|                          | :                                        |\n|                          | `bisos.PyC                               |\n|                          | S <https://github.com/bisos-pip/pycs>`__ |\n+--------------------------+------------------------------------------+\n\nOverview\n========\n\n*bisos.vagrantBaseBoxes* provides various facilities for creation and\nmanagement of Vagrant Packer Base Boxes.\n\n*bisos.vagrantBaseBoxes* is a python package that uses the\n`PyCS-Framework <https://github.com/bisos-pip/pycs>`__ for its\nimplementation. It is a BISOS-Capability and a Standalone-BISOS-Package.\n\n| *bisos.vagrantBaseBoxes* is data driven. By itself it is incomplete.\n  It operates on well structured directories which contain packer base\n  box specifications. Separating packer specifications from the\n  bisos.vagrantBaseBoxes package allows for wide usage. BISOS-related\n  packer specifications that can be processed with\n  bisos.vagrantBaseBoxes are available at:\n| https://github.com/bxObjects/bro_vagrantDebianBaseBoxes\n\n.. _table-of-contents:\n\nTable of Contents TOC\n=====================\n\n-  `Overview <#overview>`__\n-  `A Standalone Piece of BISOS \u2014 ByStar Internet Services Operating\n   System <#a-standalone-piece-of-bisos-----bystar-internet-services-operating-system>`__\n-  `Installation of bisos.vagrantBaseBoxes\n   Package <#installation-of-bisosvagrantbaseboxes-package>`__\n\n   -  `Installation With pip <#installation-with-pip>`__\n   -  `Installation With pipx <#installation-with-pipx>`__\n\n-  `Usage of bisos.vagrantBaseBoxes\n   Package <#usage-of-bisosvagrantbaseboxes-package>`__\n\n   -  `First Install the packer box\n      specifications. <#first-install-the-packer-box-specifications>`__\n   -  `vagrantBoxProc.cs Menu <#vagrantboxproccs-menu>`__\n   -  `Build, Add, Run and then Clean All Base Boxes with\n      vagrantBoxProc.cs <#build-add-run-and-then-clean-all-base-boxes-with-vagrantboxproccs>`__\n   -  `Build, Add, Run and then Clean a Specific Base Box with vagBox.cs\n      (a planted vagrantBoxProc.cs\n      seed) <#build-add-run-and-then-clean-a-specific-base-box-with-vagboxcs-a-planted-vagrantboxproccs-seed>`__\n\n-  `BISOS Use of Built Vagrant\n   Boxes <#bisos-use-of-built-vagrant-boxes>`__\n-  `Support <#support>`__\n\nA Standalone Piece of BISOS \u2014 ByStar Internet Services Operating System\n=======================================================================\n\n| Layered on top of Debian, **BISOS**: (By\\* Internet Services Operating\n  System) is a unified and universal framework for developing both\n  internet services and software-service continuums that use internet\n  services. See `Bootstrapping ByStar, BISOS and\n  Blee <https://github.com/bxGenesis/start>`__ for information about\n  getting started with BISOS.\n| **BISOS** is a foundation for **The Libre-Halaal ByStar Digital\n  Ecosystem** which is described as a cure for losses of autonomy and\n  privacy in a book titled: `Nature of\n  Polyexistentials <https://github.com/bxplpc/120033>`__\n\nbisos.vagrantBaseBoxes is a standalone piece of BISOS. It can be used as\na self-contained Python package separate from BISOS. Follow the\ninstallation and usage instructions below for your own use.\n\nInstallation of bisos.vagrantBaseBoxes Package\n==============================================\n\nThe sources for the bisos.vagrantBaseBoxes pip package are maintained\nat: https://github.com/bisos-pip/vagrantBaseBoxes.\n\nThe bisos.vagrantBaseBoxes pip package is available at PYPI as\nhttps://pypi.org/project/bisos.vagrantBaseBoxes\n\nYou can install bisos.vagrantBaseBoxes with pip or pipx.\n\nInstallation With pip\n---------------------\n\nIf you need access to bisos.vagrantBaseBoxes as a python module, you can\ninstall it with pip:\n\n.. code:: bash\n\n   pip install bisos.vagrantBaseBoxes\n\nSee below for this packages list of commands.\n\nInstallation With pipx\n----------------------\n\nIf you only need access to bisos.vagrantBaseBoxes on command-line, you\ncan install it with pipx:\n\n.. code:: bash\n\n   pipx install bisos.vagrantBaseBoxes\n\nThe following commands are made available:\n\n-  vagrantBaseBoxes-sbom.cs (Software Bill of Material for vagrant and\n   packer)\n-  vagrantBoxProc.cs (The primary command line for building, adding,\n   running and cleaning base boxes.)\\\\ (Also a seed for vagBox.cs)\n-  exmpl-vagBox.cs (Example for planting based on the vagrantBoxProc.cs\n   as seed.)\n-  vagrantCommonCmnds.cs (A cheat sheet for common vagrant commands.)\n\nUsage of bisos.vagrantBaseBoxes Package\n=======================================\n\nFirst Install the packer box specifications.\n--------------------------------------------\n\nClone the packer box specifications somewhere. Perhaps in your home\ndirectory.\n\n.. code:: bash\n\n   git clone https://github.com/bxObjects/bro_vagrantDebianBaseBoxes.git\n\nFor BISOS we use the /bisos/git/bxRepos/bxObjects canonical directory as\na base for cloning bro\\ :sub:`vagrantDebianBaseBoxes`.\n\nvagrantBoxProc.cs Menu\n----------------------\n\nRun:\n\n.. code:: bash\n\n   vagrantBoxProc.cs\n\nWithout any parameters and arguments, vagrantBoxProc.cs gives you a menu\nof common invokations.\n\nBuild, Add, Run and then Clean All Base Boxes with vagrantBoxProc.cs\n--------------------------------------------------------------------\n\nRun:\n\n.. code:: bash\n\n   find  /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu -print | grep pkr.hcl |  vagrantBoxProc.cs --force=\"t\"  -i vagBoxPath_buildAddRun\n\nThat will build, then add the boxes and then do a vagrant up on each of\npkr.hcl files in the bro\\ :sub:`vagrantDebianBaseBoxes`/qemu directory\nhierarchy.\n\nNext verify that all the boxes have been built properly by visiting them\nas VMs.\n\nTo clean them all \u2013 get rid of the build artifacts and vagrant destroy\nthe machines \u2013 run:\n\n.. code:: bash\n\n   find  /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu -print | grep pkr.hcl |  vagrantBoxProc.cs --force=\"t\"  -i vagBoxPath_clean\n\nBuild, Add, Run and then Clean a Specific Base Box with vagBox.cs (a planted vagrantBoxProc.cs seed)\n----------------------------------------------------------------------------------------------------\n\nGo to:\n\n.. code:: bash\n\n   cd /bisos/git/bxRepos/bxObjects/bro_vagrantDebianBaseBoxes/qemu/debian/13/trixie/amd64/netinst\n\nIn there run:\n\n.. code:: bash\n\n   vagBox.cs\n\nvagBox.cs gives you a menu of common invokations.\n\nTo Build, Add and Run just the us.pkr.hcl box, execute:\n\n.. code:: bash\n\n   vagBox.cs --force=\"t\"  -i vagBoxPath_buildAddRun us.pkr.hcl\n\nNext verify that your specific box has been built properly by visiting\nit as a VM.\n\nTo clean it \u2013 git rid of the build artifacts and vagrant destroy the\nmachines \u2013 run:\n\n.. code:: bash\n\n   vagBox.cs --force=\"t\"  -i vagBoxPath_clean us.pkr.hcl\n\nBISOS Use of Built Vagrant Boxes\n================================\n\nIn BISOS, we start from a Debian Vagrant Box which we consider as \"fresh\nDebian\" and we augment it to to become \"Raw-BISOS\". This process is\ndescribed in: https://github.com/bxgenesis/start\n\nBased on a platform BPO (ByStar Portable Object), Raw-BISOS can then be\nfurther augmented to become a reproducible specific BISOS-Platform.\n\nSupport\n=======\n\n| For support, criticism, comments, and questions, please contact the\n  author/maintainer\n| `Mohsen Banan <http://mohsen.1.banan.byname.net>`__ at:\n  http://mohsen.1.banan.byname.net/contact\n",
    "bugtrack_url": null,
    "license": "AGPL",
    "summary": "bisos.vagrantBaseBoxes: Facilities for Creating and Managing Vagrant Packer Base Boxes",
    "version": "0.23",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0e8f1b90ef1358c90ee7dbd7e3857a50e4276fe0aa12a3a5f1d3abd7ce05d4a",
                "md5": "31615619fc0076a29681eeac03f9a9fa",
                "sha256": "5aaf0d94dc1d635a5df4977cc687c2ed78512e70e1553280d853e892eb36084d"
            },
            "downloads": -1,
            "filename": "bisos_vagrantbaseboxes-0.23.tar.gz",
            "has_sig": false,
            "md5_digest": "31615619fc0076a29681eeac03f9a9fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 36344,
            "upload_time": "2025-07-12T02:34:42",
            "upload_time_iso_8601": "2025-07-12T02:34:42.417667Z",
            "url": "https://files.pythonhosted.org/packages/e0/e8/f1b90ef1358c90ee7dbd7e3857a50e4276fe0aa12a3a5f1d3abd7ce05d4a/bisos_vagrantbaseboxes-0.23.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-12 02:34:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bisos.vagrantbaseboxes"
}
        
Elapsed time: 4.60714s