⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository #1542

camilamacedo86 · 2025-01-03T11:20:10Z

Description

This PR integrates the catalogd project into the operator-controller monorepo and addresses several follow-up issues to ensure seamless functionality. Additionally, it moves the CI jobs implemented for catalogd to the root of the repository for a unified setup.

EPIC: #1335

Key Changes

Add catalogd to the Monorepo
- Integrated the catalogd source code into the operator-controller repository with the script. (see script changes here)
Follow-Up Changes
- Moved catalogd-specific CI jobs to the root directory
- Unified e2e tests and release workflows for both projects.
- Unified Lint and fix issues
- Unified Bingo
- Remove duplicated and redundant files

PHASE 1

Following the items addressed:

Commits Overview

Commits Done via Script

Below is a summary of the initial commits generated by the migration script:

Commits Done as Follow-Up

After the script ran, several follow-up commits were made to allow us get this first step merged:

We do not want to fail the job if codecov fails to upload the report due to rate limiting. Signed-off-by: Mikalai Radchuk <[email protected]>

Signed-off-by: Andy Goldstein <[email protected]>

…ator-framework#138)

Signed-off-by: Andy Goldstein <[email protected]>

Marking the CatalogMetadataAPI feature gate as Deprecated before introducing the HTTP server as a default mechanism to serve catalog contents Signed-off-by: Rashmi Gottipati <[email protected]>

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

closes operator-framework#113 Signed-off-by: Anik <[email protected]>

Signed-off-by: Jordan Keister <[email protected]>

…rk#148) Closes operator-framework#113 Signed-off-by: Anik <[email protected]>

* add metrics to catalogd http server that can be used for calculating the Apdex Score and assess the health of the http server that is serving catalog contents to clients Signed-off-by: Bryce Palmer <[email protected]> * quick fixes from review comments Signed-off-by: Bryce Palmer <[email protected]> * rename package from server --> metrics Signed-off-by: Bryce Palmer <[email protected]> * rename package from server --> metrics Signed-off-by: Bryce Palmer <[email protected]> --------- Signed-off-by: Bryce Palmer <[email protected]>

…work#166) * (docs): Add docs on fetching contents via HTTP server Signed-off-by: Bryce Palmer <[email protected]> * add curl examples Signed-off-by: Bryce Palmer <[email protected]> --------- Signed-off-by: Bryce Palmer <[email protected]> Signed-off-by: Bryce Palmer <[email protected]>

…erator-framework#169) * (refactor): Remove deprecated CatalogMetadata and associated code Signed-off-by: Bryce Palmer <[email protected]> * go mod tidy Signed-off-by: Bryce Palmer <[email protected]> --------- Signed-off-by: Bryce Palmer <[email protected]>

closes operator-framework#119 Signed-off-by: Anik <[email protected]>

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

Add release guide Signed-off-by: Catherine Chan-Tse <[email protected]>

* Add contributing guide to catalogd Signed-off-by: Rashmi Gottipati <[email protected]> * Address review comments Signed-off-by: Rashmi Gottipati <[email protected]> --------- Signed-off-by: Rashmi Gottipati <[email protected]>

Signed-off-by: kevinrizza <[email protected]>

Add default printer columns Signed-off-by: kevinrizza <[email protected]>

Closes operator-framework#155, operator-framework#160 Signed-off-by: Anik Bhattacharjee <[email protected]>

…operator-framework#145) (feat): direct image registry client unpacker Signed-off-by: Bryce Palmer <[email protected]>

…k#196) * (techdebt): refactor catalog controller unit tests to no longer use Ginkgo and instead use the native Go testing and testify Signed-off-by: Bryce Palmer <[email protected]> * remove rebase detritus, unnecessary IIFE, and featuregate comments/blocks. goimports. Signed-off-by: Bryce Palmer <[email protected]> --------- Signed-off-by: Bryce Palmer <[email protected]>

