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

Add note in tutorial for "x-kubernetes-preserve-unkown-fields" #612

Merged
merged 1 commit into from
Dec 14, 2020

Conversation

ztaylor54
Copy link

…." field, link to k8s docs on the topic

What do these changes do?

The result of discussion in #574

Adds a note in the walkthrough tutorial about CRDs requiring the x-kubernetes-preserve-unknown-fields: true field to be set in the CRD schema, as well as linking to relevant k8s docs on field pruning.

Description

The tutorial had not been updated to warn about Kubernetes silently pruning unknown fields, so this note should be helpful to anyone who brought their own CRD into the walkthrough and neglected to add the x-kubernetes-preserve-unknown-fields field to their schema, as I had.

Issues/PRs

Issues: #574

Related:

Type of changes

  • Mostly documentation and examples (no code changes)

Checklist

  • The code addresses only the mentioned problem, and this problem only
  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt

@ztaylor54 ztaylor54 requested a review from nolar as a code owner December 14, 2020 09:01
@nolar nolar changed the title Add note in tutorial for handler returns requiring "x-...-preserve-..… Add note in tutorial for "x-kubernetes-preserve-unkown-fields" Dec 14, 2020
@nolar nolar merged commit 139e505 into nolar:master Dec 14, 2020
@nolar
Copy link
Owner

nolar commented Dec 14, 2020

@ztaylor54 Thanks for the contribution!

@ztaylor54
Copy link
Author

@nolar No problem, thanks for being so helpful last week!

@ztaylor54 ztaylor54 deleted the 574-tutorial-docs-update branch December 14, 2020 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants