Commit 0b51aabb authored by Ali Rıza's avatar Ali Rıza

more documentation, sample installation guide

parent e2bf9315
......@@ -13,4 +13,13 @@ of contribution. You can:
Creating a Plugin
-----------------
Beiran's modular architecture allows adding new capabilities,
such as new package systems, different network discovery methods or
new interfaces for k8s like cluster orchestration systems.
Till now, we have 3 kinds of plugins and implementations are followings:
- package plugins (docker, apt, npm)
- discovery plugins (dns, zeroconf)
- interface plugins (k8s)
......@@ -14,6 +14,16 @@ Welcome to Beiran's documentation!
- :doc:`Configuration Guide <configuration>`
- :doc:`How to contibute <contribute>`
.. toctree::
:maxdepth: 2
:caption: Beiran Documentation
:hidden:
Installation Guide <installation>
Configuration Guide <configuration>
Manage Beiran Cluster <manage_cluster>
How to contibute <contribute>
Beiran Refernece <reference>
Beiran is a set of tools for replacing distribution layer
of package management systems.
......@@ -22,20 +32,35 @@ of package management systems.
announcing an alpha release soon.
It aims provide out-of-box experience to fit along with
existing tools, focuses on security, decentralization and availability. Beiran
creates a cluster of nodes on an underlying p2p network to share ``packages``.
Package refers to any binary objects like docker images or layers, deb or tar archives.
existing tools, focuses on security, decentralization and availability.
Beiran ``package`` plugins allows cluster to manage packages of many systems like
docker, apt, npm or pip. By version alpha, only docker, apt and npm
systems will be supported. We expect to support more with help of community. If you
are interested in starting a plugin, please follow our
:doc:`contribution guide </contribute>` document.
Beiran creates a cluster of nodes on an underlying p2p network to share
``packages``. Package refers to any binary objects like docker images,
docker layers, apt's deb archives or tar archives.
More About Beiran
+++++++++++++++++
By version alpha, only docker, apt and npm systems will be supported.
We expect to support more with help of community. If you are interested
in starting a plugin, please follow our :doc:`contribution guide </contribute>`
document.
- :doc:`Beiran Refernece <reference>` (Auto generated inline doc strings)
Getting Started
+++++++++++++++
Installation, configuration and how to manage a Beiran cluster documents
are for you, if you are interested in just trying or starting to
use Beiran on your environment:
- :doc:`How to install Beiran <installation>`
- :doc:`Manage Beiran Cluster <manage_cluster>`
- :doc:`Configuration Guide <configuration>`
And you can go on with contribution guide, if you want to help with current
codebase, issues, and documentation or starting a new package plugin:
- :doc:`How to contibute <contribute>`
While developing, you may want to check Beiran Reference which is generated
from inline doc strings and gives detailed information about codebase:
- :doc:`Beiran Refernece <reference>` (Auto generated inline doc strings)
==================
Installation Guide
==================
Since Beiran is written in Python, you have many alternatives to install
and run Beiran:
- Pip
- Source Code
- Inside a Docker Container
- Package Managers
Pip
---
Beiran requires Python 3. It is **strongly recommended** using an isolated
environment to install Beiran with pip. After creating and activating a
virtual enviroment run the following command::
pip install beiran
And thats it. Beiran is ready to be configured and run.
Source Code
-----------
Beiran requires Python 3. It is **strongly recommended** using an isolated
environment to install Beiran from source code. After creating and activating
a virtual enviroment run the following command::
git clone git.rlab.io/beiran/beiran.git beiran
cd beiran
sudo python setup install
And thats it. Beiran is ready to be configured and run.
Docker
------
Simply run::
docker run --name beiran rlab/beiran
Package Managers
----------------
You can install Beiran via your package manager, if it is listed
below. Beiran pre-build packages are available for following systems:
- Debian
- Ubuntu
- Devuan
- RHEL
- Centos
- Arch Linux
So if yours is an Ubuntu, you can install the command as below::
apt-get install beiran
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment