{"id":14156290,"url":"https://github.com/rdkcentral/BundleGen","last_synced_at":"2025-08-06T02:32:50.604Z","repository":{"id":37783237,"uuid":"293499926","full_name":"rdkcentral/BundleGen","owner":"rdkcentral","description":"A command-line tool to convert OCI Images into extended OCI Bundles for use with the Dobby container manager.","archived":false,"fork":false,"pushed_at":"2024-11-05T02:02:18.000Z","size":4110,"stargazers_count":5,"open_issues_count":3,"forks_count":34,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-05T03:17:09.219Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rdkcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-07T10:47:38.000Z","updated_at":"2024-11-05T02:02:23.000Z","dependencies_parsed_at":"2024-08-17T08:17:05.782Z","dependency_job_id":null,"html_url":"https://github.com/rdkcentral/BundleGen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2FBundleGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2FBundleGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2FBundleGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2FBundleGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdkcentral","download_url":"https://codeload.github.com/rdkcentral/BundleGen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228829134,"owners_count":17978158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-17T08:05:21.385Z","updated_at":"2024-12-09T03:31:25.681Z","avatar_url":"https://github.com/rdkcentral.png","language":"Python","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# OCI Bundle Generator (BundleGen)\nRDK Component to generate extended OCI bundle*'s from OCI Images, ready to be run by Dobby\n\n## Environment Setup\nYou will need Python \u003e=3.7 installed and configured. You will also require some project specific dependencies and OCI tools.\n\nA Fedora 32 `Vagrantfile` is included to provide a ready-to-use environment. Otherwise follow the steps later in this document to set up your own Fedora/Ubuntu environment.\n\n## Quick Start\nStart the Vagrant VM and SSH in.\n```console\nvagrant up\nvagrant ssh\n```\n\nActivate the Python venv\n```console\ncd ~/bundlegen\nsource .venv/bin/activate\n```\n\nRun BundleGen:\n\nIf using an image generated by the DAC SDK, then run\n```console\nbundlegen generate --platform \u003cplatform-name\u003e \u003cimg-url\u003e \u003coutput-dir\u003e\n```\n\nIf using an image from a generic OCI registry (not built by the DAC SDK), then run\n```console\nbundlegen generate --platform \u003cplatform-name\u003e --appmetadata \u003cpath-to-app-metadata\u003e \u003cimg-url\u003e \u003coutput-dir\u003e\n```\n\nNote the image URL should be in the form `docker://image-url`. If the image is on the Docker Hub, the full URL can be omitted - e.g `docker://hello-world`.\n\nSee the `docs` directory for more detailed documentation.\n\n### Docker\nA dockerfile is included that can be used to run BundleGen as an alternative to Vagrant. See the `docker` directory for instructions on how to use.\n\n## Test Scripts\nTest scripts are included for reference platforms to speed up the generation and installation process.\n\nInstall and test already generated bundle:\n```\n./test/testapp.sh 192.168.1.124 rpi-dac-image-wayland-egl-test.tar.gz\n```\n\nGenerate bundle for Raspberry Pi\n```\n./test/build_and_test_on_rpi.sh 192.168.1.124 dac-image-wayland-egl-test.tar\n```\n\n\n## Development\n*These steps only apply if you're not using the included Vagrantfile*\n\nFor development, you will need Python \u003e=3.7 installed and configured. Once installed, then install project specific dependencies.\n\n### Fedora 32\nIt's easier to work in Fedora as the OCI tooling is already available\n```bash\n# Install dependencies\nsudo dnf upgrade -y\nsudo dnf install -y make git skopeo go go-md2man\n# Install Go\nmkdir -p $HOME/go\necho 'export GOPATH=$HOME/go' \u003e\u003e $HOME/.bashrc\nsource $HOME/.bashrc\n# Build/install umoci\ngo get -d github.com/opencontainers/umoci\ncd $GOPATH/src/github.com/opencontainers/umoci/\nmake\nsudo make install\n\n# Setup virtual envioment\npython3 -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\npip install --editable .\n```\n\n### Ubuntu \u003e=18.04\nIt's also possible to build on Ubuntu.\nNote Skopeo only publishes packages for Ubuntu 18.04 or newer. It may be possible to build skopeo from source on older distributions, see https://github.com/containers/skopeo/blob/master/install.md\n\n```bash\n# Install dependencies\nsudo apt update\nsudo apt upgrade\nsudo apt install -y make git go-md2man\n# Install Go 1.13\nwget https://dl.google.com/go/go1.13.12.linux-amd64.tar.gz\ntar -xvf go1.13.12.linux-amd64.tar.gz\nsudo mv go /usr/local\nmkdir -p $HOME/go\necho 'export GOPATH=$HOME/go' \u003e\u003e $HOME/.bashrc\necho 'export GOROOT=/usr/local/go' \u003e\u003e $HOME/.bashrc\necho 'export PATH=$GOPATH/bin:$GOROOT/bin:$PATH' \u003e\u003e $HOME/.bashrc\nsource $HOME/.bashrc\n# Build/install umoci\ngo get -d github.com/opencontainers/umoci\ncd $GOPATH/src/github.com/opencontainers/umoci/\nmake\nsudo make install\n# Install skopeo\n. /etc/os-release\nsudo sh -c \"echo 'deb http://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/x${NAME}_${VERSION_ID}/ /' \u003e /etc/apt/sources.list.d/devel:kubic:libcontainers:stable.list\"\nwget -nv https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/x${NAME}_${VERSION_ID}/Release.key -O- | sudo apt-key add -\nsudo apt update \u0026\u0026 sudo apt install skopeo\n\n# Setup virtual envioment\npython3 -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\npip install --editable .\n```\n\n---\n# Copyright and license\nIf not stated otherwise in this file or this component's LICENSE file the following copyright and licenses apply:\n\nCopyright 2020 Consult Red\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2FBundleGen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdkcentral%2FBundleGen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2FBundleGen/lists"}