---
tags: fbc
---

:::warning
This document is outdated. The team has come to the conclusion that the composability goals spelled out in this design are unnecessarily complex given the current scope for veneers.
:::

# File-based catalog Veneers

## Overall Design Goals

**Composability**:
- As an operator author, I need to be able to use multiple veneers simultaneously.
- As an operator author, I need to be able to use veneers and low-level `olm.package`, `olm.channel`, and `olm.bundle` blobs simultaneously.

**Extensibility**:
- As an operator author, I need to be able to define a custom veneer API and develop tooling that can expand my custom veneer to the low-level formats.
- _Stretch Goal_: As an operator author, I need to easily discover and consume custom veneers that other operator authors have developed and published.

## Open Questions

1. On day[0] when operator teams opt in to FBC, do they need a veneer that compiles to the exact representation that we extracted from the DB on day[-1]? Is there a veneer that OLM can commit to support that enables existing packages DB -> FBC representations to be expressed succinctly?

- Related: what expressiveness is lost when using a veneer vs the `olm.channel` schema? Should our channel veneers support extra static entries? If we do that, how would we hook the generated entries into the extra static entries?
- [Strawman solution](#Initial-migration-and-conversion-to-veneer)

2. How should we handle post-processing? These veneers bring up three interesting post-processing needs:

- It is possible for bundle providing veneers to render more bundles than actually end up in channel entries. `opm validate` treats bundles without channel entries as an error. How should we handle this possibility?

With the `covington` veneer mentioned below, `tombstone` entries do not need `olm.bundle` blobs (though as they are just 1 hop from the replaces chain, they should not be invalid). However, given the composability design goals, we need to:
- render all channel-providing veneers into `olm.channel` blobs
- combine rendered `olm.channel` blobs with explicitly defined `olm.channel` blobs
- find `olm.bundle` blobs that do not have entries in any channel and remove them

But some users may want validation errors rather than auto-removal

- Should we remove `olm.bundle.object` properties from `olm.bundle` blobs that are not channel heads? If so, do we need an API that explicitly enables that?

- How should Freshmaker support work? Given extensibility goals for veneers, it seems obvious that Freshmaker will not be able to hook into veneers. Therefore, it seems like we need Freshmaker to hook in as a post-processing step, always operating on the output of the veneer rendering. See https://github.com/operator-framework/operator-registry/issues/782#issuecomment-931411205.

- Should veneers support overrides to bundles. If so, how?

## Bundles

This bundles veneer is helpful to declare rules for which bundles to include in a package.

- The `repo` field specifies an image repository to query for available image tags
- The `tagRegex` field specifies a regular expression to run against image tags to be used as a filter. Only tags that match the regex should be considered.
- The `semverRange` field specifies a semver range to apply as a filter to rendered bundles. Only bundles with versions included in the semver range should be considered.
- The `images` field is an explicit list of images to include in the output. It supersedes applied filter fields (`tagRegex` and `semverRange`). Any images in this list should be included in the rendered output.

### Input

schema: olm.veneer.bundles
repo: quay.io/example-inc/example-bundle
tagRegex: "^v\d+\.\d+\.\d+$"
semverRange: ">=0.2.x"
images:
- quay.io/example-inc/example-bundle:v0.1.0

Another equivalent example, using just explicit `images`:

schema: olm.veneer.bundles
images:
- quay.io/example-inc/example-bundle:v0.1.0
- quay.io/example-inc/example-bundle:v0.2.0
- quay.io/example-inc/example-bundle:v0.2.1
- quay.io/example-inc/example-bundle:v0.2.2
- quay.io/example-inc/example-bundle:v0.2.3
- quay.io/example-inc/example-bundle:v0.3.0
- quay.io/example-inc/example-bundle:v0.3.1
- quay.io/example-inc/example-bundle:v0.3.2
- quay.io/example-inc/example-bundle:v1.0.0
- quay.io/example-inc/example-bundle:v1.0.1

### Output

---
schema: olm.bundle
package: example
name: example.v0.1.0
image: quay.io/example-inc/example-bundle:v0.1.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.1.0
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.1.0
---
schema: olm.bundle
package: example
name: example.v0.2.0
image: quay.io/example-inc/example-bundle:v0.2.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.0
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.0
---
schema: olm.bundle
package: example
name: example.v0.2.1
image: quay.io/example-inc/example-bundle:v0.2.1
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.1
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.1
---
schema: olm.bundle
package: example
name: example.v0.2.2
image: quay.io/example-inc/example-bundle:v0.2.2
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.2
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.2
---
schema: olm.bundle
package: example
name: example.v0.2.3
image: quay.io/example-inc/example-bundle:v0.2.3
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.3
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.3
---
schema: olm.bundle
package: example
name: example.v0.3.0
image: quay.io/example-inc/example-bundle:v0.3.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.0
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.0
---
schema: olm.bundle
package: example
name: example.v0.3.1
image: quay.io/example-inc/example-bundle:v0.3.1
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.1
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.1
---
schema: olm.bundle
package: example
name: example.v0.3.2
image: quay.io/example-inc/example-bundle:v0.3.2
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.2
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.2
---
schema: olm.bundle
package: example
name: example.v1.0.0
image: quay.io/example-inc/example-bundle:v1.0.0
properties:
- type: olm.package
  value:
    name: example
    version: 1.0.0
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v1.0.0
---
schema: olm.bundle
package: example
name: example.v1.0.1
image: quay.io/example-inc/example-bundle:v1.0.1
properties:
- type: olm.package
  value:
    name: example
    version: 1.0.1
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v1.0.1

## Covington

Covington (named for its proximity to Cincinnati) is a veneer that builds a channel based on a defined order of versions in a channel.
- The `entries` field specifies an ordered chain of channel entries.
- The `tombstones` field specifies which entries should be skipped over and not considered for installation or upgrade.
- The `tailEdges` field specifies the edges that should be added to the generated tail bundle. The purpose of this is to enable the generated entries to have an upgrade path from the static entries

### Rules
This veneer forms a replaces chain from non-tombstoned versions. The basic rules are:
1. Only non-tombstoned entries result in entries in the channel
2. Each non-tombstoned entry will replace the immediately preceding non-tombstoned entry
3. Each non-tombstoned entry will skip all tombstoned entries between it and the next immediately preceding non-tombstoned entry.
4. The tail of the generated channel will include `tailEdges` in its entry.
5. The last item in the `entries` array must not be in the `tombstones` array.

### Execution Steps
1. Render `olm.bundle` blobs in memory using the `olm.veneer.bundles` veneer.
2. Build an `olm.channel`, following the rules spelled out above.
3. If there are multiple `olm.channel` blobs with identical `package` and `name` combine their entries without de-deduplicating.
4. Validate the resulting FBC and write it to stdout.

### Input

---
schema: olm.package
name: example
defaultChannel: stable
---
schema: olm.channel
package: example
name: stable
entries:
- name: example.v0.0.1
- name: example.v0.0.2
  replaces: example.v0.0.1
- name: example.v0.0.3
  replaces: example.v0.0.1
  skips:
  - example.v0.0.2
---
schema: olm.veneer.covington
package: example
name: stable
entries:
- example.v0.1.0
- example.v0.2.0
- example.v0.2.1
- example.v0.2.2
- example.v0.2.3
- example.v0.3.0
- example.v0.3.1
- example.v0.3.2
- example.v1.0.0
- example.v1.0.1
tombstones:
- example.v0.2.0
- example.v0.2.1
- example.v0.2.2
- example.v0.3.0
- example.v0.3.1
- example.v1.0.0
tailEdges:
  skips:
  - example.v0.0.1
  - example.v0.0.2
  - example.v0.0.3
---
schema: olm.veneer.bundles
repo: quay.io/example-inc/example-bundle
tagRegex: "^v\d+\.\d+\.\d+$"
semverRange: ">=0.1.x"
images:
- quay.io/example-inc/example-bundle:v0.0.1
- quay.io/example-inc/example-bundle:v0.0.2
- quay.io/example-inc/example-bundle:v0.0.3

### Output

---
schema: olm.package
name: example
defaultChannel: stable
---
schema: olm.channel
package: example
name: stable
entries:
- name: example.v0.0.1
- name: example.v0.0.2
  replaces: example.v0.0.1
- name: example.v0.0.3
  replaces: example.v0.0.1
  skips:
  - example.v0.0.2
- name: example.v0.1.0
  skips:
  - example.v0.0.1
  - example.v0.0.2
  - example.v0.0.3
- name: example.v0.2.3
  replaces: example.v0.1.0
  skips: 
  - example.v0.2.0
  - example.v0.2.1
  - example.v0.2.2
- name: example.v0.3.2
  replaces: example.v0.2.3
  skips:
  - example.v0.3.0
  - example.v0.3.1
- name: example.v1.0.1
  replaces: example.v0.3.2
  skips: 
  - example.v1.0.0
---
schema: olm.bundle
package: example
name: example.v0.1.0
image: quay.io/example-inc/example-bundle:v0.1.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.1.0
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.1.0
---
schema: olm.bundle
package: example
name: example.v0.2.3
image: quay.io/example-inc/example-bundle:v0.2.3
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.3
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.3
---
schema: olm.bundle
package: example
name: example.v0.3.2
image: quay.io/example-inc/example-bundle:v0.3.2
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.2
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.2
---
schema: olm.bundle
package: example
name: example.v1.0.1
image: quay.io/example-inc/example-bundle:v1.0.1
properties:
- type: olm.package
  value:
    name: example
    version: 1.0.1
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v1.0.1

## Semver

Semver is a veneer that builds one or more channels based on a semver ordering of bundles.
- The `nameTemplate` field is used to automatically generate channel names based on semver fields (e.g. major, minor, and patch number).
- The `semverRange` field specifies a semver range that can further filter bundles for based on their version for inclusion in the channel.
- The `skipPatch` field specifies whether skip patch ordering should be enabled.

### Rules
This veneer supports two different modes. The following rules are applied once entries have been assigned to channels based on the `nameTemplate`:

#### `skippatch: false`
Iterate the channel entries for each channel, starting at the second entry, and set each entries `replaces` value to the `name` of the previous entry.

#### `skippatch: true`
For each minor version present in the channel, select the bundle with the highest patch. Set `skips` to all other patch versions within that minor version. Set `replaces` to the highest patch version in the next lowest minor version (if there is one).

### Execution Steps
1. Render `olm.bundle` blobs in memory using the `olm.veneer.bundles` veneer.
2. Build one or more `olm.channel` blobs (using the `nameTemplate` to render the channel names). Then follow the rules spelled out above.
3. If there are multiple `olm.channel` blobs with identical `package` and `name` combine their entries without de-deduplicating.
4. Write the resulting FBC to stdout

### Input

---
schema: olm.package
name: example
defaultChannel: stable
---
schema: olm.veneer.semver
package: example
semverRange: ">=0.2.x"
nameTemplate: release-v{{.Major}}.{{.Minor}}
skipPatch: false
---
schema: olm.veneer.semver
package: example
nameTemplate: stable
skipPatch: true
---
schema: olm.veneer.bundles
repo: quay.io/example-inc/example-bundle
tagRegex: "^v\d+\.\d+\.\d+$"

### Output

---
schema: olm.package
name: example
defaultChannel: stable
---
schema: olm.channel
package: example
name: release-v0.2
entries:
- name: example.v0.2.0
- name: example.v0.2.1
  replaces: example.v0.2.0
- name: example.v0.2.2
  replaces: example.v0.2.1
- name: example.v0.2.3
  replaces: example.v0.2.2
---
schema: olm.channel
package: example
name: release-v0.3
entries:
- name: example.v0.3.0
- name: example.v0.3.1
  replaces: example.v0.3.0
- name: example.v0.3.2
  replaces: example.v0.3.1
---
schema: olm.channel
package: example
name: release-v1.0
entries:
- name: example.v1.0.0
- name: example.v1.0.1
  replaces: example.v1.0.0
---
schema: olm.channel
package: example
name: stable
entries:
- name: example.v0.1.0
- name: example.v0.2.3
  replaces: example.v0.1.0
  skips:
  - example.v0.2.0
  - example.v0.2.1
  - example.v0.2.2
- name: example.v0.3.2
  replaces: example.v0.2.3
  skips:
  - example.v0.3.0
  - example.v0.3.1
- name: example.v1.0.1
  replaces: example.v0.3.2
  skips:
  - example.v1.0.0
---
schema: olm.bundle
package: example
name: example.v0.1.0
image: quay.io/example-inc/example-bundle:v0.1.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.1.0
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.1.0
---
schema: olm.bundle
package: example
name: example.v0.2.0
image: quay.io/example-inc/example-bundle:v0.2.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.0
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.0
---
schema: olm.bundle
package: example
name: example.v0.2.1
image: quay.io/example-inc/example-bundle:v0.2.1
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.1
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.1
---
schema: olm.bundle
package: example
name: example.v0.2.2
image: quay.io/example-inc/example-bundle:v0.2.2
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.2
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.2
---
schema: olm.bundle
package: example
name: example.v0.2.3
image: quay.io/example-inc/example-bundle:v0.2.3
properties:
- type: olm.package
  value:
    name: example
    version: 0.2.3
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.2.3
---
schema: olm.bundle
package: example
name: example.v0.3.0
image: quay.io/example-inc/example-bundle:v0.3.0
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.0
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.0
---
schema: olm.bundle
package: example
name: example.v0.3.1
image: quay.io/example-inc/example-bundle:v0.3.1
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.1
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.1
---
schema: olm.bundle
package: example
name: example.v0.3.2
image: quay.io/example-inc/example-bundle:v0.3.2
properties:
- type: olm.package
  value:
    name: example
    version: 0.3.2
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v0.3.2
---
schema: olm.bundle
package: example
name: example.v1.0.0
image: quay.io/example-inc/example-bundle:v1.0.0
properties:
- type: olm.package
  value:
    name: example
    version: 1.0.0
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v1.0.0
---
schema: olm.bundle
package: example
name: example.v1.0.1
image: quay.io/example-inc/example-bundle:v1.0.1
properties:
- type: olm.package
  value:
    name: example
    version: 1.0.1
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
- type: olm.bundle.object
  value:
    data: <a_whole_bunch_of_base64_data_here>
relatedImages:
- name: ""
  image: quay.io/example-inc/example:v1.0.1

## Initial migration and conversion to veneer

When an operator team decides to opt into file-based catalogs, they will very likely have a bunch of existing content that needs to remain intact to avoid breaking existing users. However, there is no declarative veneer we can design that can fully replicate how replaces mode packages are built without requiring the veneer to read channel and upgrade graph metadata from bundles, which our design specifically opposes. Therefore, we need a mechanism that enables existing upgrade graphs to be combined with veneer-generated upgrade graphs in the same channel.

Here's how the opt-in for a package could look, using a directory structure to walk through this example.

First, we start out with just a database file representing the package:

$ cd etcd-operator
$ tree .
.
└── etcd-operator.db

Next, we render the catalog and delete the database:

$ mkdir catalog
$ opm render etcd-operator.db -o yaml > catalog/catalog.yaml && rm etcd-operator.db
$ tree .
.
└── catalog
    └── catalog.yaml

Now, we have the low-level FBC representation of the package. We need to make this more user-friendly to maintain though, so we'll convert it to a veneer. We'll create a veneer directory and separate the package, channel, and bundles into individual files to make things easier to find and navigate.

The first step is to extract the `olm.package` and `olm.channel` blobs directly into the veneer:

$ mkdir -p veneer/migrated
$ yq eval-all 'select(.schema == "olm.package")' catalog/catalog.yaml > veneer/package.yaml
$ yq eval-all 'select(.schema == "olm.channel")' catalog/catalog.yaml > veneer/migrated/channels.yaml
$ tree .
.
├── catalog
│   └── catalog.yaml
└── veneer
    ├── migrated
    │   └── channels.yaml
    └── package.yaml

The second step is to generate and add the `olm.veneer.bundles` blob. We'll start it off with just a static list of bundle images we read from `catalog.yaml`

$ yq eval-all 'select(.schema == "olm.bundle") | [.image] | {"schema": "olm.bundle.veneers", "images": .}' catalog/catalog.yaml > veneer/migrated/bundles.yaml
$ tree .
.
├── catalog
│   └── catalog.yaml
└── veneer
    ├── migrated
    │   ├── bundles.yaml
    │   └── channels.yaml
    └── package.yaml

Now we have all of our existing content migrated into a more manageable veneer. To help users on-board to a more declarative method for managing which channels and bundles to include in their package, let's add some example veneers that will augment their existing content.

Here's a script we can run that will automatically generate some examples with docs to explain how to use them. We can intelligently build examples based on the names and heads of existing channels to make it easier for operator authors to get started right away:

pkg=$(pwd)
mkdir veneer/channels
for ch in $(opm alpha list channels catalog | tail -n+2 | awk '{print $2}'); do
    head=$(opm alpha list channels catalog | grep " $ch " | awk '{print $3}')
    cat << EOF >> veneer/channels/$ch.covington.example.yaml
##
## This example uses the 'olm.veneer.covington' veneer, which is similar to
## the way OpenShift defines upgrade edges for its payload.
##
## Covington (named for its proximity to Cincinnati) is a veneer that builds a
## channel based on a defined order of versions in a channel.
##  - The \`entries\` field specifies an ordered chain of channel entries.
##  - The \`tombstones\` field specifies which entries should be skipped over and
##    not considered for installation or upgrade.
##  - The \`tailEdges\` field specifies the edges that should be added to the
##    generated tail bundle. The purpose of this is to enable the generated
##    entries to have an upgrade path from the static entries
##
## Uncomment the below lines to activate this veneer:

# ---
# schema: olm.veneer.covington
# package: $pkg
# name: $ch
# entries: []
# tombstones: []
# tailEdges:
#   # update these edges to ensure that new that channel tail of this veneer
#   # properly upgrades from your existing content.
#   replaces: $head
#   skips:
#   - $head
#   skipRange: <=$head
EOF

    cat << EOF >> veneer/channels/$ch.semver.example.yaml
##
## This example uses the 'olm.veneer.semver' veneer.
##
## Semver is a veneer that builds one or more channels based on a semver ordering
## of bundles.
##  - The \`nameTemplate\` field is used to automatically generate channel names
##    based on semver fields (e.g. major, minor, and patch number).
##  - The \`semverRange\` field specifies a semver range that can further filter
##    bundles for based on their version for inclusion in the channel.
##  - The \`skipPatch\` field specifies whether skip patch ordering should be enabled.
##
## Uncomment the below lines to activate this veneer:

# ---
# schema: olm.veneer.semver
# package: $pkg
# name: $ch
# semverRange >$head
# nameTemplate: release-v{{.Major}}.{{.Minor}}
# skipPatch: false
# tailEdges:
#   # update these edges to ensure that new that channel tail of this veneer
#   # properly upgrades from your existing content.
#   replaces: $head
#   skips:
#   - $head
#   skipRange: <=$head
EOF

done

After we run that script, our package directory looks like this:

.
├── catalog
│   └── catalog.yaml
├── mkveneers.sh
└── veneer
    ├── channels
    │   ├── alpha.covington.example.yaml
    │   ├── alpha.semver.example.yaml
    │   ├── clusterwide-alpha.covington.example.yaml
    │   ├── clusterwide-alpha.semver.example.yaml
    │   ├── singlenamespace-alpha.covington.example.yaml
    │   └── singlenamespace-alpha.semver.example.yaml
    ├── migrated
    │   ├── bundles.yaml
    │   └── channels.yaml
    └── package.yaml

Next, let's add another `olm.veneer.bundles` blob, where operator authors can define how new bundles can be discovered and rendered into their catalog.

cat << EOF >> veneer/bundles.yaml
##
## This example uses the 'olm.veneer.bundles' veneer.
##
## This bundles veneer is helpful to declare rules for which bundles to include in a
## package.
##
##  - The \`repo\` field specifies an image repository to query for available image tags
##  - The \`tagRegex\` field specifies a regular expression to run against image tags to be
##    used as a filter. Only tags that match the regex should be considered.
##  - The \`semverRange\` field specifies a semver range to apply as a filter to rendered
##    bundles. Only bundles with versions included in the semver range should be
##    considered.
##  - The \`images\` field is an explicit list of images to include in the output. It
##    supersedes applied filter fields (\`tagRegex\` and \`semverRange\`). Any images in this
##    list should be included in the rendered output.
##
## TODO: Add explicit bundle images to the \`images\` field below or configure
##   \`repo\`, with optional \`tagRegex\` and \`semverRange\` filters to auto-discover
##   bundle images to render.
---
schema: olm.veneer.bundles
images: []
EOF