README
¶
library-olm
A v0 collection of Go libraries and CLIs for Operator Lifecycle Manager (OLM).
This repository is the basis for the eventual operator-framework/library-olm. It is
personal and pre-release: APIs may change without notice while at v0.
Contents
migration/— OLMv0 → OLMv1 migration library and CLIs (OCPSTRAT-2693). Start withspecs/20260821-migration-v0-to-v1/README.md.
The migration work follows a Specification-Driven Design (SDD) layout:
| Doc | Purpose |
|---|---|
| specs/20260821-migration-v0-to-v1/README.md | Overview of the feature |
| specs/20260821-migration-v0-to-v1/requirements.md | What must be built, field-by-field |
| specs/20260821-migration-v0-to-v1/plan.md | How it will be built (phased) |
| specs/20260821-migration-v0-to-v1/validation.md | How we prove it works |
License
Apache 2.0 — see LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package image provides OCI registry access, content caching, and layer extraction for container images.
|
Package image provides OCI registry access, content caching, and layer extraction for container images. |
|
bundle
Package bundle provides support for OLM operator bundle images.
|
Package bundle provides support for OLM operator bundle images. |
|
catalog
Package catalog provides support for OLM catalog images.
|
Package catalog provides support for OLM catalog images. |
|
internal/testutil
Package testutil provides shared test infrastructure for image handler tests.
|
Package testutil provides shared test infrastructure for image handler tests. |
|
migration
|
|
|
examples/cmd/migrate-catalogs-v0-to-v1
command
migrate-catalogs-v0-to-v1 migrates OLMv0 CatalogSources to OLMv1 ClusterCatalogs.
|
migrate-catalogs-v0-to-v1 migrates OLMv0 CatalogSources to OLMv1 ClusterCatalogs. |
|
examples/cmd/migrate-operators-v0-to-v1
command
migrate-operators-v0-to-v1 is a CLI tool for migrating operators managed by OLMv0 (Subscription/CSV) to OLMv1 (ClusterExtension/ClusterObjectSet).
|
migrate-operators-v0-to-v1 is a CLI tool for migrating operators managed by OLMv0 (Subscription/CSV) to OLMv1 (ClusterExtension/ClusterObjectSet). |
|
pkg/catalogmigration
Package catalogmigration maps image-backed OLMv0 CatalogSources to OLMv1 ClusterCatalogs.
|
Package catalogmigration maps image-backed OLMv0 CatalogSources to OLMv1 ClusterCatalogs. |
|
pkg/clioutput
Package clioutput contains format-neutral records and progress rendering for both migration CLIs and callers of the migration APIs.
|
Package clioutput contains format-neutral records and progress rendering for both migration CLIs and callers of the migration APIs. |
|
pkg/migration
Package migration provides the OLMv0-to-OLMv1 operator migration library.
|
Package migration provides the OLMv0-to-OLMv1 operator migration library. |
Click to show internal directories.
Click to hide internal directories.