When adding formatting to the controlPlaneEndpoint config reference for
kubeadm-config v1beta4 it appears the first letter of the value was accidentally
dropped. This adds it back in the two places where this happened.
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The upstream source comments are not quite strict at using `*`s,
`<`s or `>`s. These characters, when not enclosed in backtiqs, are
interpreted as Markdown emphasize markers or HTML tags.
Hacking the generator code is not the right solution. We should
attempt to fix them in the source code instead.
Before that, let's keep fixing the generated outputs manually.
This PR fixes some issues caused by the bad format in source code comments
that confuse the reference generator. Problems are related to the use of
`*` in comment text as literal string rather than emphasis.
There are limitations in the generator when parsing ambiguous strings
such as `*`, `<` etc. `*` is used in Markdown for emphasis, but some
comments are using the literal '*' without properly escaping it.
`<` and `>` are not allowed in Markdown parser. The generated content
for this is at best some warning strings.
This PR fixes this issue manually.
An ideal fix would be proposed to the upstream source code wherever
these happen.
There are some format problems in the generated reference. These
problems aren't easy to solve if not fixing the format of the upstream
source code comments. This PR fixes them manually.
The `admission.k8s.io/v1` API group is not generated into the v2/v3 OpenAPI
specification as part of Kubernetes API because it is not officially "served".
However, the structs in the API group are used in other APIs that are user-facing.
This PR addes the reference API and fixes references to it.
k8s.gcr.io is deprecated in favor of registry.k8s.io. The kubernetes
codebase have been updated with the new endpoint.
Ref: https://github.com/kubernetes/k8s.io/issues/3411
Signed-off-by: Arnaud Meukam <ameukam@gmail.com>
This PR fixes several things in the admission-controllers page:
- The `PodSecurity` plugin is enabled by default, but it was not listed so;
- The `apiserver.config.k8s.io/v1alpha1` has been deprecated since v1.17, we are still documenting it side by side with the `apiserver.config.k8s.io/v1` API group;
- The `eventratelimit.admission.k8s.io/v1alpha1` API could use a better reference rather than the design doc; **The imagepolicy.v1alpha1 API is not documented anywhere, I'll add it later on.**
- There are statements about future, which should be removed;
- We are supposed refer to the `LimitRage` API reference rather than pointing users to the design docs;
- We are supposed refer to the `ResourceQuota` API reference rather than pointing users to the design docs;
- There are long lines in the page source which could have been wrapped properly.
The `TracingConfiguration` struct we reference from the system traces
page only exists in the v1alpha1 version of the API server
configuration. This PR fixes the problem.
The previous commit for configuration APIs has some nits to fix:
- The client-authentication API has both v1beta1 and v1 supported.
We need to include both.
- The kube-scheduler v1alpha1 is superceded by v1alpha3 which is new.
- The links to some external type definitions should point to the 1.23
API rather than old versions.
* Add config API for kubelet v1alpha1
The CredentialProvider struct is defined in the v1alpha1 config API
rather than v1beta1. The upstream generator is updated to include this
version (https://github.com/kubernetes-sigs/reference-docs/pull/268).
This commit adds references to the API as well.
* Wrap long lines in the page
Sean McGinnis
Arhell
Qiming Teng
Joshua Su
August
Kubernetes Prow Robot
Abigail McCarthy
Arnaud Meukam
Rita Zhang
Conner Crosby
George Gaál
Sean Wei
yuli