Document new stable labels for zone, region and instance-type #17498

andrewsykim · 2019-11-08T17:54:45Z

Signed-off-by: Andrew Sy Kim kiman@vmware.com

Enhancement: kubernetes/enhancements#837
PRs: kubernetes/kubernetes#81431 kubernetes/kubernetes#82049

I didn't update examples/setup references to use the new labels because the old beta labels are still the source of truth for v1.17. Those will be updated for v1.18.

ref: #17496

k8sio-netlify-preview-bot · 2019-11-08T17:54:52Z

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

Building with commit 3fd6d69

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

sftim · 2019-11-10T10:25:59Z

content/en/docs/reference/kubernetes-api/labels-annotations-taints.md

@@ -57,10 +57,25 @@ This will be set only if you are using a `cloudprovider`. This setting is handy
 if you want to target certain workloads to certain instance types, but typically you want
 to rely on the Kubernetes scheduler to perform resource-based scheduling. You should aim to schedule based on properties rather than on instance types (for example: require a GPU, instead of requiring a `g2.2xlarge`).

+**NOTE**: starting in v1.17, this label is deprecated in favor of [node.kubernetes.io/instance-type](nodekubernetesioinstance-type).


I recommend using a {{< note >}} shortcode here, and again below. Also the hyperlink is broken.

Eg:

Suggested change

**NOTE**: starting in v1.17, this label is deprecated in favor of [node.kubernetes.io/instance-type](nodekubernetesioinstance-type).

{{< note >}}This label is deprecated in favor of [node.kubernetes.io/instance-type](#nodekubernetesioinstance-type){{< /note >}}

andrewsykim · 2019-11-14T21:01:32Z

Comments addressed, PTAL

sftim

Fine by me.

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

Page previews:
https://deploy-preview-17498--kubernetes-io-vnext-staging.netlify.com/docs/concepts/configuration/assign-pod-node/

https://deploy-preview-17498--kubernetes-io-vnext-staging.netlify.com/docs/reference/access-authn-authz/admission-controllers/

https://deploy-preview-17498--kubernetes-io-vnext-staging.netlify.com/docs/reference/kubernetes-api/labels-annotations-taints/

kbhawkey · 2019-11-16T18:25:21Z

content/en/docs/reference/kubernetes-api/labels-annotations-taints.md

+Used on: Node
+
+The Kubelet populates this with the instance type as defined by the `cloudprovider`.
+This will be set only if you are using a `cloudprovider`. This setting is handy


Hello @andrewsykim ,
line 68: As I recall, this page uses this to mean labels/annotations/taints? Does this section apply to all terms?
line 69: This will be set ... cloudprovider --meaning that the instance-type will be set if the user has defined the providerID?

@kbhawkey this is an exact copy of what was already written for the old label (beta.kubernetes.io/instance-type) which I copied for consistency reasons. I can update both based on our feedback but would prefer to do this in a separate PR. Let me know what you think is best.

Hello @andrewsykim , OK. Sure, I found the statements about cloudprovider confusing.

The notes are good, though to look like the other deprecated types, could you add deprecated to the headers (like the other types that are deprecated), instead of a note referencing v1.17?
For example:

## beta.kubernetes.io/instance-type (deprecated) ## failure-domain.beta.kubernetes.io/region (deprecated) ## failure-domain.beta.kubernetes.io/zone (deprecated)

Thanks!

good catch! updated :)

@andrewsykim , Just checking: do you need the notes (about deprecation in v1.1.7) lines 60, 77, and 107 if you add deprecated to the headers?

I think so because it's not always clear what version of the docs you're reading, stating it explicitly is helpful so users know when the replacement labels were added.

daminisatya · 2019-11-20T09:38:05Z

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

You have some review comments to be addressed

kbhawkey

@andrewsykim , Looks fine.
You could remove the duplicate content under, beta.kubernetes.io/instance-type (deprecated) and just leave the note.

kbhawkey · 2019-11-20T22:11:11Z

content/en/docs/reference/kubernetes-api/labels-annotations-taints.md

+Used on: Node
+
+The Kubelet populates this with the instance type as defined by the `cloudprovider`.
+This will be set only if you are using a `cloudprovider`. This setting is handy


@andrewsykim , Just checking: do you need the notes (about deprecation in v1.1.7) lines 60, 77, and 107 if you add deprecated to the headers?

…de.kubernetes.io/instance-type labels to docs Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

andrewsykim · 2019-11-21T00:49:33Z

@kbhawkey comments addresseed

kbhawkey · 2019-11-21T01:06:09Z

/lgtm

daminisatya · 2019-11-21T09:23:17Z

/lgtm

@andrewsykim Do you think this PR needs a tech review? if so can you suggest someone who can do that?

andrewsykim · 2019-11-21T21:18:27Z

@liggitt gave an initial review in #17496, maybe he can provide another review after KubeCON?

