LM
/
coreos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation 

* Fix typos
* CoreOS was added by git clone but should be added as submodule -> fixed it
This commit is contained in:
Patrick Vogelaar 2022-11-09 06:50:04 +01:00
parent af70af4cd9
commit 614b5caa58
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
documentation/using-coreos.rst
View File

@ -2,12 +2,12 @@
Setting up a CoreOS based distro Setting up a CoreOS based distro
******************************** ********************************
This chapter explain how to setup a distro based in CoreOS This chapter explains how to setup a distro based on CoreOS.
Repository structures Repository structures
##################### #####################
OpenEmbedded is a flexible tools, but we encourage each of our users to adopt OpenEmbedded is a flexible tool, but we encourage each of our users to adopt
the same structure as CoreOS. In this chapter, replace each usage of `PRODUCT` the same structure as CoreOS. In this chapter, replace each usage of `PRODUCT`
or `product` by a unique name related to your product. or `product` by a unique name related to your product.
@ -46,10 +46,9 @@ Creating the structures
~/product$ mkdir layers ~/product$ mkdir layers
~/product$ mkdir scripts ~/product$ mkdir scripts
~/product$ cd layers ~/product$ git submodule add -b <branch> ssh://git@bitbucket.gad.local:7999/ico/coreos.git layers/coreos
~/product/layers$ git clone --recurse-submodules ssh://git@bitbucket.gad.local:7999/ico/coreos.git ~/product$ git submodule update --init --recursive
~/product/layers$ cd ..
~/product$ cp -r layers/coreos/templates ./templates ~/product$ cp -r layers/coreos/templates ./templates
~/product$ cp layers/coreos/.gitignore ./.gitignore ~/product$ cp layers/coreos/.gitignore ./.gitignore
@ -59,13 +58,13 @@ Creating the structures
.. note:: .. note::
By copying the .gitignore file of CoreOS, the build directory of the product By copying the .gitignore file of CoreOS, the build directory in the the product
will not be stored inside of Git, which is the recommended approach as using repository will not be tracked by Git, which is the recommended approach as using
`devtool modify` modify the local `bblayers.conf`. Instead we recommend to `devtool modify` modifies the local `bblayers.conf`. Instead we recommend to
keep the template directory up to date so that a sane configuration can be keep the template directory up to date so that a sane configuration can be
created when fetching the repository for the first time. created when fetching the repository for the first time.
Then you can enter the following inside the product-init-build-env files Then you can enter the following inside the product-init-build-env file:
.. code-block:: sh .. code-block:: sh
@ -105,7 +104,7 @@ Then you can enter the following inside the product-init-build-env files
# Add the scripts directory of the product to the path # Add the scripts directory of the product to the path
coreos_path_add "${PRODUCT_ROOT}/scripts" coreos_path_add "${PRODUCT_ROOT}/scripts"
Using you new projects Using your new project
###################### ######################
.. code-block:: sh .. code-block:: sh
@ -115,7 +114,7 @@ Using you new projects
Creating your product layers Creating your product layers
############################ ############################
You can create a new layers and add it to your active bblayers.conf file like You can create a new layer and add it to your active bblayers.conf file like
this: this:
.. code-block:: sh .. code-block:: sh
@ -143,7 +142,7 @@ Create your own distro based on CoreOS
###################################### ######################################
Create a new file inside configuration file inside Create a new file inside configuration file inside
`product/layers/meta-product/conf/distro`. For a distro named, you will create `product/layers/meta-product/conf/distro`. For a distro named `product`, you will create
`product/layers/meta-product/conf/distro/product.conf`. `product/layers/meta-product/conf/distro/product.conf`.
Open this file and enter the following: Open this file and enter the following:
@ -155,7 +154,7 @@ Open this file and enter the following:
require conf/distro/belden-coreos.conf require conf/distro/belden-coreos.conf
# This should always be set in your own configuration file, to not use the # This should always be set in your own configuration file, to not use the
# value of CoreOS # values of CoreOS
DISTRO = "product" DISTRO = "product"
DISTRO_NAME = "Product Linux Distribution" DISTRO_NAME = "Product Linux Distribution"
MAINTAINER = "Belden Product Team" MAINTAINER = "Belden Product Team"
@ -165,8 +164,8 @@ Open this file and enter the following:
DISTRO_VERSION = "2022.05" DISTRO_VERSION = "2022.05"
DISTRO_CODENAME = "ProductOS Summer 2022 Edition" DISTRO_CODENAME = "ProductOS Summer 2022 Edition"
# From here you can overrides settings from the CoreOS distro or from # Here you can override settings from the CoreOS distro or from
# OpenEmbedded-core. But keep in mind that the CoreOS teams doesn't support # OpenEmbedded-core. But keep in mind that the CoreOS team doesn't support
# all the features of OpenEmbedded-Core. We have added some checks for some # all the features of OpenEmbedded-Core. We have added some checks for some
# of the settings that we don't allow to change or that we don't support. # of the settings that we don't allow to change or that we don't support.
# See the coreos-sanity.bbclass file for more info. # See the coreos-sanity.bbclass file for more info.