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 appropriate 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, either:
  47
  48 * Set the DEPLOY_TO_REPO parameter to opendaylight-epel-7-x86_64-devel. This is
  49   a scratch repo that sandbox packaging jobs have permission to push to.
  50   Packages will land in the `scratch repo on Nexus`_.
  51 * Add a path regex that matches it to the Archive Artifacts param of the job
  52   (`ARCHIVE_ARTIFACTS=/home/jenkins/rpmbuild/RPMS/ noarch/opendaylight*.rpm`).
  53   The files matched will be stored in OpenDaylight's log archive along with the
  54   other job logs.
  55
  56 packaging-build-rpm-snap
  57 ^^^^^^^^^^^^^^^^^^^^^^^^
  58
  59 The `packaging-build-rpm-snap job`_ packages the most recent `snapshot
  60 distribution <distribution-job-builds.html>` build from a given branch as an
  61 RPM. This could be used by a developer to test code that was just merged, but
  62 which has not been included in an `autorelease build
  63 <autorelease-builds.html>`_ yet. The job is also triggered daily, to ensure
  64 that OpenDaylight's Continuous Delivery pipeline is fed new builds even if
  65 autorelease is broken.
  66
  67 Test Jobs
  68 ---------
  69
  70 packaging-test-rpm
  71 ^^^^^^^^^^^^^^^^^^
  72
  73 The `packaging-test-rpm job`_ accepts a link to an RPM and validates it. It
  74 installs the package with the system's package manager, starts OpenDaylight's
  75 systemd service, verifies that it's reported as active, connects to the Karaf
  76 shell and checks that some key bundles are present.
  77
  78 Repositories
  79 ------------
  80
  81 OpenDaylight Nexus
  82 ^^^^^^^^^^^^^^^^^^
  83
  84 Packages resulting from build jobs running on OpenDaylight's infrastructure are
  85 automatically hosted on OpenDaylight's Nexus repositories.
  86
  87 Continious Delivery Repositories
  88 ................................
  89
  90 OpenDaylight provides fully-automated Continuous Delivery pipelines for RPMs.
  91
  92 Every RPM built in the production RelEng Jenkins silo is pushed to the devel
  93 repo appropriate for its branch. Builds are triggered for every successful
  94 autorelase job, as well as daily using the latest available snapshot build.
  95
  96
  97 Continuous Delivery repos for Oxygen and Fluorine:
  98
  99 - `opendaylight-oxygen-epel-7-x86_64-devel`_
 100 - `opendaylight-fluorine-epel-7-x86_64-devel`_
 101
 102 CentOS Community Build System
 103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 104
 105 While most RPM builds are triggered automatically in OpenDaylight's Jenkins,
 106 some RPMs are promoted to be hosted in OpenDaylight's CentOS repositories.
 107 There are a series of repos that are updated at varying frequencies, from
 108 testing repos that are updated with pre-release versions very frequently to
 109 release repos that are the permanent home of official OpenDaylight releases.
 110
 111 Release Repositories
 112 ....................
 113
 114 Repositories with the -release suffix host official OpenDaylight releases. They
 115 are updated infrequently to never, and will host their release artifacts
 116 forever. Release repos are subdivided into two groups based version numbers.
 117 Repositories with both a major and minor version number (81, 82) are pinned to
 118 a specific OpenDaylight release or service release (Oxygen 8.0.0, Oxygen SR1
 119 8.1.0). Repositories with only a major version (8, 9) will always host the
 120 latest service release from that major release. If a new SR comes out, the repo
 121 will get the update (Oxygen 3 will replace Oxygen SR2).
 122
 123 Release repo for the latest Oxygen service release:
 124
 125 - `nfv7-opendaylight-8-release`_
 126
 127 Release repos that will permanently host specific Carbon and Nitrogen releases:
 128
 129 - `nfv7-opendaylight-80-release`_
 130 - `nfv7-opendaylight-81-release`_
 131 - `nfv7-opendaylight-82-release`_
 132
 133 Repository Configuration Files
 134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 135
 136 While it's possible to install RPMs directly (`dnf install -y <URL>`), it's
 137 often easier to use a repository configuration file to install whatever the
 138 latest RPM is in a given repo.
 139
 140 The OpenDaylight Integration/Packaging project provides `example repo config
 141 files for each official repository`_.
 142
 143 Package managers like Yum and DNF will automatically find repo configuration
 144 files placed in the /etc/yum.repos.d/ directory. Curl them into place with
 145 something like:
 146
 147     sudo curl -o /etc/yum.repos.d/opendaylight-9-devel.repo \
 148       "https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging.git;a=blob_plain;f=packages/rpm/example_repo_configs/opendaylight-9-devel.repo"
 149
 150 Standard install commands will now find the repository as expected.
 151
 152     sudo dnf install -y opendaylight
 153
 154 The latest RPM in the repo will be installed.
 155
 156 Custom RPMs
 157 -----------
 158
 159 It's possible for developers to build custom RPMs, typically with unmerged
 160 patches that need system testing.
 161
 162 Most developers will want to run these jobs in the ODL Jenkins sandbox
 163 instance, as only a few community members have permission to manually trigger
 164 jobs on the releng Jenkins instance. See the `Jenkins sandbox`_ docs for
 165 details about how to get permissions to trigger sandbox jobs, required
 166 configuration and normal usage.
 167
 168 To build an custom distribution with unmerged code, first use the
 169 `integration-multipatch-test`_ job to create distribution that includes the set
 170 of unmerged patches.  See the `Custom Distributions
 171 <distribution-job-builds.html#custom- distributions>`_ section for extensive
 172 docs.
 173
 174 Once you have the distribution you want to package as an RPM, pass it to the
 175 `packaging-build-rpm job`_ to do the build. Use the See the `packaging-build-rpm`_
 176 section for docs.
 177
 178 .. _packaging-build-rpm job: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-master/
 179 .. _parameters: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-master/build
 180 .. _RPM build logic in Integration/Packaging's repo: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging.git;a=tree;f=packages/rpm
 181 .. _packaging-build-rpm-snap job: https://jenkins.opendaylight.org/releng/job/packaging-build-rpm-snap-master/
 182 .. _packaging-test-rpm job: https://jenkins.opendaylight.org/releng/job/packaging-test-rpm-master/
 183 .. _opendaylight-oxygen-epel-7-x86_64-devel: https://nexus.opendaylight.org/content/repositories/opendaylight-oxygen-epel-7-x86_64-devel/org/opendaylight/integration-packaging/opendaylight/
 184 .. _oxygen-devel: https://nexus.opendaylight.org/content/repositories/opendaylight-oxygen-epel-7-x86_64-devel/org/opendaylight/integration-packaging/opendaylight/
 185 .. _opendaylight-fluorine-epel-7-x86_64-devel: https://nexus.opendaylight.org/content/repositories/opendaylight-fluorine-epel-7-x86_64-devel/org/opendaylight/integration-packaging/opendaylight/
 186 .. _nfv7-opendaylight-80-release: http://cbs.centos.org/repos/nfv7-opendaylight-80-release/x86_64/os/Packages/
 187 .. _nfv7-opendaylight-81-release: http://cbs.centos.org/repos/nfv7-opendaylight-81-release/x86_64/os/Packages/
 188 .. _nfv7-opendaylight-82-release: http://cbs.centos.org/repos/nfv7-opendaylight-82-release/x86_64/os/Packages/
 189 .. _nfv7-opendaylight-8-release: http://cbs.centos.org/repos/nfv7-opendaylight-8-release/x86_64/os/Packages/
 190 .. _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
 191 .. _integration-multipatch-test: https://jenkins.opendaylight.org/releng/search/?q=integration-multipatch-test
 192 .. _Jenkins sandbox: https://docs.opendaylight.org/en/stable-carbon/submodules/releng/builder/docs/jenkins.html#jenkins-sandbox
 193 .. _scratch repo on Nexus: https://docs.opendaylight.org/en/stable-carbon/submodules/releng/builder/docs/jenkins.html#jenkins-sandbox