Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more instructions on how to build/install the image, see the documentation here: RDK reference image

Installing and Running DAC Applications

Once the reference image has been flashed to the Raspberry Pi, follow the below instructions to install and run a sample DAC application onto the RPi. Two sample DAC applications are available here: https://github.com/stagingrdkm/lntpub/tree/master/bundle/rpi. These applications are in the OCI bundle format and have already been prepared for the Raspberry Pi.

...

Code Block
wscat -c ws://$BOX/jsonrpc -s notification -x '{"jsonrpc":"2.0","id":1,"method":"Packager.1.getInstalled" }'
wscat -c ws://$BOX/jsonrpc -s notification -x '{"jsonrpc":"2.0","id":1,"method":"Packager.1.remove", "params":{ "pkgId": "mypkgid" } }'


The full list of RDKShell and Packager APIs can be found in the full documentation.

App Development and Publishing

NOTES:

  • Examples included with SDK
  • SDK produces OCI image that can be converted to platform with BundleGen
  • Metadata submitted to ASMS

-------------------------------------------------------------------------------------------------------------------------------------------------

Proposed organisation:

  • Overview (Picture and text description - then point to subpages for more info) 
    • Backgound: Containers, OCI, runtime
    • SDK → stefan's page
    • Backend/cloud → Piotr's ASMS page, bundle gen
    • Client STB → dobby, plugins,
  • For developers
    • How get started - reference image on RPi
    • Using SDK
    • Using ASMS/bundle gen, OCI tools?
    • Build image, OCI_container, RDKShell, Packer, Plugins
    • Running a container

Overview

DAC builds upon open-source specifications, components and tools from the Open Container Initiative (OCI). In particular, it uses crun, a fast, small, OCI-runtime compliant engine that can configure and launch applications containers. As part of the DAC project, a number of new open-source components have been contributed to RDK including:

...

The above example used a pre-created OCI bundle. Using the SDK it is possible to build your own applications that can be run in a container. Below are some simple instructions to build a sample app using the SDK. Refer to the SDK and BundleGen documentation for more detailed instructions.

TODO:: This needs completing when the full SDK and ASMS info is available

  1. Build application using the SDK
  2. Upload the image to an OCI registry. This could be the Docker Hub or a private OCI registry hosted on your workstation (e.g. https://docs.docker.com/registry/deploying/). The output from the SDK will be a .tar.gz file, which can be uploaded to the registry using Skopeo (https://github.com/

...

  1. containers/skopeo)
  2. Set up the BundleGen VM as per the BundleGen documentation
  3. Create the bundle with BundleGen

  4. .........

NOTES:

  • Examples included with SDK
  • SDK produces OCI image that can be converted to platform with BundleGen
  • Metadata submitted to ASMS

...

These are the first components of an end-to-end system that operators can use to adapt, manage and control containers to be suitable for their platform.

...