Commit Graph

66 Commits (release-1.32)

Author SHA1 Message Date
Shannon Kularathna 14220821d1 Move best practices from dynamic admission control page to best practices page
Moved content as-is (no text changes) for a more readable diff between commits.

The following sections werent moved:

* Idempotence main section (better content in new page)
* Intercepting all versions of an object (better content in new page)
* Guaranteeing the final state of an object is seen
* Avoiding operating in the kube-system namespace
2025-03-21 20:04:03 +00:00
Shannon Kularathna bf971d28d3 Add a new page for mutating webhook good practices.
- Link to new page from dynamic admission control page
- Retain TODOs for info that'll be migration from existing page
2025-03-21 20:00:38 +00:00
Kubernetes Prow Robot 91919bdba5
Merge pull request #46798 from fasaxc/patch-1
Add more suggestions for avoiding deadlocks to webhook docs
2025-02-20 14:08:27 -08:00
Shaun Crampton 0c40eced7e Add more suggestions for avoiding deadlocks
Webhooks can cause deadlocks in several ways, expand the list to cover more subtle cases.

Co-authored-by: Kat Cosgrove <kat.cosgrove@gmail.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2025-02-17 13:21:59 +00:00
AmarNathChary 370c47dacc changed comments 2024-12-05 12:03:27 +05:30
AmarNathChary 8104af95c1 changed back to yaml 2024-12-03 14:55:12 +05:30
AmarNathChary 1e5175b94d Updated extensible admission controller yaml file to json 2024-12-02 14:20:12 +05:30
David Xia 80d2f96c93
Update extensible-admission-controllers.md
fix typo
2024-07-16 13:26:09 -04:00
Tim Bannister 9f327512c6 Reorder authn/authz pages
Group topics together, in order of how these happen within Kubernetes'
API server's processing chain (authn, then authz, then admission
control).
2024-04-23 01:42:18 +01:00
Igor Velichkovich 4bffa3c7fa Mark feature AdmissionWebhookMatchConditions to stable in 1.30 2024-03-12 10:14:31 -07:00
Qiming Teng 60bf42a527 Update test cases for v1.28
This PR makes sure the manifests under `content/en/examples`
are valid in v1.28. The primary fixes are:

- Updated the go.mod/go.sum file for testing against v1.28.0 release.
- Revise test case code to ensure newly added manifests are tested;
- Adapt Pod validation options to upstream validation code change;
- Move a ValidatingWebhookConfiguration YAML back to inline because
  the manifest cannot validate against the validator. The CA bundle
  referenced is not a valid string (base64 encoded). That means the
  YAML cannot be used/tested as is by users.
2023-08-18 09:03:30 +08:00
Amine 42078a08fb Fix typos and add comments to the match conditions example 2023-08-09 09:38:48 +02:00
Amine 2218f3d573 Remove note stating that we need AdmissionWebhookMatchConditions to be enabled explicitely 2023-08-08 20:02:35 +02:00
Amine 9bac8cfc1a
Add note on max number of match condition elements a user can define per webhook 2023-07-25 19:54:51 +01:00
Amine f9c824917f convert the `ValidatingWebhookConfiguration` example into a manifest using a codenew shortcode 2023-07-24 23:10:55 +01:00
Kubernetes Prow Robot f787489ec5
Merge pull request #40535 from aitorpazos/patch-1
Note on caBundle encoding in extensible-admission-controllers.md
2023-05-02 15:38:14 -07:00
Qiming Teng ad7c0712c6 Fix examples test for 1.27
- Some examples are actually not good "examples", i.e. they are not
  not ready for the users to try out.
- Some examples are failing the validation in their current format.
- Some examples skipped the test case.

