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

CRD versioning Public Documentation #8834

Merged
merged 9 commits into from Jun 18, 2018

Conversation

@mbohlool
Copy link
Member

mbohlool commented May 31, 2018

Documentation for CRD Versioning feature kubernetes/enhancements#544

Note: The PR is not ready for review. Just created as a placeholder.

@mbohlool mbohlool added this to the 1.11 milestone May 31, 2018

@k8sio-netlify-preview-bot

This comment has been minimized.

Copy link
Collaborator

k8sio-netlify-preview-bot commented May 31, 2018

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

Built with commit 8e5dc60

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

@k8s-ci-robot k8s-ci-robot added the size/L label May 31, 2018

@mistyhacks mistyhacks force-pushed the kubernetes:release-1.11 branch from 4b3430b to 7549d77 Jun 4, 2018

@mistyhacks mistyhacks force-pushed the mbohlool:doc branch from 52122ab to f504e14 Jun 4, 2018

@mistyhacks

This comment has been minimized.

Copy link
Member

mistyhacks commented Jun 4, 2018

I rebased to resolve conflicts.

@mbohlool mbohlool force-pushed the mbohlool:doc branch from f504e14 to ae2dec6 Jun 6, 2018

@k8s-ci-robot k8s-ci-robot added size/XL and removed size/L labels Jun 6, 2018

@mbohlool mbohlool changed the title [Placeholder] CRD versioning Public Documentation CRD versioning Public Documentation Jun 6, 2018

@mbohlool mbohlool force-pushed the mbohlool:doc branch from ae2dec6 to b57b3c5 Jun 6, 2018

@k8s-ci-robot k8s-ci-robot added size/XXL and removed size/XL labels Jun 6, 2018

@mbohlool mbohlool force-pushed the mbohlool:doc branch from b57b3c5 to 1fd278f Jun 6, 2018

@k8s-ci-robot k8s-ci-robot added size/L and removed size/XXL labels Jun 6, 2018

@mbohlool

This comment has been minimized.

Copy link
Member Author

mbohlool commented Jun 6, 2018

/cc @sttts Please take a look.

@mbohlool

This comment has been minimized.

Copy link
Member Author

mbohlool commented Jun 6, 2018

/cc @liggitt please take a look

@k8s-ci-robot k8s-ci-robot requested a review from liggitt Jun 6, 2018

@k8s-ci-robot

This comment has been minimized.

Copy link

k8s-ci-robot commented Jun 6, 2018

@mbohlool: GitHub didn't allow me to request PR reviews from the following users: a, look, please, take.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @liggitt please take a look

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.

@mistyhacks

This comment has been minimized.

Copy link
Member

mistyhacks commented Jun 6, 2018

When this is ready for docs review, please edit the title to remove the Placeholder text, and remove the hold.

{{% /capture %}}

{{% capture body %}}
Kubernetes standard API types has versioning to let developers extend them and roll out new features. To extend kubernetes with

This comment has been minimized.

@sttts

sttts Jun 7, 2018

Contributor

two times "extend" with a different context. For the first one: to let developer evolve APIs without breaking backwards compatibility.

Kubernetes standard API types has versioning to let developers extend them and roll out new features. To extend kubernetes with
Custom Resources, you should be able to do the same by supporting multiple versions of Custom Resources. CustomResourceDefinition API supports a `versions` field that can be used to list all versions for that object. Note that previous `version` field is deprecated and optional but if it is not empty, it must be the first item in the `versions` field.

For example, a CustomResourceDefinition with two versions would look like this:

This comment has been minimized.

@sttts

sttts Jun 7, 2018

Contributor

s/would look/looks/

Served: true
# One and only one version must be marked as storage version.
storage: true
- Name: v2

This comment has been minimized.

@sttts

sttts Jun 7, 2018

Contributor

would use v1beta1 instead. v1 and v2 are probably not the prime examples for versions without conversions.

