Skip to main content
Jump to: navigation, search

Difference between revisions of "CBI"

Line 1: Line 1:
 
The Eclipse Common Build Infrastructure (CBI) is an initiative combining infrastructure, technologies and practices for building Eclipse Software.
 
The Eclipse Common Build Infrastructure (CBI) is an initiative combining infrastructure, technologies and practices for building Eclipse Software.
  
==What is CBI==
+
= Jenkins @ Eclipse (JIPP) =
 +
Jenkins is a continuous integration (CI) server used on Eclipse servers for Eclipse projects as part of the [[CBI|Common Build Infrastructure (CBI)]]. Jenkins instances are maintained by the Eclipse Webmasters/Release Engineer.
  
The core of CBI today is Maven with the Tycho plugins. The Tycho plugins teach Maven how to build (and consume) Eclipse plugins and OSGi bundles. This enables building Eclipse projects with "maven clean install" just as one would build other Maven projects.
+
* List of Jenkins Instances Per Project (JIPP):
 +
** https://ci.eclipse.org/ (standalone)
 +
** https://jenkins.eclipse.org/ (Kubernetes cluster)
  
Common services such as the Jar signing facility, MacOS signing facility, and Windows signing facility are also included with CBI. Other tools and services may be included in the future as the need arises.
+
NOTE: JIPP instances are being migrated from a standalone implementation to a Kubernetes cluster implementation.
  
Over time mature templates and common pom.xml files will be provided that set common values finely honed with experience.
+
== What's provided? ==
  
One might go so far as to include Git, Jenkins, the build slaves, and Nexus (aka. the artifact repository & server side of Maven) as part of CBI since they are also common and crucial to builds.
+
Each Eclipse Project has access to one Jenkins instance (JIPP), including the following:
  
Gerrit, Bugzilla, and the Downloads site are closely related. Some might consider them part of CBI as well.
+
* (1) Jenkins instance, with (1) resources Base Pack (see below)
 +
** Membership-sponsored projects may allocate more resources (see below)
 +
* Digital signing Service: Java JAR, Java Cryptography Extensions, Windows Portable Executable with Microsoft Authenticode,  macOS application bundles.
 +
* Packaging service: Apple Disk Image (.dmg), Linux Flatpak
 +
* Disk space: Ephemeral for builds, permanent for release builds.
 +
* Access to worldwide download mirrors
 +
 
 +
== Additional Resource Packs ==
 +
 
 +
