WIP: FBC data model migrations

[joelanford]

Signed-off-by: Joe Lanford [email protected]<!--

Before making a PR, please read our contributing guidelines https://github.com/operator-framework/operator-lifecycle-manager/blob/master/CONTRIBUTING.md Note: Make sure your branch is rebased to the latest upstream master.

-->

WIP: This is an implementation with few tests. Before merge, we need to add some tests to ensure migrations work as expected and GRPC compatibility is maintained.

Description of the change:

1. add olm.icon blob and migration
2. fbc: promote bundle version from property to first-class field
3. fbc: promote package-level metdata from olm.csv.metadata to olm.package blob

For all of these, the opm serve implementation is updated to correctly plumb the new fields into the GRPC API.

Motivation for the change:

1. With the work in catalogd to allow querying a catalog by schema, package, and/or name, we can give catalogd clients more granular access to package metadata without the icon, which is beneficial for clients that want to list packages without also having to download all of the icons, which they may not care about (e.g. CLI clients or catalog resolvers like operator-controller)
2. The current data model requires an olm.package property, where both the package name and version are required. The bundle schema already has the package name, and the bundle version is a key piece of information when dealing with bundles. Promoting the bundle version to a first class field and eliminating the olm.package property from FBCs reduces duplication of package name and improves performance and ergonomics for clients that need to know the bundle version (which is virtually all clients).
3. Often, clients want to know package-level metadata like display name, a short description, its provider and maintainers, and lists of links and keywords. This metadata is essentially duplicated in all bundles unnecessarily and it is more useful when coloated with the package. Otherwise, clients need to also download all bundles and process them to find the "best" bundle from which to derive this metadata, this is wasteful of CPU and disk space.

Open questions:

1. Is it okay to remove the olm.package's .icon field when we migrate to olm.icon? FBC clients that don't know about the new olm.icon will think there is no icon (GRPC clients will still get the icon in the expected place). If we don't remove the .icon field, the benefit of separating it out is completely eliminated, and we might as well not separate it because then we'd just duplicate the icon unnecessarily.
2. Is it okay to remove the olm.bundle's olm.package property when we promote the version to a first-class field? Same sort of problem as above, In this case, we could probably keep both the property and the version field, but then we would need extra validation to ensure they match and we'd be using slightly more space per bundle.
3. Do we agree that the following make sense as package-level fields?

• Short Description
• Display Name
• Provider
• Maintainers
• Links
• Keywords

5. For all of the fields in (3) can we safely extract those from the bundle with the highest semver version in the package? Of those, I wonder most about links, which bundle authors may be setting to version-specific release notes or documentation. Maybe we leave links at the bundle level just in case? In the future, if there is a clearer need for package-level links we can always add a package-level links field and change the migration to promote any links that are present in all bundles?

Reviewer Checklist

• [ ] Implementation matches the proposed design, or proposal is updated to match implementation
• [ ] Sufficient unit test coverage
• [ ] Sufficient end-to-end test coverage
• [ ] Docs updated or added to /docs
• [ ] Commit messages sensible and descriptive

[openshift-ci[bot]]

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

[openshift-ci[bot]]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: joelanford

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• ~~OWNERS~~ [joelanford]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

[codecov[bot]]

Codecov Report

:x: Patch coverage is 34.89933% with 194 lines in your changes missing coverage. Please review. :white_check_mark: Project coverage is 54.88%. Comparing base (ef3bfdf) to head (dd26966). :warning: Report is 120 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/api/model_to_api.go	4.76%	59 Missing and 1 partial :warning:
.../action/migrations/003_promote_package_metadata.go	41.93%	49 Missing and 5 partials :warning:
alpha/action/migrations/001_split_icon.go	10.00%	16 Missing and 2 partials :warning:
alpha/declcfg/write.go	37.93%	13 Missing and 5 partials :warning:
alpha/model/model.go	46.42%	11 Missing and 4 partials :warning:
alpha/declcfg/declcfg_to_model.go	58.62%	11 Missing and 1 partial :warning:
...ha/action/migrations/002_promote_bundle_version.go	62.50%	6 Missing and 3 partials :warning:
alpha/declcfg/load.go	0.00%	8 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1679      +/-   ##
==========================================
- Coverage   55.17%   54.88%   -0.30%     
==========================================
  Files         136      139       +3     
  Lines       15918    16161     +243     
==========================================
+ Hits         8783     8870      +87     
- Misses       5982     6118     +136     
- Partials     1153     1173      +20     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[openshift-merge-robot]

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[github-actions[bot]]

PRs go stale after 90 days of inactivity. If there is no further activity, the PR will be closed in another 30 days.