Update CRD defaulting docs for GA #17450

sttts · 2019-11-06T10:55:11Z

No description provided.

k8sio-netlify-preview-bot · 2019-11-06T10:55:19Z

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 371e615

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5dd01232e8399600081b8f75

makoscafee · 2019-11-06T12:42:33Z

/milestone 1.17

sftim

Feedback, and also a question about the mutating webhook form of defaulting.

sftim · 2019-11-06T17:59:52Z

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md

@@ -628,7 +628,7 @@ Additionally, the following restrictions are applied to the schema:

 These fields can only be set with specific features enabled:

- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting is in beta since 1.16 and requires the `CustomResourceDefaulting` feature gate to be enabled (which is the case automatically for many clusters for beta features). Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).
+- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting is in GA since 1.17 (beta since 1.16 with the `CustomResourceDefaulting` feature gate to be enabled, which is the case automatically for many clusters for beta features). Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).


Do you prefer this wording:

Suggested change

- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting is in GA since 1.17 (beta since 1.16 with the `CustomResourceDefaulting` feature gate to be enabled, which is the case automatically for many clusters for beta features). Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).

- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting relies on the `CustomResourceDefaulting` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), enabled by default since v1.16. Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).

?

No, the suggested sentence is wrong. In GA and in beta it is enabled by default. In GA you cannot disable it.

Hello @sttts, line 631 is a bit difficult to parse.
Question:
How does Defaulting compare to Validation Schema Defaulting found in the section named Defaulting below?

Suggested rewording:

