Jump to: navigation, search

StarlingX/Developer Guide

< StarlingX
Revision as of 19:24, 20 June 2018 by David.b.kinder (talk | contribs) (Created page with "This section contains the steps for building a StarlingX ISO. == Requirements == The recommended minimum requirements include: === Hardware Requirements === A workstation...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This section contains the steps for building a StarlingX ISO.


The recommended minimum requirements include:

Hardware Requirements

A workstation computer with:

  • Processor: x86_64 only supported architecture
  • Memory: At least 32GB RAM
  • Hard Disk: 100GB HDD
  • Network: Network adapter with active Internet connection

Software Requirements

A workstation computer with:

  • Operating System: Ubuntu 16.04 LTS 64-bit
  • Docker
  • Android Repo Tool
  • Proxy Settings Configured (If Required)

Development Environment Setup

This section describes how to set up a StarlingX development system on a workstation computer. After completing these steps, you will be able to build a StarlingX ISO image on the following Linux distribution:

  • Ubuntu 16.04 LTS 64-bit

Update Your Operating System

Before proceeding with the build, ensure your OS is up to date. You’ll first need to update the local database list of available packages:

$ sudo apt-get update

Installation Requirements and Dependencies

  1. Install the required packages in an Ubuntu host system with:
    $ sudo apt-get install git
  1. Install the required Docker CE packages in an Ubuntu host system. See Get Docker for more information.

  2. Install the required Android Repo Tool in an Ubuntu host system. See Installing Repo for more information.

Install stx-tools project

  1. Clone the <stx-tools> project
    $ git clone git://git.openstack.org/openstack/stx-tools

Create a Workspace Directory

  1. Create a starlingx workspace directory on your workstation computer. Usually, you’ll want to create it somewhere under your user’s home directory.
    $ mkdir -p $HOME/starlingx/

Build the CentOS Mirror Repository

This section describes how to build the CentOS Mirror Repository.

Setup Repository Docker Container

  1. Navigate to the <stx-tools>/centos-mirror-tool project directory:
    $ cd stx-tools/centos-mirror-tools/
  1. If necessary you might have to set http/https proxy in your Dockerfile before building the docker image.
    ENV http_proxy  "http://your.actual_http_proxy.com:your_port" && \
        https_proxy "https://your.actual_https_proxy.com:your_port" && \
        ftp_proxy "http://your.actual_ftp_proxy.com:your_port"
    RUN echo "proxy=http://your-proxy.com:port" >> /etc/yum.conf
  1. Build your <name>:<tag> base container image with e.g. aarcemor:centos-mirror-repository
    $ docker build -t aarcemor:centos-mirror-repository -f Dockerfile .
  1. Launch a <name> docker container using previously created Docker base container image <name>:<tag> e.g. aarcemor-centos-mirror-repository. As /localdisk is defined as the workdir of the container, the same folder name should be used to define the volume. The container will start to run and populate a logs and output folders in this directory. The container shall be run from the same directory where the other scripts are stored.
    $ docker run -itd --name aarcemor-centos-mirror-repository -v $(pwd):/localdisk aarcemor:centos-mirror-repository bash
  1. Execute the <name> docker container e.g. aarcemor-centos-mirror-repository
    $ docker exec -it aarcemor-centos-mirror-repository bash

Import GPG Keys

  1. Inside the docker container, import the keys into the local GPG keyring and query public key information:
    / # rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY*
    / # rpm -qi gpg-pubkey-\*

Download Packages

  1. Enter the following command to download the required packages to populate the CentOS Mirror Repository:
    / # bash download_mirror.sh
  1. Monitor the download of packages until it is complete. When download is complete, the following message is displayed:
    totally 17 files are downloaded!
    step #3: done successfully
    IMPORTANT: The following 3 files are just bootstrap versions. Based on them, the workable images
    for StarlingX could be generated by running "update-pxe-network-installer" command after "build-iso"
        - out/stx-r1/CentOS/pike/Binary/LiveOS/squashfs.img
        - out/stx-r1/CentOS/pike/Binary/images/pxeboot/initrd.img
        - out/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz

Verify Packages

  1. Verify there are no missing or failed packages:
    / # cat output/3rd_rpms_missing_L1.txt output/3rd_srpms_missing_L1.txt output/centos_rpms_missing_L1.txt output/centos_srpms_missing_L1.txt
    / # cat output/3rd_rpms_fail_move_L1.txt output/3rd_srpms_fail_move_L1.txt output/centos_rpms_fail_move_L1.txt output/centos_srpms_fail_move_L1.txt
  1. In case there are missing or failed ones due to network instability (or timeout), you should download them manually, to assure you get all RPMs listed in "rpms_from_3rd_parties.lst" and "rpms_from_centos_repo.lst".

  2. After all packages were succesfully downloaded, remove all i686 RPMs packages and change output directory ownership:

    / # find ./output -name "*.i686.rpm" | xargs rm -f
    / # chown 751:751 -R ./output

Create CentOS Mirror Repository

  1. From a console of the workstation, create a mirror/CentOS directory under your starlingx workspace directory:
    $ mkdir -p $HOME/starlingx/mirror/CentOS/
  1. Copy the built CentOS Mirror Repository built under <stx-tools>/centos-mirror-tool to the $HOME/starlingx/mirror/CentOS workspace directory.
    $ cp -r stx-tools/centos-mirror-tools/output/stx-r1/ $HOME/starlingx/mirror/CentOS/

Work in Progress...