StarlingX source manifest to manage the repositories
Go to file
Zuul 68fce86c05 Merge "Add apt-ostree to repo manifest" 2024-01-18 20:30:50 +00:00
.gitignore Add test framework 2018-06-08 15:48:00 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:25 +00:00
.zuul.yaml Adding job to upload commits to GitHub 2020-02-06 11:10:07 -05:00
README.rst starlingx/manifest README improvement 2023-07-19 12:24:46 -03:00
bindep.txt Add bindep.txt to install libxml2 2019-08-06 14:25:52 -05:00
common.xml Add git for storage of public keys and certs 2023-02-08 14:30:40 -05:00
compiler.xml Revert "Manifest files: set default revision for the r/stx.4.0 branches" 2020-07-14 12:07:35 -07:00
containers.xml Add new repo app-node-interface-metrics-exporter 2023-12-04 15:48:14 +00:00
default.xml Merge "Add apt-ostree to repo manifest" 2024-01-18 20:30:50 +00:00
distro.xml Remove linux-yocto git repo from manifest 2023-09-21 22:46:26 -04:00
flock.xml Merge "Add apt-ostree to repo manifest" 2024-01-18 20:30:50 +00:00
stx-openstack.xml Update stx-openstack to master branch 2023-10-05 00:41:35 +00:00
test-requirements.txt Add test framework 2018-06-08 15:48:00 -05:00
tox.ini Add git for storage of public keys and certs 2023-02-08 14:30:40 -05:00

README.rst

StarlingX Manifest

Download

The StarlingX source code can be downloaded from the default manifest XML file, by using the git-repo tool1, with the following commands:

export MANIFEST_URL="https://opendev.org/starlingx/manifest.git"
export MANIFEST_BRANCH="master"
export MANIFEST="default.xml"
repo init -u ${MANIFEST_URL} -b ${MANIFEST_BRANCH} -m ${MANIFEST}
repo sync

StarlingX Build Environment

The StarlingX Build Environment2 is a set of containers designed to run in a Kubernetes environment.

As an alternative, a Vagrant-based StarlingX Build Environment is available in the starlingx/tis-repo3.

Layered Build

Build layering4 is a feature to accelerate development within StarlingX. It optimizes the build of a small set of most-used top level packages, while avoiding rebuild of a large amount of infrequently used packages.

The packages are partitioned into the following layers, according to the corresponding manifests:

  • compiler: Low level build tools: compilers, scripts, and packaging tools;
  • distro: Linux and third party packages, e.g. ceph, openstack;
  • flock: Basic StarlingX packages. These are the most used ones.

Reserved Manifests

The following manifests are reserved:

  • common: packages always included in the build, regardless of layer;
  • containers: packages to build containers;
  • default: used as a means to download the StarlingX source code.

Developer Notes

When updating XML files, please remember to update the appropriate .gitignore file in https://opendev.org/starlingx/root otherwise the "repo status" command will show the new repo as an untracked change.

When updating the default.xml manifest, please also remember to update the appropriate layer manifest as well.

References


  1. https://gerrit.googlesource.com/git-repo/#install↩︎

  2. https://wiki.openstack.org/wiki/StarlingX/DebianBuildEnvironment↩︎

  3. https://opendev.org/starlingx/tis-repo↩︎

  4. https://docs.starlingx.io/developer_resources/Layered_Build.html↩︎