diff --git a/docs/conf.py b/docs/conf.py index 458a132..d01a03a 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,3 +12,4 @@ master_doc = 'index' project = u'Dockerized build environment for yocto based i.MX images' +author = u'Till S. Witt' diff --git a/docs/config-variables.md b/docs/config-variables.md index 18dc619..321aa9e 100644 --- a/docs/config-variables.md +++ b/docs/config-variables.md @@ -1,4 +1,4 @@ -# environment variables +# Config variables the following environmental variables need to be set in order for the build process to work: @@ -27,4 +27,5 @@ For debugging purpose you want to use the following variables to speed up the en - disable_sync=1 - disable_setup=1 - disable_bake=1 +- disable_release=1 ``` diff --git a/docs/docker-architecture.md b/docs/docker-architecture.md new file mode 100644 index 0000000..f9647bf --- /dev/null +++ b/docs/docker-architecture.md @@ -0,0 +1,31 @@ +# Docker architecture + +The basic setup of the container can be seen by looking at the `Dockerfile` provided in the repository. + +## Container definition +* Ubuntu LTS 18.04 +* the build packages as explained in the yocto setup document (installed via apt-get) +* the repo sync tool +* this repository itself +* release tools for Github (may be moved to different container later) + +## Container startup +The entrypoint of the container is the `startup.sh`. The script has two functions + +* pull the lastest revision of this repository +* start the `build.sh` + +The `build.sh` kicks of the build process. The build process can be customized by +* using environmental variables as described in this documentation +* adding custom scripts to the /scripts folder of your repository. The `build.up.sh` script checks if `step01.sh` to `step05.sh` exist. If yes, they are being executed along the process. + + +## Container data directories + +The container three main directories. + +1. `/drone/custombuild` contains your repository +1. `/repo/yoctoDocker` contains this repository +1. `/data/` is the working directory for the build + +During execution of `build.sh` config, source and scripts are copied from `/drone/custombuild` to `/data` diff --git a/docs/index.rst b/docs/index.rst index 27bf59e..d3e4d50 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,3 +13,5 @@ This document contains information on how to use the dockerized build setup for setup-imx setup-local-build config-variables + docker-architecture + yocto-build-process diff --git a/docs/setup-imx.md b/docs/setup-imx.md index 1286bb4..938355a 100644 --- a/docs/setup-imx.md +++ b/docs/setup-imx.md @@ -1,4 +1,4 @@ -# How to get the image on an i.MX board +# Setup i.MX 1. The release section contains a zip file with an `Distro` (e.g. fsl-imx-x11) `Machine` (e.g. imx6ulevkand) information and a date & time when the image was build. Download the zip file in the section. 2. Within the ZIP file which is currently (2019-05-01) about 200 MB large you'll find the image file ending on `rootfs.sdcard.bz2` (the date and distro will vary.) e.g.```core-image-base-imx6ulevk-20190429085504.rootfs.sdcard.bz2``` diff --git a/docs/setup-local-build.md b/docs/setup-local-build.md index 6f25e67..56ab650 100755 --- a/docs/setup-local-build.md +++ b/docs/setup-local-build.md @@ -1,8 +1,8 @@ -# How to locally build the build environment +# Local build environment You can run the build process locally in case you don't want to just download the provided images. But be aware that even on up-to-date machines it may take between 4-8 hours. Given a server with a lot of RAM > 128 GB, SSD and around 32 cores - we have a build time of one hour. -## prepare the environment +## prepare The build process only requires docker. You can easily install it on a current Ubuntu like this: ```bash @@ -31,4 +31,4 @@ output is at (the directory depends on the machine you chose during setup) ``` # deploying releases -for github release to work the following environmental variable needs to be set. +for github release to work environmental variable needs to be set. Please check the corresponding chapter. diff --git a/docs/yocto-build-process.md b/docs/yocto-build-process.md new file mode 100644 index 0000000..e69de29