daminisatya · 2019-11-22T15:23:34Z

@liggitt Can you give a final review? just need a technical sign off.

liggitt · 2019-11-26T02:49:25Z

/lgtm

daminisatya · 2019-11-26T05:16:49Z

/lgtm
/approve

k8s-ci-robot · 2019-11-26T05:17:23Z

[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

…de.kubernetes.io/instance-type labels to docs (#17498) Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

* 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 <tim@scalefactory.com> * 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 <lachlan.evenson@microsoft.com> * Add Downward API and /etc/hosts Pod IP validation Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * remove addressed known issue via k/k pr 85246 Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * Remove known issue and add flag as part of k/k 79993 Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * remove follow up placeholders Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * Update verbiage Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * Make IP addressing consistent throughout the task Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * Update to status.podIPs Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com> * Update content/en/docs/tasks/network/validate-dual-stack.md Use set instead of env Co-Authored-By: Khaled Henidak (Kal) <khnidk@outlook.com> * 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 <kiman@vmware.com> * Service topology alpha documentation (#17459) * Update list of feature flags for in-tree plugins migrated to CSI (#17533) Signed-off-by: Deep Debroy <ddebroy@docker.com> * 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 <jordan@liggitt.net> * 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 8, 2019

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 8, 2019

k8s-ci-robot requested review from derekwaynecarr and kevin-wangzefeng November 8, 2019 17:55

tengqm added this to the 1.17 milestone Nov 9, 2019

sftim reviewed Nov 10, 2019

View reviewed changes

tengqm mentioned this pull request Nov 12, 2019

Document new stable labels for zone, region and instance-type #17496

Closed

sftim reviewed Nov 15, 2019

View reviewed changes

kbhawkey reviewed Nov 16, 2019

View reviewed changes

kbhawkey reviewed Nov 21, 2019

View reviewed changes

add topology.kubernetes.io/zone, topology.kubernetes.io/region and no…

3fd6d69

…de.kubernetes.io/instance-type labels to docs Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

k8s-ci-robot assigned kbhawkey Nov 21, 2019

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

k8s-ci-robot assigned daminisatya Nov 21, 2019

k8s-ci-robot assigned liggitt Nov 26, 2019

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

k8s-ci-robot merged commit b38809b into kubernetes:dev-1.17 Nov 26, 2019

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

add topology.kubernetes.io/zone, topology.kubernetes.io/region and no…

a444780

…de.kubernetes.io/instance-type labels to docs (#17498) Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document new stable labels for zone, region and instance-type #17498

Document new stable labels for zone, region and instance-type #17498

andrewsykim commented Nov 8, 2019 •

edited

Loading

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

edited

Loading

sftim Nov 10, 2019

andrewsykim commented Nov 14, 2019

sftim left a comment

kbhawkey commented Nov 16, 2019 •

edited

Loading

kbhawkey Nov 16, 2019

andrewsykim Nov 20, 2019

kbhawkey Nov 20, 2019

andrewsykim Nov 20, 2019

kbhawkey Nov 20, 2019

andrewsykim Nov 21, 2019

kbhawkey Nov 21, 2019

daminisatya commented Nov 20, 2019

kbhawkey left a comment

kbhawkey Nov 20, 2019

andrewsykim commented Nov 21, 2019

kbhawkey commented Nov 21, 2019

daminisatya commented Nov 21, 2019

andrewsykim commented Nov 21, 2019 •

edited

Loading

daminisatya commented Nov 22, 2019

liggitt commented Nov 26, 2019

daminisatya commented Nov 26, 2019

k8s-ci-robot commented Nov 26, 2019

	NOTE: starting in v1.17, this label is deprecated in favor of [node.kubernetes.io/instance-type](nodekubernetesioinstance-type).
	{{< note >}}This label is deprecated in favor of [node.kubernetes.io/instance-type](#nodekubernetesioinstance-type){{< /note >}}

Document new stable labels for zone, region and instance-type #17498

Document new stable labels for zone, region and instance-type #17498

Conversation

andrewsykim commented Nov 8, 2019 • edited Loading

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

Choose a reason for hiding this comment

andrewsykim commented Nov 14, 2019

sftim left a comment

Choose a reason for hiding this comment

kbhawkey commented Nov 16, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daminisatya commented Nov 20, 2019

kbhawkey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewsykim commented Nov 21, 2019

kbhawkey commented Nov 21, 2019

daminisatya commented Nov 21, 2019

andrewsykim commented Nov 21, 2019 • edited Loading

daminisatya commented Nov 22, 2019

liggitt commented Nov 26, 2019

daminisatya commented Nov 26, 2019

k8s-ci-robot commented Nov 26, 2019

andrewsykim commented Nov 8, 2019 •

edited

Loading

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

edited

Loading

kbhawkey commented Nov 16, 2019 •

edited

Loading

andrewsykim commented Nov 21, 2019 •

edited

Loading