- ct
```

If you save the above definition to `my-versioned-crontab.yaml` and create it:

This comment has been minimized.

@sttts

sttts Jun 7, 2018

Contributor

If ...,

This comment has been minimized.

@mbohlool

mbohlool Jun 7, 2018

Author Member

I don't get this one.

This comment has been minimized.

@sttts

sttts Jun 9, 2018

Contributor

expected a "If ..., then ..." sentence.

@mistyhacks mistyhacks force-pushed the mbohlool:doc branch from 7f6ce28 to 3090cdf Jun 15, 2018

@mistyhacks

This comment has been minimized.

Copy link
Member

mistyhacks commented Jun 15, 2018

I just rebased and pushed 3 new commits:

  • Applying pending feedback
  • Updating the main CRD page
  • Moving the two CRD topics under a new directory and adding a redirect for the old location of the previously-existing page

PTAL

mistyhacks added some commits Jun 15, 2018

@mistyhacks

This comment has been minimized.

Copy link
Member

mistyhacks commented Jun 15, 2018

I think this is in good shape. Removing the hold and approving. PTAL and lgtm or provide more feedback. Preview at https://deploy-preview-8834--kubernetes-io-vnext-staging.netlify.com/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning/ and sibling topics. Note the reorganization of the TOC.

/hold cancel
/approve

@k8s-ci-robot

This comment has been minimized.

Copy link

k8s-ci-robot commented Jun 15, 2018

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mistyhacks

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:

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

@@ -103,20 +107,20 @@ Use a custom resource (CRD or Aggregated API) if most of the following apply:

Kubernetes provides two ways to add custom resources to your cluster:

- [Custom Resource Definitions](/docs/concepts/api-extension/custom-resources/) (CRDs) are easier to use: they do not require any programming in some cases.
- CRDs are simple and do not always require programming.

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

nit: CRDs are simple and can be created without any programming

The algorithm used for sorting the versions is designed to sort versions in the
same way that the Kubernetes project sorts Kubernetes versions. Versions start with a
`v` followed by a number, an optional `beta` or `alpha` designation, and
optional additional versioning information. Broadly, a version string might look

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

The third part must be a numeric version as well.

When an object is written, it is persisted at the version designated as the
storage version at the time of the write. If the storage version changes,
existing objects are never converted automatically. However, newly-created
or updated objects are created at the new storage version. It is possible for an

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

are written at

When you read an object, you specify the version as part of the path. If you
specify a version that is different from the object's persisted version,
Kubernetes returns the object to you at the version you requested, but does not
modify the persisted object. You can request an object at any version that is

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

"modify" here is ambigious: a) the persisted object is not changed "on disk" b) it is returned without any conversion

storage at version `v1beta1`
2. You add version `v1` to your CustomResourceDefinition and designate it as
the storage version.
3. You read your object at version `v1beta`, then you read the object again at

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

v1beta1

version `v1`. Both returned objects are identical except for the apiVersion
field.
4. You create a new object. It is persisted in storage at version `v1`. You now
have two objects, one of which is at `v1beta`, and the other of which is at

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

v1beta1


To illustrate this, consider the following hypothetical series of events:

1. The storage version is `v1beta`. You create an object. It is persisted in

This comment has been minimized.

@sttts

sttts Jun 18, 2018

Contributor

v1beta1

@sttts

This comment has been minimized.

Copy link
Contributor

sttts commented Jun 18, 2018

Lgtm after the typos and nits are fixed. Well done!

@zparnold

This comment has been minimized.

Copy link
Member

zparnold commented Jun 18, 2018

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm label Jun 18, 2018

@k8s-ci-robot k8s-ci-robot merged commit 71bf468 into kubernetes:release-1.11 Jun 18, 2018

4 checks passed

cla/linuxfoundation mistyhacks authorized
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
tide In merge pool.
Details
@sttts

This comment has been minimized.

Copy link
Contributor

sttts commented Jun 19, 2018

@zparnold lgtm is counter-productive if there are a number of typos. Will you create a follow-up PR to fix them?

@nikhita

This comment has been minimized.

Copy link
Member

nikhita commented Jun 19, 2018

Will you create a follow-up PR to fix them?

#9142

@sttts

This comment has been minimized.

Copy link
Contributor

sttts commented Jun 19, 2018

Thanks @nikhita.

mistyhacks added a commit that referenced this pull request Jun 20, 2018

CRD versioning Public Documentation (#8834)
* CRD versioning Public Documentation

* Copyedit

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Address feedback

* More rewrites

* Address feedback

* Update main CRD page in light of versioning

* Reorg CRD docs

* Further reorg

* Tweak title

mistyhacks added a commit that referenced this pull request Jun 27, 2018

CRD versioning Public Documentation (#8834)
* CRD versioning Public Documentation

* Copyedit

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Address feedback

* More rewrites

* Address feedback

* Update main CRD page in light of versioning

* Reorg CRD docs

* Further reorg

* Tweak title

mistyhacks added a commit that referenced this pull request Jun 27, 2018

CRD versioning Public Documentation (#8834)
* CRD versioning Public Documentation

* Copyedit

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Address feedback

* More rewrites

* Address feedback

* Update main CRD page in light of versioning

* Reorg CRD docs

* Further reorg

* Tweak title

k8s-ci-robot added a commit that referenced this pull request Jun 27, 2018

Release docs for Kubernetes 1.11 (#9171)
* Seperate priority and preemption (#8144)

* Doc about PID pressure condition. (#8211)

* Doc about PID pressure condition.

Signed-off-by: Da K. Ma <klaus1982.cn@gmail.com>

* "so" -> "too"

* Update version selector for 1.11

* StorageObjectInUseProtection is GA (#8291)

* Feature gate: StorageObjectInUseProtection is GA

Update feature gate reference for 1.11

* Trivial commit to re-trigger Netlify

* CRIContainerLogRotation is Beta in 1.11 (#8665)

* Seperate priority and preemption (#8144)

* CRIContainerLogRotation is Beta in 1.11

xref: kubernetes/kubernetes#64046

* Bring StorageObjectInUseProtection feature to GA (#8159)

* StorageObjectInUseProtection is GA (#8291)

* Feature gate: StorageObjectInUseProtection is GA

Update feature gate reference for 1.11

* Trivial commit to re-trigger Netlify

* Bring StorageObjectInUseProtection feature to GA

StorageObjectInUseProtection is Beta in K8s 1.10.

It's brought to GA in K8s 1.11.

* Fixed typo and added feature state tags.

* Remove KUBE_API_VERSIONS doc (#8292)

The support to the KUBER_API_VERSIONS environment variable is completely
dropped (no deprecation). This PR removes the related doc in
release-1.11.

xref: kubernetes/kubernetes#63165

* Remove InitialResources from admission controllers (#8293)

The feature (was experimental) is dropped in 1.11.

xref: kubernetes/kubernetes#58784

* Remove docs related to in-tree support to GPU (#8294)

* Remove docs related to in-tree support to GPU

The in-tree support to GPU is completely removed in release 1.11.
This PR removes the related docs in release-1.11 branch.

xref: kubernetes/kubernetes#61498

* Update content updated by PR to Hugo syntax

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Update the doc about extra volume in kubeadm config (#8453)

Signed-off-by: Xianglin Gao <xianglin.gxl@alibaba-inc.com>

* Update CRD Subresources for 1.11 (#8519)

* coredns: update notes in administer-cluster/coredns.md (#8697)

CoreDNS is installed by default in 1.11.
Add notes on how to install kube-dns instead.

Update notes about CoreDNS->CoreDNS upgrades as in 1.11
the Corefile is retained.

Add example on upgrading from kube-dns to CoreDNS.

* kubeadm-alpha: CoreDNS related changes (#8727)

Update note about CoreDNS feature gate.

This change also updates a tab as a kubeadm sub-command
will change.

It looks for a new generated file:
generated/kubeadm_alpha_phase_addon_coredns.md
instead of:
generated/kubeadm_alpha_phase_addon_kube-dns.md

* Update cloud controller manager docs to beta 1.11 (#8756)

* Update cloud controller manager docs to beta 1.11

* Use Hugo shortcode for feature state

* kubeadm-upgrade: include new command `kubeadm upgrade diff` (#8617)

Also:
- Include note that this was added in 1.11.
- Modify the note about upgrade guidance.

* independent: update CoreDNS mentions for kubeadm (#8753)

Give CoreDNS instead of kube-dns examples in:
- docs/setup/independent/create-cluster-kubeadm.md
- docs/setup/independent/troubleshooting-kubeadm.md

* update 1.11 --server-print info (#8870)

* update 1.11 --server-print info

* Copyedit

* Mark ExpandPersistentVolumes feature to beta (#8778)

* Update version selector for 1.11

* Mark ExpandPersistentVolumes Beta

xref: kubernetes/kubernetes#64288

* fix shortcode, add placeholder files to fix deploy failures (#8874)

* declare ipvs ga (#8850)

* kubeadm: update info about CoreDNS in kubeadm-init.md (#8728)

Add info to install kube-dns instead of CoreDNS, as CoreDNS
is the default DNS server in 1.11.

Add notes that kubeadm config images can be used to list and pull
the required images in 1.11.

* kubeadm: update implementation-details.md about CoreDNS (#8829)

- Replace examples from kube-dns to CoreDNS
- Add notes about the CoreDNS feature gate status in 1.11
- Add note that the service name for CoreDNS is also
called `kube-dns`

* Update block device support for 1.11 (#8895)

* Update block device support for 1.11

* Copyedits

* Fix typo 'fiber channel' (#8957)

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* kubeadm-upgrade: add the 'node [config]' sub-command (#8960)

- Add includes for the generated pages
- Include placeholder generated pages

* kubeadm-init: update the example for the MasterConfiguration (#8958)

- include godocs link for MasterConfiguration
- include example MasterConfiguration
- add note that `kubeadm config print-default` can be used

* kubeadm-config: include new commands (#8862)

Add notes and includes for these new commands in 1.11:
- kubeadm config print-default
- kubeadm config migrate
- kubeadm config images list
- kubeadm config images pull

Include placeholder generated files for the above.

* administer-cluster/coredns: include more changes (#8985)

It was requested that for this page a couple of methods
should be outlined:
- manual installation for CoreDNS explained at the Kubernetes
section of the GitHub project for CoreDNS
- installation and upgrade via kubeadm

Make the above changes and also add a section "About CoreDNS".

This commit also lowercases a section title.

* Update CRD subresources doc for 1.11 (#8918)

* Add docs for volume expansion and online resizing (#8896)

* Add docs for volume expansion going beta

* Copyedit

* Address feedback

* Update exec plugin docs with TLS credentials (#8826)

* Update exec plugin docs with TLS credentials

kubernetes/kubernetes#61803 implements TLS client credential support for
1.11.

* Copyedit

* More copyedits for clarification

* Additional copyedit

* Change token->credential

* NodeRestriction admission prevents kubelet taint removal (#8911)

* dns-custom-namerserver: break down the page into mutliple sections (#8900)

* dns-custom-namerserver: break down the page into mutliple sections

This page is currently about kube-dns and is a bit outdated.
Introduce the heading `# Customizing kube-dns`.