default: can be set for apiextensions.k8s.io/v1 CustomResourceDefinitions. Defaulting is in GA since v1.17. The CustomResourceDefaulting feature gate is enabled automatically (which is the default case for many clusters for beta features) starting with beta v1.16. Compare to [Validation ...

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md

sftim · 2019-11-06T18:05:04Z

content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md

@@ -174,7 +174,7 @@ Aggregated APIs offer more advanced API features and customization of other feat
 | Feature | Description | CRDs | Aggregated API |
 | ------- | ----------- | ---- | -------------- |
 | Validation | Help users prevent errors and allow you to evolve your API independently of your clients. These features are most useful when there are many clients who can't all update at the same time. | Yes.  Most validation can be specified in the CRD using [OpenAPI v3.0 validation](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#validation).  Any other validations supported by addition of a [Validating Webhook](/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook-alpha-in-1-8-beta-in-1-9). | Yes, arbitrary validation checks |
-| Defaulting | See above | Yes, either via [OpenAPI v3.0 validation](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting) `default` keyword (beta in 1.16), or via a [Mutating Webhook](/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook-beta-in-1-9) | Yes |
+| Defaulting | See above | Yes, either via [OpenAPI v3.0 validation](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting) `default` keyword (GA in 1.17), or via a [Mutating Webhook](/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook-beta-in-1-9) | Yes |


What's the story with Mutating Webhook defaulting? Is that still supported and available?

Yes. nit: The link was out of date though. Perhaps s/mutatingadmissionwebhook-beta-in-1-9/mutatingadmissionwebhook

Fixed link. Clarified that mutatingadmissionwebhooks are limited because they are not run when reading from storage.

roycaihw · 2019-11-08T04:08:12Z

Technically LGTM

sttts · 2019-11-16T15:14:52Z

Addressed comments.

kbhawkey · 2019-11-16T18:37:55Z

Page previews:
https://deploy-preview-17450--kubernetes-io-vnext-staging.netlify.com/docs/concepts/extend-kubernetes/api-extension/custom-resources/

https://deploy-preview-17450--kubernetes-io-vnext-staging.netlify.com/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/

kbhawkey · 2019-11-16T22:56:41Z

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md

@@ -781,10 +781,10 @@ crontab "my-new-cron-object" created

 ### Defaulting

-{{< feature-state state="beta" for_kubernetes_version="1.16" >}}
+{{< feature-state state="stable" for_kubernetes_version="1.17" >}}


The preview shows the version at 1.16 -- seems odd. Perhaps a problem with netlify.

daminisatya · 2019-11-20T09:36:21Z

@sttts Just a reminder about the last Docs deadline - 22nd Nov, by which this PR needs to be merged!

daminisatya · 2019-11-22T15:21:22Z

@kbarnard10 Is this PR good to go?

kbhawkey · 2019-11-22T16:26:53Z

@daminisatya , Changes seem OK.
/lgtm

daminisatya · 2019-11-22T17:05:43Z

/approve

k8s-ci-robot · 2019-11-22T17:06:05Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: daminisatya

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [daminisatya]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* feat: graduate TaintNodesByCondition to GA (#17073) * Promote StartupProbe to beta (enabled by default). (#17164) * Watch bookmarks to GA (#17026) * feat: graduate ScheduleDaemonSetPods to GA (#17350) * Update Docker installation instructions (#17405) * Use exact version numbers for installing Docker in Ubuntu (#17428) * Move CSIMigration and CSIMigrationGCE to Beta in Kubernetes v1.17 (#17478) * Promote NodeLease feature to GA (#17189) * Update docs for csi topology ga (#17408) * Update RunAsUsername to beta (#17460) * doc:Update RunAsUsername to beta * doc: update samples - kubernetes.io/os is no longer beta * Updating based on review feedback * Promote Node-specific volume limits to GA (#17432) * Promote PodShareProcessNamespace to stable (#17192) * Promote PodShareProcessNamespace to stable * Add for_k8s_version to feature-state label Co-Authored-By: Tim Bannister <[email protected]> * Readd version-check to shareProcessNamespace task * Update service load balancer finalizer doc for GA (#17438) * Update Topology Manager docs (#17451) * Added information on how device plugins can take advantage of Topology Manager * Updated the Topology Manager documentation to include additionalinformation and update some out of date sections * Fix broken Topology Manager link (#17746) Part of What's Next Device Plugin section * Update CRD defaulting docs for GA (#17450) * Add documentation for VolumeSnapshot Beta (#17233) * Updating EndpointSlice documentation for beta release in 1.17 (#17411) * (docs/dualstack): v1.17 updates (#17457) * Add placehold doc updates for dualstack in 1.17 Signed-off-by: Lachlan Evenson <[email protected]> * Add Downward API and /etc/hosts Pod IP validation Signed-off-by: Lachlan Evenson <[email protected]> * remove addressed known issue via k/k pr 85246 Signed-off-by: Lachlan Evenson <[email protected]> * Remove known issue and add flag as part of k/k 79993 Signed-off-by: Lachlan Evenson <[email protected]> * remove follow up placeholders Signed-off-by: Lachlan Evenson <[email protected]> * Update verbiage Signed-off-by: Lachlan Evenson <[email protected]> * Make IP addressing consistent throughout the task Signed-off-by: Lachlan Evenson <[email protected]> * Update to status.podIPs Signed-off-by: Lachlan Evenson <[email protected]> * Update content/en/docs/tasks/network/validate-dual-stack.md Use set instead of env Co-Authored-By: Khaled Henidak (Kal) <[email protected]> * add topology.kubernetes.io/zone, topology.kubernetes.io/region and node.kubernetes.io/instance-type labels to docs (#17498) Signed-off-by: Andrew Sy Kim <[email protected]> * Service topology alpha documentation (#17459) * Update list of feature flags for in-tree plugins migrated to CSI (#17533) Signed-off-by: Deep Debroy <[email protected]> * Update Node concept for TaintNodesByCondition going GA (#17577) * feat: graduate ResourceQuotaScopeSelectors to GA in 1.17 (#17554) * kubeadm: update the upgrade documentation for 1.17 (#17587) * doc: Simplify Windows deployments with RuntimeClass (#16697) * doc: Simplify Windows deployments with RuntimeClass * Updating on review feedback * doc: Adding windows-build label from enhancement 1301 * update doc for kubelet option --reserved-cpus (#17648) * feat: update TaintNodesByCondition in feature gates table (#17377) * Update docs for v1 resource quota configuration (#17547) * AdmissionConfiguration v1 (#17548) * Update WebhookAdmissionConfiguration examples (#17549) * Update AWS EBS Migration Feature state (#16126) * Add resource version section to api-concepts documentation (#16910) * Add Resource Version semantics section to api concepts * Clarify risks of going back in time, add details about compaction and watch cache sizes * Apply suggestions from liggitt Co-Authored-By: Jordan Liggitt <[email protected]> * remove pesudocode, apply feedback * Fix typo * Clarify equality rules * Cleanup kubectl generators docs (#17609) * Write ReplicationController without a space * Drop mentioning unsupported cluster versions * Fix capitalization for “API group” * Tweak wording * Avoid using deprecated generator in example * add Antrea description in dev-1.17 (#17919) * Promote VolumeSubpathEnvExpansion to GA * Reference Documentation for the Kubernetes API for 1.17 (#18019) * Update feature-gates.md (#18033) * Reference Documentation for kubectl Commands for 1.17 (#18017) * Update for v1.17 (#18034) * Update config.toml(release-1.17) for 1.17 (#18031)

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 6, 2019

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 6, 2019

k8s-ci-robot requested review from enisoc and roycaihw November 6, 2019 10:55

sttts mentioned this pull request Nov 6, 2019

Defaulting of Custom Resources kubernetes/enhancements#575

Closed

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 6, 2019

k8s-ci-robot added this to the 1.17 milestone Nov 6, 2019

sftim reviewed Nov 6, 2019

View reviewed changes

Update CRD defaulting docs for GA

371e615

sttts force-pushed the sttts-crd-defaulting-ga branch from faaf1f8 to 371e615 Compare November 16, 2019 15:13

kbhawkey reviewed Nov 16, 2019

View reviewed changes

k8s-ci-robot assigned kbhawkey Nov 22, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 22, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 22, 2019

k8s-ci-robot merged commit 0562ef4 into kubernetes:dev-1.17 Nov 22, 2019

mrbobbytables pushed a commit that referenced this pull request Dec 6, 2019

Update CRD defaulting docs for GA (#17450)

d42940b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update CRD defaulting docs for GA #17450

Update CRD defaulting docs for GA #17450

sttts commented Nov 6, 2019

k8sio-netlify-preview-bot commented Nov 6, 2019 •

edited

Loading

makoscafee commented Nov 6, 2019

sftim left a comment

sftim Nov 6, 2019

sttts Nov 16, 2019

kbhawkey Nov 16, 2019

sftim Nov 6, 2019

roycaihw Nov 8, 2019 •

edited

Loading

sttts Nov 16, 2019

roycaihw commented Nov 8, 2019

sttts commented Nov 16, 2019

kbhawkey commented Nov 16, 2019

kbhawkey Nov 16, 2019

daminisatya commented Nov 20, 2019

daminisatya commented Nov 22, 2019

kbhawkey commented Nov 22, 2019

daminisatya commented Nov 22, 2019

k8s-ci-robot commented Nov 22, 2019

	- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting is in GA since 1.17 (beta since 1.16 with the `CustomResourceDefaulting` feature gate to be enabled, which is the case automatically for many clusters for beta features). Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).
	- `default`: can be set for `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting relies on the `CustomResourceDefaulting` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), enabled by default since v1.16. Compare [Validation Schema Defaulting](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#defaulting).

Update CRD defaulting docs for GA #17450

Update CRD defaulting docs for GA #17450

Conversation

sttts commented Nov 6, 2019

k8sio-netlify-preview-bot commented Nov 6, 2019 • edited Loading

makoscafee commented Nov 6, 2019

sftim left a comment

Choose a reason for hiding this comment

sftim Nov 6, 2019

Choose a reason for hiding this comment

sttts Nov 16, 2019

Choose a reason for hiding this comment

kbhawkey Nov 16, 2019

Choose a reason for hiding this comment

sftim Nov 6, 2019

Choose a reason for hiding this comment

roycaihw Nov 8, 2019 • edited Loading

Choose a reason for hiding this comment

sttts Nov 16, 2019

Choose a reason for hiding this comment

roycaihw commented Nov 8, 2019

sttts commented Nov 16, 2019

kbhawkey commented Nov 16, 2019

kbhawkey Nov 16, 2019

Choose a reason for hiding this comment

daminisatya commented Nov 20, 2019

daminisatya commented Nov 22, 2019

kbhawkey commented Nov 22, 2019

daminisatya commented Nov 22, 2019

k8s-ci-robot commented Nov 22, 2019

k8sio-netlify-preview-bot commented Nov 6, 2019 •

edited

Loading

roycaihw Nov 8, 2019 •

edited

Loading