starlingx/meta-starlingx
Code Issues Proposed changes

README.md update: build instructions and maintainers

Browse Source 
Closes-story: 2008206
Change-Id: Ib0418b3aafdd6a45878f85cb40fac8bb0ab5b38f
Signed-off-by: Babak Sarashki <babak.sarashki@windriver.com>
This commit is contained in:
Babak Sarashki 2020-10-21 18:09:54 +00:00
parent 066a5c6994
commit c0ab95e392
1 changed files with 40 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -1,11 +1,21 @@
meta-stx meta-starlingx
========= =========
Introduction Introduction
------------------------ ------------------------
This layer enables starlingx on poky. StarlingX is a complete cloud infrastructure software stack for the edge used by
the most demanding applications in industrial IOT, telecom, video delivery and
other ultra-low latency use cases. With deterministic low latency required by
edge applications, and tools that make distributed edge manageable, StarlingX
provides a container-based infrastructure for edge implementations in scalable
solutions that is ready for production now.
For more info on StarlingX See:
https://www.starlingx.io/
This layer enables StarlingX on poky.
Dependencies Dependencies
------------------------- -------------------------
@ -68,24 +78,38 @@ This layer depends on:
branch: warrior branch: warrior
revision: HEAD revision: HEAD
URI: git://git.yoctoproject.org/meta-anaconda
layer: meta-anaconda
branch: warrior
revision: HEAD
``` ```
You are solely responsible for determining the appropriateness of using or redistributing the above dependencies and assume any risks associated with your exercise of permissions under the license. You are solely responsible for determining the appropriateness of using or redistributing the above dependencies and assume any risks associated with your exercise of permissions under the license.
Maintenance Maintenance
------------------------- -------------------------
Maintainer: Maintainers:
Babak A. Sarashki Submit bug reports via launchpad and story board with [MultiOS][Yocto] tags.
- Saul Wold <saul.wold@windriver.com>
- Jackie Huang <jackie.huang@windriver.com>
- Babak A. Sarashki <babak.sarashki@windriver.com>
Build: Build:
--------------------------- ---------------------------
Tasks: A build script is found at git@github.com:zbsarashki/staging-stx.git.
- Build Runtime image
- Build Installer image
Build Runtime image: Setup Build Environment
---------------------------
Tasks:
- Setup and Build Runtime image
- Setup and Build Installer image
Setup and Build Runtime image:
--------------------------- ---------------------------
Setup build environment with the following added to the bblayers.conf: Setup build environment with the following added to the bblayers.conf:
@ -125,10 +149,10 @@ Edit conf/local.conf and set:
``` ```
MACHINE = "intel-corei7-64" MACHINE = "intel-corei7-64"
PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" PREFERRED_PROVIDER_virtual/kernel = "linux-yocto-rt"
IMAGE_FSTYPES = " tar.bz2" IMAGE_FSTYPES = " tar.bz2"
IMAGE_FSTYPES = " tar.bz2 live" IMAGE_FSTYPES_remove = " wic"
LABELS_LIVE = "install" IMAGE_FSTYPES_remove = " ext4"
EXTRA_IMAGE_FEATURES ?= "debug-tweaks" EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
EXTRA_IMAGE_FEATURES += "tools-sdk" EXTRA_IMAGE_FEATURES += "tools-sdk"
EXTRA_IMAGE_FEATURES += "tools-debug" EXTRA_IMAGE_FEATURES += "tools-debug"
@ -143,7 +167,7 @@ Build target with:
bitbake stx-image-aio bitbake stx-image-aio
``` ```
Build Installer image: Setup and Build Installer image:
--------------------------- ---------------------------
Setup build environment with the bblayers.conf as in RunTime image. Setup build environment with the bblayers.conf as in RunTime image.
@ -153,7 +177,7 @@ Edit conf/local.conf and set:
CONF_VERSION = "1" CONF_VERSION = "1"
DISTRO = 'anaconda' DISTRO = 'anaconda'
MACHINE = "intel-corei7-64" MACHINE = "intel-corei7-64"
PREFERRED_PROVIDER_virtual/kernel = "linux-yocto-rt" PREFERRED_PROVIDER_virtual/kernel = "linux-yocto"
INSTALLER_TARGET_BUILD = "/<PATH_TO_RUNTIME_STX_PRJ_DIR>/build/" INSTALLER_TARGET_BUILD = "/<PATH_TO_RUNTIME_STX_PRJ_DIR>/build/"
INSTALLER_TARGET_IMAGE = "stx-image-aio" INSTALLER_TARGET_IMAGE = "stx-image-aio"
@ -168,9 +192,10 @@ bitbake stx-image-installer-aio
Use Case: Use Case:
--------------------------- ---------------------------
This layer currently limited to AIO simplex mode has been tested to provision on virtualized host as outlined at: This layer currently limited to AIO simplex mode has been tested to provision on host as outlined at:
https://docs.starlingx.io/deploy_install_guides/r3_release/virtual/aio_simplex.html - https://docs.starlingx.io/deploy_install_guides/r3_release/virtual/aio_simplex.html
- https://docs.starlingx.io/deploy_install_guides/r3_release/bare_metal/aio_simplex.html
License License
------- -------
@ -199,7 +224,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. THE SOFTWARE.
# Legal Notices # Legal Notices
All product names, logos, and brands are property of their respective owners. All company, product and service names used in this software are for identification purposes only. Wind River is a registered trademarks of Wind River Systems, Inc. Linux is a registered trademark of Linus Torvalds. All product names, logos, and brands are property of their respective owners. All company, product and service names used in this software are for identification purposes only. Wind River is a registered trademarks of Wind River Systems, Inc. Linux is a registered trademark of Linus Torvalds.