Introduce a separate section about CoreDNS.

* Copyedits, fix headings for customizing DNS

Hey Lubomir,
I coypedited pretty heavily because this workflow is so much easier for docs and because I'm trying to help improve everything touching kubeadm as much as possible.

But there's one outstanding issue wrt headings and intro content: you can't add a heading 1 to a topic to do what you wanted to do. The page title in the front matter is rendered as a heading 1 and everything else has to start at heading 2. (We still need to doc this better in the docs contributing content, I know.)

Instead, I think we need to rewrite the top-of-page intro content to explain better the relationship between kube-dns and CoreDNS. I'm happy to write something, but I thought I'd push this commit first so you can see what I'm doing.

Hope it's all clear -- ping here or on Slack with any questions ~ Jennifer

* Interim fix for talking about CoreDNS

* Fix CoreDNS details

* PSP readOnly hostPath (#8898)

* Add documentation for crictl (#8880)

* Add documentation for crictl

* Copyedit

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Final copyedit

* VolumeSubpathEnvExpansion alpha feature (#8835)

* Note that Heapster is deprecated (#8827)

* Note that Heapster is deprecated

This notes that Heapster is deprecated, and migrates the relevant
docs to talk about metrics-server or other solutions by default.

* Copyedits and improvements

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Address feedback

* fix shortcode to troubleshoot deploy (#9057)

* update dynamic kubelet config docs for v1.11 (#8766)

* update dynamic kubelet config docs for v1.11

* Substantial copyedit

* Address feedback

* Reference doc for kubeadm (release-1.11) (#9044)

* Reference doc for kubeadm (release-1.11)

* fix shortcode to troubleshoot deploy (#9057)

* Reference doc for kube-components (release-1.11) (#9045)

* Reference doc for kube-components (release-1.11)

* Update cloud-controller-manager.md

* fix shortcode to troubleshoot deploy (#9057)

* Documentation on lowercasing kubeadm init apiserver SANs (#9059)

* Documentation on lowercasing kubeadm init apiserver SANs

* fix shortcode to troubleshoot deploy (#9057)

* Clarification in dynamic Kubelet config doc (#9061)

* Promote sysctls to Beta (#8804)

* Promote sysctls to Beta

* Copyedits

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Review comments

* Address feedback

* More feedback

* kubectl reference docs for 1.11 (#9080)

* Update Kubernetes API 1.11 ref docs (#8977)

* Update v1alpha1 to v1beta1.

* Adjust left nav for 1.11 ref docs.

* Trim list of old ref docs.

* Update Federation API ref docs for 1.11. (#9064)

* Update Federation API ref docs for 1.11.

* Add titles.

* Update definitions.html

* CRD versioning Public Documentation (#8834)

* CRD versioning Public Documentation

* Copyedit

Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>

* Address feedback

* More rewrites

* Address feedback

* Update main CRD page in light of versioning

* Reorg CRD docs

* Further reorg

* Tweak title

* CSI documentation update for raw block volume support (#8927)

* CSI documetation update for raw block volume support

* minor edits for "CSI raw block volume support"

Some small grammar and style nits.

* minor CSIBlockVolume edits

* Update kubectl component ref page for 1.11. (#9094)

* Update kubectl component ref page for 1.11.

* Add title. Replace stevepe with username.

* crd versioning doc: fix nits (#9142)

* Update `DynamicKubeletConfig` feature to beta (#9110)

xref: kubernetes/kubernetes#64275

* Documentation for dynamic volume limits based on node type (#8871)

* add cos for storage limits

* Update docs specific for aws and gce

* fix some minor things

* Update storage-limits.md

* Add k8s version to feature-state shortcode

* The Doc update for ScheduleDaemonSetPods (#8842)

Signed-off-by: Da K. Ma <klaus1982.cn@gmail.com>

* Update docs related to PersistentVolumeLabel admission control (#9109)

The said admission controller is disabled by default in 1.11
(kubernetes/kubernetes#64326) and scheduled to be removed in future
release.

* client exec auth: updates for 1.11 (#9154)

* Updates HA kubeadm docs (#9066)

* Updates HA kubeadm docs

Signed-off-by: Chuck Ha <ha.chuck@gmail.com>

* kubeadm HA - Add stacked control plane steps

* ssh instructions and some typos in the bash scripts

Signed-off-by: Chuck Ha <ha.chuck@gmail.com>

* Fix typos and copypasta errors

* Fix rebase issues

* Integrate more changes

Signed-off-by: Chuck Ha <ha.chuck@gmail.com>

* copyedits, layout and formatting fixes

* final copyedits

* Adds a sanity check for load balancer connection

Signed-off-by: Chuck Ha <ha.chuck@gmail.com>

* formatting fixes, copyedits

* fix typos, formatting

* Document the Pod Ready++ feature (#9180)

Closes: #9107
Xref: kubernetes/kubernetes#64057

* Mention 'KubeletPluginsWatcher' feature (#9177)

* Mention 'KubeletPluginsWatcher' feature

This feature is more developers oriented than users oriented, so simply
mention it in the feature gate should be fine.
In future, when the design doc is migrated from Google doc to the
kubernetes/community repo, we can add links to it for users who want to
dig deeper.

Closes: #9108
Xref: kubernetes/kubernetes#63328, kubernetes/kubernetes#64605

* Copyedit

* Amend dynamic volume list docs (#9181)

The dynamic volume list feature has been documented but the feature gate
related was not there yet.

Closes: #9105

* Document for service account projection (#9182)

This adds docs for the service account projection feature.

Xref: kubernetes/kubernetes#63819, kubernetes/community#1973
Closes: #9102

* Update pod priority and preemption user docs (#9172)

* Update pod priority and preemption user docs

* Copyedit

* Documentation on setting node name with Kubeadm (#8925)

* Documentation on setting node name with Kubeadm

* copyedit

* Add kubeadm upgrade docs for 1.11 (#9089)

* Add kubeadm upgrade docs for 1.11

* Initial docs review feedback

* Add 1-11 to outline

* Fix formatting on tab blocks

* Move file to correct location

* Add `kubeadm upgrade node config` step

* Overzealous ediffing

* copyedit, fix lists and headings

* clarify --force flag for fixing bad state

* Get TOML ready for 1.11 release

* Blog post for 1.11 release (#9254)

* Blog post for 1.11 release

* Update 2018-06-26-kubernetes-1.11-release-announcement.md

* Update 2018-06-26-kubernetes-1.11-release-announcement.md

* Update 2018-06-26-kubernetes-1.11-release-announcement.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.