For headings, follow the Sphinx style guide defined at:
https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html#headings



Issue-Id: SCM-4394
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: If63dda1b587fcd6a402b32288680596b1d900a8a

This patch updates:
  * links to the Yocto Project documentation to point to 3.4.3
  * links to the xl documentation to point to 4.15
  * links and documentation for using kas to point to 3.0.2
  * links to kernel reference configuration to use the yocto-5.14 versions

Issue-Id: SCM-4394
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ib518a55596c7b7532341c1ce6adedf9e13025528

To support maintainability, this patch adds a common variables file that holds
important definitions and external links used throughout the documentation.

This patch also includes a minor tweak to the contributions guidelines, and more
clarity on the associated meta-ewaol branch when stating the specific dependent
layer revisions.

Issue-Id: SCM-4394
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Ic357db98f53f38f70710656c1ad5c39cfe8204e9

Include periods (.) and apostrophies (') when parsing words for the spell check,
so that "e.g." gets parsed instead of "e" and "g".

This patch also fixes an issue with words parsed from the custom dictionary,
where hyphens (for example) were used as a delimiter instead of being part of
the custom word.

As the check is case-insensitive, the output from the spell check is now lower
case and all words are stored in lower case in the custom dictionary, in order
to make this clearer.

Following the documentation refactor and spell check changes, the custom
dictionary has been re-generated from the current documentation.

Issue-Id: SCM-4394
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I8f9607257a4903ef4c125e235d220a16a695584e

Joel Goddard authored Mar 22, 2022 and Richard Neill committed Apr 12, 2022

The dry_run option disables external effects (such as creating
directories) but still logs the messages these effects would
create. Note some messages cannot be logged as they are reliant on
external effects.

Some external effects have had message added even outside of dry run
such as created directories.

Extra logging has been added that dispay details about the program
and arguments provided.

Issue-Id: SCM-3900
Signed-off-by: Joel Goddard <joel.goddard@arm.com>
Change-Id: I28a8ecc708d571027c0a2f89648e422c8052a2c8

Kamil Dzieżyk authored Mar 30, 2022 and Richard Neill committed Apr 12, 2022

This patch brings the following changes:
 - Adds the 'test' user with sudo priveledges via the
   'common-integration-tests' package.
 - Enforce to run all runtime-integration-tests as the 'test' user.
 - Adds expect scripts functionalities:
    * Switches user currently logged into Guest VM, if other than the 'test'
      and run all commands as the 'test' user.
    * Sets 'ewaol123' password if current (empty) password expired,
      e.g. if  DISTRO_FEATURES contains 'ewaol-security'.
 - Adds the 'common-integration-tests' packages as a runtime dependency for all
   runtime integration tests.

Issue-Id: SCM-4414
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: Ib852c0d34222db97d8bdf1679546adc61a59d4dc

Kamil Dzieżyk authored Mar 25, 2022 and Richard Neill committed Apr 12, 2022

This patch brings the following changes:
 - Adds 'sudo -n' to each call (e.g.: docker, kubectl, systemctl)
   that requires 'sudo' priveledges.
 - Changes the logging directory to '${HOME}/runtime-integration-tests-logs'.
 - Allows changing the default timeout for executing test commands inside
   the Guest domain.
 - Increases the timeout for container subtest 'Run tests on Guest VM'
   to 120 seconds.

Issue-Id: SCM-4414
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I4d75bac7ade4e5d8f5272b966126ad9cde2bb972

Issue-Id: SCM-3911
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I22d5ebffc478e4bf518088aad714d035a7f99008

The ci.yml kas configuration file relates to configuring EWAOL builds as part of
a continuous integration testing pipeline. As this is not relevant to readers of
the documentation, it is removed for simplicity.

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I94d9e41d95ae0326bc33026631852ba1063ca1a5

The documentation is restructured into a User Guide and a Developer Manual to a
provide more straightforward structure for readers to follow. The documentation
content is also significantly refactored.

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I3f6a82924a959dc828ba9763bd2e5bab3095ef09

Joel Goddard authored Mar 21, 2022 and Diego Sueiro committed Mar 30, 2022

From the command line -D or --no_deploy_artifacts can be used to
override the deploy_artifacts setting from config files.

Issue-Id: SCM-3900
Signed-off-by: Joel Goddard <joel.goddard@arm.com>
Change-Id: I26f697dbc192f4b000cb92f3f8ad5659cf6349d2

Joel Goddard authored Mar 10, 2022 and Diego Sueiro committed Mar 30, 2022

Added classes to manage settings that can be set from both
command line arguments and config files. Each setting is
only defined once. Default config has been merged with new
settings classes so settings are defined in one place.

Settings can have optional resolve functions for extra
processing and validation. Internal settings are excluded
from command line and config files.

ArgumentDictionary is replaced with RunnerSettings which
provides helpers for validation and resolution of configs.
Setting values are now accessed as variables on the
RunnerSettomgs.

Note: Arguments previously set with the format '%(arg)s'
should now use '{arg}' instead.
Note: Some logging has changed.

Issue-Id: SCM-3900
Signed-off-by: Joel Goddard <joel.goddard@arm.com>
Change-Id: Iec9f418ad776e801470467a7f3aa16e546212b13

Kamil Dzieżyk authored Jan 03, 2022 and Diego Sueiro committed Mar 30, 2022

The ewaol-security brings the followng EWAOL images customizations:
 - Force password update for each user account after first log in.
 - Appends 'security.scc' to kernel configuration.
 - Appends 'seccomp' to DISTRO_FEATURES.
 - Ensures all relevant packages are configured '--with-libcap[-ng]'
 - Removes ssh 'root' access and 'debug-tweaks' from IMAGE_FEATURES.
 - Appends 'allow-empty-password' to IMAGE_FEATURES, to allow password
   update on first login either over serial or ssh.

Issue-Id: SCM-3905
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I940770da2d6aa444db2405ead420fed0d1e2dc6b

Kamil Dzieżyk authored Jan 03, 2022 and Diego Sueiro committed Mar 30, 2022

This patch brings the following changes:
 * Adds following packages into all EWAOL images: 'sudo', 'bash'
   and 'bash-completion'.
 * Sets up two user accounts:
   - 'user' without administrative privileges,
   - 'ewaol' with administrative privileges via the 'sudo' group.

Issue-Id: SCM-3905
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: Icb0ad09ef34ea93a2627d433efd0699f9a00be51

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I56c8089eb291563c9cef3054b562e0f339b3e0b5

Joel Goddard authored Mar 09, 2022 and Diego Sueiro committed Mar 30, 2022

The common directories containing all kas config files and the
project root to run is added as a read only volume for the
container. Kas file paths are modified to point to the mount path
to pass to the container.

This allows configs outside project root to be used without extra
manual configuration and absolute paths to be used. Relative paths
will still be considered relative to project root.

Issue-Id: SCM-3900
Signed-off-by: Joel Goddard <joel.goddard@arm.com>
Change-Id: I1a5aeebdb9b12e5ca4e3f1cdc6434fbaf4872c15

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I05976a6632f55ea6f16abb000d6612ae4e78e13f

Richard Neill authored Mar 04, 2022 and Diego Sueiro committed Mar 08, 2022

Among other updates, kas 3.0 is required to support BB_ENV_PASSTHROUGH_ADDITIONS
which has been merged in meta-ewaol dependent layers.

Issue-Id: SCM-3910
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I847599be6cf2ba826ab01fa81b55f6d5e7673fac

Kamil Dzieżyk authored Mar 02, 2022 and Diego Sueiro committed Mar 07, 2022

This patch adds '98-xenbr0-inherit-mac.link' config file used for xen bridge
interface.
This config file changes the mac address policy from 'persistent' to 'none' to
allow cloning 'xenbr0' mac address from currently connected network interface
(e.g. eth0 or enP4p4s0), instead of generating a random mac address.

Issue-Id: SCM-3910
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I73011213ede8d15f8036a395de16adfed4297df2

Kamil Dzieżyk authored Mar 02, 2022 and Diego Sueiro committed Mar 07, 2022

This patch prevents creation of a 'xenbr0' bridge on Guest VMs,
because it is not used.

Issue-Id: SCM-3910
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: I6fdc436a37a2f38517cb617f031758d087bf894d

Joel Goddard authored Mar 01, 2022 and Diego Sueiro committed Mar 07, 2022

Arguments can be passed to pycodestyle via python_pycodestyle_args.
 This allows for direct use of pycodestyle arguments such as
--python_pycodestyle_args="--max-line-length=75 --ignore=E1".

Issue-Id: SCM-3900
Signed-off-by: Joel Goddard <joel.goddard@arm.com>
Change-Id: I70f2dd59048a91ebdd04e9c18ddfc752763630b1

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I16eab7ec57dcef81bcec2f70c7bbda56f9f7b9b3

Richard Neill authored Feb 24, 2022 and Diego Sueiro committed Mar 01, 2022

Issue-Id: SCM-3910
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I266f500817a9e2a423157d70d9d1903d6a6beda5

We also need to append the ewaol-virtualization-sdk-image recipe to include
the extra dependency on xen and xen-devicetree deploy for generating the wic
image.

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I9608c1145ba963aaf580bc6faa4c0b0cfe2cb712

By inheriting image-buildinfo the EWAOL images will include the /etc/build file
which contains information about the build configuration as well as the layers
revisions.

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I61a80628ed9decd8701a8e793444dfb9d03bccfa

We should use EWAOL_CONTROL_VM_MEMORY_SIZE instead of EWAOL_HOST_MEMORY_SIZE to
set XEN_DEVICETREE_DOM0_MEM.

This is a left over from:
    ff4907b4 doc,ewaol-[bsp,config,distro,tests]: Update EWAOL nomenclature

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I6578d77774878a754d88670721615776998d6592

Kamil Dzieżyk authored Feb 16, 2022 and Richard Neill committed Feb 24, 2022

For ewaol-guest-vm image 'packagegroup-base-extended' is removed from
IMAGE_INSTALL, to not include packages based on MACHINE_FEATURES.

Issue-Id: SCM-3910
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: Ie2e83b03c3ec6e4c08fbf53db99f2f5bffed88a8

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iadec28f33cc613446bbb9786fc15c37c20a1fe9f

Primary updates included in this patch:

* Consistently use passive voice in documentation
* Remove K3s usage instructions, instead relying on upstream project
* Update yoctoproject documentation version
* Update EWAOL overview 'major features'

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I327d87d2e346b98debd8d854462bfd549d6d3eae

This patch refactors the naming scheme for EWAOL build targets, and creates the
EWAOL Virtualization SDK image. The build targets are now as follows:

Baremetal Images:
  * ewaol-baremetal-image
  * ewaol-baremetal-sdk-image

Virtualization Images:
  * ewaol-virtualization-image
  * ewaol-virtualization-sdk-image

In addition, this patch refactors the kas config files to more clearly define
the process for building the different targets via kas. It is now necessary to
supply kas with an architecture config file (e.g. baremetal.yml) and a machine
config file (e.g. n1sdp.yml) for a valid build. To support this, the
`ewaol-baremetal` DISTRO_FEATURE is introduced as a counterpart to the
`ewaol-virtualization` DISTRO_FEATURE.

Issue-Id: SCM-3839
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I66b27bd55c8762cc3a389e0150554c536855bab9

This patch updates and aligns the nomenclature used for EWAOL components
throughout the repository.

The main changes are:

* Images are consistently referred to according to the target architecture
  (e.g., ewaol-baremetal-image, ewaol-virtualization-image).

* The VMs running on an EWAOL virtualization image are consistently referred to
  Control VM and Guest VM, provided as Xen Dom0 and DomU respectively.

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iae24137d394f6dfed5da3090c7f76d6845439cc4

Issue-Id: SCM-3893
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I961a4177ebf98f13cd04358e6556c100bd11123b

Kamil Dzieżyk authored Jan 20, 2022 and Richard Neill committed Feb 24, 2022

This patch introduces a new recipe that packages prebuilt VMs into the EWAOL
Host image. 'PREBUILT_VM_INSTANCES' variable defines how many VM instances
will be included. Each prebuilt VM requires setting:

 (*) PREBUILT_VM*_CFG_SRC       # path to xl domain config file
 (*) PREBUILT_VM*_KERNEL_SRC    # path to kernel image
 (*) PREBUILT_VM*_DISK_SRC      # path to disk image

Issue-Id: SCM-3898
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: Iea143cd0337bc57a1503aad2c87649bbae195774

Kamil Dzieżyk authored Jan 20, 2022 and Richard Neill committed Feb 24, 2022

This patch brings up support for multiple EWAOL VMs, based on the same image
and kernel recipes. Each VM can have custom settings like rootfs extra space,
memory size and number of cpus. Currently, each VM has a different hostname,
based on its index: 'ewaol-vm1' for the first, 'ewaol-vm2' for the second, etc.

Number of VM instances is defined by 'EWAOL_VM_INSTANCES',
and is set to '1' by default.

For each VM following paremeters can be set:
 (*) EWAOL_VM*_ROOTFS_EXTRA_SPACE
 (*) EWAOL_VM*_MEMORY_SIZE
 (*) EWAOL_VM*_NUMBER_OF_CPUS

This patch also updates the default "*_TEST_GUEST_NAME" variables used by the
EWAOL runtime integration tests to 'ewaol-vm1'.

Issue-Id: SCM-3898
Signed-off-by: Kamil Dziezyk <kamil.dziezyk@arm.com>
Change-Id: Ib11e6edb7596b7ff75c930ef48fd15ba6cdfdc77

Issue-Id: SCM-3910
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I56aa664459407588d5508dd189ea92299ca68c97

Issue-Id: SCM-3910
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: Iea974b8f12a61c418a68b49b02fb9e10b3b81588

A patch's GIT_COMMITTER_DATE updates when it is (for example) cherry-picked,
causing the copyright header check to potentially prompt for an updated
copyright header. As copyright applies to the authored content of a patch, this
patch makes the header check consider its GIT_AUTHOR_DATE instead, which reports
the date that the content was authored.

The ewaol-vm-image.bb recipe is an edge case that was authored in 2021 but made
to include copyright for 2022 (which was when it was merged), due to the header
check's usage of GIT_COMMITTER_DATE. Now that the check is using
GIT_AUTHOR_DATE instead, this patch makes a trivial change to that file so that
the latest author date of the recipe is reported as 2022, fixing the error
produced by the header check.

Issue-Id: SCM-3910
Signed-off-by: Richard Neill <richard.neill@arm.com>
Change-Id: I9c072e7ca668d749ded2ad1797b6cf5a1cf3499c

Diego Sueiro authored Feb 03, 2022 and Richard Neill committed Feb 03, 2022

Introduce the EWAOL_VM_KERNEL_IMAGETYPE variable to hold the VM kernel image type
and avoid issues when the Host MACHINE and VM MACHINE use different
KERNEL_IMAGETYPE.

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I194435cb05cb3bfb7292ec0b46cd2d517567ab04

Diego Sueiro authored Feb 02, 2022 and Richard Neill committed Feb 03, 2022

Since we use generic-arm64 as the MACHINE for the EWAOL VM we need to
include meta-arm layer which holds its definition.

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I472a2f133f2fa9d290f224d0552d859da5e2534e

Diego Sueiro authored Feb 02, 2022 and Richard Neill committed Feb 03, 2022

Issue-Id: SCM-3910
Signed-off-by: Diego Sueiro <diego.sueiro@arm.com>
Change-Id: I1c8d89e2c502320b327563256d042995a79ddbeb