From 0469dc9b32f986a8e9653c7ffbb7f6dccf324077 Mon Sep 17 00:00:00 2001 From: "Mengqi (David) Yu" Date: Thu, 14 Sep 2023 18:34:24 +0000 Subject: [PATCH] address comments --- .../concepts/cluster-administration/flow-control.md | 6 +++--- content/en/docs/reference/debug-cluster/_index.md | 5 +++++ .../_index.md => debug-cluster/flow-control.md} | 13 ++++++------- 3 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 content/en/docs/reference/debug-cluster/_index.md rename content/en/docs/reference/{flow-control/_index.md => debug-cluster/flow-control.md} (95%) diff --git a/content/en/docs/concepts/cluster-administration/flow-control.md b/content/en/docs/concepts/cluster-administration/flow-control.md index 41cb8376e55..a1d1ca385a0 100644 --- a/content/en/docs/concepts/cluster-administration/flow-control.md +++ b/content/en/docs/concepts/cluster-administration/flow-control.md @@ -777,8 +777,8 @@ Example FlowSchema object to isolate list event requests: ## {{% heading "whatsnext" %}} -You can visit flow control [reference doc](/docs/reference/flow-control/) to learn more about troubleshooting. -For background information on design details for API priority and fairness, see +- You can visit flow control [reference doc](/docs/reference/flow-control/) to learn more about troubleshooting. +- For background information on design details for API priority and fairness, see the [enhancement proposal](https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/1040-priority-and-fairness). -You can make suggestions and feature requests via [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery) +- You can make suggestions and feature requests via [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery) or the feature's [slack channel](https://kubernetes.slack.com/messages/api-priority-and-fairness). diff --git a/content/en/docs/reference/debug-cluster/_index.md b/content/en/docs/reference/debug-cluster/_index.md new file mode 100644 index 00000000000..20b4a63fe89 --- /dev/null +++ b/content/en/docs/reference/debug-cluster/_index.md @@ -0,0 +1,5 @@ +--- +title: Debug cluster +weight: 120 +no_list: false +--- diff --git a/content/en/docs/reference/flow-control/_index.md b/content/en/docs/reference/debug-cluster/flow-control.md similarity index 95% rename from content/en/docs/reference/flow-control/_index.md rename to content/en/docs/reference/debug-cluster/flow-control.md index 9eac9a4c9c1..40bf92da232 100644 --- a/content/en/docs/reference/flow-control/_index.md +++ b/content/en/docs/reference/debug-cluster/flow-control.md @@ -1,7 +1,6 @@ --- title: Flow control -weight: 120 -no_list: true +weight: 130 --- @@ -33,12 +32,12 @@ PriorityLevelConfigurations. ## Debug endpoints -When you enable the API Priority and Fairness feature, the `kube-apiserver` +With the `APIPriorityAndFairness` feature enabled, the `kube-apiserver` serves the following additional paths at its HTTP(S) ports. You need to ensure you have permissions to access these endpoints. You don't have to do anything if you are using admin. -Permissions can be granted if needed following [this doc](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) +Permissions can be granted if needed following the [RBAC](/docs/reference/access-authn-authz/rbac/) doc to access `/debug/api_priority_and_fairness/` by specifying `nonResourceURLs`. - `/debug/api_priority_and_fairness/dump_priority_levels` - a listing of @@ -149,14 +148,14 @@ to access `/debug/api_priority_and_fairness/` by specifying `nonResourceURLs`. ## Debug logging At `-v=3` or more verbosity, the API server outputs an httplog line for every -request in the APIServer log, and it includes the following attributes. +request in the API server log, and it includes the following attributes. - `apf_fs`: the name of the flow schema to which the request was classified. - `apf_pl`: the name of the priority level for that flow schema. - `apf_iseats`: the number of seats determined for the initial (normal) stage of execution of the request. - `apf_fseats`: the number of seats determined for the final stage of - execution (accounting for the associated WATCH notifications) of the + execution (accounting for the associated `watch` notifications) of the request. - `apf_additionalLatency`: the duration of the final stage of execution of the request. @@ -168,7 +167,7 @@ of how APF handled the request, primarily for debugging purposes. APF adds the following two headers to each HTTP response message. They won't appear in the audit log. They can be viewed from the client side. -For client using klog, use verbosity `-v=8` or higher to view these headers. +For client using `klog`, use verbosity `-v=8` or higher to view these headers. - `X-Kubernetes-PF-FlowSchema-UID` holds the UID of the FlowSchema object to which the corresponding request was classified.