Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Linux Foundation Releng Documentation is an operational guide and service index for projects using Linux Foundation Continuous Integration (LFCI). It is not a single software product: it brings together infrastructure guidance, self-service procedures, and documentation for tools such as Gerrit, Jenkins, and Nexus.

What the Releng documentation covers

The master documentation site organizes practical guidance for operating within LF’s CI environment. Its landing page links to an environment overview and best practices, along with guides for Ansible, Git, Gerrit, GPG2, Jenkins, Jenkins Sandbox, Jenkins Build Failure Analyzer, Nexus 2 and 3, MeetBot, and SSH.

It also links to self-service procedures for project creation, committer management, and GitHub Copilot Enterprise access for LF project maintainers. The tools section points to resources including common-packer, lfdocs-conf, lftools, global-jjb, pipelines, and gerrit-to-platform. Separate infrastructure documentation covers inventory, escalation, infrastructure bootstrap, Gerrit, Jenkins, JIRA, Nexus, OpenStack management, and GitHub setup.

How the LF CI infrastructure is organized

LF says projects generally receive a similar CI setup unless there is a reason to deviate. The documented design separates public-facing CI systems and artifact storage from private build capacity:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  • DMZ cloud: Hosts CI and artifact services that project communities need to reach.
  • Private dynamic instance cloud: Runs build instances that can access DMZ resources and external internet services, but not deeper LF networks.
  • Other services: Services that do not need to sit alongside CI may be hosted separately to limit the potential impact of a security issue involving repository hosting.

Projects may begin in a restricted pre-formation phase. After formation, hosted services become public and inventories are updated. The environment guidance also says seed code must meet applicable intellectual-property and licensing requirements and use a squash commit with a Developer’s Certificate of Origin sign-off. See the LF CI environment overview for the operational context.

How project creation with INFO.yaml works

Project creation is a reviewed, repository-based workflow. A maintainer prepares project information in the releng/info-master repository; merging the approved change triggers automation to create the Gerrit project and related resources.

  1. Find the correct location in releng/info-master and create the project directory.
  2. Create or generate INFO.yaml, then fill in the project and committer details.
  3. Check the file, commit it with sign-off, and submit the change for review.
  4. After approval and merge, allow the automation to create the project and associated resources.

Jenkins deployment setup requires follow-up work. After INFO.yaml merges, project credentials are updated; maintainers then configure Maven settings and credential mappings in the project’s ci-management repository so Jenkins can deploy artifacts and container images to Nexus or Nexus3. The project creation guide describes the procedure.

How to publish project documentation

LF recommends writing project documentation in reStructuredText and building it with Sphinx. Two LF tools support the workflow: lfdocs-conf supplies shared documentation dependencies and configuration, while global-jjb provides CI job templates to build and publish documentation.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  1. Write the project documentation in reStructuredText.
  2. Use Sphinx to build it, with lfdocs-conf for shared configuration and dependencies.
  3. Configure the project’s CI jobs with the relevant global-jjb templates to build and publish the documentation.

The exact repository setup depends on the project; the project documentation guide explains the LF-supported toolchain.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

What to do when Gerrit, Jenkins, or Nexus is down

LF treats Gerrit, Jenkins, and Nexus as critical because they support code retrieval and review, builds, and artifact access. A project’s own code or compile failure is different from an infrastructure outage: it becomes an infrastructure emergency when a service failure prevents builds or blocks these shared functions.

  1. Investigate the problem and fix it locally if possible.
  2. If the issue appears to involve LF infrastructure, contact the LF IT infrastructure channel.
  3. If emergency escalation is needed, call the emergency line and identify both the affected project and the failed service.

Use the infrastructure escalation guide for the documented response path.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.