Skip to content
This repository has been archived by the owner on Sep 14, 2020. It is now read-only.

Document the preservation of Kopf's persistence state in "v1" CRDs #364

Merged
merged 4 commits into from
May 11, 2020

Conversation

nolar
Copy link
Contributor

@nolar nolar commented May 8, 2020

What do these changes do?

Convert CRDs from v1beta1 to v1 API version, and document the unknown field preservation for Kopf's status storage.

Description

Kubernetes 1.16 introduced new changes to custom and built-in resources with stricter schemas and no possibility for arbitrary field storage by default:

There are workarounds though — via x-kubernetes-preserve-unknown-fields: true.

This PR documents these workarounds and upgrades the framework's CRDs to v1. Legacy CRDs for Kubernetes <= 1.15 are stored nearby (useful when starting in e.g. GKE with default K8s 1.14 and maximum 1.15).

The CRD definition is the only difference. The framework is supposed to work with both versions of CRDs. And the new annotations storage (#331) should solve the root problem "properly" via the code.

Issues/PRs

Issues: #358 #308 #321

Related: #331

Type of changes

  • Mostly documentation and examples (no code changes)

Checklist

  • Documentation reflects the changes

@nolar nolar added the documentation Documentation improvements label May 8, 2020
@zincr
Copy link

zincr bot commented May 8, 2020

🤖 zincr found 0 problems , 0 warnings

✅ Large Commits
✅ Approvals
✅ Specification
✅ Dependency Licensing

@zincr
Copy link

zincr bot commented May 8, 2020

🤖 zincr found 1 problem , 0 warnings

❌ Approvals
✅ Large Commits
✅ Specification
✅ Dependency Licensing

Details on how to resolve are provided below


Approvals

All proposed changes must be reviewed by project maintainers before they can be merged

Not enough people have approved this pull request - please ensure that 1 additional user, who have not contributed to this pull request approve the changes.

  • ✅ Approved by PR author @nolar
  • ❌ 1 additional approval needed
     

@nolar nolar changed the title Document the preservation of Kopf's persistence state in CRDs Document the preservation of Kopf's persistence state in "v1" CRDs May 8, 2020
@nolar nolar requested review from 3abdelazim and mnarodovitch May 11, 2020 08:47
@nolar nolar added this to the 0.27 milestone May 11, 2020
@nolar nolar force-pushed the doc-preserve-arbitrary-fields branch from 9e0ab69 to 70709d5 Compare May 11, 2020 11:29
mnarodovitch
mnarodovitch previously approved these changes May 11, 2020
@nolar nolar force-pushed the doc-preserve-arbitrary-fields branch from 70709d5 to 61bde04 Compare May 11, 2020 16:22
@nolar nolar merged commit 349a976 into zalando-incubator:master May 11, 2020
@nolar nolar deleted the doc-preserve-arbitrary-fields branch May 11, 2020 16:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants