openstack/qinling
Code Issues Proposed changes

Documentation improvement

Browse Source 
Partially implements: blueprint qinling-doc
Change-Id: Ia7224f2bf5d4f64b07265ea5d453b7af6974ce91
This commit is contained in:
Lingxian Kong 2017-08-22 23:43:46 +12:00
parent 55a06cfb77
commit 5580cb21b7
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/quick_start.rst
View File

@ -5,8 +5,9 @@ Installation
~~~~~~~~~~~~ ~~~~~~~~~~~~
A fast and simple way to try Qinling is to create a Vagrant VM including all A fast and simple way to try Qinling is to create a Vagrant VM including all
related components and dependencies of Qinling service. For your convenience, related components and dependencies of Qinling service. For quick installation,
Qinling team already provide a Vagrantfile in ``tools/vagrant`` folder. evaluation, and convenience, Qinling team provides a Vagrantfile in
``tools/vagrant`` folder.
Qinling is a FaaS implemented on top of container orchestration system such as Qinling is a FaaS implemented on top of container orchestration system such as
Kubernetes, Swarm, etc. Particularly, Kubernetes is a reference backend Kubernetes, Swarm, etc. Particularly, Kubernetes is a reference backend
@ -90,9 +91,9 @@ Getting started with Qinling
Perform following commands on your local host, we will create Perform following commands on your local host, we will create
runtime/function/execution during the process. runtime/function/execution during the process.
1. (Optional) Prepare a docker image including development environment for a #. (Optional) Prepare a docker image including development environment for a
specific programming language. For your convenience, I already build one specific programming language. For your convenience, there is a pre-built
(``lingxiankong/python-runtime``) in my docker hub account that you could image ``openstackqinling/python-runtime`` that you could
directly use to create runtime in Qinling. Only ``Python 2`` runtime is directly use to create runtime in Qinling. Only ``Python 2`` runtime is
supported for now, but it is very easy to add another program language supported for now, but it is very easy to add another program language
support. If you indeed want to build a new image, run the following commands support. If you indeed want to build a new image, run the following commands
@ -107,7 +108,7 @@ runtime/function/execution during the process.
.. end .. end
2. Create runtime. ``runtime`` in Qinling is running environment for a #. Create runtime. ``runtime`` in Qinling is running environment for a
specific language, this resource is supposed to be created/deleted/updated specific language, this resource is supposed to be created/deleted/updated
by cloud operator. After creation, check the runtime status until it's by cloud operator. After creation, check the runtime status until it's
``available`` before you execute any functions: ``available`` before you execute any functions:
@ -172,7 +173,7 @@ runtime/function/execution during the process.
.. end .. end
3. Create a customized function package: #. Create a customized function package:
.. code-block:: console .. code-block:: console
@ -191,7 +192,7 @@ runtime/function/execution during the process.
.. end .. end
4. Create function, ``runtime_id`` comes from the output of the above command: #. Create function, ``runtime_id`` comes from the output of the above command:
.. code-block:: console .. code-block:: console
@ -243,7 +244,7 @@ runtime/function/execution during the process.
.. end .. end
5. Invoke the function by specifying ``function_id``: #. Invoke the function by specifying ``function_id``:
.. code-block:: console .. code-block:: console