ProductMD library documentation

ProductMD is a Python library providing parsers for metadata related to composes and installation media.

ProductMD supports multiple metadata format versions:

• v1.x (1.0, 1.1, 1.2): Local compose format with relative paths

• v2.0: Distributed compose format with Location objects (HTTPS URLs, OCI references)

Contents:

• Terminology
  • Release
  • Product Version
  • Product
  • Base Product
  • Compose
  • Variant
  • Tree
• Versioning
• Milestones
• ProductMD 2.0 Format Specification
  • Overview
  • Location Object
  • URL Schemes
  • Metadata Files
  • Version Detection
  • Checksum Format
  • Backward Compatibility
  • See Also
• v1.2 to v2.0 Migration Guide
  • Reading v2.0 Metadata (Consumers)
  • Writing v2.0 Metadata (Producers)
  • Downgrading back to v1.2
  • Verifying integrity
  • See Also
• Distributed Composes: Use Cases
  • What is a Distributed Compose?
  • Use Case 1: CDN-Hosted Composes
  • Use Case 2: OCI Registry Storage
  • Use Case 3: Mixed Storage
  • Use Case 4: Multi-Site Mirroring
  • Use Case 5: CI/CD Pipeline Integration
  • Localization Workflow
  • See Also

Python modules:

• common – Base classes and common functions
  • Constants
  • Functions
  • Classes
• compose – Easy access to compose metadata
  • Classes
• composeinfo – Compose metadata
  • Constants
  • Classes
  • Private Classes
• discinfo – Installation media metadata
  • Classes
• extra_files – Extra files metadata
  • Classes
• images – Image metadata
  • Classes
• location – Artifact locations and integrity
  • Constants
  • Functions
  • Classes
• modules – Module metadata
  • Classes
• rpms – RPM metadata
  • Classes
• treeinfo – Instalable trees metadata
  • Classes
• version – Version detection and handling
  • Constants
  • Functions
  • Classes

CLI Tools:

• productmd
  • Synopsis
  • Description
  • Input Auto-Detection
  • Commands
  • Exit Status
  • Examples
  • See Also
• productmd-upgrade
  • Synopsis
  • Description
  • Options
  • Examples
  • See Also
• productmd-downgrade
  • Synopsis
  • Description
  • Options
  • Examples
  • See Also
• productmd-localize
  • Synopsis
  • Description
  • Options
  • HTTP Authentication
  • OCI Support
  • Examples
  • See Also
• productmd-verify
  • Synopsis
  • Description
  • Options
  • Examples
  • See Also

File formats (v2.0 – distributed composes):

• Composeinfo file format 2.0
  • Changes from 1.1
  • Location Object
  • File Format
  • Examples
• Extra files file format 2.0
  • Changes from 1.x
  • Location Object
  • File Format
  • Examples
• Images file format 2.0
  • Changes from 1.1
  • Location Object
  • File Format
  • Image Identity
  • Examples
• Modules file format 2.0
  • Changes from 1.x
  • Location Object
  • File Format
  • Comparison with v1.x Format
  • Examples
• RPMs file format 2.0
  • Changes from 1.1
  • Location Object
  • File Format
  • Examples

File formats (v1.1 – local composes):

• Composeinfo file format 1.1
  • Changes from 1.0
  • File Format
• Discinfo file format 1.0
  • File Format
  • Examples
• Images file format 1.1
  • Changes from 1.0
  • File Format
  • Image Identity
• RPMs file format 1.1
  • Changes from 1.0
  • File Format
  • Examples
• Treeinfo file format 1.1
  • Changes from 1.0
  • File Format
  • Examples

Old file formats:

• Composeinfo file format 1.0
• Images file format 1.0
• RPMs file format 1.0
• Treeinfo file format 1.0

Indices and tables

• Index

• Module Index

• Search Page