starlingx/docs
Code Issues Proposed changes

remove pike from mirror path name

Browse Source 
StarlingX has moved beyond the OpenStack pike release and will
be following master and the latest release, so don't include
OpenStack release names.

Remove 'cgcs-' and 'tis-' elements from several paths and command
names.  Also replace 'stx-r1' with 'stx' in various paths.

Story: 2006387
Task: 41102
Depends-On: https://review.opendev.org/#/c/687401
Depends-On: https://review.opendev.org/#/c/687403
Change-Id: Ic9c4f73d11f864aeb72d6cd0c63553b67b9a39e1
Signed-off-by: Scott Little <scott.little@windriver.com>
This commit is contained in:
Saul Wold 2019-11-11 17:54:13 -08:00 committed by Scott Little
parent 7179940827
commit 86365c6761
1 changed files with 38 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/source/developer_resources/build_guide.rst
View File

@ -307,9 +307,9 @@ Download packages
sudo rm -rf /tmp/stx_mirror_vyPozw sudo rm -rf /tmp/stx_mirror_vyPozw
IMPORTANT: The following 3 files are just bootstrap versions. Based on them, the workable images 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" for StarlingX could be generated by running "update-pxe-network-installer" command after "build-iso"
- ./output/stx-r1/CentOS/pike/Binary/LiveOS/squashfs.img - ./output/stx/CentOS/Binary/LiveOS/squashfs.img
- ./output/stx-r1/CentOS/pike/Binary/images/pxeboot/initrd.img - ./output/stx/CentOS/Binary/images/pxeboot/initrd.img
- ./output/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz totally 17 files are downloaded! - ./output/stx/CentOS/Binary/images/pxeboot/vmlinuz totally 17 files are downloaded!
*************** ***************
Verify packages Verify packages
@ -339,9 +339,8 @@ downloading the packages:
/localdisk/designer/<user>/<project>/stx-tools/centos-mirror-tools/output /localdisk/designer/<user>/<project>/stx-tools/centos-mirror-tools/output
. .
└── stx-r1 └── stx
└── CentOS └── CentOS
└── pike
├── Binary ├── Binary
│   ├── EFI │   ├── EFI
│   │   └── BOOT │   │   └── BOOT
@ -382,7 +381,7 @@ Exit from the building Docker container. Run the following commands:
:: ::
cp -r $HOME/starlingx/workspace/localdisk/designer/<user>/<project>/stx-tools/centos-mirror-tools/output/stx-r1 $HOME/starlingx/mirror/CentOS/ cp -r $HOME/starlingx/workspace/localdisk/designer/<user>/<project>/stx-tools/centos-mirror-tools/output/stx $HOME/starlingx/mirror/CentOS/
.. _create_stx_pkgs: .. _create_stx_pkgs:
@ -401,14 +400,14 @@ Create StarlingX packages
:: ::
ln -s /import/mirrors/CentOS/stx-r1/CentOS/pike/downloads/ $MY_REPO/stx/ ln -s /import/mirrors/CentOS/stx/CentOS/downloads/ $MY_REPO/stx/
Alternatively, you can run the "populate_downloads.sh" script to copy Alternatively, you can run the "populate_downloads.sh" script to copy
the tarballs instead of using a symlink: the tarballs instead of using a symlink:
:: ::
populate_downloads.sh /import/mirrors/CentOS/stx-r1/CentOS/pike/ populate_downloads.sh /import/mirrors/CentOS/stx/CentOS/
Outside the container Outside the container
@ -417,9 +416,9 @@ Create StarlingX packages
:: ::
mkdir -p $HOME/starlingx/mirror/CentOS/stx-installer mkdir -p $HOME/starlingx/mirror/CentOS/stx-installer
cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/images/pxeboot/initrd.img $HOME/starlingx/mirror/CentOS/stx-installer/initrd.img cp $HOME/starlingx/mirror/CentOS/stx/CentOS/Binary/images/pxeboot/initrd.img $HOME/starlingx/mirror/CentOS/stx-installer/initrd.img
cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/images/pxeboot/vmlinuz $HOME/starlingx/mirror/CentOS/stx-installer/vmlinuz cp $HOME/starlingx/mirror/CentOS/stx/CentOS/Binary/images/pxeboot/vmlinuz $HOME/starlingx/mirror/CentOS/stx-installer/vmlinuz
cp $HOME/starlingx/mirror/CentOS/stx-r1/CentOS/pike/Binary/LiveOS/squashfs.img $HOME/starlingx/mirror/CentOS/stx-installer/squashfs.img cp $HOME/starlingx/mirror/CentOS/stx/CentOS/Binary/LiveOS/squashfs.img $HOME/starlingx/mirror/CentOS/stx-installer/squashfs.img
************** **************
Build packages Build packages
@ -443,7 +442,7 @@ Build packages
:: ::
cd $MY_REPO_ROOT_DIR/stx-tools/toCOPY cd $MY_REPO_ROOT_DIR/stx-tools/toCOPY
bash generate-cgcs-centos-repo.sh /import/mirrors/CentOS/stx-r1/CentOS/pike/ bash generate-local-repo.sh /import/mirrors/CentOS/stx/CentOS/
#. Build the packages: #. Build the packages:
@ -451,17 +450,17 @@ Build packages
build-pkgs build-pkgs
#. **Optional!** Generate-Cgcs-Tis-Repo: #. **Optional!** Generate local-repo:
While this step is optional, it improves performance on subsequent While this step is optional, it improves performance on subsequent
builds. The cgcs-tis-repo has the dependency information that builds. The local-repo has the dependency information that
sequences the build order. To generate or update the information, you sequences the build order. To generate or update the information, you
need to execute the following command after building modified or new need to execute the following command after building modified or new
packages. packages.
:: ::
generate-cgcs-tis-repo generate-local-repo.sh
------------------- -------------------
Build StarlingX ISO Build StarlingX ISO
@ -596,7 +595,7 @@ Limitations
*********** ***********
* Little or no benefit for designers who refresh a pre-existing workspace at * Little or no benefit for designers who refresh a pre-existing workspace at
least daily (e.g. download_mirror.sh, repo sync, generate-cgcs-centos-repo.sh, build-pkgs, build-iso). In these cases, an incremental build (i.e. reuse of least daily (e.g. download_mirror.sh, repo sync, generate-centos-repo.sh, build-pkgs, build-iso). In these cases, an incremental build (i.e. reuse of
same workspace without a :command:`build-pkgs --clean`) is often just as same workspace without a :command:`build-pkgs --clean`) is often just as
efficient. efficient.
* Not likely to be useful to solo designers, or teleworkers that wish to compile * Not likely to be useful to solo designers, or teleworkers that wish to compile
@ -693,7 +692,7 @@ The following paths are relative to ``$MY_WORKSPACE/$BUILD_TYPE``
BUILD_AVOIDANCE_SRPM_DIRECTORIES="inputs srpm_assemble rpmbuild/SRPMS rpmbuild/SOURCES" BUILD_AVOIDANCE_SRPM_DIRECTORIES="inputs srpm_assemble rpmbuild/SRPMS rpmbuild/SOURCES"
BUILD_AVOIDANCE_SRPM_FILES="" BUILD_AVOIDANCE_SRPM_FILES=""
BUILD_AVOIDANCE_RPM_DIRECTORIES="results rpmbuild/RPMS rpmbuild/SPECS repo/cgcs-tis-repo/dependancy-cache" BUILD_AVOIDANCE_RPM_DIRECTORIES="results rpmbuild/RPMS rpmbuild/SPECS repo/local-repo/dependancy-cache"
BUILD_AVOIDANCE_RPM_FILES=".platform_release" BUILD_AVOIDANCE_RPM_FILES=".platform_release"
Details of the files and directories downloaded include: Details of the files and directories downloaded include:
@ -709,7 +708,7 @@ Details of the files and directories downloaded include:
* ``results`` = Per package build logs and artifacts generated by mockchain * ``results`` = Per package build logs and artifacts generated by mockchain
* ``rpmbuild/RPMS`` = Build RPMs * ``rpmbuild/RPMS`` = Build RPMs
* ``rpmbuild/SPECS`` = Spec files of build RPMs * ``rpmbuild/SPECS`` = Spec files of build RPMs
* ``repo/cgcs-tis-repo/dependancy-cache`` = build-pkgs data summarizing: * ``repo/local-repo/dependancy-cache`` = build-pkgs data summarizing:
* The 'Requires' of RPMs * The 'Requires' of RPMs
* The 'BuildRequires' of src.rpms * The 'BuildRequires' of src.rpms
@ -763,7 +762,7 @@ Designer actions
:: ::
repo sync repo sync
generate-cgcs-centos-repo.sh generate-centos-repo.sh
populate_downloads.sh populate_downloads.sh
build-pkgs --build-avoidance build-pkgs --build-avoidance
@ -890,7 +889,7 @@ the last full build. Your build script might look like this:
# update software # update software
repo init -u ${BUILD_REPO_URL} -b ${BUILD_BRANCH} repo init -u ${BUILD_REPO_URL} -b ${BUILD_BRANCH}
repo sync --force-sync repo sync --force-sync
$MY_REPO_ROOT_DIR/tools/toCOPY/generate-cgcs-centos-repo.sh $MY_REPO_ROOT_DIR/tools/toCOPY/generate-centos-repo.sh
$MY_REPO_ROOT_DIR/tools/toCOPY/populate_downloads.sh $MY_REPO_ROOT_DIR/tools/toCOPY/populate_downloads.sh
# User can optionally define BUILD_METHOD equal to one of 'FULL', 'AVOIDANCE', or 'AUTO' # User can optionally define BUILD_METHOD equal to one of 'FULL', 'AVOIDANCE', or 'AUTO'