Refactor olm #1895
Open
Refactor olm #1895
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OLM is specific enough
A custom catalog will be used to test in CI. CI will test that a bundle is deployable and upgradeable.
This is the lowest version we run tests on.
The environment we were using to test the OLM bundle is long gone. Instead, we are going to deploy a KinD environment, install OLM, and test that our bundle installs. This test includes creating a subscription, creating a rabbitmq object and verifying that images have "rabbitmq" in the name. It is naive, but this workflow can be extended to run operator system tests.
|
@mkuratczyk @MirahImage @PujaVad tagging you in case your fancy a review 🙂 I know you don't have much context on operatorhub or OLM, but any feedback is welcome. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary Of Changes
Additional Context
Historically, the OLM bundle generation scripts and templates lived in a dedicated repo. To my judgement, because we are not checking in the manifests generated, it's unnecessary to keep the templates in a different repository.
This refactor also removes the Python dependency, and relies purely on Make and shell scripts to generate the manifests. This is a logical step because we are proficient with Carvel YTT, which is an excellent tool to manipulate and template YAML. Adopting Carvel also allows to setup an image promotion workflow. The refactor now builds bundles to an "untested" registry, runs tests on the image, if the tests are successful, then relocates the image to the "production" registry. This helps to keep the production registry lean, easy to navigate and understand.
Important: the jobs that open a PR have the
--dry-runoption for now, because I haven't been able to validate these commands. I will validate after mergeLocal Testing
It is possible to test the workflow locally using nektos/act, but it requires setting the secrets and variables manually.
The new makefile can be tested using some variables, to avoid using the "production" defaults.
Creating an account on quay registry is free. Alternatively, it is also possible to use dockerhub for testing purposes, however, that requires setting the
REGISTRY=docker.iomake variable.