These issues are fixed.
2023-04-16 17:26:12 +08:00
Aitor cf20f82dbd
Note on caBundle encoding in extensible-admission-controllers.md
The note on caBundle field description mentions it is PEM encoded, but the actual field value is then encoded into Base64, which is worth mentioning.
2023-04-06 09:10:12 +00:00
Tim Allclair 27460b23fa
AdmissionWebhookMatchConditions feature documentation (#40058)
* AdmissionWebhookMatchConditions feature documentation

* #squash ivelichkovich feedback

* #squash sftim feedback

* Correct statement about request.object

* #squash: sftim feedback

* #squash jpbetz feedback

* #squash: denied function removed

* #squash fix match conditions example

* #squash fix expression quoting

* #squash scope authorizatoin check example

* #squash separate RBAC webhook example

* #squash sftim feedback

* #squash add shared client config for example

* Don't use yaml anchors in example
2023-04-03 08:23:51 -07:00
Richard Tweed 68b19b6f00 Specify that subresources excluded from mutating webhook example 2023-02-06 22:33:00 +00:00
Qiming Teng a6ec7d8017 Tweak extensible admission controllers page
This PR removes outdated information about `admissionregistration.v1beta1` API groups
which are no longer supported in 1.24. Additional notes are added to
avoid confusion when parsing the examples.
2022-07-01 00:33:57 +08:00
xin.li b831e96c6a [en] modify debug-cluster/audit
Signed-off-by: xin.li <xin.li@daocloud.io>
2022-04-29 20:40:59 +08:00
Shubham Kuchhal 8fbccfcd8f Improvement: Correct the "empty" link in Dynamic Admission Control. 2021-10-26 13:51:38 +05:30
Shubham Kuchhal 1262222578 Change master to v1.22.0 2021-10-04 15:52:46 +05:30
Shubham Kuchhal d4a08df1b9 Improvement: Correct the "code" link in Dynamic Admission Control. 2021-10-04 12:40:03 +05:30
Edward Huang 0c5a2e06da Fixed up typo in extensible-admission-controllers.md 2021-07-05 11:41:11 +12:00
Michael Gugino 27b2611cbc
Update webhook server example code link
Fix 404 error and point to the latest released code.
2021-04-23 12:19:23 -04:00
Qiming Teng 108149fa2f Add WebhookAdmission reference
This is a reference for WebhookAdmission config generated from kubernetes-sigs/reference-docs/genref tool.
More specifically, it is generated using the following command:

```shell
./genref -include apiserver-webhookadmission
```
2021-04-07 09:13:47 +08:00
Karen Bradshaw 7d9916af0c clean up use of word: easy 2021-02-01 15:14:25 -05:00
Anna Jung 09d0f598fa Merge master into dev-1.19 to keep in sync 2020-08-11 08:34:02 -05:00
Qiming Teng d592baed54 Replace redirections in the reference section
This PR removes the redirections used in the reference section and fixes
some bad links.
2020-08-08 12:35:52 +08:00
Savitha Raghunathan e2a861c2f9 Merge remote-tracking branch 'upstream/master' into dev-1.19 2020-07-27 19:10:42 -04:00
Jordan Liggitt f12bc65e80 Address doc review comments 2020-07-15 12:24:42 -04:00
Jordan Liggitt 2d4357abc6 Add deprecation warning info 2020-07-15 11:30:44 -04:00
Qiming Teng e097b93c8e Fix pages that reference removed API groups
Quite some resources have been moved out of the `extensions` API group
since 1.18; the `apps/v1beta1` and `apps/v1beta2` group versions are
also dropped. This PR updates the pages which still reference such API
groups or group versions.
2020-07-04 13:23:26 +08:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Karen Bradshaw 311679eeb4 clean up prior api refs and links 2020-05-29 12:09:44 -04:00
Dixing (Dex) Xu 77cee072b8
fix capitalization 2020-03-31 19:53:59 +08:00
Tsahi Duek 5f496a6ce6
Changed 'caBundle' description (#19341)
It is not clear that the 'caBundle' field in the Mutating/Validating webhook object is used for client-side validation from the admission controller itself.
The comment which appears at the source code is much more clear --> https://github.com/kubernetes/api/blob/master/admissionregistration/v1beta1/types.go#L534-L537

My suggestion is to change the description to match the documentation which is IMO much more clear
2020-03-15 21:28:35 -07:00
Andrew Allbright 1242c008a8
Update some instances of latin abbreviation e.g. to alternative phrases (#19182) 2020-02-29 23:12:40 -08:00
Qiming Teng ceccbc049c
Resource name constraints (1) (#19106)
xref: #17969, #19099, #18746
2020-02-19 15:44:30 -08:00
Tim Bannister 3cf7ba1092
Clean up admission controller deprecation example (#18399) 2020-01-29 15:28:14 -08:00
Mikalai Radchuk a5515a7c0e Fixes list rendering (#18499) 2020-01-07 15:07:42 -08:00
Xiang Dai f21f4b2257 Fix en language misspell (#18201)
* fix misspell

Signed-off-by: Xiang Dai <764524258@qq.com>

* clean white noise

Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 06:49:32 -08:00
Damini Satya dff2f7b960 Official 1.17 Release Docs (#18011)
* 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)
2019-12-09 16:11:29 -08:00
Alena Varkockova 15b4194727 Fix typo in the word annotation (#17716) 2019-11-21 04:05:28 -08:00
Jim Angel 647b4cd39d fixed yaml block so it renders (#17259) 2019-10-29 14:26:53 -07:00
Jordan Liggitt aad4f0bd13 Fix webhook admission example (#17179) 2019-10-27 18:15:25 -07:00
Yuk, Yongsu d437e8c6bc en: Change the full link in the document to an inline link. (#17057)
* Change the full link in the document to an inline link.

grep -r "https \: \ / \ / kubernetes \ .io" content/en/docs
Changed to inline link except the following list.
- URLs are mentioned directly in the body
- release note
- url to blog
- url to community
- Url to be redirected

* Apply suggestions from code review

Co-Authored-By: June Yi <june.yi@samsung.com>
2019-10-23 06:20:14 -07:00
Jian Zeng 4368f099a7 Add empty lines & remove trailing space (#16796)
Let lists be rendered correctly
2019-10-11 15:04:05 -07:00