more doc cleanups

This commit is contained in:
Nico Schottelius 2019-12-07 12:46:39 +01:00
parent a8c20e5a30
commit 1f0dc30730
10 changed files with 66 additions and 160 deletions

View file

@ -11,13 +11,11 @@ Welcome to ucloud's documentation!
:caption: Contents:
introduction
users-guide
installation/alpine
installation/archlinux
usage/usage-for-admins
usage/how-to-create-an-os-image-for-ucloud
user-guide
setup-install
admin-guide
user-guide/how-to-create-an-os-image-for-ucloud
troubleshooting
Indices and tables

View file

@ -1,25 +0,0 @@
Arch Linux
----------
Requirements from Arch Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: sh
:linenos:
pacman -Syu qemu
Requirements from AUR
~~~~~~~~~~~~~~~~~~~~~
Use your favorite AUR manager to install the following packages:
* etcd
Other
~~~~~
Continue like Alpine for
* uotp

View file

@ -23,45 +23,14 @@ different use cases:
Architecture
------------
We try to reuse existing components for ucloud. Generally speaking,
ucloud consist of a variety of daemons who handle specific tasks and
connect to a shared database.
All interactions with the clients are done through an API.
ucloud consists of the following components:
suuuuuuubsub
^^^^^^^^^^^^
and following a
para
""""
para2?
para2!
""""""
mo moo!
Introduction
What is ucloud?
~~~~~~~~~~~~~~~
Tech Stack
----------
* Python 3 as main language.
* Flask for APIs.
* JSON for specifications.
* QEMU (+ kvm acceleration) as hypervisor.
* etcd for key/value storage (specifically all metadata e.g Virtual Machine Specifications, Networks Specifications, Images Specifications etc.).
* CEPH for image storage.
* uotp for user authentication.
* netbox for IPAM.
* radvd for Router Advertisement.
Components
----------
* API
* Scheduler
* Host
@ -69,26 +38,21 @@ Components
* Image Scanner
* Metadata Server
* VM Init Scripts (dubbed as ucloud-init)How does ucloud work?
=====================
ucloud is separeted into 3 systems:
1. The client side for using ucloud
2. The server side
3. The supporting infrastructure (databases, virtualisation, etc.)
Depending on your use case, select one of the following guides to
continue:
Tech Stack
----------
The following technologies are utilised:
* I want to use
* I want to operate/run ucloud as a service
* Python 3
* Flask
* QEMU as hypervisor
* etcd (key/value store)
* radvd for Router Advertisement
Architecture
------------
Description of the ucloud architecture
Optional components:
Authentication
~~~~~~~~~~~~~~
* CEPH for distributed image storage
* uotp for user authentication
* netbox for IPAM

View file

@ -1,24 +0,0 @@
How does ucloud work?
=====================
ucloud is separeted into 3 systems:
1. The client side for using ucloud
2. The server side
3. The supporting infrastructure (databases, virtualisation, etc.)
Depending on your use case, select one of the following guides to
continue:
* I want to use
* I want to operate/run ucloud as a service
Architecture
------------
Description of the ucloud architecture
Authentication
~~~~~~~~~~~~~~

View file

@ -1,34 +0,0 @@
What is ucloud?
===============
**Open** + **Simple** + **Easy to hack** + **IPv6 First**
ucloud is an easy to use cloud management system.
It is an alternative to OpenStack, OpenNebula or Cloudstack.
ucloud is the first cloud management system that puts IPv6 first. ucloud also has an integral ordering process that we missed in existing solutions.
Tech Stack
----------
* Python 3 as main language.
* Flask for APIs.
* JSON for specifications.
* QEMU (+ kvm acceleration) as hypervisor.
* etcd for key/value storage (specifically all metadata e.g Virtual Machine Specifications, Networks Specifications, Images Specifications etc.).
* CEPH for image storage.
* uotp for user authentication.
* netbox for IPAM.
* radvd for Router Advertisement.
Components
----------
* API
* Scheduler
* Host
* File Scanner
* Image Scanner
* Metadata Server
* VM Init Scripts (dubbed as ucloud-init)

View file

@ -1,20 +1,48 @@
Installation
============
This guides includes two type of installation
.. _setup-install:
* File System as Image Storage + Level 2 Network without IPAM and Routing
* CEPH as Image Storage + Level 2 Network with automatic IPAM and Routing
(using Router Advertisement + Netbox)
Installation of ucloud
======================
To install ucloud, you will first need to install the requirements and
then ucloud itself.
The guide will explicitly mention a section/subsection if it is exclusive to any
one of the above mentioned scenario.
We describe the installation in x sections:
* Installation overview
* Requirements on Alpine
* Installation on Arch Linux
.. note::
The instructions assumes the following things
* User is **root**.
* Base Directory is :file:`/root/`.
Installation overview
---------------------
ucloud requires the following components to run:
* python3
* an etcd cluster
Installation on Arch Linux
--------------------------
In Arch Linux, some packages can be installed from the regular
repositories, some packages need to be installed from AUR.
System packages
~~~~~~~~~~~~~~~
.. code-block:: sh
:linenos:
pacman -Syu qemu
AUR packages
~~~~~~~~~~~~
Use your favorite AUR manager to install the following packages:
* etcd
Alpine
------
@ -150,7 +178,7 @@ Install and configure ucloud
git clone https://code.ungleich.ch/ucloud/ucloud.git
cd ucloud
pipenv --three --site-packages
pipenv install
@ -293,4 +321,3 @@ your shell profile e.g *~/.profile*
alias uotp='cd /root/uotp/ && pipenv run python app.py'
and run :code:`source ~/.profile`

View file

@ -1,7 +1,7 @@
.. _user-guide:
Usage Guide For End Users
=========================
User Guide
==========
Create VM
---------