File based catalog #201

didierofrivia · 2024-08-26T15:08:54Z

This PR replaces the old catalog generation sql based for the file based. This is due some limitations (semver check that doesn't allow beta tags) and deprecation notice: time="2024-08-26T13:47:11Z" level=warning msg="\x1b[1;33mDEPRECATION NOTICE:\nSqlite-based catalogs and their related subcommands are deprecated. Support for\nthem will be removed in a future release. Please migrate your catalog workflows\nto the new file-based catalog format.\x1b[0m"

Verification steps

Build local catalog.

make catalog
make catalog-build CATALOG_IMG=quay.io/kuadrant/authorino-operator-catalog:local-testing-dd

Push the image to Quay.io.

make catalog-push CATALOG_IMG=quay.io/kuadrant/authorino-operator-catalog:local-testing-dd

Create kind cluster

kind create cluster --name kuadrant-local

Deploy OLM

bin/operator-sdk olm install

Deploy authorino operator using OLM

make deploy-catalog CATALOG_IMG=quay.io/kuadrant/authorino-operator-catalog:local-testing-dd

Check the authorino operator is up and running (it takes up to few minutes)

k get pods -n authorino-operator
NAME                                                              READY   STATUS      RESTARTS   AGE
authorino-operator-catalog-67mrl   0/1     Terminating   0          5s
authorino-operator-catalog-gjc5c   1/1     Running       0          2s

codecov-commenter · 2024-08-26T15:12:20Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.78%. Comparing base (bf9ba03) to head (5d37da2).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #201   +/-   ##
=======================================
  Coverage   61.78%   61.78%           
=======================================
  Files           2        2           
  Lines         785      785           
=======================================
  Hits          485      485           
  Misses        249      249           
  Partials       51       51

Flag	Coverage Δ
unit	`61.78% <ø> (ø)`

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.

eguzki

some nits left, but overall LGTM

make/catalog.mk

eguzki · 2024-08-26T16:34:07Z

.github/workflows/build-images.yaml

@@ -208,10 +209,9 @@ jobs:
          image: ${{ env.OPERATOR_NAME }}-catalog
          tags: ${{ env.IMG_TAGS }}
          platforms: linux/amd64,linux/arm64


not related to this PR, but I do not think that catalog image needs to be multi-platform. It's just a single yaml file!

Could pulling the image from a different platform fail if only amd64 is available (despite being just a single yaml inside)?

The image is being pulled by OLM. So, not being entirely sure, this needs to be checked first 👍

From OS docs:

Set --filter-by-os to the operating system and architecture to use for the base image, which must match the target OpenShift Container Platform cluster. Valid values are linux/amd64, linux/ppc64le, and linux/s390x.

Which not sure if it could be interpreted to also the actual catalog yaml img that it's delivered

Makefile

utils/generate-catalog.sh

Signed-off-by: dd di cesare <didi@posteo.net>

* Changing OPM tool installation * Adding needed ENV vars Signed-off-by: dd di cesare <didi@posteo.net>

Signed-off-by: dd di cesare <didi@posteo.net>

guicassolato · 2024-08-27T10:04:05Z

config/deploy/olm/kustomization.yaml

@@ -0,0 +1,8 @@
+# Adds namespace to all resources.
+namespace: authorino-system


For consistency with the other supported installation methods:

Suggested change

namespace: authorino-system

namespace: authorino-operator

guicassolato · 2024-08-27T10:04:12Z

config/deploy/olm/namespace.yaml

+metadata:
+  labels:
+    control-plane: controller-manager
+  name: system


Suggested change

name: system

name: operator

guicassolato · 2024-08-27T10:04:24Z

config/deploy/olm/subscription.yaml

+  name: kuadrant
+spec:
+  source: authorino-operator-catalog
+  sourceNamespace: authorino-system


Suggested change

sourceNamespace: authorino-system

sourceNamespace: authorino-operator

guicassolato · 2024-08-27T10:09:32Z

config/deploy/olm/subscription.yaml

+  source: authorino-operator-catalog
+  sourceNamespace: authorino-system
+  name: authorino-operator
+  channel: "preview"


We decided using stable as the default channel. Even if this ends up overridden by command-line args, I think having preview could be confusing.

Suggested change

channel: "preview"

channel: "stable"

guicassolato · 2024-08-27T10:09:49Z

catalog/authorino-operator-channel-entry.yaml

+---
+schema: olm.channel
+package: authorino-operator
+name: preview


Suggested change

name: preview

name: stable

I know it's just a template, but to avoid confusion.

Signed-off-by: dd di cesare <didi@posteo.net>

guicassolato

Thanks, @didierofrivia!

didierofrivia marked this pull request as ready for review August 26, 2024 15:29

didierofrivia requested review from guicassolato, mikenairn and eguzki August 26, 2024 15:29

didierofrivia self-assigned this Aug 26, 2024

didierofrivia added kind/enhancement New feature or request area/tooling Makefile and scripts for the dev workflow, testing, etc labels Aug 26, 2024

eguzki previously approved these changes Aug 26, 2024

View reviewed changes

guicassolato reviewed Aug 26, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

guicassolato reviewed Aug 26, 2024

View reviewed changes

utils/generate-catalog.sh Outdated Show resolved Hide resolved

guicassolato reviewed Aug 26, 2024

View reviewed changes

utils/generate-catalog.sh Outdated Show resolved Hide resolved

didierofrivia dismissed eguzki’s stale review via 58d4c08 August 27, 2024 08:06

didierofrivia added 9 commits August 27, 2024 10:08

[git] Ignoring built catalogs

7b6b6f9

Signed-off-by: dd di cesare <didi@posteo.net>

[make] Removing catalog creation targets

e3a3a14

* Changing OPM tool installation * Adding needed ENV vars Signed-off-by: dd di cesare <didi@posteo.net>

[make] Adding file based catalog generation targets and scripts

fe6e62e

Signed-off-by: dd di cesare <didi@posteo.net>

[workflow] Using the new file based catalog target

4a62d3f

Signed-off-by: dd di cesare <didi@posteo.net>

[manifests] For olm catalog installation target

802ca2c

Signed-off-by: dd di cesare <didi@posteo.net>

[make] Using PROJECT_DIR instead of PROJECT_PATH

d3a5cbe

Signed-off-by: dd di cesare <didi@posteo.net>

[make] Fixing kustomize target

6dee91e

Signed-off-by: dd di cesare <didi@posteo.net>

[catalog] Setting stable as default channel

a291874

Signed-off-by: dd di cesare <didi@posteo.net>

[script] Removing realpath

26630ea

Signed-off-by: dd di cesare <didi@posteo.net>

didierofrivia force-pushed the file-based-catalog branch from 58d4c08 to 26630ea Compare August 27, 2024 08:08

didierofrivia requested review from eguzki and guicassolato August 27, 2024 08:16

guicassolato reviewed Aug 27, 2024

View reviewed changes

[manifests] Replacing namespace and default channel

5d37da2

Signed-off-by: dd di cesare <didi@posteo.net>

didierofrivia requested a review from guicassolato August 28, 2024 13:55

guicassolato approved these changes Aug 28, 2024

View reviewed changes

didierofrivia merged commit a923f4b into main Aug 28, 2024
11 checks passed

didierofrivia deleted the file-based-catalog branch August 28, 2024 14:33

guicassolato mentioned this pull request Sep 4, 2024

Reorder and add descriptions of make targets #205

Merged

guicassolato mentioned this pull request Sep 24, 2024

Added support for s390x and ppc64le via catalog source #214

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File based catalog #201

File based catalog #201

didierofrivia commented Aug 26, 2024 •

edited

Loading

codecov-commenter commented Aug 26, 2024 •

edited

Loading

eguzki left a comment

eguzki Aug 26, 2024

guicassolato Aug 26, 2024

eguzki Aug 26, 2024

didierofrivia Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato Aug 27, 2024

guicassolato left a comment

		@@ -0,0 +1,8 @@
		# Adds namespace to all resources.
		namespace: authorino-system

	sourceNamespace: authorino-system
	sourceNamespace: authorino-operator

File based catalog #201

File based catalog #201

Conversation

didierofrivia commented Aug 26, 2024 • edited Loading

Verification steps

codecov-commenter commented Aug 26, 2024 • edited Loading

Codecov Report

eguzki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guicassolato left a comment

Choose a reason for hiding this comment

didierofrivia commented Aug 26, 2024 •

edited

Loading

codecov-commenter commented Aug 26, 2024 •

edited

Loading