Difference between revisions of "LEAP SOP"

From CDOT Wiki
Jump to: navigation, search
Line 5: Line 5:
  
 
== Fetching source ==
 
== Fetching source ==
Source packages are located under 7.x folder on http://vault.centos.org/. There are several types of repository:
+
Source packages are located under 7.x directory on http://vault.centos.org/. There are several types of repository:
  
 
; os: Base packages
 
; os: Base packages
Line 25: Line 25:
  
 
=== Common errors and solutions ===
 
=== Common errors and solutions ===
; build.log - Code compilation error
+
; Code compilation error
: <u>Reason</u>: Certain depended library is too old
+
: <u>Reason</u>: Certain pulled library is too old
 
: <u>Solution</u>:  Try to build all other packages and then rebuild this one
 
: <u>Solution</u>:  Try to build all other packages and then rebuild this one
  
; build.log - Cannot detect system type   
+
; Cannot detect system type   
 
: <u>Reason</u>: The software uses outdated <tt>config.guess</tt> and <tt>config.sub</tt> to autodetect system type
 
: <u>Reason</u>: The software uses outdated <tt>config.guess</tt> and <tt>config.sub</tt> to autodetect system type
 
: <u>Solution</u>:  Replace both files in the source with the latest online version. See https://www.gnu.org/software/gettext/manual/html_node/config_002eguess.html  
 
: <u>Solution</u>:  Replace both files in the source with the latest online version. See https://www.gnu.org/software/gettext/manual/html_node/config_002eguess.html  
  
; build.log - Unknown system type
+
; Unknown system type
 
: <u>Reason</u>: The software only allows it to be built with kernel 2.6/3.x  
 
: <u>Reason</u>: The software only allows it to be built with kernel 2.6/3.x  
 
: <u>Solution</u>: Add 4.x support to the system checking script
 
: <u>Solution</u>: Add 4.x support to the system checking script
Line 40: Line 40:
 
: <u>Reason</u>: Package only supports the architectures on <tt>ExclusiveArch</tt> list in the spec file
 
: <u>Reason</u>: Package only supports the architectures on <tt>ExclusiveArch</tt> list in the spec file
 
: <u>Solution</u>: Checkout the package on Fedora ARM Koji and CentOS AArch64 repo and determine whether the package is possible to support AArch64 or not
 
: <u>Solution</u>: Checkout the package on Fedora ARM Koji and CentOS AArch64 repo and determine whether the package is possible to support AArch64 or not
 +
 +
; Fail to patch
 +
: <u>Reason</u>: Wrong patches or sources were packed into the source rpm
 +
