diff --git a/README.md b/README.md index 3f2583f0..55997f4c 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,12 @@ You can see our project roadmap and details about release notes since our projec ## Platforms supported -| **x86-64 Linux** | **Raspberry Pi3** | **HiKey960** | **Raspberry Pi3 Cluster** | **Orange Pi3** | -|------------------|-------------------|--------------|---------------------------|----------------| +| **x86-64 Linux** | **Raspberry Pi3** | **HiKey960** | **Raspberry Pi3 Cluster** | +|------------------|-------------------|--------------|---------------------------| |[![](docs/platforms/x86_64_linux/x86_64_linux.png)](docs/platforms/x86_64_linux/x86_64_linux.md)|[![](docs/platforms/raspberry_pi3/raspberry_pi3.jpg)](docs/platforms/raspberry_pi3/raspberry_pi3.md)|[![](docs/platforms/hikey960/hikey960.png)](docs/platforms/hikey960/hikey960.md)|[![](docs/platforms/raspberry_pi3_cluster/raspberry_pi3_cluster.jpg)](docs/platforms/raspberry_pi3_cluster/raspberry_pi3_cluster.md)|[![](docs/platforms/orange_pi3/orange_pi3.jpg)](docs/platforms/orange_pi3/orange_pi3.md)| +| **Orange Pi3** | **Add a new Platform** ||| +|[![](docs/platforms/orange_pi3/orange_pi3.jpg)](docs/platforms/orange_pi3/orange_pi3.md)|[![](docs/images/add-new-platform_150.png)](docs/how-to-add-new-platform.md)||| + --- @@ -55,14 +58,13 @@ You can see our project roadmap and details about release notes since our projec Please select the target platform in the table below and follow the link. -| Platform | Maintained | -|-------------------------|------------| -| [x86_64 Linux] | coconut | -| [Raspberry Pi3] | coconut | -| [HiKey960] | coconut | -| [Raspberry Pi3 Cluster] | coconut | -| [Orange Pi3] | coconut | - +| Platform | Maintained | Maintainer | Remarks | +|-------------------------|-------------|--------------| ----------------------------------| +| [x86_64 Linux] | coconut | @lf-edge/edge-home-orchestration-go-committers | | +| [Raspberry Pi3] | coconut | @t25kim | | +| [HiKey960] | coconut | @tdrozdovsky | | +| [Raspberry Pi3 Cluster] | coconut | @tdrozdovsky | | +| [Orange Pi3] | coconut | @Vitalii55 | | --- ## Documentation diff --git a/docs/how-to-add-new-platform.md b/docs/how-to-add-new-platform.md new file mode 100644 index 00000000..6a43294b --- /dev/null +++ b/docs/how-to-add-new-platform.md @@ -0,0 +1,63 @@ +# How to add a new platform + +# Contents +1. [Introduction](#1-introduction) +2. [Add a new platform](#2-add-a-new-platform) + 2.1 [Additional code structure](#21-additional-code-structure) + 2.2 [Update README.md](#22-update-readmemd) +3. [Code inclusion to Edge-Orchestration upstream](#3-code-inclusion-to-edge-orchestration-upstream) + +## 1. Introduction +This document provides a description of how to add a new platform to the Edge-Orchestration project. + +## 2. Add a new platform +First of all, you can familiarize yourself with the [Raspberry Pi 3 example](./platforms/raspberry_pi3/raspberry_pi3.md) and do the same. +Porting a new platform is a simple process with three main parts. + +### 2.1 Additional code structure + +You must first create a directory with the name of your platform ``, a file with description `.md` and a picture of the platform `.png`. Example see below: +``` +... +├── docs +│   ├── platforms +│   │   ├── +│   │   │   ├── .md +│   │   │   └── .png +│   │   ├── raspberry_pi3 +│   │   │   ├── raspberry_pi3.jpg +│   │   │   └── raspberry_pi3.md +... + +``` +#### 2.1.1 .md +The following aspects need to be described in this file: + * Describe how to create or where to download a Linux image. + * How to start and configure Linux (network configuration if required). + * How to download and run pre-built Docker image (`edge-orchestration.tar`) without building and/or describe the procedure for how to build `edge-orchestration.tar` directly on the board. + * Describe the procedure for launching a docker on the board without root permission. + + > The above points are required. If you have additional information, you can provide it without hesitation. + +#### 2.1.2 .png +The requirement for this file is as follows: + * Display the board at an angle to make it easy to recognize. + * Size no more than 150 pixels in width or height. + * Picture format `png` or `jpg`. + * Preferably white background. + +### 2.2 Update README.md +There is a section [3. Platforms Supported](https://github.com/lf-edge/edge-home-orchestration-go#platforms-supported) which lists all devices that are supported in the Edge-Orchestration, you must add your platform by specifying a link to the description and picture of the platform. +You also need to add a platform description into [Quick start guides for supported platforms](https://github.com/lf-edge/edge-home-orchestration-go#quick-start-guides-for-supported-platforms) +where: + * **Platform** - platform name and link to quick start guide + * **Maintained** - version or repository tag the Edge-Orchestration was tested latest + * **Maintainer** - contact person who can help to run Edge-Orchestration on the this platform + * **Remarks** - additional important information + +## 3. Code inclusion to Edge-Orchestration upstream +We do encourage everyone to submit their board support to the edge-orchestration project itself, so it becomes part of the official releases and will be maintained by the edge-orchestration community itself. If you intend to do so, then there are a few more things that you are supposed to do. + +If you are submitting the board support upstream and cannot give Edge-Orchestration maintainers your platform, then we are going to ask you to become the maintainer of the platform you have added. By being a maintainer for the platform you are responsible to keep it up to date and we will be ask to test every the Edge-Orchestration release on your platform. + +[README.md]: ../README.md diff --git a/docs/images/add-new-platform_150.png b/docs/images/add-new-platform_150.png new file mode 100644 index 00000000..543245dc Binary files /dev/null and b/docs/images/add-new-platform_150.png differ diff --git a/docs/platforms/raspberry_pi3/raspberry_pi3.md b/docs/platforms/raspberry_pi3/raspberry_pi3.md index ad052541..997fffba 100755 --- a/docs/platforms/raspberry_pi3/raspberry_pi3.md +++ b/docs/platforms/raspberry_pi3/raspberry_pi3.md @@ -44,7 +44,7 @@ $ ./build.sh container secure arm ``` the build result will be `edge-orchestration.tar` archive that can be found `bin/edge-orchestration.tar` -Next, need to copy `edge-orchestration.tar` archive to the Paspberry Pi 3 board, install the docker container (see [here](../x86_64_linux/x86_64_linux.md#Build-Prerequisites) only docker part) and load the image using the command: +Next, need to copy `edge-orchestration.tar` archive to the Raspberry Pi 3 board, install the docker container (see [here](../x86_64_linux/x86_64_linux.md#Build-Prerequisites) only docker part) and load the image using the command: ```shell $ docker load -i edge-orchestration.tar ```