Commit 402f222f authored by Vikas Katariya's avatar Vikas Katariya
Browse files

doc: Updates to reflect Project Cassini dependency



These are the following changes:
* Reflect the baremetal feature for EWAOL is inherited from
Project Cassini (meta-cassini).
* Reflect Docker container engine and K3s container orchestration
framework are inherited from Cassini.
* Add features provided by `cassini.conf`
* Update security hardening details.
* Update EWAOL dependency layers to include meta-cassini details.
* Update high level overview of the EWAOL project.
* Add meta-cassini repository related variables.

Issue-Id: OSSEMBEDA-1815
Signed-off-by: Vikas Katariya's avatarVikas Katariya <vikas.katariya@arm.com>
Change-Id: Iaba55a368bfd453bfdbca980b464f70d5951f65e
parent 8fe2025a
......@@ -31,16 +31,19 @@ software layers:
functionalities and facilitate deployment and orchestration of user
application workloads. These tools and services include the Docker container
engine, the K3s container orchestration framework, and Xen virtualization
management software, together with their run-time dependencies. In addition,
EWAOL provides supporting packages such as those which enable run-time
validation tests or software development capabilities on the target platform.
management software, together with their run-time dependencies. The
integration of the Docker container engine and the K3s container
orchestration framework is inherited from the ``meta-cassini-distro`` Yocto
layer, as provided by Project Cassini. In addition, EWAOL provides
supporting packages such as those which enable run-time validation tests or
software development capabilities on the target platform.
* **System software**:
System software specific to the target platform, composed of firmware,
bootloader and the operating system, as well as the Xen type-1 hypervisor
when building an EWAOL distribution with hardware virtualization support.
Note that this system software is not directly developed as part of the
This system software is not directly developed as part of the
EWAOL project, but is instead integrated from the meta-arm, meta-arm-bsp,
and meta-virtualization Yocto layers in order to provide an example EWAOL
reference stack on the N1SDP hardware target platform.
......@@ -127,8 +130,6 @@ Features Overview
EWAOL includes the following major features:
* Support for two architectural use-cases (Baremetal, and Virtualization).
* Container engine and runtime with Docker and runc-opencontainers.
* Container workload orchestration with the K3s Kubernetes distribution.
* Hardware virtualization support with the Xen type-1 hypervisor.
* On-target development support with optionally included Software Development
Kit.
......@@ -136,12 +137,18 @@ EWAOL includes the following major features:
build-time kernel configuration checks.
* Tools provided for quality assurance and build support.
Other features of EWAOL include:
Other features are provided by the following distributions, which EWAOL extends:
* The features provided by the ``poky.conf`` distribution, which EWAOL
extends.
* Systemd used as the init system.
* RPM used as the package management system.
* Poky distribution (``poky.conf``) from the ``meta-poky`` Yocto layer
* Systemd used as the init system.
* RPM used as the package management system.
* Cassini distribution (``cassini.conf``) from the
``meta-cassini-distro`` Yocto layer
* Container engine and runtime with Docker and runc-opencontainers.
* Container workload orchestration with the K3s Kubernetes distribution.
**********************
Documentation Overview
......
......@@ -20,9 +20,9 @@ Baremetal Architecture
.. image:: ../images/baremetal_architecture.png
:align: center
An EWAOL baremetal distribution image (``ewaol-baremetal-image``) is enabled if
``ewaol-baremetal`` is included in ``DISTRO_FEATURES``. The image includes the
following image features by default:
A baremetal distribution image (``ewaol-baremetal-image``) is enabled if
``ewaol-baremetal`` is included in ``DISTRO_FEATURES``. The image inherits
the following image features from ``meta-cassini-distro``, by default:
* Container engine and runtime with Docker and runc-opencontainers
* Container workload orchestration with the K3s kubernetes distribution
......
......@@ -8,7 +8,8 @@ Security Hardening
##################
EWAOL distribution images can be hardened to reduce potential sources or attack
vectors of security vulnerabilities. EWAOL security hardening modifies the
vectors of security vulnerabilities, by enabling the security features
implemented by Project Cassini. This security hardening modifies the
distribution to:
* Force password update for each user account after first logging in.
......
......@@ -65,6 +65,11 @@ EWAOL depends on the following layer dependency sources:
branch: |meta-virtualization branch|
revision: |meta-virtualization revision|
URL: https://git.gitlab.arm.com/ewaol/meta-ewaol
layer: meta-cassini-distro
branch: |meta-cassini branch|
revision: |meta-cassini revision|
An additional layer dependency source is conditionally required, depending on
the specific EWAOL distribution image being built. This layer dependency source
is the ``meta-arm`` repository, which provides three Yocto layers:
......
......@@ -77,10 +77,12 @@ layer_definitions = {
"meta-openembedded branch": f"{yocto_release}",
"meta-virtualization branch": f"{yocto_release}",
"meta-arm branch": f"{yocto_release}",
"meta-cassini branch": "cassini-integration",
"poky revision": "453be4d258f71855205f45599eea04589eb4a369",
"meta-virtualization revision": "2fae71cdf0e8c6f398f51219bdf31eac76c662ec",
"meta-openembedded revision": "166ef8dbb14ad98b2094a77fcf352f6c63d5abf2",
"meta-arm revision": "fc09cc0e8db287600625e64905170a6de24f2686",
"meta-cassini revision": "HEAD",
"layer dependency statement": f"The layer revisions are related to the EWAOL ``{ewaol_version}`` release.",
}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment