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.

Sign up for GitHub

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

Jump to bottom

Update CRD labels, retention policy and split-installation documentation #1212

Merged
merged 1 commit into from
May 13, 2024
Merged

Update CRD labels, retention policy and split-installation documentation #1212

merged 1 commit into from
May 13, 2024

Conversation

alexellis
Copy link
Member

@alexellis alexellis commented May 10, 2024 •
edited
Loading

Description

Update CRD labels, retention policy and split-installation documentation

Why is this needed?

  • CRDs now have a label so that they can be removed at once for uninstallation
  • CRDs gained a annotation to tell Helm not to remove them when uninstalling the chart, this solves a user experience problem where people uninstall the chart before installing it again, and lose their functions
  • Updated and corrected the split-installation of CRDs, and offered a way to use statically generated CRDs in a combined file whilst retaining version compatibility with the main chart

Who is this for?

Corva.ai have requested single namespace installation

How Has This Been Tested?

Basic testing in CI, plus E2e testing of a migration.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@alexellis alexellis changed the title Move CRDs up to top level of chart Move all CRDs into templates May 10, 2024
@alexellis alexellis mentioned this pull request May 10, 2024
Closed
@alexellis alexellis requested a review from welteki May 10, 2024 14:24
@alexellis alexellis changed the title Move all CRDs into templates Update CRD labels, retention policy and split-installation documentation May 13, 2024
@alexellis
Update CRD labels, retention policy and split-installation documentation
c07b4af 
* CRDs now have a label so that they can be removed at once for
uninstallation
* CRDs gained a annotation to tell Helm not to remove them when
uninstalling the chart, this solves a user experience problem where
people uninstall the chart before installing it again, and lose
their functions
* Updated and corrected the split-installation of CRDs, and
offered a way to use statically generated CRDs in a combined
file whilst retaining version compatibility with the main chart

Tested e2e with Role, ClusterRole and upgrading previous CRDs

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
@alexellis alexellis merged commit d5b07cd into master May 13, 2024
7 checks passed
alexellis added a commit that referenced this pull request May 13, 2024
@alexellis
Updates to CRD lifecycle and split installation instructions
fdcea1e 
See notes in #1212

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
@alexellis alexellis deleted the move-crds-up branch May 13, 2024 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@welteki welteki welteki approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alexellis @welteki