Skip to main content
Jump to: navigation, search

Difference between revisions of "CBI"

m (Fixed broken link to "Build Technologies")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
The Eclipse Common Build Infrastructure (CBI) is an initiative combining 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
  
==Initiative Goals==
+
== 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.}}
 +
 
 +
=CBI Goals=
 
Primary goals are:
 
Primary goals are:
 
* Make it really easy to contribute Eclipse projects
 
* Make it really easy to contribute Eclipse projects
Line 25: Line 68:
 
* Get all Eclipse projects building their software on Eclipse Foundation hardware.
 
* Get all Eclipse projects building their software on Eclipse Foundation hardware.
 
* Make it easy for people to build custom Eclipse distributions.
 
* Make it easy for people to build custom Eclipse distributions.
 
 
==Who is using it?==
 
 
There's a [https://ci.eclipse.org/ list of projects] building with CBI available.
 
  
 
==Preferred Build Technologies==
 
==Preferred Build Technologies==
Line 35: Line 73:
 
===Jenkins===
 
===Jenkins===
  
* [http://ci.eclipse.org The list of Jenkins instances at Eclipse]
+
* See: [[Jenkins]]
* [[Jenkins]]
+
  
 
===Maven===
 
===Maven===
Line 120: Line 157:
  
 
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]].
 
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]].
 
==Related Topics and Links==
 
* [[Build_Technologies| Build Technologies]]
 
  
 
==Resources==
 
==Resources==
=== Mailing-list ===
+
* [https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
[https://dev.eclipse.org/mailman/listinfo/cbi-dev cbi-dev]
+
 
+
=== FAQ ===
+
 
+
 
* See your [[CBI/FAQ|Frequently Asked Question list]]
 
* See your [[CBI/FAQ|Frequently Asked Question list]]
  
===Bugs===
 
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap;product=CBI;version=1.0;list_id=2249872 CBI 1.0]
 
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap;product=CBI;version=2.0;list_id=2249872 CBI 2.0]
 
* [https://bugs.eclipse.org/bugs/buglist.cgi?action=wrap&product=CBI&list_id=38248 List of All Bugs] (Product = CBI)
 
 
===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]
 
 
 
==Meetings==
 
 
=== Next Meeting ===
 
See the [http://wiki.eclipse.org/CBI/Conference conference bridge details]. Contact andrew dot ross at eclipse dot org if you would like to be added to the Calendar reminder. The dates the upcoming calls are as follows:
 
* November 15th, 9am EST
 
 
===Meeting Minutes===
 
* [http://wiki.eclipse.org/CBI/Jan10_2012 January 10, 2012]
 
* [http://wiki.eclipse.org/CBI/Jan24_2012 January 24, 2012]
 
* [http://wiki.eclipse.org/CBI/Feb7_2012 February 7, 2012]
 
* [http://wiki.eclipse.org/CBI/March6_2012 March 6, 2012]
 
* [http://wiki.eclipse.org/CBI/Mar20_2012 March 20, 2012]
 
* [http://wiki.eclipse.org/CBI/Code_Sprint_April_11_2012 Code Sprint #1, April 11, 2012] - in Ottawa, Canada
 
* [http://wiki.eclipse.org/CBI/Apr17_2012 April 17, 2012]
 
* [http://wiki.eclipse.org/CBI/May1_2012 May 1, 2012]
 
* [http://wiki.eclipse.org/CBI/May15_2012 May 15, 2012]
 
* [http://wiki.eclipse.org/CBI/May29_2012 May 29, 2012]
 
* [http://wiki.eclipse.org/CBI/June12_2012 June 12, 2012]
 
* [http://wiki.eclipse.org/CBI/June26_2012 June 26, 2012]
 
* [http://wiki.eclipse.org/CBI/July25_2012 July 25, 2012]
 
* [http://wiki.eclipse.org/CBI/November15_2012 November 15, 2012]
 
* [http://wiki.eclipse.org/CBI/January8_2013 January 8, 2013]
 
  
[[Category:CBI]]
+
[[Category:CBI]] [[Category:Releng]] [[Category:Jenkins]]

Latest revision as of 15:43, 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.


CBI 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