diff options
| -rw-r--r-- | README.md | 16 | ||||
| -rw-r--r-- | documentation/userguide/quickstart.rst | 15 | ||||
| -rw-r--r-- | documentation/userguide/runtimes.rst | 33 | ||||
| -rw-r--r-- | shrinkwrap/config/FVP_Base_RevC-2xAEMvA-base.yaml | 2 |
4 files changed, 49 insertions, 17 deletions
@@ -5,4 +5,18 @@ Arm Fixed Virtual Platforms (FVP). Users simply invoke the tool to build the required config, then pass their own kernel and rootfs to the tool to boot the full system on FVP. -See [ReadTheDocs](http://shrinkwrap.rtd.oss.arm.com/en/latest/index.html) for full documentation. +See [ReadTheDocs](http://shrinkwrap.rtd.oss.arm.com/en/latest/index.html) for +full documentation. (only available to internal Arm users). + +Alternatively, to build the docs locally, the following packages need to be +installed on the host: + + sudo apt-get install python3-pip + pip3 install -U -r documentation/requirements.txt + +To build and generate the documentation in html format, run: + + sphinx-build -b html -a -W documentation public + +To render and explore the documentation, simply open `public/index.html` in a +web browser. diff --git a/documentation/userguide/quickstart.rst b/documentation/userguide/quickstart.rst index c71e7db..3d707b3 100644 --- a/documentation/userguide/quickstart.rst +++ b/documentation/userguide/quickstart.rst @@ -71,21 +71,6 @@ provide a value when running the config. .. code-block:: none - name: cca.yaml - - description: Brings together TF-A, RMM, Hafnium and a set of simple - secure partitions to demonstrate Arm CCA running on FVP. - - concrete: True - - run-time variables: LOCAL_NET_PORT: 8022 - BL1: ${artifact:BL1} - FIP: ${artifact:FIP} - ROOTFS: None - KERNEL: None - - -------------------------------------------------------------------------------- - name: ns-edk2-acpi.yaml description: Best choice for: I want to run Linux on FVP, booting with diff --git a/documentation/userguide/runtimes.rst b/documentation/userguide/runtimes.rst index f5f4793..7d47b0d 100644 --- a/documentation/userguide/runtimes.rst +++ b/documentation/userguide/runtimes.rst @@ -50,6 +50,12 @@ repository. shrinkwrap will look here for the default image, but will fail unless you have previously logged your local docker instance into the repository. This is a one-time operation. +.. note:: + + Only Arm employees are able to access this repository. If you are not an Arm + employee, you will need to build the image locally on your system. (See + below). + First, create an **identity token** using the Artifactory UI: - Goto https://artifactory.geo.arm.com @@ -67,3 +73,30 @@ Now perform the login on your local system: docker login -u <arm email address> -p <reference token> oss-kernel--docker.artifactory.geo.arm.com You are now logged in and able to pull shrinkwrap images. + +***************************** +Build Container Image Locally +***************************** + +If you have a need to build the shrinkwrap container image on your local system, +you can do it as follows: + +.. code-block:: shell + + cd docker + ./build.sh + +This will build an image called +``oss-kernel--docker.artifactory.geo.arm.com/shrinkwrap/base-debian11-<ARCH>`` +with the tag ``local``. To use the locally built image, call shrinkwrap as +follows if running on an x86_64 system: + +.. code-block:: shell + + shrinkwrap --runtime=<name> --image=oss-kernel--docker.artifactory.geo.arm.com/shrinkwrap/base-debian11-x86_64:local ... + +Or like this if running on an aarch64 system: + +.. code-block:: shell + + shrinkwrap --runtime=<name> --image=oss-kernel--docker.artifactory.geo.arm.com/shrinkwrap/base-debian11-aarch64:local ... diff --git a/shrinkwrap/config/FVP_Base_RevC-2xAEMvA-base.yaml b/shrinkwrap/config/FVP_Base_RevC-2xAEMvA-base.yaml index b8a7005..835112f 100644 --- a/shrinkwrap/config/FVP_Base_RevC-2xAEMvA-base.yaml +++ b/shrinkwrap/config/FVP_Base_RevC-2xAEMvA-base.yaml @@ -4,7 +4,7 @@ description: >- Arm Architecture Envelope Model FVP configured with 8 CPUs across 2 clusters (2x4) and 2GB DRAM. - TODO: Validate this config. It is based on what's being used for Newmore STP. + TODO: Validate this config. run: name: FVP_Base_RevC-2xAEMvA |