docs/rpms.rst

   1 RPMs
   2 ====
   3
   4 OpenDaylight has a mature RPM Continuous Delivery pipeline. Every autorelease
   5 build is automatically packaged as an RPM, and even if autorelease is broken
   6 a daily job builds the latest distribution snapshot build into an RPM.
   7
   8 RPMs can be passed to test jobs that install them, start OpenDaylight with its
   9 systemd service, connect to the Karaf shell and verify basic functionality.
  10
  11 RPMs are hosted on the CentOS Community Build system repositories. Some repos
  12 are updated very frequently with the latest builds, while others are permanent
  13 homes of official releases.
  14
  15 Developers can build custom RPMs with pre-merge patches for testing by first
  16 creating a custom distribution with the integration-multipatch-test job and
  17 then feeding the resulting artifact to the packaging-build-rpm job.
  18
  19 Build Jobs
  20 ----------
  21
  22 OpenDaylight Integration/Packaging has added support for many variations of
  23 fully automated RPM builds.
  24
  25 packaging-build-rpm
  26 ^^^^^^^^^^^^^^^^^^^
  27
  28 The `packaging-build-rpm job`_ is the primary way to build an RPM from an
  29 OpenDaylight distribution (built by `autorelease <autorelease-builds.html>`_
  30 or the `snapshot distribution <distribution-job-builds.html>` job). It accepts
  31 a set of `parameters`_ that can be used to configure the build and passes them
  32 to the `RPM build logic in Integration/Packaging's repo`_. The job produces
  33 both a noarch RPM and source RPM. The noarch RPM can be passed to test jobs for
  34 validation. The source RPM can be downloaded to a system with the required
  35 credentials and then pushed to the CentOS Community Build system to be built
  36 into a noarch RPM on their servers and hosted in their repos.
  37
  38 The RPM and SRPM artifacts of the job are handled differently depending on the
  39 Jenkins silo the job is executing in.
  40
  41 When running in production (releng silo), artifacts are hosted on Nexus. There
  42 are RPM repos for each active branch (`oxygen-devel`_). New builds are
  43 automatically added to the approprate devel for their branch.
  44
  45 When running in the sandbox, artifacts are thrown away by default. To keep an
  46 artifact for further testing, add a path regex that matches them to the Archive
  47 Artifacts param of the job (`ARCHIVE_ARTIFACTS=/home/jenkins/rpmbuild/RPMS/
  48 noarch/opendaylight*.rpm`). The files matched will be stored in OpenDaylight's
  49 log archive along with the other job logs.
  50
  51 packaging-build-rpm-snap
  52 ^^^^^^^^^^^^^^^^^^^^^^^^
  53
  54 The `packaging-build-rpm-snap job`_ packages the most recent `snapshot
  55 distribution <distribution-job-builds.html>` build from a given branch as an
  56 RPM. This could be used by a developer to test code that was just merged, but
  57 which has not been included in an `autorelease build
  58 <autorelease-builds.html>`_ yet. The job is also triggered daily, to ensure
  59 that OpenDaylight's Continuous Delivery pipeline is fed new builds even if
  60 autorelease is broken.
  61
  62 Test Jobs
  63 ---------
  64
  65 packaging-test-rpm
  66 ^^^^^^^^^^^^^^^^^^
  67
  68 The `packaging-test-rpm job`_ accepts a link to an RPM and validates it. It
  69 installs the package with the system's package manager, starts OpenDaylight's
  70 systemd service, verifies that it's reported as active, connects to the Karaf
  71 shell and checks that some key bundles are present.
  72
  73 Repositories
  74 ------------
  75
  76 CentOS
  77 ^^^^^^
  78
  79 While most RPM builds are triggered automatically in OpenDaylight's Jenkins,
  80 some RPMs are promoted to be hosted in OpenDaylight's CentOS repositories.
  81 There are a series of repos that are updated at varying frequencies, from
  82 testing repos that are updated with pre-release versions very frequently to
  83 release repos that are the permanent home of official OpenDaylight releases.
  84
  85 Testing Repositories
  86 ....................
  87
  88 Repositories with the -testing suffix are updated very frequently with
  89 pre-release versions of OpenDaylight from the appropriate branch. New RPMs
  90 replace the old ones, so installing from these repos will always provide the
  91 most recent versions.
  92
  93 Testing repos for Boron, Carbon and Nitrogen:
  94
  95 - `nfv7-opendaylight-5-testing`_
  96 - `nfv7-opendaylight-6-testing`_
  97 - `nfv7-opendaylight-7-testing`_
  98
  99 Release Repositories
 100 ....................
 101
 102 Repositories with the -release suffix host official OpenDaylight releases. They
 103 are updated infrequently to never, and will host their release artifacts
 104 forever. Release repos are subdivided into two groups based version numbers.
 105 Repositories with both a major and minor version number (52, 53, 60) are pinned
 106 to a specific OpenDaylight release or service release (Boron SR2 5.2.0, Boron
 107 SR3 5.3.0, Carbon 6.0.0). Repositories with only a major version (5, 6) will
 108 always host the latest service release from that major release. If a new SR
 109 comes out, the repo will get the update (Boron SR4 will replace Boron SR3).
 110
 111 Release repos for the latest Boron and Carbon service releases:
 112
 113 - `nfv7-opendaylight-5-release`_
 114 - `nfv7-opendaylight-6-release`_
 115
 116 Release repos that will permanently host specific Boron and Carbon releases:
 117
 118 - `nfv7-opendaylight-50-release`_
 119 - `nfv7-opendaylight-51-release`_
 120 - `nfv7-opendaylight-52-release`_
 121 - `nfv7-opendaylight-53-release`_
 122 - `nfv7-opendaylight-60-release`_
 123
 124 Repository Configuration Files
 125 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 126
 127 While it's possible to install RPMs directly (`dnf install -y <URL>`), it's
 128 often easier to use a repository configuration file to install whatever the
 129 latest RPM is in a given repo.
 130
 131 The OpenDaylight Integration/Packaging project provides `example repo config
 132 files for each official repository`_.
 133
 134 Package managers like Yum and DNF will automatically find repo configuration
 135 files placed in the /etc/yum.repos.d/ directory. Curl them into place with
 136 something like:
 137
 138     sudo curl -o /etc/yum.repos.d/opendaylight-7-testing.repo \
 139       "https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging.git;a=blob_plain;f=packages/rpm/example_repo_configs/opendaylight-7-testing.repo"
 140
 141 Standard install commands will now find the repository as expected.
 142
 143     sudo dnf install -y opendaylight
 144
 145 Custom RPMs
 146 -----------
 147
 148 It's possible for developers to build custom RPMs, typically with unmerged
 149 patches that need system testing. First, use the `integration-multipatch-test`_
 150 job to create a custom distribution that includes the set of unmerged patches.
 151 See the `Custom Distributions <distribution-job-builds.html#custom-
 152 distributions>`_ section for extensive docs. Once you have a custom
 153 distribution artifact, pass it to the `packaging-build-rpm job`_ to package it
 154 as an RPM. See the `packaging-build-rpm`_ section for docs.
 155
 156
 157 .. _packaging-build-rpm job: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-master/
 158 .. _parameters: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-master/build
 159 .. _RPM build logic in Integration/Packaging's repo: https://github.com/opendaylight/integration-packaging/blob/master/rpm/build.py
 160 .. _packaging-build-rpm-snap job: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-snap-master/
 161 .. _packaging-test-rpm job: https://jenkins.opendaylight.org/releng/job/packaging-test-rpm-master/
 162 .. _nfv7-opendaylight-5-testing: http://cbs.centos.org/repos/nfv7-opendaylight-5-testing/x86_64/os/Packages/
 163 .. _nfv7-opendaylight-6-testing: http://cbs.centos.org/repos/nfv7-opendaylight-6-testing/x86_64/os/Packages/
 164 .. _nfv7-opendaylight-7-testing: http://cbs.centos.org/repos/nfv7-opendaylight-7-testing/x86_64/os/Packages/
 165 .. _nfv7-opendaylight-5-release: http://cbs.centos.org/repos/nfv7-opendaylight-5-release/x86_64/os/Packages/
 166 .. _nfv7-opendaylight-6-release: http://cbs.centos.org/repos/nfv7-opendaylight-6-release/x86_64/os/Packages/
 167 .. _nfv7-opendaylight-50-release: http://cbs.centos.org/repos/nfv7-opendaylight-50-release/x86_64/os/Packages/
 168 .. _nfv7-opendaylight-51-release: http://cbs.centos.org/repos/nfv7-opendaylight-51-release/x86_64/os/Packages/
 169 .. _nfv7-opendaylight-52-release: http://cbs.centos.org/repos/nfv7-opendaylight-52-release/x86_64/os/Packages/
 170 .. _nfv7-opendaylight-53-release: http://cbs.centos.org/repos/nfv7-opendaylight-53-release/x86_64/os/Packages/
 171 .. _nfv7-opendaylight-60-release: http://cbs.centos.org/repos/nfv7-opendaylight-60-release/x86_64/os/Packages/
 172 .. _example repo config files for each official repository: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging.git;a=tree;f=packages/rpm/example_repo_configs;hb=refs/heads/master
 173 .. _integration-multipatch-test: https://jenkins.opendaylight.org/releng/search/?q=integration-multipatch-test
 174 .. _oxygen-devel: https://nexus.opendaylight.org/content/repositories/opendaylight-oxygen-epel-7-x86_64-devel/org/opendaylight/integration-packaging/opendaylight/