Search
  • Docs
  • Join
    • Sign up for Foundation Membership
    • More about the Foundation
  • Log In

Navigate StarlingX source code

version

Version 8.0

Version 6.0

Version 7.0

Version 9.0

Latest

Navigate StarlingX source code¶

StarlingX code is kept in multiple Git directories. To simplify the process of keeping your local copy up to date, the StarlingX project provides Android-type repo manifests that can be followed by the Android Repo tool.

Required tools¶

In addition to your preferred text editor you will need two tools to download the StarlingX source code:

  • Git (available from your preferred Linux distro)

  • Android Repo tool (a simple python script that is installed manually)

To install Git, follow the instructions to install the Git package from your Linux distro.

To install the required Android Repo tool on the Linux host system, follow the steps in the Installing Repo <https://source.android.com/setup/build/downloading#installing-repo>

Additional information about the Repo tool is available in the Repo Command Reference <https://source.android.com/setup/develop/repo>.

Initial download of StarlingX code¶

  1. Create a starlingx workspace directory on your system. Best practices dictate creating the workspace in your $HOME directory:

    $ mkdir -p $HOME/starlingx/
    
  2. Use the Repo tool to create a local clone of the manifest Git repository based on the master branch:

    $ cd $MY_REPO_ROOT_DIR
    $ repo init -u https://opendev.org/starlingx/manifest -m default.xml
    
  3. Synchronize the repository:

    $ repo sync -j`nproc`
    

Keeping in sync with StarlingX upstream¶

$ repo sync -j`nproc`
this page last updated: 2025-03-18 16:21:32
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug

StarlingX

  • Introduction
  • Deployment Configurations
  • Planning
  • Installation Guides
  • Security
  • System Configuration
  • Data Networks
  • Node Management
  • Storage
  • Fault Management
  • Backup and Restore
  • Updates and Upgrades
  • KubeVirt
  • Admin Tasks
  • User Tasks
  • Guest Integration
  • REST API Reference
  • CLI Reference
  • Distributed Cloud
  • Sample Application Deployments
  • Documentation Archive
  • Operation Guides
  • Contributor Guides
  • R8.0 Release Notes
  • Developer Resources
    • StarlingX Build Guide
    • Layered Build Guide
    • Layered Build Reference
    • 分层构建 “(Layered Build)”
    • Backup and Restore
    • Build StarlingX Docker Images
    • Code Submission Guidelines
    • Debug StarlingX Issues
    • Enable TSN in Kata Containers
    • Enable SDO Rendezvous Service on StarlingX
    • Mirror OpenDev Repo to GitHub
    • Move to new OpenStack version in StarlingX
    • Navigate StarlingX source code
    • Packaging Reference
    • Project Specifications
    • StarlingX architecture documents
    • StarlingX patching
    • StarlingX IPv6 Deployment
    • Enable OPC UA on StarlingX
  • Project Specifications

Page Contents

  • Navigate StarlingX source code
    • Required tools
    • Initial download of StarlingX code
    • Keeping in sync with StarlingX upstream

StarlingX

  • Projects

Documentation

  • StarlingX Manuals
  • API Documentation
  • Wiki

Branding & Legal

  • Logos & Guidelines
  • Trademark Policy
  • Privacy Policy
  • OpenStack CLA

Stay In Touch

The StarlingX project is provided under the Apache 2.0 license. starlingx.io is powered by Rackspace Cloud Computing.