⚠ Generate Embedded ObjectMeta in the CRDs #539
Conversation
|
Welcome @dvaldivia! |
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/M
dvaldivia
changed the title
|
/assign @DirectXMan12 |
|
I updated the PR description |
| if f, ok := KnownPackages["k8s.io/apimachinery/pkg/apis/meta/v1"]; ok { | ||
| f(p, pkg) | ||
| } | ||
| // This is a allow-listed set of properties of ObjectMeta, other runtime properties are not part of this list |
There was a problem hiding this comment.
as per the meeting today, please link to sttts's comment here
There was a problem hiding this comment.
To clarify, I think @DirectXMan12 is referring to this comment #395 (comment). Can you confirm?
There was a problem hiding this comment.
yeah, that's what I was talking about.
There was a problem hiding this comment.
@DirectXMan12 @coderanger I'll update the PR
There was a problem hiding this comment.
done, rebased, squashed and comment added.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: dvaldivia The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
dvaldivia
force-pushed
the
embedded-objectmeta
branch
from
1228456
to
3beb2ea
Compare
k8s-ci-robot
added
the
needs-rebase
|
@dvaldivia: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
1 similar comment
|
@dvaldivia: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
subsumed by #557 (with attribution :-) ) |
This PR makes it so embedded
ObjectMetain the CRD get's properly generated if the generator optiongenerateEmbeddedObjectMeta=trueis passed, this is needed because if a CRD has embeddedObjectMetain any field andpreserveUnknowFieldsis set to false, all the metadata will be lost when doing conversion between versions.An example on how to have the embedded ObjectMeta generated in the resulting CRD
This PR makes it so by default any embedded
ObjectMetais not generated in the resulting CRD, however the top levelObjectMetabelonging to the CRD itself is never generated as the kubernetes API disallows changes to the CRD metadata between conversions.The generated
ObjectMetais also only a subset of the original set of fields insideObjectMetathis is due to the fact that other runtime fields are problematic if they are being traded with the kubernetes API, such ascreationTimeStamp(rancher/rancher#23857) so this only generatesname, namespace, labels, annotations and finalizerswhich from a design perspective should be enough. This follows the recommendation by @sttts who recommended aEmbeddedObjectMetabut instead of using a different type, we have a reduced set of fields that are "just enough" for a CRD design.An example of why we need this is for example if a CRD had a
volumeClaimTemplate(for an underlying statefulset) which includeObjectMetasuch as Labels, Annotations and/org name which are meant to be passed to the PVC where getting lost between conversions.This PR is based on the work by @arjunrn and @champak following the discussion on #448 and the PR #498 and it's also similar to #395 as it addressed the same problem, but adds the type casting for
FieldsV1and the requested argument to control this feature (per @DirectXMan12 on #395)