kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Address doc review comments

This commit is contained in:
Jordan Liggitt 2020-07-15 11:45:01 -04:00
parent 2d4357abc6
commit f12bc65e80
3 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
content/en/docs/reference/access-authn-authz/extensible-admission-controllers.md
View File

@ -628,11 +628,18 @@ So a webhook response to add that label would be:
{{% /tab %}} {{% /tab %}}
{{< /tabs >}} {{< /tabs >}}
Starting in v1.19, admission webhooks can optionally return warning messages that are returned to the requesting client. Starting in v1.19, admission webhooks can optionally return warning messages that are returned to the requesting client
Warnings can be sent with allowed or rejected admission responses. in HTTP `Warning` headers with a warning code of 299. Warnings can be sent with allowed or rejected admission responses.
No "Warning:" prefix should be included in the message.
Warning messages should describe a problem the client making the API request should correct or be aware of. If you're implementing a webhook that returns a warning:
Limit warnings to 120 characters if possible. Warnings over 256 characters and large numbers of warnings may be truncated. * Don't include a "Warning:" prefix in the message
* Use warning messages to describe problems the client making the API request should correct or be aware of
* Limit warnings to 120 characters if possible
{{< caution >}}
Individual warning messages over 256 characters may be truncated by the API server before being returned to clients.
If more than 4096 characters of warning messages are added (from all sources), additional warning messages are ignored.
{{< /caution >}}
{{< tabs name="AdmissionReview_response_warning" >}} {{< tabs name="AdmissionReview_response_warning" >}}
{{% tab name="admission.k8s.io/v1" %}} {{% tab name="admission.k8s.io/v1" %}}

16
content/en/docs/reference/using-api/deprecation-policy.md
View File

@ -298,17 +298,19 @@ exist and function in releases up to and including X+8. Only in release X+9,
when API v1 has aged out, does the Widget resource cease to exist, and the when API v1 has aged out, does the Widget resource cease to exist, and the
behavior get removed. behavior get removed.
Starting in Kubernetes 1.19, making an API request to a deprecated REST API endpoint: Starting in Kubernetes v1.19, making an API request to a deprecated REST API endpoint:
1. returns a `Warning` header (as defined in [RFC7234, Section 5.5](https://tools.ietf.org/html/rfc7234#section-5.5)) in the API response. 1. Returns a `Warning` header (as defined in [RFC7234, Section 5.5](https://tools.ietf.org/html/rfc7234#section-5.5)) in the API response.
2. adds a `"k8s.io/deprecated":"true"` annotation to the [audit event](/docs/tasks/debug-application-cluster/audit/) recorded for the request. 2. Adds a `"k8s.io/deprecated":"true"` annotation to the [audit event](/docs/tasks/debug-application-cluster/audit/) recorded for the request.
3. sets an `apiserver_requested_deprecated_apis` gauge metric to `1` in the `kube-apiserver` 3. Sets an `apiserver_requested_deprecated_apis` gauge metric to `1` in the `kube-apiserver`
process. The metric has labels for `group`, `version`, `resource`, `subresource` that can be joined process. The metric has labels for `group`, `version`, `resource`, `subresource` that can be joined
to the `apiserver_request_total` metric, and a `removed_version` label that indicates the to the `apiserver_request_total` metric, and a `removed_version` label that indicates the
Kubernetes release in which the API will no longer be served. The following prometheus query Kubernetes release in which the API will no longer be served. The following Prometheus query
would return information about requests made to deprecated APIs which will be removed in v1.22: returns information about requests made to deprecated APIs which will be removed in v1.22:
`apiserver_requested_deprecated_apis{removed_version="1.22"} * on(group,version,resource,subresource) group_right() apiserver_request_total` ```promql
apiserver_requested_deprecated_apis{removed_version="1.22"} * on(group,version,resource,subresource) group_right() apiserver_request_total
```
### Fields of REST resources ### Fields of REST resources

2
content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning.md
View File

@ -276,6 +276,8 @@ the version.
### Version deprecation ### Version deprecation
{{< feature-state state="stable" for_k8s_version="v1.19" >}}
Starting in v1.19, a CustomResourceDefinition can indicate a particular version of the resource it defines is deprecated. Starting in v1.19, a CustomResourceDefinition can indicate a particular version of the resource it defines is deprecated.
When API requests to a deprecated version of that resource are made, a warning message is returned in the API response as a header. When API requests to a deprecated version of that resource are made, a warning message is returned in the API response as a header.
The warning message for each deprecated version of the resource can be customized if desired. The warning message for each deprecated version of the resource can be customized if desired.