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

Integrate K8up Helm chart into this repository #649

Closed
ccremer opened this issue May 2, 2022 · 2 comments
Closed

Integrate K8up Helm chart into this repository #649

ccremer opened this issue May 2, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@ccremer
Copy link
Contributor

ccremer commented May 2, 2022

Summary

As developer
I want to maintain the K8up Helm chart in this repository
So that I don't have to maintain the deployment config with Kustomize and in an external Helm repo.

As K8up Admin
I want to install a K8up Helm chart version that redistributes the K8up CRDs
So that I don't have to select the K8up version that is included in the Chart separately

Context

This is about migrating the K8up Helm chart into this repository.

We should make a new major release to clearly communicate the switch to another repository.

These are basically the things to do:

Out of Scope

  • Migrating existing Helm chart releases

Further links

Acceptance Criteria

  • Given master branch in the K8up repository, when I browse the contents then there is a fully-documented Helm chart available that installs K8up operator (without CRDs) and the Kustomize setup is deleted.
  • Given master branch of the K8up repository, when I run make e2e-test then the operator is installed with the local chart instead of Kustomize.
  • Given master branch of the K8up repository, when I run make generate then the RBAC roles and rules are generated in the Helm templates directory and enriched with Helm labeling functions.
  • Given K8up repository, when I want to make breaking changes to the chart, then I don't need to bump K8up (operator) major version
  • Given K8up documentation, when I want to release K8up, then I can look up a documented release process.
  • Given I want to make changes to the Helm chart, when I create a PR, then a PR job ensures that the chart is following quality standards (for example documentation with helm-docs).
  • Release documentation is updated here: https://k8up.io/k8up/2.2/explanations/release.html

Implementation Ideas

  • when I push a vX.Y.Z Git tag, then K8up (operator) is released with changelog excluding changes to the K8up chart.
  • when I push a chart-X.Y.Z Git tag, then K8up chart is released with changelog containing only changes to the K8up chart and the release contains the CRDs corresponding to the K8up version.
@ccremer
Copy link
Contributor Author

ccremer commented May 17, 2022

Note: In vshn/appcat-service-postgresql#39 (and some commits afterwards) we have already engineered the automation for this type of repo and releasing. I also ironed out some issues that came up with such a design.
I'm going to reword the acceptance criteria to match it.

@ccremer
Copy link
Contributor Author

ccremer commented Sep 13, 2022

this is actually done

@ccremer ccremer closed this as completed Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant