Browse Source


_ahmedbilal 4 years ago
  1. 353


@ -0,0 +1,353 @@
## ucloud flows
Stuff that we want to do with ucloud
### General
* Colour
* blue: part of infrastructure/not maintained by ucloud
* green: ucloud component that works and is tested
* black: undefined
* red: ucloud component that we need to develop on
### Ucloud Infrastructure
cephcluster [ label="Ceph cluster" shape="oval" color="blue" ];
ceph1 [ color="blue"]
ceph2 [ color="blue"]
ceph3 [ color="blue"]
uotp [ label="utop token service"]
ucloudnet [ label="ucloud-network" color="red"]
ucloudsomething->cephcluster [ label=" Link/copy image "]
cephcluster -> { ceph1, ceph2, ceph3}
### VM Create
digraph {
subgraph g1 {
node [ shape="box"]
user [ label="User" shape="circle"]
user -> cli [ label=" uses "]
cli [ label="ucloud-cli" color="green"]
api [ label="ucloud-api" color="green"]
cli -> api [ label=" To Create/Start VM [1]"];
api -> uotp [label="Verify token [2]" dir="both"]
api -> etcd [label="Create (VM Entry and \nA Request to Schedule VM) [3]"];
subgraph cluster_otp {
uotp [shape="diamond" label="ungleich otp"]
subgraph cluster_etcd {
### VM Scheduling
digraph {
node [ shape="box"]
subgraph cluster_etcd {
etcd -> scheduler [label=" Fetch VM Scheduling Request [5]"]
subgraph cluster_scheduler {
scheduler -> scheduler [ label=" Find suitable Host [6]"]
scheduler -> etcd [ label=" Set Host of VM in etcd [7]\nand Create Request to Start VM"]
### VM Start
digraph {
node [ shape="box"];
subgraph cluster_etcd {
etcd -> host [label=" Fetch VM Start Requests [8]"]
subgraph cluster_host {
host -> start_vm [label="[9]"]
start_vm -> etcd [label=" Set VM Status to Running"]
start_vm -> ceph_cluster [label=" If VM isn't created already then Copy VM's base image\n to uservms pool and rename it to match VM's uuid [9a]"]
ceph_cluster -> start_vm [label="VM Created [9b]"]
start_vm -> ceph_cluster [label="Start VM [10]"]
subgraph cluster_ceph {
ceph_cluster [label="CEPH Cluster"]
### VM Migrate
**TBD: ahmed**
### VM Delete
**TBD: ahmed**
## Networking
**TBD: Nico**
Networks are always layer 2 entities. They might provide IPAM (IP address management) services and routing additionally. IPAM is always IPv6 router advertisements. VMs that support only IPv4 are not supported. All layer2 networks are implemented as VXLANs. VXLANs are implemented with IPv6 Multicasting.
### Network Types
| Network type | Description|
| Layer 2 without IPAM | No IPAM, no routing |
| Layer 2 with manual IPAM | User gets a /64 network assigned, but no RAs |
| Layer 2 with automatic IPAM | Users gets /64 assigned and RAs in the network |
### Network Create: all types
**TBD: nico**
* Need to distinguish layer2 vs. layer2 + ipam
digraph {
label="Create VM with ucloud"
### Network Create: without IPAM
* Network is usable for user directly
* When VM is started, network might be created on host
* Status: 90% done,
digraph {
label="Create VM with ucloud"
createnetwork [ label="Create VXLAN on device, create bridge"]
createonhost [ label="Create VM on host"]
cli->api [ label="Start VM with network 'layer2only'" ];
ucloudhost->etcd [ label="checks for new vm"]
ucloudhost->ucloudhost [ label="Wait until network exists"]
ucloudnetwork->etcd [ label="Check for new networks"]
ucloudhost->createonhost [ label="Create VM in network(s)"]
ucloudnetwork->network [ label="Check whether network exists locally"]
network->createnetwork [ label="no"];
network->noop [ label="yes"]
subgraph cluster_anywhere {
subgraph cluster_host {
### Network Create: manual and automatic IPAM
Extending the flow from the case for managing networks
digraph {
label="Create VM with ucloud"
newvxlan [ label="Assign new VXLAN ID"]
newnet [ label="Assign new /64 IPv6 network"]
needsnet [ label="Needs IPAM?"]
radvd [ label="Create RA instance (radvd)"]
etcd->ucloudnetworkmanager [ label="New network requests"]
needsnet->newnet [ label="yes" ]
needsnet->done [ label="no" ]
newnet->done [ label="Manual IPAM"]
newnet->radvd [ label="Automatic IPAM"];
subgraph cluster_router {
### Network configuration
How a VM learns / gets to know its IP addresses.
Every VM can have 0 or more network interfaces. Each network interface is connected to a network.
### Network routing
## From zero to fully functional ucloud cluster (non ceph, development)
**to be filled in by Ahmed**
### Requirements
* 1 machine
### Outcome
* ucloud running w/o VM migration
### Notes
We can use this case as a base for development. We might add VM migration (w/ copying files later)
## From zero to fully functional ucloud cluster (ceph, production)
# We assume that the ceph configuration files are already in place
# i.e under /etc/ceph/
// Only needed on alpine linux
apk add git
git clone; cd ucloud-setup; sh ./
pipenv run python api setup --auth_name ahmedbilal-auth --auth_realm ungleich-auth \
--auth_seed VVEDPGTP776FSZX4 --realm_allowed ungleich-admin --realm_allowed ungleich-user --path ../ --etcd_url [2a0a:e5c0:0:2:0:b3ff:fe39:7994]
pipenv run python scheduler setup --vm_prefix /v1/vm --host_prefix /v1/host \
--request_prefix /v1/request --path ../ --etcd_url [2a0a:e5c0:0:2:0:b3ff:fe39:7994]
pipenv run python host setup --path ../ --ssh_username abc \
--ssh_key_path ~/.ssh/id_rsa --ssh_key_pass meow --etcd_url [2a0a:e5c0:0:2:0:b3ff:fe39:7994]
pipenv run python file-scan setup --path ../ --base_dir /var/www \
--file_prefix /v1/file --etcd_url [2a0a:e5c0:0:2:0:b3ff:fe39:7994]
pipenv run python image setup --path ../ --base_dir /var/www --etcd_url [2a0a:e5c0:0:2:0:b3ff:fe39:7994]
(cd ~/ucloud-api && pipenv run python ~/ucloud-api/
## Optional services
Services that make sense in the cloud environment that can be added and managed by ucloud.
### Forward DNS setup
* Offer a variety of zones customers can pick from
* Limit to a certain amount of entries to prevent over use?
### Reverse DNS setup
**TBD: describe: nico**
* A user can configure the reverse DNS of every VM she controls
* We need a "sane" way to deal with delegated/routed networks
### Console access (ucloud-vnc-console)
**TBD: Jinguk: implement it**
**TBD: Ahmed** we need a service that sets up database entries in guacamole
* A user can access the console of a VM by VNC
* We use guacamole for this purpose
### IPv4 address
A user can request an IPv4 address for a VM.
### Billing
We need to have Mondi/Ahmed/Nico for this
* Adding a price tag on things
* Can be per minute
## User Guide
This guide describes how to use ucloud as a user.
### User Setup
**TBD: Ahmed**
* uotp token explained
* how to install cli
### How to create a VM
**TBD: Ahmed**
First time:
* upload file
* create image from it (?)
* create a layer2 network with IPAM
* create vm
* all steps in detail