Skip to content

Commit 1f7eea0

Browse files
authored
Merge pull request #21216 from kbhawkey/kb-cleanup-api-versions
clean up prior api refs and links
2 parents 075d2b2 + 311679e commit 1f7eea0

File tree

119 files changed

+47
-516937
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+47
-516937
lines changed

content/en/blog/_posts/2019-01-14-apiserver-dry-run-and-kubectl-diff.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,7 @@ using `kube-apiserver --feature-gates DryRun=true`.
6060
If you have dynamic admission controllers, you might have to fix them to:
6161

6262
- Remove any side-effects when the dry-run parameter is specified on the webhook request,
63-
- Specify in the [`sideEffects`](/docs/reference/generated/kubernetes-api/v1.13/#webhook-v1beta1-admissionregistration)
64-
field of the `admissionregistration.k8s.io/v1beta1.Webhook` object to indicate that the object doesn't
65-
have side-effects on dry-run (or at all).
63+
- Specify in the [`sideEffects`](https://v1-13.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#webhook-v1beta1-admissionregistration) field of the `admissionregistration.k8s.io/v1beta1.Webhook` object to indicate that the object doesn't have side-effects on dry-run (or at all).
6664

6765
### How to use it
6866

content/en/blog/_posts/2019-09-18-kubernetes-1-16-release-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Introducing CSI plugin support for out-of-tree providers, enabling Windows nodes
7171

7272
## Introducing Endpoint Slices
7373

74-
The release of Kubernetes 1.16 includes an exciting new alpha feature: the EndpointSlice API. This API provides a scalable and extensible alternative to the [Endpoints](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#endpoints-v1-core) resource, which dates back to the very first versions of Kubernetes. Behind the scenes, Endpoints play a big role in network routing within Kubernetes. Each Service endpoint is tracked within these resources - kube-proxy uses them for generating proxy rules that allow pods to communicate with each other so easily in Kubernetes, and many ingress controllers use them to route HTTP traffic directly to pods.
74+
The release of Kubernetes 1.16 includes an exciting new alpha feature: the EndpointSlice API. This API provides a scalable and extensible alternative to the [Endpoints](https://v1-16.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#endpoints-v1-core) resource, which dates back to the very first versions of Kubernetes. Behind the scenes, Endpoints play a big role in network routing within Kubernetes. Each Service endpoint is tracked within these resources - kube-proxy uses them for generating proxy rules that allow pods to communicate with each other so easily in Kubernetes, and many ingress controllers use them to route HTTP traffic directly to pods.
7575

7676
### Providing Greater Scalability
7777

content/en/blog/_posts/2020-04-06-API-Priority-and-Fairness-Alpha.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ Upon arrival at the handler, a request is assigned to exactly one priority level
4343

4444
* FlowSchema: FlowSchema will identify a PriorityLevelConfiguration object and the way to compute the request’s “flow identifier”. Currently we support matching requests according to: the identity making the request, the verb, and the target object. The identity can match in terms of: a username, a user group name, or a ServiceAccount. And as for the target objects, we can match by apiGroup, resource[/subresource], and namespace.
4545
* The flow identifier is used for shuffle sharding, so it’s important that requests have the same flow identifier if they are from the same source! We like to consider scenarios with “elephants” (which send many/heavy requests) vs “mice” (which send few/light requests): it is important to make sure the elephant’s requests all get the same flow identifier, otherwise they will look like many different mice to the system!
46-
* See the API Documentation [here](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#flowschema-v1alpha1-flowcontrol-apiserver-k8s-io)!
46+
* See the API Documentation [here](https://kubernetes.io/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#flowschema-v1alpha1-flowcontrol-apiserver-k8s-io)!
4747

4848
* PriorityLevelConfiguration: Defines a priority level.
4949
* For apiserver self requests, and any reentrant traffic (e.g., admission webhooks which themselves make API requests), a Priority Level can be marked “exempt”, which means that no queueing or limiting of any sort is done. This is to prevent priority inversions.
5050
* Each non-exempt Priority Level is configured with a number of "concurrency shares" and gets an isolated pool of concurrency to use. Requests of that Priority Level run in that pool when it is not full, never anywhere else. Each apiserver is configured with a total concurrency limit (taken to be the sum of the old limits on mutating and readonly requests), and this is then divided among the Priority Levels in proportion to their concurrency shares.
5151
* A non-exempt Priority Level may select a number of queues and a "hand size" to use for the shuffle sharding. Shuffle sharding maps flows to queues in a way that is better than consistent hashing. A given flow has access to a small collection of queues, and for each incoming request the shortest queue is chosen. When a Priority Level has queues, it also sets a limit on queue length. There is also a limit placed on how long a request can wait in its queue; this is a fixed fraction of the apiserver's request timeout. A request that cannot be executed and cannot be queued (any longer) is rejected.
5252
* Alternatively, a non-exempt Priority Level may select immediate rejection instead of waiting in a queue.
53-
* See the [API documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#prioritylevelconfiguration-v1alpha1-flowcontrol-apiserver-k8s-io) for this feature.
53+
* See the [API documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#prioritylevelconfiguration-v1alpha1-flowcontrol-apiserver-k8s-io) for this feature.
5454

5555
## What’s missing? When will there be a beta?
5656
We’re already planning a few enhancements based on alpha and there will be more as users send feedback to our community. Here’s a list of them:

content/en/docs/contribute/generate-ref-docs/kubernetes-api.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,19 +138,19 @@ git status
138138
The output is similar to:
139139

140140
```
141-
static/docs/reference/generated/kubernetes-api/v1.17/css/bootstrap.min.css
142-
static/docs/reference/generated/kubernetes-api/v1.17/css/font-awesome.min.css
143-
static/docs/reference/generated/kubernetes-api/v1.17/css/stylesheet.css
144-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/FontAwesome.otf
145-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.eot
146-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.svg
147-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.ttf
148-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.woff
149-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.woff2
150-
static/docs/reference/generated/kubernetes-api/v1.17/index.html
151-
static/docs/reference/generated/kubernetes-api/v1.17/js/jquery.scrollTo.min.js
152-
static/docs/reference/generated/kubernetes-api/v1.17/js/navData.js
153-
static/docs/reference/generated/kubernetes-api/v1.17/js/scroll.js
141+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/bootstrap.min.css
142+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/font-awesome.min.css
143+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/stylesheet.css
144+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/FontAwesome.otf
145+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.eot
146+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.svg
147+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.ttf
148+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff
149+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff2
150+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/index.html
151+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/jquery.scrollTo.min.js
152+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/navData.js
153+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/scroll.js
154154
```
155155

156156
## Updating the API reference index pages
@@ -177,7 +177,7 @@ version number.
177177
## Locally test the API reference
178178
179179
Publish a local version of the API reference.
180-
Verify the [local preview](http://localhost:1313/docs/reference/generated/kubernetes-api/v1.17/).
180+
Verify the [local preview](http://localhost:1313/docs/reference/generated/kubernetes-api/{{< param "version">}}/).
181181
182182
```shell
183183
cd <web-base>

content/en/docs/contribute/generate-ref-docs/quickstart.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -219,19 +219,19 @@ static/docs/reference/generated/kubectl/css/font-awesome.min.css
219219
### Generated Kubernetes API reference directories and files
220220
221221
```
222-
static/docs/reference/generated/kubernetes-api/v1.17/index.html
223-
static/docs/reference/generated/kubernetes-api/v1.17/js/navData.js
224-
static/docs/reference/generated/kubernetes-api/v1.17/js/scroll.js
225-
static/docs/reference/generated/kubernetes-api/v1.17/js/query.scrollTo.min.js
226-
static/docs/reference/generated/kubernetes-api/v1.17/css/font-awesome.min.css
227-
static/docs/reference/generated/kubernetes-api/v1.17/css/bootstrap.min.css
228-
static/docs/reference/generated/kubernetes-api/v1.17/css/stylesheet.css
229-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/FontAwesome.otf
230-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.eot
231-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.svg
232-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.ttf
233-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.woff
234-
static/docs/reference/generated/kubernetes-api/v1.17/fonts/fontawesome-webfont.woff2
222+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/index.html
223+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/navData.js
224+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/scroll.js
225+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/js/query.scrollTo.min.js
226+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/font-awesome.min.css
227+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/bootstrap.min.css
228+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/css/stylesheet.css
229+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/FontAwesome.otf
230+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.eot
231+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.svg
232+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.ttf
233+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff
234+
static/docs/reference/generated/kubernetes-api/{{< param "version" >}}/fonts/fontawesome-webfont.woff2
235235
```
236236
237237
Run `git add` and `git commit` to commit the files.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This page describes how to build, configure, use, and monitor admission webhooks
1818
{{% /capture %}}
1919

2020
{{% capture body %}}
21+
2122
## What are admission webhooks?
2223

2324
Admission webhooks are HTTP callbacks that receive admission requests and do
@@ -549,7 +550,7 @@ Example of a minimal response from a webhook to forbid a request:
549550

550551
When rejecting a request, the webhook can customize the http code and message returned to the user using the `status` field.
551552
The specified status object is returned to the user.
552-
See the [API documentation](/docs/reference/generated/kubernetes-api/v1.14/#status-v1-meta) for details about the status type.
553+
See the [API documentation](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#status-v1-meta) for details about the status type.
553554
Example of a response to forbid a request, customizing the HTTP status code and message presented to the user:
554555
{{< tabs name="AdmissionReview_response_forbid_details" >}}
555556
{{% tab name="admission.k8s.io/v1" %}}

content/en/docs/reference/using-api/api-concepts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ The modifying verbs (`POST`, `PUT`, `PATCH`, and `DELETE`) can accept requests i
357357

358358
Dry-run is triggered by setting the `dryRun` query parameter. This parameter is a string, working as an enum, and the only accepted values are:
359359

360-
* `All`: Every stage runs as normal, except for the final storage stage. Admission controllers are run to check that the request is valid, mutating controllers mutate the request, merge is performed on `PATCH`, fields are defaulted, and schema validation occurs. The changes are not persisted to the underlying storage, but the final object which would have been persisted is still returned to the user, along with the normal status code. If the request would trigger an admission controller which would have side effects, the request will be failed rather than risk an unwanted side effect. All built in admission control plugins support dry-run. Additionally, admission webhooks can declare in their [configuration object](/docs/reference/generated/kubernetes-api/v1.13/#webhook-v1beta1-admissionregistration-k8s-io) that they do not have side effects by setting the sideEffects field to "None". If a webhook actually does have side effects, then the sideEffects field should be set to "NoneOnDryRun", and the webhook should also be modified to understand the `DryRun` field in AdmissionReview, and prevent side effects on dry-run requests.
360+
* `All`: Every stage runs as normal, except for the final storage stage. Admission controllers are run to check that the request is valid, mutating controllers mutate the request, merge is performed on `PATCH`, fields are defaulted, and schema validation occurs. The changes are not persisted to the underlying storage, but the final object which would have been persisted is still returned to the user, along with the normal status code. If the request would trigger an admission controller which would have side effects, the request will be failed rather than risk an unwanted side effect. All built in admission control plugins support dry-run. Additionally, admission webhooks can declare in their [configuration object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#webhook-v1beta1-admissionregistration-k8s-io) that they do not have side effects by setting the sideEffects field to "None". If a webhook actually does have side effects, then the sideEffects field should be set to "NoneOnDryRun", and the webhook should also be modified to understand the `DryRun` field in AdmissionReview, and prevent side effects on dry-run requests.
361361
* Leave the value empty, which is also the default: Keep the default modifying behavior.
362362

363363
For example:
@@ -490,7 +490,7 @@ Nevertheless it is possible to change `metadata.managedFields` through an
490490
option to try if, for example, the `managedFields` get into an inconsistent
491491
state (which clearly should not happen).
492492

493-
The format of the `managedFields` is described in the [API](/docs/reference/generated/kubernetes-api/v1.16/#managedfieldsentry-v1-meta).
493+
The format of the `managedFields` is described in the [API](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#fieldsv1-v1-meta).
494494

495495
### Conflicts
496496

@@ -706,9 +706,9 @@ Resource versions are strings that identify the server's internal version of an
706706

707707
Clients find resource versions in resources, including the resources in watch events, and list responses returned from the server:
708708

709-
[v1.meta/ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#objectmeta-v1-meta) - The `metadata.resourceVersion` of a resource instance identifies the resource version the instance was last modified at.
709+
[v1.meta/ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#objectmeta-v1-meta) - The `metadata.resourceVersion` of a resource instance identifies the resource version the instance was last modified at.
710710

711-
[v1.meta/ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.16/#listmeta-v1-meta) - The `metadata.resourceVersion` of a resource collection (i.e. a list response) identifies the resource version at which the list response was constructed.
711+
[v1.meta/ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#listmeta-v1-meta) - The `metadata.resourceVersion` of a resource collection (i.e. a list response) identifies the resource version at which the list response was constructed.
712712

713713
### The ResourceVersion Parameter
714714

content/en/docs/tasks/debug-application-cluster/audit.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ request to `/apis/batch/v1/namespaces/some-namespace/jobs/some-job-name`.
119119
}
120120
]
121121
```
122+
122123
{{< /note >}}
123124

124125
### Log backend
@@ -234,7 +235,7 @@ spec:
234235
url: "https://audit.app"
235236
```
236237

237-
For the complete API definition, see [AuditSink](/docs/reference/generated/kubernetes-api/v1.13/#auditsink-v1alpha1-auditregistration). Multiple objects will exist as independent solutions.
238+
For the complete API definition, see [AuditSink](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#auditsink-v1alpha1-auditregistration). Multiple objects will exist as independent solutions.
238239
The name of an AuditSink object must be a valid
239240
[DNS subdomain name](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names).
240241

@@ -339,12 +340,12 @@ audit policies.
339340
[Fluentd][fluentd] is an open source data collector for unified logging layer.
340341
In this example, we will use fluentd to split audit events by different namespaces.
341342

342-
1. install [fluentd][fluentd_install_doc], fluent-plugin-forest and fluent-plugin-rewrite-tag-filter in the kube-apiserver node
343-
{{< note >}}
344-
Fluent-plugin-forest and fluent-plugin-rewrite-tag-filter are plugins for fluentd. You can get details about plugin installation from [fluentd plugin-management][fluentd_plugin_management_doc].
343+
{{< note >}}Fluent-plugin-forest and fluent-plugin-rewrite-tag-filter are plugins for fluentd. You can get details about plugin installation from [fluentd plugin-management][fluentd_plugin_management_doc].
345344
{{< /note >}}
346345

347-
1. create a config file for fluentd
346+
1. Install [fluentd][fluentd_install_doc], fluent-plugin-forest and fluent-plugin-rewrite-tag-filter in the kube-apiserver node
347+
348+
1. Create a config file for fluentd
348349

349350
```
350351
cat <<'EOF' > /etc/fluentd/config
@@ -399,19 +400,19 @@ Fluent-plugin-forest and fluent-plugin-rewrite-tag-filter are plugins for fluent
399400
EOF
400401
```
401402

402-
1. start fluentd
403+
1. Start fluentd
403404

404405
```shell
405406
fluentd -c /etc/fluentd/config -vv
406407
```
407408

408-
1. start kube-apiserver with the following options:
409+
1. Start kube-apiserver with the following options:
409410

410411
```shell
411412
--audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-log-path=/var/log/kube-audit --audit-log-format=json
412413
```
413414

414-
1. check audits for different namespaces in `/var/log/audit-*.log`
415+
1. Check audits for different namespaces in `/var/log/audit-*.log`
415416

416417
### Use logstash to collect and distribute audit events from webhook backend
417418

@@ -490,8 +491,7 @@ Note that in addition to file output plugin, logstash has a variety of outputs t
490491
let users route data where they want. For example, users can emit audit events to elasticsearch
491492
plugin which supports full-text search and analytics.
492493

493-
494-
[kube-apiserver]: /docs/admin/kube-apiserver
494+
[kube-apiserver]: /docs/reference/command-line-tools-reference/kube-apiserver/
495495
[auditing-proposal]: https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/auditing.md
496496
[auditing-api]: https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/staging/src/k8s.io/apiserver/pkg/apis/audit/v1/types.go
497497
[configure-helper]: https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/cluster/gce/gci/configure-helper.sh

static/docs/reference/generated/kubernetes-api/v1.10/index.html

Lines changed: 0 additions & 111340 deletions
This file was deleted.

static/docs/reference/generated/kubernetes-api/v1.10/navData.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)