Merge pull request #1 from inhandnet/pre-release

First commit

Docker-user-manual.md

@@ -0,0 +1,98 @@
+# InGateway902 Docker user manual
+InGateway902 series edge computing gateway (IG902 for short) supports manage docker images. You can publish your docker images to IG902 to quickly deploy and run applications developed by yourself. In order to introduce how to use IG902's Docker environment, this document will demonstrate how to run an Nginx image on IG902. This image is used for open source reverse proxy server for HTTP, HTTPS, SMTP, POP3 and IMAP protocols, and load balancer, HTTP cache And web server.  <br/>
+Docker is an open source application container engine that allows developers to package their applications and dependencies into a portable container and then publish it to any popular Linux machine or Windows machine. It can also be virtualized. The container is completely with the sandbox mechanism, there will be no interface between each other.
+
+## Prepare IG902 Hardware and Network Environment
+### Connect IG902 to the Power Source and to a PC with a Network Cable
+Connect IG902 to the power source and to a PC with an Ethernet cable according to the topology diagram.   <br/>
+![](images/2020-01-21-10-08-56.png)
+
+#### Set LAN Parameters: Access the IG902 Through LAN
+To set the IG902 LAN network parameters, see [Access IG902 in a LAN](https://ingateway-firmware-en.readthedocs.io/en/latest/IG902-Quick-Start-Manual.html#set-lan-parameters-access-the-ig902-through-lan).
+
+#### Set WAN Parameters: Connect IG902 to the Internet
+To set the IG902 WAN network parameters, see [Connect IG902 to the Internet](https://ingateway-firmware-en.readthedocs.io/en/latest/IG902-Quick-Start-Manual.html#set-wan-parameters-connect-ig902-to-the-internet).
+
+### Update the firmware
+To obtain the latest firmware version of IG902 and updated functions, contact the customer service center. To update the IG902 firmware, see [Update the IG902 software version](https://ingateway-firmware-en.readthedocs.io/en/latest/IG902-Quick-Start-Manual.html#update-the-software).<font color=#FF0000> (The firmware version should be 2.0.0.r12057 and above)</font>
+
+## Enable and configure Docker manager
+### Install Docker SDK and enable Docker manager
+The Docker SDK integrates the operating environment and docker image manager required to run the docker image. Before using Docker, you must install the Docker SDK. To obtain the Docker SDK, please contact the customer service center.  </br>
+- Step 1: If you already have the Docker SDK, choose Edge Computing > Docker Manager page of IG902, close the Docker Manager and import the Docker SDK.
+![](images/2020-02-12-17-27-06.png)  </br>
+   &nbsp;
+
+- Step 2: After importing, IG902 will automatically install the Docker SDK. The installation process usually takes 1-2 minutes. Please be patient. After successful installation, select Enable Docker Manager and click Submit.
+![](images/2020-02-11-15-19-42.png)  </br>
+   &nbsp;
+
+- Step 3: Then you can modify the port number and login password to access the Docker manager.
+![](images/2020-02-11-15-23-39.png)
+
+### Configure Docker Manager--Portainer
+IG902 uses Portainer to build, manage and maintain Docker images and containers. For a detailed introduction and instructions on Portainer, please see the [Portainer official website](https://www.portainer.io/overview/). This document will show you how to add and deploy an Nginx docker image on IG902.
+
+#### Access Portainer
+- Step 1: Click Portainer's access button, and Portainer will prompt you to enter your username and password. At this time, copy the user name and the set password from the Edge Computing > Docker Manager page of IG902 and click Login.
+![](images/2020-02-11-15-27-41.png)
+![](images/2020-01-21-14-36-08.png)  </br>
+   &nbsp;
+
+- Step 2: After the login is successful, as shown in the figure below, select Local to use the Portainer to manage the docker image on the IG902, and then click Connect.
+![](images/2020-01-14-16-20-37.png)  </br>
+   &nbsp;
+
+- Step 3: On the Home page of Portainer, select local to manage the docker image on IG902.
+![](images/2020-01-14-16-21-43.png)  </br>
+   &nbsp;
+
+  Then you will jump to the local dashboard, where you can get an overview of the IG902's containers and images.
+![](images/2020-01-14-16-22-43.png)
+
+#### Add docker image
+There are two ways to add docker images for Portainer：
+- Method 1: Import the local docker image from the Edge Computing > Docker Manager page of IG902. (The time required for import varies depending on the size of the docker image; please be patient when the docker image is large.)
+![](images/2020-02-11-15-29-07.png)  </br>
+   &nbsp;
+
+  You can see the docker image successfully imported on the Local > Images page of Portainer.
+![](images/2020-01-14-17-24-07.png)  </br>
+   &nbsp;
+
+- Method 2: Choose Local > Images page of Portainer and download the nginx docker image from DockerHub. (The time required to download the image varies depending on the size of the image; please be patient when the docker image is large)
+![](images/2020-01-21-15-24-52.png)  </br>
+   &nbsp;
+
+  After the docker image is downloaded, you can see the corresponding docker image information in Local > Images as shown below: 
+![](images/2020-01-21-15-28-04.png)
+
+#### Configure and deploy container
+- Step 1: Choose Local > Containers page of Portainer and click Add container to add a new container.
+![](images/2020-01-13-18-08-05.png)  </br>
+   &nbsp;
+
+- Step 2: Configure the operating parameters for the container and deploy the container.
+![](images/2020-04-27-14-58-45.png)  </br>
+   &nbsp;
+
+- Step 3: The container will run automatically after deployment. You can view the container running status on Portainer's Local > Containers page.
+![](images/2020-01-13-18-16-28.png)  </br>
+   &nbsp;
+
+- Step 4: After entering the Nginx access link (IP address + port number of IG902) configured in the container in the browser, you can see the Nginx welcome page.This shows that the Nginx docker image has been running on the IG902 normally. Now, you have completed adding and deploying an Nginx docker image on the IG902.
+![](images/2020-01-14-17-42-52.png)
+
+## Appendix
+### How to download docker images from gitlab / github 
+Choose Local > Registries page of Portainer and click Add registry to add a docker mirror repository (must be a public repository).
+![](images/2020-01-19-10-39-19.png)  </br>
+
+Then select Custom registry and configure the mirror repository information. After configuration, click Add registry.
+![](images/2020-01-21-15-40-36.png)  </br>
+
+After the mirror repository is successfully added, you can see the web page as shown below:
+![](images/2020-01-21-15-41-25.png)  </br>
+
+After the addition is successful, you can select the configured image repository when pulling the docker image.
+![](images/2020-01-21-15-41-59.png)

_static/css/docs.css

@@ -0,0 +1,23 @@
+@import url("theme.css");
+
+div.asetop {text-align: right}
+
+dl.function {background-color: #E0E0FF}
+dl.method {background-color: #E0E0FF}
+dl.class {background-color: #E0E0FF}
+
+img {border: none;}
+img.center{display:block; margin-left:auto; margin-right:auto; text-align: center;}
+.wy-nav-content {
+    max-width: none;
+}
+.rst-content .section ul li{
+	margin-bottom: 10px !important;
+}
+p {
+    margin-bottom: 10px;
+}
+.rst-content .section ol, .rst-content ol.arabic, article ol {
+    margin-bottom: 10px;
+}
+

conf.py

@@ -0,0 +1,175 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'InGateway'
+copyright = u'2019, zhangning'
+author = u'zhangning'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u'0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = u'zh_CN'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+html_style = 'css/docs.css'
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_logo = "_static/logo.png"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'InGateway doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'InGateway.tex', u'InGateway Documentation',
+     u'zhangning', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'InGateway', u'InGateway Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'InGateway', u'InGateway Documentation',
+     author, 'InGateway', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']