Devfile registry operator pre-release to OperatorHub

michael-valdron commented 1 year ago

Which area/kind this issue is related to?

/area registry /area releng

Issue Description

In #410, we plan to make our first release of the registry operator available on OperatorHub for consumers. To ensure early adopters are ready to ship when this release becomes available, it would be necessary to also provide pre-releases.

Resolve devfile/api#1106 to ensure no problems with publishing.

Acceptance Criteria

[x] Required documentation for publication https://k8s-operatorhub.github.io/community-operators/packaging-operator/#provide-information-about-your-operator
- [x] What the managed application is about and where to find more information
- [x] The features of your Operator and how to use it
- [x] Any manual steps required to fulfill pre-requisites for running/installing your Operator
[x] Cut pre-release number for registry operator
[x] Ensure bundle files are up to date and placed under the following directory structure within a folk of k8s-operatorhub/community-operators: https://k8s-operatorhub.github.io/community-operators/packaging-operator/#create-a-release
[x] Create a PR of these change to the folk within the k8s-operatorhub/community-operators repository and merge once approved

michael-valdron commented 1 year ago

Cut pre-release number for registry operator

I think we should start with 0.1.0, increment on minor until our first release 1.0.0.

michael-valdron commented 1 year ago

Add minimal documentation for publication to OperatorHub

michael-valdron commented 1 year ago

Add minimal documentation for publication to OperatorHub

Documentation acceptance criteria has been included.

michael-valdron commented 1 year ago

Begun prep work for pre-release. Updated maintainers, CR descriptors, and set version fields to 0.1.0.

michael-valdron commented 1 year ago

Waiting for devfile/registry-operator#45 to merge: https://github.com/devfile/api/issues/1106#issuecomment-1699848699

michael-valdron commented 1 year ago

Rebased prep changes with recent changes from https://github.com/devfile/registry-operator/pull/45 & https://github.com/devfile/registry-operator/pull/46

michael-valdron commented 1 year ago

It seems that kustomize has an ongoing bug which prevents us from using it to build off custom resources which kind ends with List: https://github.com/kubernetes-sigs/kustomize/issues/5042

For this issue, I cannot generate the examples of ClusterDevfileRegistriesList and DevfileRegistriesList under the CSV, I can continue without these and open a new issue for this separately to fix once https://github.com/kubernetes-sigs/kustomize/issues/5042 is resolved.

Will try manually entering the examples of ClusterDevfileRegistriesList and DevfileRegistriesList at this time.

michael-valdron commented 1 year ago

Part 1 of this issue is ready for review: https://github.com/devfile/registry-operator/pull/47

michael-valdron commented 1 year ago

Part 2: Cutting the new release v0.1.0 in the registry operator repository Part 3: Begin the process of publication to OperatorHub by opening a PR to k8s-operatorhub/community-operators with the version bundle

michael-valdron commented 1 year ago

New release v0.1.0 has been cut on GitHub.

Part 3: Begin the process of publication to OperatorHub by opening a PR to k8s-operatorhub/community-operators with the version bundle

This part is being blocked by #1251 due to OLM validation passing being required for publication to OperatorHub.

michael-valdron commented 1 year ago

Contributing doc for OperatorHub: https://github.com/operator-framework/community-operators/blob/master/docs/contributing-via-pr.md

rm3l commented 1 year ago

Candidate for demo at the end of the Sprint in which it will be completed.

michael-valdron commented 1 year ago

https://github.com/devfile/registry-operator/pull/49#issuecomment-1724086442

michael-valdron commented 1 year ago

Keeping status blocked to include #1028 under new release cut.

michael-valdron commented 1 year ago

New release v0.1.1 has been cut on GitHub.

Part 3: Begin the process of publication to OperatorHub by opening a PR to k8s-operatorhub/community-operators with the version bundle

Starting part 3 to publish to OperatorHub.

michael-valdron commented 1 year ago

Opened a PR with current version's bundle: https://github.com/k8s-operatorhub/community-operators/pull/3287

Experiencing an failing check which seems to be flagging a missing field which is not missing from the CSV file: https://github.com/k8s-operatorhub/community-operators/pull/3287#discussion_r1336452067

michael-valdron commented 1 year ago

Opened a PR with current version's bundle: k8s-operatorhub/community-operators#3287

Experiencing an failing check which seems to be flagging a missing field which is not missing from the CSV file: k8s-operatorhub/community-operators#3287 (comment)

Opened Q&A discussion about this problem: https://github.com/k8s-operatorhub/community-operators/discussions/3294

michael-valdron commented 1 year ago

Opened a PR with current version's bundle: k8s-operatorhub/community-operators#3287 Experiencing an failing check which seems to be flagging a missing field which is not missing from the CSV file: k8s-operatorhub/community-operators#3287 (comment)

Opened Q&A discussion about this problem: k8s-operatorhub/community-operators#3294

Update: I received feedback on this problem and found that categories was misspelled under the CSV :facepalm:. I have corrected this in https://github.com/devfile/registry-operator/pull/52 and will cut a new patch version for the OperatorHub publication.

michael-valdron commented 1 year ago

There is a missing place to update the operator version: https://github.com/k8s-operatorhub/community-operators/pull/3287#discussion_r1349245313

Investigating this on the operator side.

michael-valdron commented 1 year ago