pulp / pulp/pulp-operator

Update/Fix release script and csv

Open
#1,202 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Go
Stars
88
Forks
66
Avg merge
53m
Merged PRs (30d)
1

Description

Describe the bug
Releasing a new version of the operator using the release.sh script will fail community-operators and community-operators-prod pipelines because of:

  • missing metadata.annotations.support field (new required field)
  • containerImage is not used by any container in the csv
  • bundle replace version not found

and also some warnings:

Value : (pulp-operator.v1.0.0-beta.4) csv.Spec.minKubeVersion is not informed. It is recommended you provide this information. Otherwise, it would mean that your operator project can be distributed and installed in any cluster version available, which is not necessarily the case for all projects.
Value pulp-operator.v1.0.0-beta.4: this bundle is using APIs which were deprecated and removed in v1.25. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25. Migrate the API(s) for cronjobs: (["ClusterServiceVersion.Spec.InstallStrategy.StrategySpec.Permissions[0].Rules[4]"]),poddisruptionbudgets: (["ClusterServiceVersion.Spec.InstallStrategy.StrategySpec.Permissions[0].Rules[10]"]),

Expected behavior
We should update the release.sh script to avoid these errors and/or manual intervention by:

  sed -i "s#containerImage: quay.io/pulp/pulp-operator:devel#containerImage: quay.io/pulp/pulp-operator:v${PULP_OPERATOR_RELEASE_VERSION}#g" $CSV_FILE
  echo "  replaces: pulp-operator.v${PULP_OPERATOR_REPLACE_VERSION}" >> $CSV_FILE

Additional context
Maybe the warning should be handled through a separate issue. (Keeping it here for now)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with release/release.sh, especially the version substitutions around the referenced lines, and pulp-operator.clusterserviceversion.yaml. Check how the script generates the CSV and compare its output with the community-operators pipeline requirements. Done means the support annotation, container image version, and replaces version are generated correctly without manual intervention.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, shell
Domain
devops, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.