Bumps [golang.org/x/net](https://github.com/golang/net) from 0.10.0 to 0.17.0. - [Commits](golang/net@v0.10.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…mpatible (operator-framework#195) Bump github.com/docker/docker Bumps [github.com/docker/docker](https://github.com/docker/docker) from 23.0.1+incompatible to 23.0.3+incompatible. - [Release notes](https://github.com/docker/docker/releases) - [Commits](moby/moby@v23.0.1...v23.0.3) --- updated-dependencies: - dependency-name: github.com/docker/docker dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…work#185) Implements https://docs.google.com/document/d/1iWSrWL9pYRJ5Ua3VYErkK1Q2lAusBUeDCh66Ew4lDbQ/edit?usp=sharing Closes operator-framework#180 Signed-off-by: Anik Bhattacharjee <[email protected]>

GoDoc for Phase Signed-off-by: Anik Bhattacharjee <[email protected]>

LalatenduMohanty · 2025-01-08T18:23:10Z

Makefile

@@ -321,7 +321,7 @@ export GORELEASER_ARGS

 .PHONY: release
 release: $(GORELEASER) #EXHELP Runs goreleaser for the operator-controller. By default, this will run only as a snapshot and will not publish any artifacts unless it is run with different arguments. To override the arguments, run with "GORELEASER_ARGS=...". When run as a github action from a tag, this target will publish a full release.
-	$(GORELEASER) $(GORELEASER_ARGS)
+	OPERATOR_CONTROLLER_IMAGE_REPO=$(IMAGE_REPO) CATALOGD_IMAGE_REPO=$(CATALOG_IMAGE_REPO) $(GORELEASER) $(GORELEASER_ARGS)


Looks good. I tested this successfully.

catalogd/Dockerfile

LalatenduMohanty · 2025-01-08T20:26:08Z

catalogd/tilt.md

-
-Any time you change any of the files listed in the `deps` section in the `<binary name>_binary` `local_resource`,
-Tilt automatically rebuilds the go binary. As soon as the binary is rebuilt, Tilt pushes it (and only it) into the
-appropriate running container, and then restarts the process.


We already have https://github.com/operator-framework/operator-controller/blob/main/docs/contribute/developer.md. But this doc might contain more details. Wondering if we should keep it.

I just checked, and the info is the same.
The ONLY extra info in the catalogd doc is

Shortly after starting, Tilt processes the `Tiltfile`, resulting in: - Building the go binaries - Building the images - Loading the images into kind - Running kustomize and applying everything except the Deployments that reference the images above - Modifying the Deployments to use the just-built images - Creating the Deployments ## Making code changes Any time you change any of the files listed in the `deps` section in the `<binary name>_binary` `local_resource`, Tilt automatically rebuilds the go binary. As soon as the binary is rebuilt, Tilt pushes it (and only it) into the appropriate running container, and then restarts the process.

It has been added to the root document.

Makefile

OchiengEd

Should be good once all outstanding issues are resolved. Specifically, Todd's comment.

- Consolidated the release process to use `operator-controller.yaml` for all requirements. - Removed `catalogd.yaml` as it is no longer necessary. - Simplified the release action: - A single release action now generates images and binaries for both projects. - Unified process ensures consistent release management across the monorepo.

- Updated the root `Makefile` with a unified `test-unit` target to execute unit tests for the entire project. - Removed the `test-unit` target from the `Makefile` under the `catalogd` directory as it is no longer needed.

- Added `.tilt-support` directory at the root, updated to work with both `operator-controller` and `catalogd`. - Removed the Tilt workflow from the `catalogd` directory, consolidating all configurations into the root Tilt setup. - Updated configurations to use `catalogd` from the source code instead of fetching it from `github.com/operator-framework/catalogd`. Co-authored-by: Joe Lanford <[email protected]>

- Removed `check-go-version.sh` from `catalogd/hack/scripts` as it is no longer needed. - Both projects now rely on the `go.mod` file at the root directory for Go version checks. - Removed duplicated files from the repository: - `CODEOWNERS` - `CONTRIBUTING.md` - `DOC` - `LICENSE.md` - Use hack/boilerplate.go.txt from root and remove duplication

- Standardized Bingo definitions across `catalogd` and `operator-controller`. - Ensured both projects use the same Bingo config to maintain consistency

docs/contribute/developer.md

camilamacedo86 · 2025-01-09T04:59:45Z

docs/contribute/developer.md

-pushd ..
-git clone https://github.com/operator-framework/tilt-support
-popd
-```


@joelanford ^ I removed it since now we have it locally.
@LalatenduMohanty

LalatenduMohanty

/lgtm

OchiengEd

lgtm

Mikalai Radchuk and others added 30 commits July 28, 2023 11:55

Makes codecov-action optional

bb7e825

We do not want to fail the job if codecov fails to upload the report due to rate limiting. Signed-off-by: Mikalai Radchuk <[email protected]>

Enable dependabot (operator-framework#125)

ae01ba3

Signed-off-by: Andy Goldstein <[email protected]>

Enable merge queue (operator-framework#131)

823972c

Signed-off-by: Andy Goldstein <[email protected]>

Switch to using tilt-support repo

442b6a9

Signed-off-by: Andy Goldstein <[email protected]>

Add DCO information

8a5e079

Signed-off-by: Andy Goldstein <[email protected]>

Add CI for tilt (operator-framework#134)

64a9fe5

Signed-off-by: Andy Goldstein <[email protected]>

Enable CatalogMetadataAPI via explicit flag, fix syncing issues (oper…

f1067da

…ator-framework#138)

Setup CODEOWNERS (#140)

1a81219

Signed-off-by: Andy Goldstein <[email protected]>

Deprecate the CatalogMetadataAPI feature gate (operator-framework#141)

a8f7196

Marking the CatalogMetadataAPI feature gate as Deprecated before introducing the HTTP server as a default mechanism to serve catalog contents Signed-off-by: Rashmi Gottipati <[email protected]>

Remove Package and BundleMetadata APIs (operator-framework#149)

8aab690

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

add go-apidiff action (operator-framework#151)

cd2c38d

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

Store FBC in local directory (operator-framework#144)

04d3828

closes operator-framework#113 Signed-off-by: Anik <[email protected]>

update demo based on API changes (operator-framework#154)

d30f161

Signed-off-by: Jordan Keister <[email protected]>

Serve locally stored fbc content via an http server (operator-framewo…

966a4d6

…rk#148) Closes operator-framework#113 Signed-off-by: Anik <[email protected]>

(server) Expose content URL on CR status (operator-framework#168)

20d83c1

closes operator-framework#119 Signed-off-by: Anik <[email protected]>

deps: bump kubernetes and operator-registry (operator-framework#173)

7272fd4

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

Add RELEASING.md (operator-framework#176)

06f0f9f

Add release guide Signed-off-by: Catherine Chan-Tse <[email protected]>

Add contribution guide (operator-framework#165)

28737da

* Add contributing guide to catalogd Signed-off-by: Rashmi Gottipati <[email protected]> * Address review comments Signed-off-by: Rashmi Gottipati <[email protected]> --------- Signed-off-by: Rashmi Gottipati <[email protected]>

Update README with simplified make target ref (operator-framework#178)

51e5807

Signed-off-by: kevinrizza <[email protected]>

add default printer columns (operator-framework#174)

7f903c6

Add default printer columns Signed-off-by: kevinrizza <[email protected]>

(cleanup) Kustomization (operator-framework#183)

8a90d8d

Closes operator-framework#155, operator-framework#160 Signed-off-by: Anik Bhattacharjee <[email protected]>

(feature): add direct image registry client Unpacker implementation (…

9f3ba06

…operator-framework#145) (feat): direct image registry client unpacker Signed-off-by: Bryce Palmer <[email protected]>

(feature) Implement polling image source in intervals (operator-frame…

0b86f72

…work#185) Implements https://docs.google.com/document/d/1iWSrWL9pYRJ5Ua3VYErkK1Q2lAusBUeDCh66Ew4lDbQ/edit?usp=sharing Closes operator-framework#180 Signed-off-by: Anik Bhattacharjee <[email protected]>

Add GoDoc for Phase (operator-framework#199)

e078853

GoDoc for Phase Signed-off-by: Anik Bhattacharjee <[email protected]>

camilamacedo86 changed the title ~~⚠️ [Monorepo] Add Catalogd to Operator-Controller Repository~~ ⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository Jan 8, 2025

camilamacedo86 requested a review from tmshort January 8, 2025 13:27

camilamacedo86 assigned tmshort Jan 8, 2025

LalatenduMohanty reviewed Jan 8, 2025

View reviewed changes

tmshort reviewed Jan 8, 2025

View reviewed changes

Makefile Outdated Show resolved Hide resolved

OchiengEd reviewed Jan 9, 2025

View reviewed changes

camilamacedo86 force-pushed the monorepo_camila branch from b097c3a to c84462a Compare January 9, 2025 04:40

[Monorepo] Combine Unit Tests

3398e48

- Updated the root `Makefile` with a unified `test-unit` target to execute unit tests for the entire project. - Removed the `test-unit` target from the `Makefile` under the `catalogd` directory as it is no longer needed.

camilamacedo86 force-pushed the monorepo_camila branch from c84462a to cc01a31 Compare January 9, 2025 04:43

camilamacedo86 requested review from tmshort, OchiengEd and LalatenduMohanty January 9, 2025 04:43

camilamacedo86 and others added 3 commits January 9, 2025 04:55

[Monorepo] Unify Bingo Usage

8b875ef

- Standardized Bingo definitions across `catalogd` and `operator-controller`. - Ensured both projects use the same Bingo config to maintain consistency

camilamacedo86 force-pushed the monorepo_camila branch from cc01a31 to 8b875ef Compare January 9, 2025 04:56

camilamacedo86 commented Jan 9, 2025

View reviewed changes

docs/contribute/developer.md Show resolved Hide resolved

camilamacedo86 commented Jan 9, 2025

View reviewed changes

LalatenduMohanty approved these changes Jan 9, 2025

View reviewed changes

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

LalatenduMohanty added this pull request to the merge queue Jan 9, 2025

OchiengEd approved these changes Jan 9, 2025

View reviewed changes

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 9, 2025

tmshort added this pull request to the merge queue Jan 9, 2025

Merged via the queue into operator-framework:main with commit 75bb73e Jan 9, 2025
23 of 25 checks passed

camilamacedo86 deleted the monorepo_camila branch January 9, 2025 19:47

tmshort mentioned this pull request Jan 29, 2025

🐛 fix release artefacts after monorepo changes and release candidate 1.2.0-rc1 #1661

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository #1542

⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository #1542

camilamacedo86 commented Jan 3, 2025 •

edited

Loading

LalatenduMohanty Jan 8, 2025

LalatenduMohanty Jan 8, 2025

camilamacedo86 Jan 9, 2025

OchiengEd left a comment

camilamacedo86 Jan 9, 2025

LalatenduMohanty left a comment

OchiengEd left a comment

⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository #1542

⚠️ [Monorepo] PHASE 1 - Add Catalogd to Operator-Controller Repository #1542

Conversation

camilamacedo86 commented Jan 3, 2025 • edited Loading

Description

Key Changes

PHASE 1

Commits Overview

Commits Done via Script

Commits Done as Follow-Up

LalatenduMohanty Jan 8, 2025

Choose a reason for hiding this comment

LalatenduMohanty Jan 8, 2025

Choose a reason for hiding this comment

camilamacedo86 Jan 9, 2025

Choose a reason for hiding this comment

OchiengEd left a comment

Choose a reason for hiding this comment

camilamacedo86 Jan 9, 2025

Choose a reason for hiding this comment

LalatenduMohanty left a comment

Choose a reason for hiding this comment

OchiengEd left a comment

Choose a reason for hiding this comment

camilamacedo86 commented Jan 3, 2025 •

edited

Loading