Skip to content

Commit 99775be

Browse files
committed
docs(kep-5793): address review nits on admission control docs
- Link feature gate to specific #ManifestBasedAdmissionControlConfig anchor in all four files - Reword startup error to "fails to start, displaying a descriptive error" - Change "exist in an isolated universe" to "exist in isolation" - Expand "config info" to "configuration information" - Add HTML comment break between numbered list items for proper rendering - Reorder metrics table columns to Type, Description, Metric to reduce side-scrolling Signed-off-by: Anish Ramasekar <anish.ramasekar@gmail.com>
1 parent ee9d3f3 commit 99775be

4 files changed

Lines changed: 13 additions & 11 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Names ending in `.static.k8s.io` are reserved for
487487
[manifest-based admission control](/docs/reference/access-authn-authz/manifest-admission-control/)
488488
and cannot be used for API-based webhook configurations. This reservation is
489489
enforced when the `ManifestBasedAdmissionControlConfig`
490-
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled.
490+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/#ManifestBasedAdmissionControlConfig) is enabled.
491491
{{< /note >}}
492492

493493
Each configuration can contain one or more webhooks.

content/en/docs/reference/access-authn-authz/manifest-admission-control.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ independently of {{< glossary_tooltip text="etcd" term_id="etcd" >}}, and can
1919
protect API-based admission resources from modification.
2020

2121
To use the feature, enable the `ManifestBasedAdmissionControlConfig`
22-
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) and
22+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/#ManifestBasedAdmissionControlConfig) and
2323
configure the `staticManifestsDir` field in the
2424
[AdmissionConfiguration](/docs/reference/config-api/apiserver-config.v1/#apiserver-k8s-io-v1-AdmissionConfiguration)
2525
file passed to the kube-apiserver via `--admission-control-config-file`.
@@ -129,12 +129,12 @@ When the feature gate is disabled, a warning is returned instead.
129129

130130
{{< note >}}
131131
If two manifest files define objects of the same type with the same name, the
132-
API server fails to start with a descriptive error.
132+
API server fails to start, displaying a descriptive error.
133133
{{< /note >}}
134134

135135
### Restrictions
136136

137-
Manifest-based admission configurations exist in an isolated universe and cannot
137+
Manifest-based admission configurations exist in isolation and cannot
138138
reference API resources. The following restrictions apply:
139139

140140
- **Webhooks**: Must use `clientConfig.url`. The `clientConfig.service` field is
@@ -229,6 +229,8 @@ The kube-apiserver watches the configured directories for changes:
229229
previous valid configuration is retained.
230230
- Successful reloads atomically replace the previous configuration.
231231

232+
<!-- -->
233+
232234
1. **Atomic file updates**: To avoid partial reads during file writes, make
233235
changes atomically (for example, write to a temporary file and rename it).
234236
This is especially important when updating mounted ConfigMaps or Secrets in
@@ -248,11 +250,11 @@ Manifest-based admission control provides the following metrics for monitoring
248250
reload health:
249251

250252
{{< table caption="Metrics for manifest-based admission control" >}}
251-
| Metric | Type | Description |
252-
|:-------|:-----|:------------|
253-
| `apiserver_manifest_admission_config_controller_automatic_reloads_total` | Counter | Total number of reload attempts, with `status` (`success` or `failure`), `plugin`, and `apiserver_id_hash` labels. |
254-
| `apiserver_manifest_admission_config_controller_automatic_reload_last_timestamp_seconds` | Gauge | Timestamp of the last reload attempt, with `status`, `plugin`, and `apiserver_id_hash` labels. |
255-
| `apiserver_manifest_admission_config_controller_last_config_info` | Gauge | Current configuration info (value is always 1), with `plugin`, `apiserver_id_hash`, and `hash` labels. Use the `hash` label to detect configuration drift across API servers. |
253+
| Type | Description | Metric |
254+
|:-----|:------------|:-------|
255+
| Counter | Total number of reload attempts, with `status` (`success` or `failure`), `plugin`, and `apiserver_id_hash` labels. | `apiserver_manifest_admission_config_controller_automatic_reloads_total` |
256+
| Gauge | Timestamp of the last reload attempt, with `status`, `plugin`, and `apiserver_id_hash` labels. | `apiserver_manifest_admission_config_controller_automatic_reload_last_timestamp_seconds` |
257+
| Gauge | Current configuration information (value is always 1), with `plugin`, `apiserver_id_hash`, and `hash` labels. Use the `hash` label to detect configuration drift across API servers. | `apiserver_manifest_admission_config_controller_last_config_info` |
256258
{{< /table >}}
257259

258260
The `plugin` label identifies which admission plugin the metric applies to:

content/en/docs/reference/access-authn-authz/mutating-admission-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Names ending in `.static.k8s.io` are reserved for
6060
[manifest-based admission control](/docs/reference/access-authn-authz/manifest-admission-control/)
6161
and cannot be used for API-based policies or bindings. This reservation is
6262
enforced when the `ManifestBasedAdmissionControlConfig`
63-
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled.
63+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/#ManifestBasedAdmissionControlConfig) is enabled.
6464
{{< /note >}}
6565

6666
If a MutatingAdmissionPolicy does not need to be configured via parameters, simply leave

content/en/docs/reference/access-authn-authz/validating-admission-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Names ending in `.static.k8s.io` are reserved for
4949
[manifest-based admission control](/docs/reference/access-authn-authz/manifest-admission-control/)
5050
and cannot be used for API-based policies or bindings. This reservation is
5151
enforced when the `ManifestBasedAdmissionControlConfig`
52-
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled.
52+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/#ManifestBasedAdmissionControlConfig) is enabled.
5353
{{< /note >}}
5454

5555
If a `ValidatingAdmissionPolicy` does not need to be configured via parameters, simply leave

0 commit comments

Comments
 (0)