: <u>Solution</u>: Retrieve the original CentOS src.rpm and repack it again, see also: [[#Duplicated source file names]]
  
 
=== Resources ===
 
=== Resources ===
# Previous build of the package
+
* Previous build of the package
# CentOS AArch64 repo: http://buildlogs.centos.org/centos/7
+
* CentOS AArch64 repo: http://buildlogs.centos.org/centos/7
# Fedora ARM Koji: http://arm.koji.fedoraproject.org
+
* Fedora ARM Koji: http://arm.koji.fedoraproject.org
# CentOS git repo (for reverting CentOS changes): http://git.centos.org
+
* CentOS git repo (for reverting CentOS changes): http://git.centos.org
# GOOGLE!
+
* GOOGLE!
  
 
== Source modification ==
 
== Source modification ==
Line 65: Line 69:
  
 
</source>
 
</source>
* Add ''.leap'' after the release version, add ''.leap.1'', ''.leap.2'' ... and so on for further modification
+
* Add '''.leap''' after the release version, add '''.leap.1'', '''.leap.2''' ... and so on for further modifications
  
 
* Make sure to specify all the changes under the <tt>%changelog</tt> section:
 
* Make sure to specify all the changes under the <tt>%changelog</tt> section:
Line 72: Line 76:
 
- Add AArch64 support
 
- Add AArch64 support
 
- Roll in LEAP Branding
 
- Roll in LEAP Branding
 
 
</source>
 
</source>
  
 
=== Rebranding ===
 
=== Rebranding ===
 +
 
The packages that contain the word ''.centos'' in their release version are branded packages. In order to properly rebranding those packages for LEAP, here is the checklist:
 
The packages that contain the word ''.centos'' in their release version are branded packages. In order to properly rebranding those packages for LEAP, here is the checklist:
 
* Replace the word ''CentOS'' or ''CentOS Linux'' with ''LEAP'' in spec package descriptions and patches (make sure they are branding-related)
 
* Replace the word ''CentOS'' or ''CentOS Linux'' with ''LEAP'' in spec package descriptions and patches (make sure they are branding-related)
Line 100: Line 104:
  
 
== Build order ==
 
== Build order ==
It is better and time-saving to build certain packages before any other packages, because other packages is likely to depend on them:
+
It is safer and more time-efficient to build certain essential packages before any other packages are built, because other packages are very likely to depend on them:
* leap-release
+
* leap-release - the base of the whole distribution
* gcc, glibc, make
+
* gcc, glibc, make - basic compiler
* coreutils
+
* coreutils - basic tools
* xorg-x11-server
+
* xorg-x11-server - xorg-x11-drv* always require the specific version of xorg-x11-server they are built with
 +
 
 +
== Duplicated source file names ==
 +
It is possible that a few packages contain patches or sources having identical names. When installing source rpms to rpmbuild tree (<tt>$HOME/rpmbuild/*</tt>), try to avoid installing too many of them at a time (50+).  Wipe the rpmbuild tree after finish modifying and building those packages on Koji.  There are a few problematic packages were discovered:
 +
* Openjdk 6,7,8 packages
 +
* xorg-x11-drv-dummy and xorg-x11-drv-fbdev
 +
 
 +
 
  
 
More coming ...
 
More coming ...

Revision as of 20:52, 27 March 2016

Introduction

This wiki page describes the SOP (Standard Operating Procedure) for releasing LEAP like packaging-related processes. It also includes packaging standards, common fixes, patch resources, and debugging methods.

Package building

Fetching source

Source packages are located under 7.x directory on http://vault.centos.org/. There are several types of repository:

os
Base packages
updates
Package updates
extra
Extra packages such as docker, cockpit, golang, etc.

Source rpms can only be downloaded through yum or curl/wget, since there is no Rsync repository for Centos source rpms.

Determine problem

If a package fails to be built on Koji, there are several possibilities causing it:

  • Package name is not added to the pkg list of the tag
  • Package only supports the architectures on ExclusiveArch list in the spec file
  • Same version of the package already existed on Koji
  • Repository of the build-tag is being regenerated or broken
  • Package spec contains RHEL or CentOS specific rpm macros
  • Missing Dependency
  • Package has to be patched in order to be built on AArch64 platform

Common errors and solutions

Code compilation error
Reason: Certain pulled library is too old
Solution: Try to build all other packages and then rebuild this one
Cannot detect system type
Reason: The software uses outdated config.guess and config.sub to autodetect system type
Solution: Replace both files in the source with the latest online version. See https://www.gnu.org/software/gettext/manual/html_node/config_002eguess.html
Unknown system type
Reason: The software only allows it to be built with kernel 2.6/3.x
Solution: Add 4.x support to the system checking script
BuildError No matching arches were found
Reason: Package only supports the architectures on ExclusiveArch list in the spec file
Solution: Checkout the package on Fedora ARM Koji and CentOS AArch64 repo and determine whether the package is possible to support AArch64 or not
Fail to patch
Reason: Wrong patches or sources were packed into the source rpm
Solution: Retrieve the original CentOS src.rpm and repack it again, see also: #Duplicated source file names

Resources

Source modification

There a few standards to follow during modification:

  • Add comments about any line changes
  • Add the word LEAP at the beginning of any comments, for example:
# LEAP Add AArch64 support
ExclusiveArch: x86_64 aarch64
  • When commenting out a existing line of code, add one more % before any rpm macro otherwise rpmbuild will complain. For instance:
# Before commenting out
cp %{SOURCE1} $RPM_BUILD_ROOT%{_datadir}/virt-tools

# After
# cp %%{SOURCE1} $RPM_BUILD_ROOT%%{_datadir}/virt-tools
  • Add .leap' after the release version, add .leap.1, .leap.2 ... and so on for further modifications
  • Make sure to specify all the changes under the %changelog section:
*  Fri Mar 25 2016 Foo Bar <foo.bar@example.com> - 1:1.28.1-1.55.leap
- Add AArch64 support
- Roll in LEAP Branding

Rebranding

The packages that contain the word .centos in their release version are branded packages. In order to properly rebranding those packages for LEAP, here is the checklist:

  • Replace the word CentOS or CentOS Linux with LEAP in spec package descriptions and patches (make sure they are branding-related)
  • Replace CentOS branding patches with LEAP branding patches
    • If certain patch file contains author name, regenerate the patch with your own name instead of modifying the patch directly
  • Replace CentOS links with LEAP links accordingly
  • Sometimes Red Hat trademarks and links have to be replaced as well
  • Remove CentOS/RHEL certificate files and binaries


Particular branded packages

libreport/abrt
Libreport and abrt are the library and application for automatic bug detection and reporting to RHEL bug tracker servers. Since CentOS added several significant patches to both packages for supporting their own bug tracker, removing those patches can be very complicated process. The best way to solve this problem is retrieving the original RHEL versions from http://git.centos.org, add our own de-branding patches, and bump the version-release number + .leap to match the requirements of dependency.
ntp/chrony/Packagekit/system-config-date
These packages contain network time protocol configurations pointing to the NTP pool address: pool.VENDERZONE.ntp.org . By default, they are pointing to pool.centos.ntp.org. Since ntp pool for LEAP hasn't been set up, it is necessary to remove any .VENDERZONE in the spec files in stead of just replacing the brand.
grub2/shim/shim-signed/system-config-kdump
There is a important variable efidir in the patches and specs in these packages. It represents the name of the EFI directory containing all the EFI boot files. Make sure the value of efidir leap.
oscap-anaconda-addon/oscap-security-guide
TODO

Build order

It is safer and more time-efficient to build certain essential packages before any other packages are built, because other packages are very likely to depend on them:

  • leap-release - the base of the whole distribution
  • gcc, glibc, make - basic compiler
  • coreutils - basic tools
  • xorg-x11-server - xorg-x11-drv* always require the specific version of xorg-x11-server they are built with

Duplicated source file names

It is possible that a few packages contain patches or sources having identical names. When installing source rpms to rpmbuild tree ($HOME/rpmbuild/*), try to avoid installing too many of them at a time (50+). Wipe the rpmbuild tree after finish modifying and building those packages on Koji. There are a few problematic packages were discovered:

  • Openjdk 6,7,8 packages
  • xorg-x11-drv-dummy and xorg-x11-drv-fbdev


More coming ...