document /watch prefix deprecation #65147

liggitt · 2018-06-15T16:08:08Z

these have been marked as deprecated in code for many releases, and all client accesses have switched to using the ?watch=true access method, but documentation was never updated

@kubernetes/sig-api-machinery-api-reviews @kubernetes/api-reviewers

The watch API endpoints prefixed with `/watch` are deprecated and will be removed in a future release. These standard method for watching resources (supported since v1.0) is to use the list API endpoints with a `?watch=true` parameter. All client-go clients have used the parameter method since v1.6.0.

liggitt · 2018-06-15T17:27:30Z

The /proxy prefix paths (deprecated since 1.2) were removed in 1.10 in #59884

I'd like to get deprecation of the /watch prefix paths on the record for 1.11.

hzxuzhonghu · 2018-06-20T03:43:06Z

staging/src/k8s.io/apiserver/pkg/endpoints/installer.go

@@ -382,7 +382,7 @@ func (a *APIInstaller) registerResourceHandlers(path string, storage rest.Storag
 		actions = appendIf(actions, action{"LIST", resourcePath, resourceParams, namer, false}, isLister)
 		actions = appendIf(actions, action{"POST", resourcePath, resourceParams, namer, false}, isCreater)
 		actions = appendIf(actions, action{"DELETECOLLECTION", resourcePath, resourceParams, namer, false}, isCollectionDeleter)
-		// DEPRECATED


Haven't been deprecated long ago? Can we remove now?

it wasn't formally announced, so not yet.

lavalamp · 2018-06-21T20:26:35Z

I was just saying on a api coverage spreadsheet that all these should be just deleted at this point...

cc @mbohlool to double check the open api spec

liggitt · 2018-06-21T20:46:06Z

I was just saying on a api coverage spreadsheet that all these should be just deleted at this point...

cc @mbohlool to double check the open api spec

unfortunately, the endpoints are listed throughout the openapi spec, with no doc-visible deprecation notices. this PR updates it to note the deprecation - https://github.com/kubernetes/kubernetes/pull/65147/files#diff-9ce7ea8441086bf1902b4f936f4601d0

liggitt · 2018-06-25T22:39:13Z

@lavalamp @deads2k should we include this deprecation announcement in the 1.11 release notes?

liggitt · 2018-07-13T18:13:55Z

/assign @mbohlool @deads2k @lavalamp

spiffxp · 2018-08-01T01:21:14Z

@liggitt needs-rebase (also, I'm happy to lgtm after rebase unless you specifically need approval from the aformentioned reviewers)

liggitt · 2018-08-06T21:35:09Z

rebased. would like an ack from @lavalamp / @deads2k

lavalamp · 2018-08-06T21:48:19Z

/lgtm
/approve

k8s-ci-robot · 2018-08-06T21:48:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lavalamp, liggitt

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:

~~api/OWNERS~~ [lavalamp,liggitt]
~~docs/api-reference/OWNERS~~ [lavalamp,liggitt]
~~staging/src/k8s.io/apiserver/OWNERS~~ [lavalamp,liggitt]

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

spiffxp · 2018-08-06T23:44:56Z

/go/src/k8s.io/kubernetes/api/openapi-spec is out of date. Please run hack/update-openapi-spec.sh
/go/src/k8s.io/kubernetes/api/swagger-spec is out of date. Please run hack/update-swagger-spec.sh

k8s-ci-robot · 2018-08-07T00:06:13Z

New changes are detected. LGTM label has been removed.

liggitt · 2018-08-07T00:06:45Z

regenerated, retagging

fejta-bot · 2018-08-07T02:54:28Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel comment for consistent failures.

spiffxp · 2018-08-07T03:38:45Z

/go/src/k8s.io/kubernetes/docs/api-reference is out of date. Please run hack/update-api-reference-docs.sh

... sure would have been nice if it said this last time

spiffxp · 2018-08-07T03:39:06Z

/lgtm cancel
to stop fejta-bot from /retest spamming

liggitt · 2018-08-07T12:21:05Z

third time's the charm

k8s-github-robot · 2018-08-07T13:43:46Z

/test all [submit-queue is verifying that this PR is safe to merge]

k8s-github-robot · 2018-08-07T15:01:14Z

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions here.

jethrogb · 2018-12-28T07:01:58Z

Why is this deprecated? This is a regression in terms of RBAC

liggitt · 2018-12-28T14:35:50Z

Why is this deprecated?

The top-level path segment access patterns (for proxy and watch) were deprecated in favor of the proxy subresource and the watch query parameter around 1.2

This is a regression in terms of RBAC

That is incorrect, watch requests are still separately permissioned using the watch verb. Prior to this, there were two URLs that would make a watch request (/watch/… and …?watch=true), and this announces deprecation of the first

jethrogb · 2018-12-28T14:50:20Z

That is incorrect, watch requests are still separately permissioned using the watch verb.

No, it is a regression. With the Watch API, you can set watch permissions on a single named resource. With WatchList, you need to give permissions on all resources of a particular type. (Related kubernetes/kubectl#305)

liggitt · 2018-12-28T14:56:11Z

you can still set watch permissions on a single named item, watched with ?watch=true&fieldSelector=metadata.name=<name>

see #63469

liggitt mentioned this pull request Jun 15, 2018

Ambiguity to find pod specific watch api endpoints in e2e test suite #65133

Closed

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

k8s-ci-robot requested review from erictune and hzxuzhonghu June 15, 2018 16:08

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jun 15, 2018

hzxuzhonghu reviewed Jun 20, 2018

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 29, 2018

liggitt force-pushed the watch-prefix-deprecation branch from 0591d57 to 204d70c Compare August 6, 2018 21:34

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 6, 2018

k8s-ci-robot assigned lavalamp Aug 6, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2018

liggitt force-pushed the watch-prefix-deprecation branch from 204d70c to 3cf4d77 Compare August 7, 2018 00:06

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2018

liggitt added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2018

k8s-ci-robot assigned spiffxp Aug 7, 2018

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2018

document /watch prefix deprecation

c31faf2

liggitt force-pushed the watch-prefix-deprecation branch from 3cf4d77 to c31faf2 Compare August 7, 2018 12:21

liggitt added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2018

k8s-github-robot merged commit 6bea053 into kubernetes:master Aug 7, 2018

liggitt deleted the watch-prefix-deprecation branch August 10, 2018 01:07

spiffxp mentioned this pull request Aug 23, 2018

Filter out deprecated api fields from coverage info kubernetes-sigs/apisnoop#35

Closed

stealthybox mentioned this pull request Sep 29, 2018

get --watch specifying a resource uses "watch list" instead of "watch" API kubernetes/kubectl#305

Closed

corruptmem mentioned this pull request Apr 1, 2019

Requests hang if watch=true and there are no objects matching query kubernetes-client/csharp#263

Closed

dims mentioned this pull request Feb 22, 2024

[WIP] Remove "WATCH" and "WATCHLIST" deprecated in 1.11 #123456

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

document /watch prefix deprecation #65147

document /watch prefix deprecation #65147

liggitt commented Jun 15, 2018 •

edited

Loading

liggitt commented Jun 15, 2018 •

edited

Loading

hzxuzhonghu Jun 20, 2018

liggitt Jun 20, 2018

hzxuzhonghu Jun 20, 2018

lavalamp commented Jun 21, 2018

liggitt commented Jun 21, 2018 •

edited

Loading

liggitt commented Jun 25, 2018

liggitt commented Jul 13, 2018

spiffxp commented Aug 1, 2018

liggitt commented Aug 6, 2018

lavalamp commented Aug 6, 2018

k8s-ci-robot commented Aug 6, 2018

spiffxp commented Aug 6, 2018

k8s-ci-robot commented Aug 7, 2018

liggitt commented Aug 7, 2018

fejta-bot commented Aug 7, 2018

spiffxp commented Aug 7, 2018

spiffxp commented Aug 7, 2018

liggitt commented Aug 7, 2018

k8s-github-robot commented Aug 7, 2018

k8s-github-robot commented Aug 7, 2018

jethrogb commented Dec 28, 2018

liggitt commented Dec 28, 2018

jethrogb commented Dec 28, 2018 •

edited

Loading

liggitt commented Dec 28, 2018 •

edited

Loading

document /watch prefix deprecation #65147

document /watch prefix deprecation #65147

Conversation

liggitt commented Jun 15, 2018 • edited Loading

liggitt commented Jun 15, 2018 • edited Loading

hzxuzhonghu Jun 20, 2018

Choose a reason for hiding this comment

liggitt Jun 20, 2018

Choose a reason for hiding this comment

hzxuzhonghu Jun 20, 2018

Choose a reason for hiding this comment

lavalamp commented Jun 21, 2018

liggitt commented Jun 21, 2018 • edited Loading

liggitt commented Jun 25, 2018

liggitt commented Jul 13, 2018

spiffxp commented Aug 1, 2018

liggitt commented Aug 6, 2018

lavalamp commented Aug 6, 2018

k8s-ci-robot commented Aug 6, 2018

spiffxp commented Aug 6, 2018

k8s-ci-robot commented Aug 7, 2018

liggitt commented Aug 7, 2018

fejta-bot commented Aug 7, 2018

spiffxp commented Aug 7, 2018

spiffxp commented Aug 7, 2018

liggitt commented Aug 7, 2018

k8s-github-robot commented Aug 7, 2018

k8s-github-robot commented Aug 7, 2018

jethrogb commented Dec 28, 2018

liggitt commented Dec 28, 2018

jethrogb commented Dec 28, 2018 • edited Loading

liggitt commented Dec 28, 2018 • edited Loading

liggitt commented Jun 15, 2018 •

edited

Loading

liggitt commented Jun 15, 2018 •

edited

Loading

liggitt commented Jun 21, 2018 •

edited

Loading

jethrogb commented Dec 28, 2018 •

edited

Loading

liggitt commented Dec 28, 2018 •

edited

Loading