Each Eclipse Project has access to one Base pack for building. For some projects, that may not be enough. Projects sponsored by [https://www.eclipse.org/membership/exploreMembership.php Eclipse Membership] (via Project Lead) have additional Packs, based on [https://www.eclipse.org/membership/become_a_member/membershipTypes.php membership level]. These packs can be allocated to projects.
 +
 
 +
* Some Packs are only available to [https://www.eclipse.org/membership/become_a_member/membershipTypes.php Enterprise and Strategic members].
 +
* Enterprise and Strategic members can engage with the Foundation to acquire additional Packs.
 +
 
 +
[[File:CBI Resource Packs.png]]
 +
 
 +
=== Resource Packs Included in Membership ===
 +
 
 +
Eclipse Foundation Member Organizations have access to Resource Packs above the Base Pack that is allotted to each Project, based on their [https://www.eclipse.org/membership/become_a_member/membershipTypes.php membership level].
 +
 
 +
[[File:CBI Resource Pack Assignments.png]]
 +
 
 +
 
 +
=== Assigning Resource Packs to a Project ===
 +
 
 +
Resource Packs are assigned by Eclipse Members to Eclipse Projects they sponsor (Members have a Project Lead on the Project). Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A <ember can assign several packs to a single project.
 +
 
 +
To assign a pack to a project, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins&short_desc=Assign%20Resource%20Pack%20to%20Project file a Bug].
 +
 
 +
== Asking for Help ==
 +
 
 +
* Need help actually building your code: ask your project mentors, or ask on the Common Build mailing list (cbi-dev). There are no dumb questions.
 +
* Subscribe to cbi-dev here: https://dev.eclipse.org/mailman/listinfo/cbi-dev
 +
 
 +
== Requesting a JIPP instance ==
 +
 
 +
Please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=CI-Jenkins&short_desc=JIPP%20Request file a bug] against Eclipse Foundation > Community > CI-Jenkins to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download or code repositories.
 +
 
 +
{{Note|About write access| If your git repo is handled by Gerrit, granting write access to your code repositories is a different procedure, so you must ask specifically for it. If you don't use Gerrit, then granting write access to your download area automatically grants write access to your code repositories and vice-versa.}}
 +
 
 +
{{important|Security issues| There may be security issues related to using the Gerrit plugin and there may be security issues related to allowing the CI system to write directly to your code repos and downloads area. If you request plugins other than those available on the Shared instance, webmaster may not be able to help troubleshoot any issues that you may encounter with your instance.}}
 +
 
 +
= Jenkins configuration and tools  =
 +
 
 +
* Check [[CI best practices]] for general recommendations how to setup Jenkins.
 +
* Check the Eclipse [[Jenkins]] page for tools, configurations and other information.
  
 
==Initiative Goals==
 
==Initiative Goals==
Line 119: Line 167:
 
* [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
 
* [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
 
* See your [[CBI/FAQ|Frequently Asked Question list]]
 
* See your [[CBI/FAQ|Frequently Asked Question list]]
 
=Eclipse CBI (JIPP)=
 
Projects hosted at Eclipse.org can request one hosted instance of CBI. Details are provided on the [[Jenkins]] page. There's a [https://ci.eclipse.org/ list of projects] currently building with CBI available.
 
 
== Tools (and locations) ==
 
Build tools like JDK, Maven, Ant and Gradle are already configured in every Jenkins instance.
 
 
* JDK
 
** jdk10-latest (/shared/common/java/oracle/jdk-10_x64-latest)
 
** jdk9-latest (/shared/common/jdk-9_x64-latest)
 
** jdk1.8.0-latest (/shared/common/jdk1.8.0_x64-latest)
 
** jdk1.7.0-latest (/shared/common/jdk1.7.0-latest)
 
** jdk1.6.0-latest (/shared/common/jdk1.6.0-latest)
 
** jdk1.5.0-latest (/shared/common/jdk1.5.0-latest)
 
 
* Maven
 
** apache-maven-latest (/shared/common/apache-maven-latest)
 
** apache-maven-3.0.5 (/shared/common/apache-maven-3.0.5)
 
 
* Ant
 
** apache-ant-1.9.6 (/shared/common/apache-ant-1.9.6)
 
 
* Gradle
 
** gradle-latest (/shared/common/gradle-latest)
 
** gradle-3.1 (/shared/common/gradle-3.1)
 
 
More generally, all tools listed on http://build.eclipse.org/common/ are available from '''/shared/common/'''.
 
 
If you need tools that are not general purpose installed, project members can install them in your project's home directory, for example ~/buildtools. [https://dev.eclipse.org/mhonarc/lists/cbi-dev/msg01869.html See email on cbi-dev]
 
 
== Default plugins ==
 
 
The following plugins are installed by default. Additional plugins can be installed on request.
 
 
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
 
* ace-editor
 
* analysis-core
 
* ant
 
* antisamy-markup-formatter
 
* authentication-tokens
 
* bouncycastle-api
 
* branch-api
 
* build-timeout
 
* cloudbees-folder
 
* conditional-buildstep
 
* credentials
 
* credentials-binding
 
* dashboard-view
 
* disk-usage
 
* display-url-api
 
* docker-commons
 
* docker-workflow
 
* durable-task
 
* external-monitor-job
 
* extra-columns
 
* find-bugs
 
* gerrit-trigger
 
* git
 
* git-client
 
* git-parameter
 
* git-server
 
* gradle
 
* greenballs
 
* handlebars
 
* icon-shim
 
* javadoc
 
* jobConfigHistory
 
* jquery
 
* jquery-detached
 
* junit
 
* ldap
 
* mailer
 
* matrix-auth
 
* matrix-project
 
* maven-plugin
 
* momentjs
 
* pam-auth
 
* parameterized-trigger
 
* pipeline-build-step
 
* pipeline-graph-analysis
 
* pipeline-input-step
 
* pipeline-milestone-step
 
* pipeline-model-api
 
* pipeline-model-declarative-agent
 
* pipeline-model-definition
 
* pipeline-model-extensions
 
* pipeline-rest-api
 
* pipeline-stage-step
 
* pipeline-stage-tags-metadata
 
* pipeline-stage-view
 
* plain-credentials
 
* promoted-builds
 
* rebuild
 
* resource-disposer
 
* scm-api
 
* script-security
 
* sonar
 
* ssh-credentials
 
* ssh-slaves
 
* structs
 
* timestamper
 
* token-macro
 
* windows-slaves
 
* workflow-aggregator
 
* workflow-api
 
* workflow-basic-steps
 
* workflow-cps
 
* workflow-cps-global-lib
 
* workflow-durable-task-step
 
* workflow-job
 
* workflow-multibranch
 
* workflow-scm-step
 
* workflow-step-api
 
* workflow-support
 
* ws-cleanup
 
* xvnc
 
</div>
 
 
== Setup for specific plugins ==
 
 
=== GitHub Pull Request Builder Plugin ===
 
 
The [https://wiki.jenkins.io/display/JENKINS/GitHub+pull+request+builder+plugin GitHub Pull Request Builder Plugin] (GHPRB) allows to build/test pull requests and provide immediate feedback in the pull request on GitHub.
 
 
'''To set this up, please open a Bugzilla issue against the CI-Jenkins component (Product: Community) and request this feature.'''
 
 
Here are some details about what happens during the setup process:
 
* The GHPRB plugin is installed in the JIPP.
 
* Webmaster creates a GitHub bot user and adds it to the respective team on GitHub.
 
* The credentials of the GitHub bot user are added to the JIPP (with user name and password, because SSH keys are not recommended/supported by the plugin).
 
* The GHPRB plugin's main config is set up.
 
 
Once the ticket is resolved you should be able to configure and use the GHPRB plugin in your jobs.
 
 
Instructions how to set up GHPRB plugin in jobs can be found here:
 
https://github.com/jenkinsci/ghprb-plugin/blob/master/README.md
 
 
'''Please note: ''' Currently we don't recommend to use the 'Use github hooks for build triggering' option. Instead, with this option turned off, Jenkins is polling GitHub instead. Which should work just fine in most cases.
 
 
More info can be found in the GitHub readme:
 
https://github.com/jenkinsci/ghprb-plugin/blob/master/README.md
 
 
=== Jenkins Pipeline (aka configuration in code) ===
 
 
An example how Eclipse plugins can be build with Tycho using a Jenkins pipeline can be found here (Thanks to Mickael Istria!):<br/>
 
https://github.com/eclipse/aCute/blob/master/Jenkinsfile
 
 
More info about Jenkins Pipeline can be found here:<br/>
 
https://jenkins.io/doc/book/pipeline/<br/>
 
https://jenkins.io/doc/book/pipeline/shared-libraries/
 
 
=== Gerrit Trigger Plugin ===
 
 
You may use the [https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger Jenkins Gerrit Trigger Plugin] in order to run a Jenkins job to verify each new patchset uploaded to Gerrit for code review. Jenkins (named "CI Bot") will then also vote on these changes using the "Verify" voting category.
 
 
[[Image:Jgit.gerrit-reviewer.png|450px]]
 
 
[[Image:Jgit.gerrit-vote.png|450px]]
 
 
Below, the configuration sections for the Git plugin and the Gerrit trigger plugin of the verification job used by the EGit project may serve as an example.
 
 
====General configuration settings====
 
 
# Check ''This project is parameterized''. Click the ''Add'' button and select ''String Parameter''. Set the parameter ''Name'' to '''GERRIT_REFSPEC''' and ''Default Value'' to '''refs/heads/master'''.
 
 
[[Image:Gerrit-refspec-param.png|600px]]
 
 
====Configuration of Source Code Management====
 
 
# Under ''Source Code Management'' select Git.
 
 
# Under ''Repositories'', click on ''Advanced'' and change the '''Refspec''' to '''${GERRIT_REFSPEC}'''.
 
 
# Under ''Additional Behaviours'', add '''Strategy for choosing what to build''' and select '''Gerrit Trigger''' as a strategy.
 
 
[[Image:Jgit.gerrit-git-config.png|600px]]
 
 
Note that the section '''Branches to build''' won't be used and may be deleted.
 
 
====Configuration of Build Triggers ====
 
 
# Under ''Build Triggers'', select '''Gerrit event'''.
 
 
[[Image:Jgit.gerrit-gerrit-config.png|600px]]
 
 
# Under ''Trigger on'', click on ''Add'' and select at least '''Patchset Created'''. This will configure the job to run on each new patchset. You can also add additional trigger, like '''Comment Added Contains Regular Expression'''. In the example below, a build will be triggered for the latest patch set if the comment is exactly '''CI Bot, run a build please'''.
 
 
[[Image:gerrit-trigger-events.png|600px]]
 
 
# Finally, configure at least one ''Gerrit Project''. The pattern is the name of project (i.e. if your repository is <code>git.eclipse.org/<xx>/<yy>.git</code>, then fill the pattern <code>xx/yy</code>). The ''Branches'' section is the list of branch to listen for events as configured above. Generally, you want one, named '''master''' to build patches submitted for the master branche, or <code>**</code> to build patches submitted to each and every branches. Set the type to '''Path'''.
 
 
[[Image:gerrit-trigger-project.png|600px]]
 
 
====Configuration of the build action====
 
 
Under "Build" click the "Add a build step" button, and select the appropriate action. The actual action depends on what you want Hudson to do. A typical example, for projects build with Maven is to select "Invoke Maven 3" and set "Maven 3" to "apache-maven-latest" and "Goals" to "clean verify".
 
 
 
===Tutorials, News, and other resources===
 
* [http://www.vogella.com/articles/EclipseTycho/article.html Tycho tutorial by Lars Vogel]
 
* [http://www.fosslc.org/drupal/content/tycho-good-bad-and-ugly Video discussing JBoss tools use of Tycho]
 
* [http://wiki.eclipse.org/CBI/Workshops Workshops being developed]
 
* [http://www.vogella.com/blog/2012/10/08/building-eclipse-sdk-locally-with-maven/ Building Eclipse SDK locally with Maven]
 
* [http://mickaelistria.wordpress.com/2012/10/08/sonar-at-eclipse-org/ Sonar at Eclipse.org !]
 
* [http://youtu.be/KJUfLvXiTSw Tycho and CBI Adoption: Feedback from the trenches]
 
* [http://www.bsiag.com/scout/?p=678 Eclipse Scout builds with CBI]
 
  
  
 
[[Category:CBI]] [[Category:Releng]] [[Category:Jenkins]]
 
[[Category:CBI]] [[Category:Releng]] [[Category:Jenkins]]

Revision as of 14:37, 13 September 2018

The Eclipse Common Build Infrastructure (CBI) is an initiative combining infrastructure, technologies and practices for building Eclipse Software.

Jenkins @ Eclipse (JIPP)

Jenkins is a continuous integration (CI) server used on Eclipse servers for Eclipse projects as part of the Common Build Infrastructure (CBI). Jenkins instances are maintained by the Eclipse Webmasters/Release Engineer.

NOTE: JIPP instances are being migrated from a standalone implementation to a Kubernetes cluster implementation.

What's provided?

Each Eclipse Project has access to one Jenkins instance (JIPP), including the following:

  • (1) Jenkins instance, with (1) resources Base Pack (see below)
    • Membership-sponsored projects may allocate more resources (see below)
  • Digital signing Service: Java JAR, Java Cryptography Extensions, Windows Portable Executable with Microsoft Authenticode, macOS application bundles.
  • Packaging service: Apple Disk Image (.dmg), Linux Flatpak
  • Disk space: Ephemeral for builds, permanent for release builds.
  • Access to worldwide download mirrors

Additional Resource Packs

Each Eclipse Project has access to one Base pack for building. For some projects, that may not be enough. Projects sponsored by Eclipse Membership (via Project Lead) have additional Packs, based on membership level. These packs can be allocated to projects.

  • Some Packs are only available to Enterprise and Strategic members.
  • Enterprise and Strategic members can engage with the Foundation to acquire additional Packs.

CBI Resource Packs.png

Resource Packs Included in Membership

Eclipse Foundation Member Organizations have access to Resource Packs above the Base Pack that is allotted to each Project, based on their membership level.

CBI Resource Pack Assignments.png


Assigning Resource Packs to a Project

Resource Packs are assigned by Eclipse Members to Eclipse Projects they sponsor (Members have a Project Lead on the Project). Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A <ember can assign several packs to a single project.

To assign a pack to a project, please file a Bug.

Asking for Help

Requesting a JIPP instance

Please file a bug against Eclipse Foundation > Community > CI-Jenkins to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download or code repositories.

Note.png
About write access
If your git repo is handled by Gerrit, granting write access to your code repositories is a different procedure, so you must ask specifically for it. If you don't use Gerrit, then granting write access to your download area automatically grants write access to your code repositories and vice-versa.


Important.png
Security issues
There may be security issues related to using the Gerrit plugin and there may be security issues related to allowing the CI system to write directly to your code repos and downloads area. If you request plugins other than those available on the Shared instance, webmaster may not be able to help troubleshoot any issues that you may encounter with your instance.


Jenkins configuration and tools

  • Check CI best practices for general recommendations how to setup Jenkins.
  • Check the Eclipse Jenkins page for tools, configurations and other information.

Initiative Goals

Primary goals are:

  • Make it really easy to contribute Eclipse projects
    • Make it really easy to copy & modify source
    • Make it really easy to build
    • Make it really easy to test
    • Make it really easy to post a change for review
    • Make it really easy to sign software

Secondary goals are:

  • Get all Eclipse projects building their software on Eclipse Foundation hardware.
  • Make it easy for people to build custom Eclipse distributions.

Preferred Build Technologies

Jenkins

Maven

Maven 3.0 drives the builds. Projects are expected to provide standard Maven 3.0 POM files for their builds. The builds should be built in such a way that they can be run on the local workstation, or on the Eclipse build server. Note that builds can only be signed on the Eclipse build server.

Tycho

Tycho is focused on a Maven-centric, manifest-first approach to building Eclipse plug-ins, features, update sites, RCP applications and OSGi bundles.

Helpful links:

p2 Repo checks

It's highly recommended that any Eclipse.org project runs frequently, and maybe even systematically, the p2 repo analyzer to make sure it conforms to some requirements of being a nice citizen in the Eclipse.org world.

Nexus

Services/Nexus

Signing tool

Deliverables

Additionally to recommendation and infrastructure, the CBI also produces pieces of software that are meant to be commonly used by all Eclipse.org projects.

CBI License bundle

We offer a P2 repository containing the org.eclipse.license bundle which is located at:

   http://download.eclipse.org/cbi/updates/license/

This URL is a composite P2 repo containing the license bundle.


If you are using Tycho you can add the p2 repo to the <repositories> section of your pom.xml file. Something similar to this:

    <repository>
      <id>license-feature</id>
      <url>http://download.eclipse.org/cbi/updates/license/</url>
      <layout>p2</layout>
    </repository>

In any particular feature which you need the license you can use the usual feature.xml section:

<?xml version="1.0" encoding="UTF-8"?>
<feature
      id="org.eclipse.help"
      label="%featureName"
      version="2.0.0.qualifier"
      provider-name="%providerName"
      plugin="org.eclipse.help.base"
      license-feature="org.eclipse.license"
      license-feature-version="1.0.0.qualifier"/> 
....

Signing tool

p2 repo checks

A set of "tests" which create reports or can be ran as unit tests that check to correctness of p2 repositories. That is partially just "correctness" in general (such as, that jars are signed, etc.) but more so that repositories conform to the requirements of the Eclipse Simultaneous release (such as, that jars have correct "Provider names", licenses, etc.). For more information, see See CBI/p2repoAnalyzers/Repo Reports.

p2 repo aggregator

A tool to combine several p2 repositories. Among other things, it makes sure they all have consistent constraints (that is, can be "installed together") unlike a raw p2 mirror task. For more information see CBI/aggregator/manual.

Resources

Back to the top