Skip to content

Stop requiring channel information within bundle image metadata.  #781

@anik120

Description

@anik120

Currently, the annotations.yaml file in a bundle requires operators.operatorframework.io.bundle.channels.v1, while operators.operatorframework.io.bundle.channel.default.v1 is optional. With the introduction of the olm.channel schema for plain-text storage backed Catalogs, the channel information must no longer be included in the bundle by operator authors. Instead, that information should be included/edited in the plain-text files that make up the Catalog.

While building a Catalog using the plaintext files, if the operators.operatorframework.io.bundle.channels.v1 field is omitted, the following error is thrown:

$ opm render docker.io/anik120/etcd:sha-2b68f58
2021/09/15 11:19:51 render reference "docker.io/anik120/etcd:sha-2b68f58": Could not find annotations file

The operators.operatorframework.io.bundle.channels.v1 field should no longer be allowed inside the bundle.

Caveat to consider:
That field is still required for sqllite backed Catalogs. Since the bundle building process is agnostic to what storage is used in the Catalog it is being included in, there needs to be a middle ground for the time being while sqllite backed Catalogs are still deprecated, so that the field serves the sqllite backed Catalogs, while also not coming in the way of plaintext files backed Catalogs.

Metadata

Metadata

Assignees

Labels

kind/api-changeCategorizes issue or PR as related to adding, removing, or otherwise changing an APIlifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.triagedIssue has been considered by a member of the OLM community

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions