Publish CRD OpenAPI Documentation #12910

roycaihw · 2019-02-28T21:02:44Z

ref: kubernetes/enhancements#692

k8sio-netlify-preview-bot · 2019-02-28T21:02:54Z

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

Building with commit bdc6e7c

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

sftim

~~/lgtm~~
Oops, not ready for review.

k8s-ci-robot · 2019-03-01T16:00:47Z

@sftim: changing LGTM is restricted to assignees, and only kubernetes/website repo collaborators may be assigned issues.

In response to this:

/lgtm

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.

npentrel · 2019-03-07T19:54:01Z

Hi @roycaihw, is this ready for review? We need all docs PRs to be ready to review by March 11th at the very latest. Thanks!

roycaihw · 2019-03-08T22:07:53Z

the documentation is ready for review. Please take a look

/cc @liggitt @mbohlool @sttts

liggitt · 2019-03-12T21:34:49Z

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

+Additional modification is applied during the conversion to keep backwards compatiblity with
+kubectl in previous 1.13 version. The conversion won't modify the validation schema defined in CRD,
+and therefore won't affect [validation](#validation) in API server. See
+[conversion implementation](https://github.com/kubernetes/kubernetes/blob/83ff0f6c64485ffe491d5116596072f466be1bd5/staging/src/k8s.io/apiextensions-apiserver/pkg/controller/openapi/conversion.go#L42-L112)


we don't typically link docs to code or pull requests... can you summarize the modifications done and the compatibility analysis here?

added

I started with listing the modifications made, but I went with link because I thought it's wordy and may distract user who don't care about the modification

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

sttts · 2019-03-13T18:42:35Z

/lgtm

sttts · 2019-03-13T18:44:17Z

/lgtm

roycaihw · 2019-03-13T20:20:44Z

/assign @cody-clark
for approval

cody-clark

Preview: https://5c894f62fbe61f0008a379c4--kubernetes-io-vnext-staging.netlify.com/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#publish-validation-schema-in-openapi-v2

I found a couple broken links / ordered lists and left a few nits, too.

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

cody-clark · 2019-03-14T21:23:02Z

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

+Kubernetes API server.
+
+The published schema will be consumed by [kubectl](/docs/reference/kubectl/overview) to perform client-side
+validation (`kubectl create` and `kubectl apply`) and schema explanation (`kubectl explain`) on custom resources,


Style guide: use present tense and active voice

"kubectl consumes the published schema to perform client-side validation (kubectl create and kubectl apply), schema explanation (kubectl explain) on custom resources, and other purposes."

updated

I left the last part unchanged ("The published schema can be consumed for other purposes") because it's not limited to only be used by kubectl. For example we know that server-side apply is planning to use the schema in future

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

cody-clark · 2019-03-15T00:52:58Z

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

+- For a schema with no type specified
+  - the field `properties` is removed
+
+3. The following fields are removed as they aren't supported by the OpenAPI protobuf implementation


This section is hard to read or scan. I'll approve this once the nits and lists are fixed, but I'd like to come up with a plan to organize this info better after the release.

I threw something together that kind of does, but it doesn't render the best on k8s.io because the inline code backticks are the same color as the alternating table cells.

Thoughts? Other ideas?

@cody-clark thanks for the suggestion. The table looks much better!

I'm not super concerned about the color, as long as we can tell the difference between code and the rest part of the sentence (bold can do the trick)

I'm concerned about the expressiveness of the table. e.g

For a schema with a $ref (the $ref field in the schema object is defined)

For a schema of null type (the type field in the schema object is defined and the value is null)

reads differently from

Schema with

$ref

null

I'll think more about how to use table to arrange this section

fix links, ordered lists, style and typo

cody-clark · 2019-03-15T20:11:16Z

Final Preview: https://deploy-preview-12910--kubernetes-io-vnext-staging.netlify.com/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#publish-validation-schema-in-openapi-v2

Thanks for following up, @roycaihw! I'll reach out after the release with something hopefully more concrete. Cheers!

/lgtm
/approve

k8s-ci-robot · 2019-03-15T20:11:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cody-clark

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~~ [cody-clark]

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

roycaihw · 2019-03-15T20:12:57Z

/hold

roycaihw · 2019-03-15T20:18:04Z

/hold

did it too late. I just noticed that a few things look wrong in the preview:

the bullet indentation is wrong in the ordered list (one layer is compacted)
the feature state is Kubernetes v1.13 alpha but not v1.14

@cody-clark any idea on how to fix? is 2) expected?

* Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Document timeout attribute for kms-plugin. (#12158) See 72540. * Official documentation on Poseidon/Firmament, a new multi-scheduler (#12343) * Removed the old version of the Poseidon documentation. Incorrect location. * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S (#12069) * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Updated the document as per review comments. Added config details. * Updated the document as per the latest review comments. Fixed nits * Made changes as per latest suggestions. * Some more changes added. * Updated as per suggestions. * Changed the release process section. * SIG Docs edits Small edits to match style guidelines. * add plus to feature state * capitalization * revert feature state shortcode since this is a Kubernetes extension, not a direct feature, it shouldn't use the regular feature state tagging. (cherry picked from commit 7730c15) * Remove initializers from doc. It will be removed in 1.14 (#12331) * kubeadm: Document CRI auto detection functionality (#12462) Signed-off-by: Rostislav M. Georgiev <[email protected]> * Minor doc change for GAing Pod DNS Config (#12514) * Graduate ExpandInUsePersistentVolumes feature to beta (#10574) * Rename 2018-11-07-grpc-load-balancing-with-linkerd.md.md file (#12594) * Add dynamic percentage of node scoring to user docs (#12235) * Add dynamic percentage of node scoring to user docs * addressed review comments * delete special symbol (#12445) * Update documentation for VolumeSubpathEnvExpansion (#11843) * Update documentation for VolumeSubpathEnvExpansion * Address comments - improve descriptions * Graduate Pod Priority and Preemption to GA (#12428) * Added Instana links to the documentation (#12977) * Added link to the Instana Kubernetes integration * Added Instana link for services section Added Instana and a link to the Kubernetes integration to the analytics services section and broadened the scope to APM, monitoring and analytics. * Oxford comma /flex * More Oxford commas, because they matter * Update kubectl plugins to stable (#12847) * documentation for CSI topology beta (#12889) * Document changes to default RBAC discovery ClusterRole(Binding)s (#12888) * Document changes to default RBAC discovery ClusterRole(Binding)s Documentation for kubernetes/enhancements#789 and kubernetes/kubernetes#73807 * documentation review feedback * CSI raw block to beta (#12931) * Change incorrect string raw to block (#12926) Fixes #12925 * Update documentation on node OS/arch labels (#12976) These labels have been promoted to GA: kubernetes/enhancements#793 * local pv GA doc updates (#12915) * Publish CRD OpenAPI Documentation (#12910) * add documentation for CustomResourcePublishOpenAPI * address comments fix links, ordered lists, style and typo * kubeadm: add document for upgrading from 1.13 to 1.14 (single CP and HA) (#13189) * kubeadm: add document for upgrading from 1.13 to 1.14 - remove doc for upgrading 1.10 -> 1.11 * kubeadm: apply amends to upgrade-1.14 doc * kubeadm: apply amends to upgrade-1.14 doc (part2) * kubeadm: apply amends to upgrade-1.14 doc (part3) * kubeadm: add note about "upgrade node experimental-control-plane" + add comment about `upgrade plan` * kubeadm: add missing "You should see output similar to this" * fix bullet indentation (#13214) * mark PodReadinessGate GA (#12800) * Update RuntimeClass documentation for beta (#13043) * Update RuntimeClass documentation for beta * Update feature gate & add upgrade section * formatting fixes * Highlight upgrade action required * Address feedback * CSI ephemeral volume alpha documentation (#10934) * update kubectl documentation (#12867) * update kubectl documentation * add document for Secret/ConfigMap generators * replace `kubectl create -f` by `kubectl apply -f` * Add page for kustomization support in kubectl * fix spelling errors and address comments * Documentation for Windows GMSA feature (#12936) * Documentation for Windows GMSA feature Signed-off-by: Deep Debroy <[email protected]> * Enhancements to GMSA docs Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Fix GMSA link Signed-off-by: Deep Debroy <[email protected]> * Add GMSA feature flag in feature flag list Signed-off-by: Deep Debroy <[email protected]> * Relocate GMSA to container configuration Signed-off-by: Deep Debroy <[email protected]> * Add example for container spec Signed-off-by: Deep Debroy <[email protected]> * Remove changes in Windows index Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Rearrange the steps into two sections and other edits Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Add reference to script to generate GMSA YAMLs Signed-off-by: Deep Debroy <[email protected]> * Some more clarifications for GMSA Signed-off-by: Deep Debroy <[email protected]> * HugePages graduated to GA (#13004) * HugePages graduated to GA * fixing nit for build * Docs for node PID limiting (kubernetes/kubernetes#73651) (#12932) * kubeadm: update the reference documentation for 1.14 (#12911) * kubeadm: update list of generated files for 1.14 NOTE: PLACEHOLDERS! these files are generated by SIG Docs each release, but we need them to pass the k/website PR CI. - add join_phase* (new sub phases of join) - add init_phase_upload-certs.md (new upload certs phase for init) - remove alpha-preflight (now both init and join have this) * kubeadm: update reference docs includes for 1.14 - remove includes from alpha.md - add upload-certs to init-phase.md - add join-phase.md and it's phases * kubeadm: update the editorial content of join and init - cleanup master->control-plane node - add some notes about phases and join - remove table about pre-pulling images - remove outdated info about self-hosting * kubeadm: update target release for v1alpha3 removal 1.14 -> 1.15 * kubeadm: copy edits for 1.14 reference docs (part1) * kubeadm: use "shell" for code blocks * kubeadm: update the 1.14 HA guide (#13191) * kubeadm: update the 1.14 HA guide * kubeadm: try to fix note/caution indent in HA page * kubeadm: fix missing sudo and minor amends in HA doc * kubeadm: apply latest amends to the HA doc for 1.14 * fixed a few missed merge conflicts * Admission Webhook new features doc (#12938) - kubernetes/kubernetes#74998 - kubernetes/kubernetes#74477 - kubernetes/kubernetes#74562 * Clarifications and fixes in GMSA doc (#13226) * Clarifications and fixes in GMSA doc Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to fix bullets Signed-off-by: Deep Debroy <[email protected]> * Reword application of sample gmsa Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * RunAsGroup documentation for Progressing this to Beta (#12297) * start serverside-apply documentation (#13077) * start serverside-apply documentation * add more concept info on server side apply * Update api concepts * Update api-concepts.md * fix style issues * Document CSI update (#12928) * Document CSI update * Finish CSI documentation Also fix mistake with ExpandInUsePersistentVolumes documented as beta * Overall docs for CSI Migration feature (#12935) * Placeholder docs for CSI Migration feature Signed-off-by: Deep Debroy <[email protected]> * Address CR comments and update feature gates Signed-off-by: Deep Debroy <[email protected]> * Add mappings for CSI plugins Signed-off-by: Deep Debroy <[email protected]> * Add sections for AWS and GCE PD migration Signed-off-by: Deep Debroy <[email protected]> * Add docs for Cinder and CSI Migration info Signed-off-by: Deep Debroy <[email protected]> * Clarify scope to volumes with file system Signed-off-by: Deep Debroy <[email protected]> * Change the format of EBS and Cinder CSI Migration sections to follow the GCE template Signed-off-by: Deep Debroy <[email protected]> * Windows documentation updates for 1.14 (#12929) * Updated the note to indicate doc work for 1.14 * first attempt at md export from gdoc * simplifyig * big attempt * moving DRAFT windows content to PR for review * moving content to PR in markdown for review * updated note tags * Delete windows-contributing.md deleting this file as it is already ported to the github contributor guide * fixed formatting in intro and cluster setup guide * updating formatting for running containers guide * rejiggered end of troubleshooting * fixed minor typos * Clarified the windows binary download step * Update _index.md making updates based on feedback * Update _index.md updating ovn-kubernetes docs * Update _index.md * Update _index.md * updating relative docs links updating all the links to be relative links to /docs * Update _index.md * Update _index.md updates for windows services and ovn-kubernetes * formatted for correct step numbering * fix typos * Update _index.md updates for flannel PR in troubleshooting * Update _index.md * Update _index.md updating a few sections like roadmap, services, troubleshooting/filing tickets * Update _index.md * Update _index.md * Update _index.md * Fixed a few whitespace issues * Update _index.md * Update _index.md * Update _index.md * add section on upgrading CoreDNS (#12909) * documentation for kubelet resource metrics endpoint (#12934) * windows docs updates for 1.14 (#13279) * Delete sample-l2bridge-wincni-config.json this file is not used anywhere * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Rename content/en/docs/getting-started-guides/windows/_index.md to content/en/docs/setup/windows/_index.md moving to new location * Delete flannel-master-kubectl-get-ds.png * Delete flannel-master-kubeclt-get-pods.png * Delete windows-docker-error.png * Add files via upload * Rename _index.md to add-windows-nodes.md * Create _index.md * Update _index.md * Update add-windows-nodes.md * Update add-windows-nodes.md * Create user-guide-windows-nodes.md * Create user-guide-windows-containers.md * Update and rename add-windows-nodes.md to intro-windows-nodes.md * Update user-guide-windows-containers.md * Rename intro-windows-nodes.md to intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update _index.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md fixing the pause image * Update intro-windows-in-kubernetes.md changing tables from html to MD * Update user-guide-windows-nodes.md converting tables from HTML to MD * Update intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md updating the numbering , even though it messes up the notes a little bit. Jim will file a ticket to follow up * Update user-guide-windows-nodes.md * update to windows docs for 1.14 (#13322) * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update intro-windows-in-kubernetes.md (#13344) * server side apply followup (#13321) * change some parts of serverside apply docs in response to comments * fix typos and wording * Update config.toml (#13365)

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 28, 2019

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

k8s-ci-robot requested review from deads2k and enisoc February 28, 2019 21:02

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language labels Feb 28, 2019

roycaihw mentioned this pull request Feb 28, 2019

Publish CRD OpenAPI Schema kubernetes/enhancements#692

Closed

sftim reviewed Mar 1, 2019

View reviewed changes

roycaihw mentioned this pull request Mar 8, 2019

Umbrella issue for Publish CRD OpenAPI followups kubernetes/kubernetes#74976

Closed

9 tasks

roycaihw force-pushed the publish-crd-openapi-1.14 branch 2 times, most recently from 5a02799 to f8757a2 Compare March 8, 2019 22:03

roycaihw changed the title ~~WIP: publish CRD OpenAPI Documentation~~ Publish CRD OpenAPI Documentation Mar 8, 2019

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 8, 2019

k8s-ci-robot requested review from liggitt, mbohlool and sttts March 8, 2019 22:07

liggitt reviewed Mar 12, 2019

View reviewed changes

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 13, 2019

roycaihw force-pushed the publish-crd-openapi-1.14 branch from d612d03 to 4f34cdc Compare March 13, 2019 01:46

sttts reviewed Mar 13, 2019

View reviewed changes

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

sttts reviewed Mar 13, 2019

View reviewed changes

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md Outdated Show resolved Hide resolved

sttts reviewed Mar 13, 2019

View reviewed changes

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md Outdated Show resolved Hide resolved

sttts reviewed Mar 13, 2019

View reviewed changes

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md Outdated Show resolved Hide resolved

sttts reviewed Mar 13, 2019

View reviewed changes

content/en/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions.md Outdated Show resolved Hide resolved

roycaihw force-pushed the publish-crd-openapi-1.14 branch from 95f8951 to b7280e9 Compare March 13, 2019 18:40

k8s-ci-robot assigned sttts Mar 13, 2019

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

add documentation for CustomResourcePublishOpenAPI

27c721f

roycaihw force-pushed the publish-crd-openapi-1.14 branch from b7280e9 to 27c721f Compare March 13, 2019 18:43

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 13, 2019

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

k8s-ci-robot assigned cody-clark Mar 13, 2019

roycaihw mentioned this pull request Mar 14, 2019

Using kube-openapi + 'kubectl explain' on Custom Resources? kubernetes/kube-openapi#97

Closed

jimangel force-pushed the dev-1.14 branch 2 times, most recently from 2534806 to ead0a28 Compare March 14, 2019 03:47

cody-clark suggested changes Mar 15, 2019

View reviewed changes

address comments

bdc6e7c

fix links, ordered lists, style and typo

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 15, 2019

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

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

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 15, 2019

k8s-ci-robot merged commit f18d212 into kubernetes:dev-1.14 Mar 15, 2019

roycaihw mentioned this pull request Mar 15, 2019

fix bullet indentation in Publish CRD OpenAPI Documentation #13214

Merged

jimangel added this to the 1.14 milestone Mar 16, 2019

jimangel mentioned this pull request Mar 16, 2019

Official 1.14 Release Docs #13174

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish CRD OpenAPI Documentation #12910

Publish CRD OpenAPI Documentation #12910

roycaihw commented Feb 28, 2019 •

edited

Loading

k8sio-netlify-preview-bot commented Feb 28, 2019 •

edited

Loading

sftim left a comment •

edited

Loading

k8s-ci-robot commented Mar 1, 2019

npentrel commented Mar 7, 2019

roycaihw commented Mar 8, 2019

liggitt Mar 12, 2019

roycaihw Mar 13, 2019

sttts commented Mar 13, 2019

sttts commented Mar 13, 2019

roycaihw commented Mar 13, 2019

cody-clark left a comment

cody-clark Mar 14, 2019

roycaihw Mar 15, 2019

cody-clark Mar 15, 2019 •

edited

Loading

roycaihw Mar 15, 2019

cody-clark commented Mar 15, 2019

k8s-ci-robot commented Mar 15, 2019

roycaihw commented Mar 15, 2019

roycaihw commented Mar 15, 2019

Publish CRD OpenAPI Documentation #12910

Publish CRD OpenAPI Documentation #12910

Conversation

roycaihw commented Feb 28, 2019 • edited Loading

k8sio-netlify-preview-bot commented Feb 28, 2019 • edited Loading

sftim left a comment • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 1, 2019

npentrel commented Mar 7, 2019

roycaihw commented Mar 8, 2019

liggitt Mar 12, 2019

Choose a reason for hiding this comment

roycaihw Mar 13, 2019

Choose a reason for hiding this comment

sttts commented Mar 13, 2019

sttts commented Mar 13, 2019

roycaihw commented Mar 13, 2019

cody-clark left a comment

Choose a reason for hiding this comment

cody-clark Mar 14, 2019

Choose a reason for hiding this comment

roycaihw Mar 15, 2019

Choose a reason for hiding this comment

cody-clark Mar 15, 2019 • edited Loading

Choose a reason for hiding this comment

roycaihw Mar 15, 2019

Choose a reason for hiding this comment

cody-clark commented Mar 15, 2019

k8s-ci-robot commented Mar 15, 2019

roycaihw commented Mar 15, 2019

roycaihw commented Mar 15, 2019

roycaihw commented Feb 28, 2019 •

edited

Loading

k8sio-netlify-preview-bot commented Feb 28, 2019 •

edited

Loading

sftim left a comment •

edited

Loading

cody-clark Mar 15, 2019 •

edited

Loading