Services and Tools

Infra maintains a wide range of tools for PMCs, project committers, and the Apache Board to use. Parts of our toolkit are only available to people who have specific duties or roles. Others, like the monitoring tools that show the status of various parts of the Apache infrastructure, are available to everyone.

• Services for Top-Level Projects (TLPs)
  • Websites
  • Email
  • ASF self-service platform
  • Getting notices of infrastructure events
  • LDAP-enabled services
• Services for incubating projects (podlings)
• Tools for ASF projects
  • Version control
  • Issue tracking and feature requests
  • Integrating your repository with Jira tickets
  • Source repository publisher/subscriber services
  • Build services
  • Product naming
  • Code signing
  • Code quality
  • Code distribution
  • Virtual servers
  • Online voting
• Other tools
  • DNS
  • URL shortener
  • Sharing snippets
  • Logging
  • Machine list
  • Whimsy

Services for Top-Level Projects (TLPs)¶

Websites¶

• www.apache.org is the main ASF website.
• ASF project websites.
• An index of all ASF projects.
• Any ASF project can use the ASF-Pelican template as the basis for their project website.
• Details about individual ASF Committers.
• Notes about committers' personal web spaces.
• The Apache Project Website Checker periodically reviews all TLP websites and reports whether they comply with Apache's policies for TLP websites.

Email¶

• All requests for new email lists should go through the self-serve system. Remember not to mark a list as private if you want it publicly archived.
• Email server - QMail/QSMTPD
• email lists - EZMLM
• Searchable private email list archives (mod_mbox). ASF Members have full access; PMC members have access to their PMC's archives only.
• Spam control - Spamfilter + SpamAssassin
• Email forwarding: See id.apache.org
• PonyMail lets you browse Apache email archives by certain categories, by user, or by project. You must log in if you want to respond to an email, or write a new one, through this interface.
• Infra maintains and uses a series of email lists, some of which are open to committers.

ASF self-service platform¶

One of Infra's goals is to empower ASF members, PMCs, and committers to do much of what they need to do without having to request help from Infra. The Self-Service Platform, for example, provides a number of handy tools that people who have an Apache email address (basically, project committers, PMC members, and ASF Members) can use to:

• Create a new Jira or Confluence project, Git repository, or email list (PMC Chairs and Infra members).
• Edit your ASF identity or update your ASF password. If you are updating your password, you need access to the email account associated with your Apache account. A reset key is only valid for 15 minutes, so be sure to use it as soon as it arrives.
• Synchronize Git repositories.
• Use the OTP Calculator to generate passwords for the OTP or S/Key one-time-password systems (generally, PMC members).
• Archive a Confluence Wiki space and make it read-only.

Locked out of the system?

If you have forgotten your password and cannot retrieve it, contact Infrastructure via root@apache.org for assistance.

Before asking for a manual password reset or email change, please consider:

• If you have access to an ASF machine via SSH (with a private key), you can use this to confirm your identity.
• If you don't have access to anything to establish your identity, you may need to file a new ICLA.

Getting notices of infrastructure events¶

You can subscribe to notices of infrastructure events that you want to know about, ranging from Subversion commits to emails to specific lists. [Learn more here](pypubsub.html).

LDAP-enabled services¶

Infra supports many ASF LDAP-enabled services. You can log in to them with your LDAP credentials.

Services for incubating projects (podlings)¶

Infra supports incubating projects, or podlings.

• An introduction to Infra and the Incubator, showing the steps for setting up a new podling.
• Guidance for selecting a project or product name

Tools for ASF projects¶

Infra supports an array of tools and services to help projects develop and support both their applications and their community. They include:

Tools for ASF projects¶

• Every project can use a dedicated space on the Confluence wiki.
  • How to manage user permissions in your project's wiki space.
  • How to give a user edit access to the wiki space.
• Reporter provides actvitity statistics and other information about your project, and editing tools to help you write and submit your project's quarterly Board reports.
• You can create and run a project blog.
• You can establish a Slack channel for real-time team discussions.
• Teams can conduct and record meetings through Internet Relay Chat (IRC) using ASFBot. However, you must conduct formal votes on decisions in the appropriate project email list, following the Apache voting process.
• Localization tools.
• The Apache Release Audit Tool (RAT) can help you confirm that your proposed product release complies with all ASF requirements.
• The ASF OAuth system provides a focal point for services wishing to make use of authentication without security implications around storing sensitive user data. Many Apache services use it to validate that the user requesting access is a committer within the project and has lawful access to the systems in question.

Version control¶

Apache provides, and Infra maintains, code repositories that Apache projects can use to keep their project code safe, accessible to team members, and under version control.

• Information about using Git

  • Read-only Git mirrors of SVN codebases
  • Writable Git repositories
  • Apache and GitHub
  • Access roles for GitHub repositories

• Information about using Subversion

  • Subversion (SVN) repositories
  • ViewVC (Browser interface to the main SVN repository)

Issue tracking and feature requests¶

The ASF recommends these options for tracking issues and feature requests:

• Jira
• The GitHub issue tracking feature

For historical reasons, some projects use Bugzilla. We continue to support Bugzilla, but will not set it up for projects that do not already use it.

Apache Allura is another issue-tracking option. If you feel it may meet your project's needs, consult directly with the Allura project through their users@allura.apache.org email list.

See issues.apache.org for a list of what each project uses.

Here is how to request a bug and issue tracker for your project.

Here are some guidelines for writing a good bug report.

Integrating your repository with Jira tickets¶

Infra can activate a Subversion and Git integration with Jira tickets for your project.

Source repository publisher/subscriber services¶

• SvnPubSub
• PyPubSub

Build services¶

Apache supports and models continuous integration and continuous deployment, or CI/CD. The Apache Build services site provides more information, and links to these build tools:

• BuildBot
• Gump
• Jenkins

Other tools to consider:

• Travis CI
• Appveyor

More information about our build and continuous integration tools is on this page.

Product naming¶

See guidance for choosing a product name

Code signing¶

• Digicert
  • Requesting access to the Digicert code signing service
  • Using Digicert
  • Digicert use statistics by Apache projects
• For distribution via the Apple App Store
• For the Google code signing service for Android apps
• More information on code signing and publishing

Code quality¶

SonarQube is an open-source platform developed by SonarSource for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security vulnerabilities on 20+ programming languages. You can check the status of many Apache project repositories here.

Read more.

Code distribution¶

Use the ASF Nexus Repository Manager to browse for and review code distributions by ASF projects.

Distributions¶

• Current distributions
• Historical distribution archives
• Rsync for distribution mirrors
• Nexus

Virtual servers¶

Infra can provide Ubuntu virtual machines for projects. See:

• Virtual machine policy
• Process for requesting a vm

Online voting¶

Projects can use the Apache STeVe voting system instance (offline when not in use). The tool name refers to the single transferable vote system it uses.

Other tools¶

DNS¶

Infra manages the ASF DNS, which is registered with Namecheap.

URL shortener¶

URL shortener

Sharing snippets¶

Paste is a service that lets ASF members post code snippets or similar file extracts they want to share to illustrate a code issue or make available for reuse, usually with other project members. You can post content as plain text, or formatted for a number of coding and scripting languages.

Logging¶

Kibana

Machine list¶

Host Keys and Fingerprints

Whimsy¶

Apache Whimsy describes itself as "providing organizational information about the ASF and our projects in easy to consume ways, and to help automate corporate processes at the ASF to make the paperwork behind the scenes easier for our many volunteers."

There are many Whimsy tools useful for PMCs and individual committers, such as Committer search.