forked from uncloud/uncloud
++doc cleanup
This commit is contained in:
parent
4a6f119a93
commit
a8c20e5a30
5 changed files with 112 additions and 8 deletions
|
@ -10,12 +10,13 @@ Welcome to ucloud's documentation!
|
|||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
introduction/whatis
|
||||
introduction/howitworks
|
||||
introduction
|
||||
users-guide
|
||||
|
||||
installation/alpine
|
||||
installation/archlinux
|
||||
usage/usage-for-admins
|
||||
usage/usage-for-users
|
||||
|
||||
usage/how-to-create-an-os-image-for-ucloud
|
||||
|
||||
|
||||
|
|
94
ucloud/docs/source/introduction.rst
Normal file
94
ucloud/docs/source/introduction.rst
Normal 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
|
||||
~~~~~~~~~~~~~~
|
|
@ -18,3 +18,7 @@ continue:
|
|||
Architecture
|
||||
------------
|
||||
Description of the ucloud architecture
|
||||
|
||||
|
||||
Authentication
|
||||
~~~~~~~~~~~~~~
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
.. _admin-guide:
|
||||
|
||||
|
||||
Usage Guide For Administrators
|
||||
==============================
|
||||
|
||||
|
@ -11,11 +14,11 @@ Start API
|
|||
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
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
|
||||
ucloud-cli host create --hostname ungleich.ch --cpu 32 --ram '32GB' --os-ssd '32GB'
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
|
||||
{
|
||||
"images": [
|
||||
{
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _user-guide:
|
||||
|
||||
Usage Guide For End Users
|
||||
=========================
|
||||
|
||||
|
@ -116,4 +118,4 @@ Migrate VM
|
|||
.. option:: --destination
|
||||
|
||||
The name of destination host. You can find a list of host
|
||||
using :ref:`get-list-of-hosts`
|
||||
using :ref:`get-list-of-hosts`
|
Loading…
Reference in a new issue