StarlingX source manifest to manage the repositories

Go to file

Lucas de Ataides 92a5f1da4c Remove openstack-armada-app from default manifest As discussed in [1], as part of the STX-Openstack upversion to Antelope , we have to decouple the platform and the application builds in separate manifests, in order to not clash the upversioned packages on the application side, with the ones on the platform. After the creation of the STX-Openstack manifest, the `starlingx/openstack-armada-app` repository can be removed from the default manifest without affecting the build process. Since the only package this repo delivers to the ISO is the `stx-openstack-helm-fluxcd`, and it's not actually required to be delivered on the platform [2], there's no impact on StarlingX [1] https://lists.starlingx.io/pipermail/starlingx-discuss/2023-June/014214.html [2] https://review.opendev.org/c/starlingx/openstack-armada-app/+/889991 Test Plan: PASS: Run a `repo init` with this change PASS: Perform a `repo sync` and make sure the openstack-armada-app repository does not exist anymore Story: 2010797 Task: 48695 Change-Id: I7b4ed700d57722a11e39766766ae7849fb22e456 Signed-off-by: Lucas de Ataides <lucas.deataidesbarreto@windriver.com>		2023-08-30 16:25:20 +00:00
.gitignore	Add test framework	2018-06-08 15:48:00 -05:00
.gitreview	Update .gitreview for f/antelope	2023-08-09 14:11:10 -04: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	Modified manifests for branch f/antelope	2023-08-09 15:36:10 -04:00
containers.xml	Modified manifests for branch f/antelope	2023-08-09 15:36:10 -04:00
default.xml	Remove openstack-armada-app from default manifest	2023-08-30 16:25:20 +00:00
distro.xml	Modified manifests for branch f/antelope	2023-08-09 15:36:10 -04:00
flock.xml	Modified manifests for branch f/antelope	2023-08-09 15:36:10 -04:00
stx-openstack.xml	Create stx-openstack manifest	2023-08-30 16:20:30 +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 tool¹, 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 Environment² 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-repo³.

Layered Build

Build layering⁴ 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.