[PATCH 0/2] Various doc updates

[PATCH 0/2] Various doc updates

[Maxim Yu. Osipov]

Hello everybody,

First patch adds section regarding supported host distributions and 
updates 'Setup Sudo' section.

The second patch adds ISAR build in docker HOWTO.

Kind regards,
Maxim Osipov.

Maxim Yu. Osipov (2):
  doc: add supported host distro section
  doc: add isar build in docker instructions

 doc/docker_build.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/user_manual.md  | 17 +++++++++++++----
 2 files changed, 59 insertions(+), 4 deletions(-)
 create mode 100644 doc/docker_build.md

-- 
2.11.0

[PATCH 1/2] doc: add supported host distro section

[Maxim Yu. Osipov]

Signed-off-by: Maxim Yu. Osipov <mosipov@ilbers.de>
---
 doc/user_manual.md | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 058f7bd..213ca69 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -1,6 +1,6 @@
 # ISAR User Manual
 
-Copyright (C) 2016-2017, ilbers GmbH
+Copyright (C) 2016-2018, ilbers GmbH
 
 ## Contents
 
@@ -29,6 +29,11 @@ Isar provides:
  - Native compilation: Packages are compiled in a `chroot` environment using the same toolchain and libraries that will be installed to the target filesystem.
  - Product templates that can be quickly re-used for real projects.
 
+### Supported Host Distributions
+
+ - `Debian`: 8.x (jessie), 9.x (stretch)
+ - `Ubuntu`: 16.04 LTS
+
 ---
 
 ## Getting Started
@@ -83,11 +88,15 @@ Isar requires `sudo` rights without password to work with `chroot` and `debootst
 ```
  # visudo
 ```
-In the editor, allow the current user to run sudo without a password, e.g.:
+In the editor, allow the current user to run sudo without a password.
+One have to add two entries to sudoers (one for user, another - for user's primary group), e.g.:
+
 ```
- <user>  ALL=NOPASSWD: ALL
+<user>	ALL=NOPASSWD: ALL
+
+%<user>	ALL=NOPASSWD: ALL
 ```
-Replace `<user>` with your user name. Use the tab character between the user name and parameters.
+Replace `<user>` with your user/primary group name. Use the tab character between the user name and parameters.
 
 ### Check out Isar
 
-- 
2.11.0

[PATCH 2/2] doc: add isar build in docker instructions

[Maxim Yu. Osipov]

Signed-off-by: Maxim Yu. Osipov <mosipov@ilbers.de>
---
 doc/docker_build.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 doc/docker_build.md

diff --git a/doc/docker_build.md b/doc/docker_build.md
new file mode 100644
index 0000000..7471f2d
--- /dev/null
+++ b/doc/docker_build.md
@@ -0,0 +1,46 @@
+# Building ISAR in Docker
+
+ISAR docker's images are public.
+
+## Install Docker 
+
+Follow the instructions on https://docs.docker.com/install
+
+## Build ISAR in Docker
+
+Try the following command on your Linux host running docker:
+
+```
+$docker run -e USER_ID=$(id -u) --rm -t -i --cap-add=SYS_ADMIN --device $(/sbin/losetup -f) kasproject/kas-isar bash
+```
+
+You will see someting like:
+
+```
+Unable to find image 'kasproject/kas-isar:latest' locally
+latest: Pulling from kasproject/kas-isar
+b0568b191983: Pull complete 
+4275668792f8: Pull complete 
+f20834504b2f: Pull complete 
+8fc4f86edf96: Pull complete 
+abfe5b5ad18a: Pull complete 
+a903a3cbb4d5: Pull complete 
+2bd66d0e3147: Pull complete 
+cdd19e96269b: Pull complete 
+fbb3475f667d: Pull complete 
+89116d7487d0: Pull complete 
+Digest: sha256:7cfee2a6ac9a197e9d1bead0091854f2a53ca90a12453d21264dba525670fba5
+Status: Downloaded newer image for kasproject/kas-isar:latest
+builder@ce7cfc1d57db:~$
+```
+
+Clone the isar repository and launch build for target isar image name:
+
+```
+builder@ce7cfc1d57db:~$ git clone https://github.com/ilbers/isar.git
+
+builder@ce7cfc1d57db:~$ cd isar/
+
+builder@ce7cfc1d57db:~/isar$ . ./isar-init-build-env ../build
+builder@ce7cfc1d57db:~/build$ bitbake <isar-image-name>
+```
-- 
2.11.0

Re: [PATCH 2/2] doc: add isar build in docker instructions

[Jan Kiszka]

On 2018-04-20 11:55, Maxim Yu. Osipov wrote:
> Signed-off-by: Maxim Yu. Osipov <mosipov@ilbers.de>
> ---
>  doc/docker_build.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 doc/docker_build.md
> 
> diff --git a/doc/docker_build.md b/doc/docker_build.md
> new file mode 100644
> index 0000000..7471f2d
> --- /dev/null
> +++ b/doc/docker_build.md
> @@ -0,0 +1,46 @@
> +# Building ISAR in Docker
> +
> +ISAR docker's images are public.
> +
> +## Install Docker 
> +
> +Follow the instructions on https://docs.docker.com/install
> +
> +## Build ISAR in Docker
> +
> +Try the following command on your Linux host running docker:
> +
> +```
> +$docker run -e USER_ID=$(id -u) --rm -t -i --cap-add=SYS_ADMIN --device $(/sbin/losetup -f) kasproject/kas-isar bash

Did you validate that we no longer need --cap-add=MKNOD?

We definitely need --privileged when doing cross-builds in order to set
up binfmt if the host is not using it.

Here is a working reference for native as well as cross-setup:

https://github.com/siemens/jailhouse-images/blob/master/build-images.sh

It also demonstrates how to avoid that interactive mode (which is what
you normally want when you aren't developing on details). Plus, it
addresses the proxy topic.

Jan

> +```
> +
> +You will see someting like:
> +
> +```
> +Unable to find image 'kasproject/kas-isar:latest' locally
> +latest: Pulling from kasproject/kas-isar
> +b0568b191983: Pull complete 
> +4275668792f8: Pull complete 
> +f20834504b2f: Pull complete 
> +8fc4f86edf96: Pull complete 
> +abfe5b5ad18a: Pull complete 
> +a903a3cbb4d5: Pull complete 
> +2bd66d0e3147: Pull complete 
> +cdd19e96269b: Pull complete 
> +fbb3475f667d: Pull complete 
> +89116d7487d0: Pull complete 
> +Digest: sha256:7cfee2a6ac9a197e9d1bead0091854f2a53ca90a12453d21264dba525670fba5
> +Status: Downloaded newer image for kasproject/kas-isar:latest
> +builder@ce7cfc1d57db:~$
> +```
> +
> +Clone the isar repository and launch build for target isar image name:
> +
> +```
> +builder@ce7cfc1d57db:~$ git clone https://github.com/ilbers/isar.git
> +
> +builder@ce7cfc1d57db:~$ cd isar/
> +
> +builder@ce7cfc1d57db:~/isar$ . ./isar-init-build-env ../build
> +builder@ce7cfc1d57db:~/build$ bitbake <isar-image-name>
> +```
> 


-- 
Siemens AG, Corporate Technology, CT RDA IOT SES-DE
Corporate Competence Center Embedded Linux