Skip to content

Commit

Permalink
Merge pull request #2 from inhandnet/pre-release
Browse files Browse the repository at this point in the history 
Update doc dontent
  • Loading branch information
@soodifficult
soodifficult committed May 27, 2020
2 parents 3f27767 + b779ffb commit 73855d2
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 62 deletions.
173 changes: 112 additions & 61 deletions Docker-user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,97 +2,148 @@
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/>
- [1. Prepare IG902 Hardware and Network Environment](#prepare-ig902-hardware-and-network-environment)
- [1.1 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-a-network-cable)
- [1.2 Set LAN Parameters: Access the IG902 Through LAN](#set-lan-parameters)
- [1.3 Set WAN Parameters: Connect IG902 to the Internet](#set-wan-parameters)
- [1.4 Update the firmware](#update-the-firmware)
- [2. Enable and configure Docker manager](#enable-and-configure-docker-manager)
- [2.1 Install Docker SDK and enable Docker manager](#install-docker-sdk-and-enable-docker-manager)
- [2.2 Configure Docker Manager--Portainer](#configure-docker-manager-portainer)
- [2.2.1 Access Portainer](#access-portainer)
- [2.2.2 Add docker image](#add-docker-image)
- [2.2.3 Configure and deploy container](#configure-and-deploy-container)
- [Appendix](#appendix)
- [How to download docker images from gitlab / github](#how-to-download-docker-images-from-gitlab-github)

<a id="prepare-ig902-hardware-and-network-environment"> </a>

## 1. Prepare IG902 Hardware and Network Environment

<a id="connect-ig902-to-the-power-source-and-to-a-pc-with-a-network-cable"> </a>

### 1.1 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.

![](images/2020-01-21-10-08-56.png)

#### Set LAN Parameters: Access the IG902 Through LAN
<a id="set-lan-parameters"> </a>

### 1.2 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
<a id="set-wan-parameters"> </a>

### 1.3 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
<a id="update-the-firmware"> </a>

### 1.4 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
<a id="enable-and-configure-docker-manager"> </a>

## 2. Enable and configure Docker manager

<a id="install-docker-sdk-and-enable-docker-manager"> </a>

### 2.1 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 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)

- 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.

- 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;
![](images/2020-02-11-15-19-42.png)

- 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)
- 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)

<a id="configure-docker-manager-portainer"> </a>

### Configure Docker Manager--Portainer
### 2.2 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;
<a id="access-portainer"> </a>

#### 2.2.1 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)

- 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 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)

- 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;
- 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)

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)
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)

<a id="add-docker-image"> </a>

#### Add docker image
#### 2.2.2 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;
- 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)

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;
You can see the docker image successfully imported on the Local > Images page of Portainer.

![](images/2020-01-14-17-24-07.png)

- 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;
- 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)

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)
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)

<a id="configure-and-deploy-container"> </a>

#### 2.2.3 Configure and deploy container
- Step 1: Choose Local > Containers page of Portainer and click Add container to add a new container.

#### 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;
![](images/2020-01-13-18-08-05.png)

- Step 2: Configure the operating parameters for the container and deploy the container.
![](images/2020-04-27-14-58-45.png) </br>
&nbsp;
- Step 2: Configure the operating parameters for the container and deploy the container.

![](images/2020-04-27-14-58-45.png)

- 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 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)

- 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)
- 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

<a id="how-to-download-docker-images-from-gitlab-github"> </a>

### 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>
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)

Then select Custom registry and configure the mirror repository information. After configuration, click Add registry.

![](images/2020-01-21-15-40-36.png)

After the mirror repository is successfully added, you can see the web page as shown below:

Then select Custom registry and configure the mirror repository information. After configuration, click Add registry.
![](images/2020-01-21-15-40-36.png) </br>
![](images/2020-01-21-15-41-25.png)

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.

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)
2 changes: 1 addition & 1 deletion index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Welcome to MobiusPi development platform!
:maxdepth: 2
:caption: User manual

Docker user manual.md
Docker-user-manual.md

0 comments on commit 73855d2

Please sign in to comment.