Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 3.69 KB

platform.md

File metadata and controls

128 lines (93 loc) · 3.69 KB

Platform Service

https://releases.apache.org

Datastore

We will iterate on these during implementation.

  1. Release Storage. A large filesystem with folders for each release's files.
  2. Metadata Database. A database on the server with the metadata schema.

See Data Model for a discussion of the objects managed by the ATR.

Web Service

  1. asfquart based asynchronous python web service.
  2. Fronted by httpd.
  3. Static content may be served without going through asfquart.
  4. Monolithic.
  5. Fronted by a CDN. The caching policies need to be properly defined.

Legacy

  1. These domains continue to work in the same way:
    • archive.apache.org
    • downloads.apache.org and dlcdn.apache.org
    • dist.apache.org
  2. See Legacy Releases from SVN Dist. In this development phase we prefer to be at transition 2.

Release Stages

  1. Build Releases
  2. Candidate Releases
  3. Current Releases
  4. Archived / Revoked / EOL / Atticked Releases

“Nightlies” a particular build type is for a later phase.

Release Phases

See Release Lifecycle for how phases are chained together to perform a Release.

Release co-ordinates

The co-ordinates make up the external path to objects. The metadata database provides the map to the local path.

  1. Stage (Candidate, Current, Archived, …)
  2. PMC (Responsible TLP or Incubator PPMC)
  3. Product Line (Main, Sub-projects)
  4. Version (String, latest)
  5. Files, Metadata (A release is a folder of one or more files or sub-folders)

The following are examples. We will iterate during implementation.

  • Latest main product release: /<stage>/<pmc>/latest/<file>
  • Main product by version: /<stage>/<pmc>/<version>/<file>
  • Latest product release: /<stage>/<pmc>/<product>/latest/<file>
  • Product release by version: /<stage>/<pmc>/<product>/<version>/<file>

Restful API

  1. GET

    • Metadata
    • Release
    • Package files including SBOMs
    • Signing keys

  2. CRUD on

    • Releases - Delete is not removal. It is a stage.
    • Artifacts - Managed with a Release. Infra can do targeted full CRUD on artifacts if required.
    • Public Signing Keys - Delete only if unused.
    • Votes - Store each vote in metadata.
    • SBOMs - Special files stored in the release folder.

  3. POST Phases - Transitions, Activities, and Communication

    • Transition into Phase.
    • Perform Phase activity.
    • Optionally email phase status.

    See Release Lifecycle for how phases are chained together to perform a Release.

  4. POST Templated Emails

    • Announcements
    • Votes
    • Status
    • Transitions

Web UI

Note: this section is a flexible outline of what we intend for the UI, and may change during implementation.

  1. Directory Pages

    • PMC directory (main page) - excludes podlings and atticked PMCs
    • PMC release directory (also PPMC)
    • Incubator podling directory
    • Atticked PMC directory

  2. Release Page

    • Download page requirements
    • Release level metadata
    • PMC Information and webspage links
    • Download package from directory of release
    • Maintenance actions
    • History of events

  3. PMC Management Page

    • PMC level metadata and releases
    • Product level metadata and releases
    • Manage releases
    • PMC lifecycle transitions - podling, TLP, attic.

  4. System Admin Page

    • Manage Distribution Channels
    • Perform Migration Tasks
    • Enable GHA Builds
    • Manage PMC Transitions
    • Watch Operations

  5. Audit Page

    • ASF event history
    • PMC event history
    • Product event history

  6. Page Template

    • Responsive with Header(Hamburger)/Content/Footer.
    • Include Search in Header(Hamburger)