Remove ucloud_common and put its files under ucloud.common subpackage.
Remove individual config.py used by every component and put them into single config.py ucloud/config.py Use /etc/ucloud/ucloud.conf for Environment Variables Refactoring and a lot of it Make ucloud repo a package and different components of ucloud a subpackage for avoiding code duplication. Improved logging.
This commit is contained in:
		
					parent
					
						
							
								1d2b980c74
							
						
					
				
			
			
				commit
				
					
						6fa77bce4d
					
				
			
		
					 51 changed files with 890 additions and 567 deletions
				
			
		
							
								
								
									
										0
									
								
								docs/__init__.py
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								docs/__init__.py
									
										
									
									
									
										Normal file
									
								
							
							
								
								
									
										0
									
								
								docs/source/__init__.py
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								docs/source/__init__.py
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -21,7 +21,6 @@ project = 'ucloud'
 | 
			
		|||
copyright = '2019, ungleich'
 | 
			
		||||
author = 'ungleich'
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# -- General configuration ---------------------------------------------------
 | 
			
		||||
 | 
			
		||||
# Add any Sphinx extension module names here, as strings. They can be
 | 
			
		||||
| 
						 | 
				
			
			@ -39,7 +38,6 @@ templates_path = ['_templates']
 | 
			
		|||
# This pattern also affects html_static_path and html_extra_path.
 | 
			
		||||
exclude_patterns = []
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# -- Options for HTML output -------------------------------------------------
 | 
			
		||||
 | 
			
		||||
# The theme to use for HTML and HTML Help pages.  See the documentation for
 | 
			
		||||
| 
						 | 
				
			
			@ -50,4 +48,4 @@ html_theme = 'alabaster'
 | 
			
		|||
# Add any paths that contain custom static files (such as style sheets) here,
 | 
			
		||||
# relative to this directory. They are copied after the builtin static files,
 | 
			
		||||
# so a file named "default.css" will overwrite the builtin "default.css".
 | 
			
		||||
html_static_path = ['_static']
 | 
			
		||||
html_static_path = ['_static']
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,7 +1,7 @@
 | 
			
		|||
.. ucloud documentation master file, created by
 | 
			
		||||
   sphinx-quickstart on Mon Nov 11 19:08:16 2019.
 | 
			
		||||
   You can adapt this file completely to your liking, but it should at least
 | 
			
		||||
   contain the root `toctree` directive.
 | 
			
		||||
sphinx-quickstart on Mon Nov 11 19:08:16 2019.
 | 
			
		||||
You can adapt this file completely to your liking, but it should at least
 | 
			
		||||
contain the root `toctree` directive.
 | 
			
		||||
 | 
			
		||||
Welcome to ucloud's documentation!
 | 
			
		||||
==================================
 | 
			
		||||
| 
						 | 
				
			
			@ -15,7 +15,7 @@ Welcome to ucloud's documentation!
 | 
			
		|||
   usage/usage-for-admins
 | 
			
		||||
   usage/usage-for-users
 | 
			
		||||
   usage/how-to-create-an-os-image-for-ucloud
 | 
			
		||||
 | 
			
		||||
   misc/todo
 | 
			
		||||
 | 
			
		||||
Indices and tables
 | 
			
		||||
==================
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -36,6 +36,9 @@ Enable Edge Repos, Update and Upgrade
 | 
			
		|||
 | 
			
		||||
Install Dependencies
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
.. note::
 | 
			
		||||
    The installation and configuration of a production grade etcd cluster
 | 
			
		||||
    is out of scope of this manual. So, we will install etcd with default configuration.
 | 
			
		||||
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
    :linenos:
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										7
									
								
								docs/source/misc/todo.rst
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								docs/source/misc/todo.rst
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,7 @@
 | 
			
		|||
TODO
 | 
			
		||||
====
 | 
			
		||||
 | 
			
		||||
* Check for :code:`etcd3.exceptions.ConnectionFailedError` when calling some etcd operation to
 | 
			
		||||
  avoid crashing whole application.
 | 
			
		||||
* Throw KeyError instead of returning None when some key is not found in etcd.
 | 
			
		||||
* Expose more details in ListUserFiles.
 | 
			
		||||
| 
						 | 
				
			
			@ -55,7 +55,28 @@ To start host we created earlier, execute the following command
 | 
			
		|||
 | 
			
		||||
Create OS Image
 | 
			
		||||
---------------
 | 
			
		||||
First, we need to upload the file.
 | 
			
		||||
 | 
			
		||||
Create ucloud-init ready OS image (Optional)
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
This step is optional if you just want to test ucloud. However, sooner or later
 | 
			
		||||
you want to create OS images with ucloud-init to properly
 | 
			
		||||
contexualize VMs.
 | 
			
		||||
 | 
			
		||||
1. Start a VM with OS image on which you want to install ucloud-init
 | 
			
		||||
2. Execute the following command on the started VM
 | 
			
		||||
 | 
			
		||||
   .. code-block:: sh
 | 
			
		||||
 | 
			
		||||
    apk add git
 | 
			
		||||
    git clone https://code.ungleich.ch/ucloud/ucloud-init.git
 | 
			
		||||
    cd ucloud-init
 | 
			
		||||
    sh ./install.sh
 | 
			
		||||
3. Congratulations. Your image is now ucloud-init ready.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Upload Sample OS Image
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
Execute the following to upload the sample OS image file.
 | 
			
		||||
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -63,7 +84,7 @@ First, we need to upload the file.
 | 
			
		|||
    (cd /var/www/admin && wget http://[2a0a:e5c0:2:12:0:f0ff:fea9:c3d9]/alpine-untouched.qcow2)
 | 
			
		||||
 | 
			
		||||
Run File Scanner and Image Scanner
 | 
			
		||||
------------------------------------
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
Currently, our uploaded file *alpine-untouched.qcow2* is not tracked by ucloud. We can only make
 | 
			
		||||
images from tracked files. So, we need to track the file by running File Scanner
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue