Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: new file-based-catalog based on 0.0.13 #194

Merged
merged 1 commit into from
Sep 20, 2022

Conversation

sthaha
Copy link
Collaborator

@sthaha sthaha commented Sep 16, 2022

This PR creates a new file-based OLM catalog index based on 0.0.13 bundle
that is already published to quay.io

This is achieved by running

make catalog-image VERSION=0.0.13 IMAGE_BASE=quay.io/rhobs/observability-operator

Signed-off-by: Sunil Thaha [email protected]

@sthaha sthaha requested a review from a team as a code owner September 16, 2022 05:00
@sthaha sthaha requested review from slashpai and JoaoBraveCoding and removed request for a team September 16, 2022 05:00
@sthaha sthaha changed the title chore: olm file based catalog based on 0.0.13 chore: new file-based-catalog based on 0.0.13 Sep 16, 2022
@sthaha
Copy link
Collaborator Author

sthaha commented Sep 16, 2022

cc: @jan--f @simonpasquier

sthaha added a commit to sthaha/observability-operator that referenced this pull request Sep 16, 2022
The Catalog index yaml file for the new file-based catalog will be
maintained in the olm-catalog branch. The PR introduces the changes
needed to generate new catalog index entry for new releases to the
development, candidate, and the stable channel and to push the updated
index to the olm-catalog git branch.

 To switch to new file-based OLM catalogs, following changes have been made

  * upgrade to newer version of operator-sdk tools (operator-sdk, olm)

  * Generate catalog for existing 0.0.13 bundle by
    * creating new catalog index dockerfile
    * adding package definition for observability-operator
    * adding channel definitions for all 3 channels
    see: rhobs#194

  * Modify GitHub workflow to adapt to the new file-based catalog

JIRA: https://issues.redhat.com/browse/MON-2791

Signed-off-by: Sunil Thaha <[email protected]>
sthaha added a commit to sthaha/observability-operator that referenced this pull request Sep 16, 2022
The Catalog index yaml file for the new file-based catalog will be
maintained in the olm-catalog branch. The PR introduces the changes
needed to generate new catalog index entry for new releases to the
development, candidate, and the stable channel and to push the updated
index to the olm-catalog git branch.

 To switch to new file-based OLM catalogs, following changes have been made

  * upgrade to newer version of operator-sdk tools (operator-sdk, olm)

  * Generate catalog for existing 0.0.13 bundle by
    * creating new catalog index dockerfile
    * adding package definition for observability-operator
    * adding channel definitions for all 3 channels
    see: rhobs#194

  * Modify GitHub workflow to adapt to the new file-based catalog

JIRA: https://issues.redhat.com/browse/MON-2791

Signed-off-by: Sunil Thaha <[email protected]>
Copy link
Collaborator

@jan--f jan--f left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two small things want to raise.

Comment on lines 43 to 44
local channels=$1; shift
local bundle=$1; shift
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
local channels=$1; shift
local bundle=$1; shift
local channels="$1"; shift
local bundle="$1"; shift

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I have fixed and updated the commit.

@@ -8,6 +8,7 @@ IMAGE_BASE ?= observability-operator

VERSION ?= $(shell cat VERSION)
OPERATOR_IMG = $(IMAGE_BASE):$(VERSION)
OPERATOR_BUNDLE=observability-operator.v$(VERSION)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
OPERATOR_BUNDLE=observability-operator.v$(VERSION)
OPERATOR_BUNDLE=observability-operator-v$(VERSION)

Isn't this a more common way of adding a version to the name? I went looking for examples and found https://olm.operatorframework.io/docs/best-practices/channel-naming/ which also seems to suggest name-version. Might be less surprising for anyone who tries to parse this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a bit confused about this comment.
We aren't changing the existing channel names stable, candidate, development in this patch.

If it is about the change proposed, that wouldn't work since opm render <bundle-image> uses the format in PR. E.g.

❯ opm render quay.io/rhobs/observability-operator-bundle:0.0.13 --output=yaml | ag '^name:'
name: observability-operator.v0.0.13

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. I just pointed it out cause the name format looked odd to me. But since its not under our control I'll merge this.

This PR creates a new file-based OLM catalog index based on 0.0.13
bundle that is already published to quay.io

This is achieved by running

```
make catalog-image VERSION=0.0.13 IMAGE_BASE=quay.io/rhobs/observability-operator
```

Signed-off-by: Sunil Thaha <[email protected]>
sthaha added a commit to sthaha/observability-operator that referenced this pull request Sep 20, 2022
The Catalog index yaml file for the new file-based catalog will be
maintained in the olm-catalog branch. The PR introduces the changes
needed to generate new catalog index entry for new releases to the
development, candidate, and the stable channel and to push the updated
index to the olm-catalog git branch.

 To switch to new file-based OLM catalogs, following changes have been made

  * upgrade to newer version of operator-sdk tools (operator-sdk, olm)

  * Generate catalog for existing 0.0.13 bundle by
    * creating new catalog index dockerfile
    * adding package definition for observability-operator
    * adding channel definitions for all 3 channels
    see: rhobs#194

  * Modify GitHub workflow to adapt to the new file-based catalog

JIRA: https://issues.redhat.com/browse/MON-2791

Signed-off-by: Sunil Thaha <[email protected]>
Copy link
Collaborator

@jan--f jan--f left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jan--f jan--f merged commit 87d3358 into rhobs:olm-catalog Sep 20, 2022
jan--f pushed a commit that referenced this pull request Sep 20, 2022
The Catalog index yaml file for the new file-based catalog will be
maintained in the olm-catalog branch. The PR introduces the changes
needed to generate new catalog index entry for new releases to the
development, candidate, and the stable channel and to push the updated
index to the olm-catalog git branch.

 To switch to new file-based OLM catalogs, following changes have been made

  * upgrade to newer version of operator-sdk tools (operator-sdk, olm)

  * Generate catalog for existing 0.0.13 bundle by
    * creating new catalog index dockerfile
    * adding package definition for observability-operator
    * adding channel definitions for all 3 channels
    see: #194

  * Modify GitHub workflow to adapt to the new file-based catalog

JIRA: https://issues.redhat.com/browse/MON-2791

Signed-off-by: Sunil Thaha <[email protected]>

Signed-off-by: Sunil Thaha <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants