✨ OPRUN-3763: Consolidate api directory #1800

tmshort · 2025-02-20T22:12:56Z

Move operator-controller APIs into apis/operator-controller Move catalogd APIs into apis/catalogd

There's a conflict in types, both have a CatalogSource type that we may not be able to easily rename, so the simplest solution was to keep the two APIs serparate

Description

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

Move operator-controller APIs into apis/operator-controller Move catalogd APIs into apis/catalogd There's a conflict in types, both have a CatalogSource type that we may not be able to easily rename, so the simplest solution was to keep the two APIs serparate Signed-off-by: Todd Short <[email protected]>

netlify · 2025-02-20T22:13:14Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`8541ad2`
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/67b7a8ebf27fe7000801220e
😎 Deploy Preview	https://deploy-preview-1800--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2025-02-20T22:28:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.32%. Comparing base (9b888eb) to head (8541ad2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1800      +/-   ##
==========================================
- Coverage   68.34%   68.32%   -0.02%     
==========================================
  Files          63       63              
  Lines        5117     5117              
==========================================
- Hits         3497     3496       -1     
- Misses       1390     1391       +1     
  Partials      230      230

Flag	Coverage Δ
e2e	`51.62% <ø> (-0.08%)`	⬇️
unit	`55.89% <ø> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

camilamacedo86 · 2025-02-21T08:41:24Z

Makefile

 	rm -f $(KUSTOMIZE_OPCON_RBAC_DIR)/role.yaml && $(CONTROLLER_GEN) rbac:roleName=manager-role paths=./internal/operator-controller/... output:rbac:artifacts:config=$(KUSTOMIZE_OPCON_RBAC_DIR)
 	# Generate the catalogd manifests
-	rm -rf $(KUSTOMIZE_CATD_CRDS_DIR) && $(CONTROLLER_GEN) crd paths="./catalogd/api/..." output:crd:artifacts:config=$(KUSTOMIZE_CATD_CRDS_DIR)
+	rm -rf $(KUSTOMIZE_CATD_CRDS_DIR) && $(CONTROLLER_GEN) crd paths=./api/catalogd/... output:crd:artifacts:config=$(KUSTOMIZE_CATD_CRDS_DIR)


By consolidating the API, I thunk we no longer need to generate rules webhooks and crd spllited
We can just

$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases

Also, I think we need to stop to rm the files.
We should run the commands and the make verify should fail if has a diff instead.

This isn't a 100% consolidation, as the CRDs are still put into separate locations of the config to keep them with their corresponding manager, which is desirable as far as downstream is concerned.

I'm looking at a fixup commit to this one that does the 100% consolidation, and it is starting out to be much bigger and complicated...

I would have to look at why/when rm was added, and I think it was to properly make all the files and clean up those that don't need to exist any more? But it was put there for a reason.

I think the rm was added to ensure that we always generate it.
but for all we can either do that in a follow-up.
So, there is no reason to block this one

camilamacedo86 · 2025-02-21T08:42:10Z

Makefile

 	--config=$(API_REFERENCE_DIR)/crd-ref-docs-gen-config.yaml \
 	--renderer=markdown --output-path=$(API_REFERENCE_DIR)/$(OPERATOR_CONTROLLER_API_REFERENCE_FILENAME);

 	rm -f $(API_REFERENCE_DIR)/$(CATALOGD_API_REFERENCE_FILENAME)
-	$(CRD_REF_DOCS) --source-path=$(ROOT_DIR)/catalogd/api \
+	$(CRD_REF_DOCS) --source-path=$(ROOT_DIR)/api/catalogd \


Can we not simplify here as well ./...

Not if the API docs are in different locations, if we wish to consolidate the documentation, then that's a possibility.

I think we need to consolidate all.
They are the same API group.
I do not think we should have the catalogd and operator-controller dir at all.

camilamacedo86

/lgtm

camilamacedo86 · 2025-02-21T17:33:04Z

Because we are moving the dir the check [go-apidiff / go-apidiff (pull_request)](https://github.com/operator-framework/operator-controller/actions/runs/13445656712/job/37570296783?pr=1800)F will fail :-(

We need to disable it, merge and then enable :-(

camilamacedo86

/lgtm cancel

We need to discuss the path for the API

tmshort · 2025-02-22T02:23:05Z

/lgtm cancel

We need to discuss the path for the API

As I said, I'm working on a fixup to combine it all into api/v1, but it requires extensive renaming and changes. One of the requirements is that the CRD outputs are placed into separate kustomize directories, associated with each manager (i.e. ClusterExtension with operator-controller, and ClusterCatalog with catalogd). This is necessary for downstream.

I do not want to block it.

azych · 2025-02-24T08:57:23Z

Given some decisions about the code layout from here: #1707 (comment)
I'm wondering what code specific to catalogd/ will be left in catalogd/ once this and then also #1744 are done?

It seems like catalogd/ would become redundant at that point and we would have instead moved to a nested structure with

cmd/project_name
api/project_name
internal/project_name

combined Makefile etc.

camilamacedo86 · 2025-02-24T09:29:55Z

Hi @azych

I'm wondering what code specific to catalogd/ will be left in catalogd/ once this and then also #1744 are done?

The catalogd/ dir will no longer exist when we finish the whole work,

tmshort requested a review from a team as a code owner February 20, 2025 22:12

camilamacedo86 reviewed Feb 21, 2025

View reviewed changes

camilamacedo86 approved these changes Feb 21, 2025

View reviewed changes

openshift-ci bot assigned camilamacedo86 Feb 21, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 21, 2025

camilamacedo86 previously requested changes Feb 21, 2025

View reviewed changes

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 21, 2025

camilamacedo86 self-requested a review February 24, 2025 09:32

grokspawn approved these changes Feb 24, 2025

View reviewed changes

grokspawn added this pull request to the merge queue Feb 24, 2025

Merged via the queue into operator-framework:main with commit 8fd4464 Feb 24, 2025
18 of 20 checks passed

tmshort changed the title ~~✨ Consolidate api directory~~ ✨ OPRUN-3763: Consolidate api directory Feb 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ OPRUN-3763: Consolidate api directory #1800

✨ OPRUN-3763: Consolidate api directory #1800

Uh oh!

tmshort commented Feb 20, 2025

Uh oh!

netlify bot commented Feb 20, 2025 •

edited

Loading

Uh oh!

codecov bot commented Feb 20, 2025 •

edited

Loading

Uh oh!

camilamacedo86 Feb 21, 2025

Uh oh!

tmshort Feb 21, 2025

Uh oh!

camilamacedo86 Feb 21, 2025 •

edited

Loading

Uh oh!

camilamacedo86 Feb 21, 2025

Uh oh!

tmshort Feb 21, 2025

Uh oh!

camilamacedo86 Feb 24, 2025

Uh oh!

camilamacedo86 left a comment

Uh oh!

camilamacedo86 commented Feb 21, 2025

Uh oh!

camilamacedo86 left a comment •

edited

Loading

Uh oh!

tmshort commented Feb 22, 2025

Uh oh!

azych commented Feb 24, 2025 •

edited

Loading

Uh oh!

camilamacedo86 commented Feb 24, 2025

Uh oh!

Uh oh!

Uh oh!

✨ OPRUN-3763: Consolidate api directory #1800

✨ OPRUN-3763: Consolidate api directory #1800

Uh oh!

Conversation

tmshort commented Feb 20, 2025

Description

Reviewer Checklist

Uh oh!

netlify bot commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

codecov bot commented Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

tmshort Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

tmshort Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 commented Feb 21, 2025

Uh oh!

camilamacedo86 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmshort commented Feb 22, 2025

Uh oh!

azych commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

camilamacedo86 commented Feb 24, 2025

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

camilamacedo86 Feb 21, 2025 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

azych commented Feb 24, 2025 •

edited

Loading