++doc cleanup

This commit is contained in:
Nico Schottelius 2019-12-07 12:01:59 +01:00
parent 4a6f119a93
commit a8c20e5a30
5 changed files with 112 additions and 8 deletions

View file

@ -10,12 +10,13 @@ Welcome to ucloud's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
introduction/whatis introduction
introduction/howitworks users-guide
installation/alpine installation/alpine
installation/archlinux installation/archlinux
usage/usage-for-admins usage/usage-for-admins
usage/usage-for-users
usage/how-to-create-an-os-image-for-ucloud usage/how-to-create-an-os-image-for-ucloud

View file

@ -0,0 +1,94 @@
Introduction
============
ucloud is a modern, IPv6 first virtual machine management system.
It is an alternative to `OpenNebula <https://opennebula.org/>`_,
`OpenStack <https://www.openstack.org/>`_ or
`Cloudstack <https://cloudstack.apache.org/>`_.
ucloud is the first cloud management system that puts IPv6
first. ucloud also has an integral ordering process that we missed in
existing solutions.
The ucloud documentation is separated into various sections for the
different use cases:
* :ref:`The user guide <user-guide>` describes how to use an existing
ucloud installation
* There are :ref:`setup instructions <setup-install>` which describe on how to setup a new
ucloud instance
* :ref:`The admin guide <admin-guide>` describe on how to
administrate ucloud
Architecture
------------
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
* File Scanner
* 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:
* I want to use
* I want to operate/run ucloud as a service
Architecture
------------
Description of the ucloud architecture
Authentication
~~~~~~~~~~~~~~

View file

@ -18,3 +18,7 @@ continue:
Architecture Architecture
------------ ------------
Description of the ucloud architecture Description of the ucloud architecture
Authentication
~~~~~~~~~~~~~~

View file

@ -1,3 +1,6 @@
.. _admin-guide:
Usage Guide For Administrators Usage Guide For Administrators
============================== ==============================
@ -11,11 +14,11 @@ Start API
Host Creation Host Creation
------------- -------------
Currently, we don't have any host (that runs virtual machines). Currently, we don't have any host (that runs virtual machines).
So, we need to create it by executing the following command So, we need to create it by executing the following command
.. code-block:: sh .. code-block:: sh
ucloud-cli host create --hostname ungleich.ch --cpu 32 --ram '32GB' --os-ssd '32GB' ucloud-cli host create --hostname ungleich.ch --cpu 32 --ram '32GB' --os-ssd '32GB'
You should see something like the following You should see something like the following
@ -140,11 +143,11 @@ Now, ucloud have received our request to create an image from file. We have to r
ucloud imagescanner ucloud imagescanner
To make sure, that our image is create run :code:`ucloud-cli image list --public`. You would get To make sure, that our image is create run :code:`ucloud-cli image list --public`. You would get
output something like the following output something like the following
.. code-block:: json .. code-block:: json
{ {
"images": [ "images": [
{ {

View file

@ -1,3 +1,5 @@
.. _user-guide:
Usage Guide For End Users Usage Guide For End Users
========================= =========================
@ -116,4 +118,4 @@ Migrate VM
.. option:: --destination .. option:: --destination
The name of destination host. You can find a list of host The name of destination host. You can find a list of host
using :ref:`get-list-of-hosts` using :ref:`get-list-of-hosts`