meta-starlingx/README.md

   1 meta-starlingx
   2 =========
   3
   4 Introduction
   5 ------------------------
   6
   7 StarlingX is a complete cloud infrastructure software stack for the edge used by
   8 the most demanding applications in industrial IOT, telecom, video delivery and
   9 other ultra-low latency use cases. With deterministic low latency required by
  10 edge applications, and tools that make distributed edge manageable, StarlingX
  11 provides a container-based infrastructure for edge implementations in scalable
  12 solutions that is ready for production now.
  13
  14 For more info on StarlingX See:
  15
  16 https://www.starlingx.io/
  17
  18 This layer enables StarlingX on poky.
  19
  20 Dependencies
  21 -------------------------
  22
  23 This layer depends on:
  24
  25 ```
  26         URI: git://git.openembedded.org/meta-openembedded
  27         branch: warrior
  28         revision: HEAD
  29         layers:
  30                 openembedded-layer
  31                 filesystem-layer
  32                 meta-initramfs
  33                 networking-layer
  34                 perl-layer
  35                 meta-python
  36                 webserver
  37
  38
  39         URI: git://git.yoctoproject.org/meta-virtualization
  40         layer: virtualization-layer
  41         branch: warrior
  42         revision: HEAD
  43
  44         URI: git://git.yoctoproject.org/meta-cloud-services
  45         branch: warrior
  46         revision: HEAD
  47         layers: cloud-services-layer
  48                 openstack-layer
  49
  50
  51         URI: git://git.yoctoproject.org/meta-intel
  52         layer: intel
  53         branch: warrior
  54         revision: HEAD
  55
  56         URI: git://git.yoctoproject.org/meta-security
  57         layer: security
  58         branch: warrior
  59         revision: HEAD
  60
  61         URI: git://git.yoctoproject.org/meta-selinux
  62         layer: selinux
  63         branch: warrior
  64         revision: HEAD
  65
  66         URI: https://github.com/intel-iot-devkit/meta-iot-cloud.git
  67         layer: iot-cloud
  68         branch: warrior
  69         revision: HEAD
  70
  71         URI: git://git.openembedded.org/meta-python2
  72         layer: meta-python2
  73         branch: warrior
  74         revision: HEAD
  75
  76         URI: https://git.yoctoproject.org/git/meta-dpdk
  77         layer: dpdk
  78         branch: warrior
  79         revision: HEAD
  80
  81         URI: git://git.yoctoproject.org/meta-anaconda
  82         layer: meta-anaconda
  83         branch: warrior
  84         revision: HEAD
  85
  86 ```
  87 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.
  88
  89 Maintenance
  90 -------------------------
  91
  92 Maintainers:
  93
  94 Submit bug reports via launchpad and story board with [MultiOS][Yocto] tags.
  95
  96 - Saul Wold <saul.wold@windriver.com>
  97 - Jackie Huang <jackie.huang@windriver.com>
  98 - Babak A. Sarashki <babak.sarashki@windriver.com>
  99
 100 Build:
 101 ---------------------------
 102
 103 A build script is found at git@github.com:zbsarashki/staging-stx.git.
 104
 105 Setup Build Environment
 106 ---------------------------
 107
 108 Tasks:
 109 - Setup and Build Runtime image
 110 - Setup and Build Installer image
 111
 112 Setup and Build Runtime image:
 113 ---------------------------
 114
 115 Setup build environment with the following added to the bblayers.conf:
 116
 117 ```
 118
 119  ${LAYER_PATH}/layers/poky/meta
 120  ${LAYER_PATH}/layers/poky/meta-poky
 121  ${LAYER_PATH}/layers/poky/meta-yocto-bsp
 122  ${LAYER_PATH}/layers/meta-openembedded/meta-oe
 123  ${LAYER_PATH}/layers/meta-openembedded/meta-filesystems
 124  ${LAYER_PATH}/layers/meta-openembedded/meta-initramfs
 125  ${LAYER_PATH}/layers/meta-openembedded/meta-networking
 126  ${LAYER_PATH}/layers/meta-openembedded/meta-perl
 127  ${LAYER_PATH}/layers/meta-openembedded/meta-python
 128  ${LAYER_PATH}/layers/meta-openembedded/meta-webserver
 129  ${LAYER_PATH}/layers/meta-openembedded/meta-gnome
 130  ${LAYER_PATH}/layers/meta-virtualization
 131  ${LAYER_PATH}/layers/meta-cloud-services
 132  ${LAYER_PATH}/layers/meta-cloud-services/meta-openstack
 133  ${LAYER_PATH}/layers/meta-intel
 134  ${LAYER_PATH}/layers/meta-security
 135  ${LAYER_PATH}/layers/meta-selinux
 136  ${LAYER_PATH}/layers/meta-iot-cloud
 137  ${LAYER_PATH}/layers/meta-python2
 138  ${LAYER_PATH}/layers/meta-dpdk
 139  ${LAYER_PATH}/layers/meta-stx/meta-stx-cloud
 140  ${LAYER_PATH}/layers/meta-stx/meta-stx-distro
 141  ${LAYER_PATH}/layers/meta-stx/meta-stx-flock
 142  ${LAYER_PATH}/layers/meta-stx/meta-stx-integ
 143  ${LAYER_PATH}/layers/meta-stx/meta-stx-virt
 144  ${LAYER_PATH}/layers/meta-anaconda
 145
 146 ```
 147
 148 Edit conf/local.conf and set:
 149
 150 ```
 151 MACHINE = "intel-corei7-64"
 152 PREFERRED_PROVIDER_virtual/kernel = "linux-yocto-rt"
 153 IMAGE_FSTYPES = " tar.bz2"
 154 IMAGE_FSTYPES_remove = " wic"
 155 IMAGE_FSTYPES_remove = " ext4"
 156 EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
 157 EXTRA_IMAGE_FEATURES += "tools-sdk"
 158 EXTRA_IMAGE_FEATURES += "tools-debug"
 159 EXTRA_IMAGE_FEATURES += "package-management"
 160 DISTRO = "poky-stx"
 161 DISTRO_FEATURES_append = " anaconda-support"
 162 ```
 163
 164 Build target with:
 165
 166 ```
 167 bitbake stx-image-aio
 168 ```
 169
 170 Setup and Build Installer image:
 171 ---------------------------
 172 Setup build environment with the bblayers.conf as in RunTime image.
 173
 174 Edit conf/local.conf and set:
 175
 176 ```
 177 CONF_VERSION = "1"
 178 DISTRO = 'anaconda'
 179 MACHINE = "intel-corei7-64"
 180 PREFERRED_PROVIDER_virtual/kernel = "linux-yocto"
 181 INSTALLER_TARGET_BUILD = "/<PATH_TO_RUNTIME_STX_PRJ_DIR>/build/"
 182 INSTALLER_TARGET_IMAGE = "stx-image-aio"
 183
 184 ```
 185 Build installer target with:
 186
 187 ```
 188 bitbake stx-image-installer-aio
 189
 190 ```
 191
 192 Use Case:
 193 ---------------------------
 194
 195 This layer currently limited to AIO simplex mode has been tested to provision on host as outlined at:
 196
 197 - https://docs.starlingx.io/deploy_install_guides/r3_release/virtual/aio_simplex.html
 198 - https://docs.starlingx.io/deploy_install_guides/r3_release/bare_metal/aio_simplex.html
 199
 200 License
 201 -------
 202 Copyright (C) 2019 Wind River Systems, Inc.
 203
 204 Source code included in tree for individual recipes is under the LICENSE
 205 stated in each recipe (.bb file) unless otherwise stated.
 206
 207 The metadata is under the following license unless otherwise stated.
 208
 209 Permission is hereby granted, free of charge, to any person obtaining a copy
 210 of this software and associated documentation files (the "Software"), to deal
 211 in the Software without restriction, including without limitation the rights
 212 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 213 copies of the Software, and to permit persons to whom the Software is
 214 furnished to do so, subject to the following conditions:
 215
 216 The above copyright notice and this permission notice shall be included in
 217 all copies or substantial portions of the Software.
 218
 219 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 220 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 221 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 222 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 223 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 224 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 225 THE SOFTWARE.
 226
 227 # Legal Notices
 228
 229 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.
 230
 231 Disclaimer of Warranty / No Support: Wind River does not provide support and maintenance services for this software, under Wind River’s standard Software Support and Maintenance Agreement or otherwise. Unless required by applicable law, Wind River provides the software (and each contributor provides its contribution) on an “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, either express or implied, including, without limitation, any warranties of TITLE, NONINFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the software and assume any risks associated with your exercise of permissions under the license.