Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc update for KEP-3352 Aggregated Discovery #40024

Merged
merged 3 commits into from
Mar 31, 2023
Merged

Doc update for KEP-3352 Aggregated Discovery #40024

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
480e2e9
Add documentation for aggregated discovery
Jefftree Mar 21, 2023
dd1c643
Update feature gate
Jefftree Mar 21, 2023
4967f9c
Update content/en/docs/concepts/overview/kubernetes-api.md
tengqm Mar 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions content/en/docs/concepts/overview/kubernetes-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,31 @@ Refer to the table below for accepted request headers.
Kubernetes stores the serialized state of objects by writing them into
{{< glossary_tooltip term_id="etcd" >}}.

## API Discovery

A list of all group versions supported by a cluster is published at
the `/api` and `/apis` endpoints. Each group version also advertises
the list of resources supported via `/apis/<group>/<version>` (for
example: `/apis/rbac.authorization.k8s.io/v1alpha1`). These endpoints
are used by kubectl to fetch the list of resources supported by a
cluster.

### Aggregated Discovery

{{< feature-state state="beta" for_k8s_version="v1.27" >}}

Kubernetes offers beta support for aggregated discovery, publishing
all resources supported by a cluster through two endpoints (`/api` and
`/apis`) compared to one for every group version. Requesting this
endpoint drastically reduces the number of requests sent to fetch the
discovery for the average Kubernetes cluster. This may be accessed by
requesting the respective endpoints with an Accept header indicating
the aggregated discovery resource:
`Accept:
application/json;v=v2beta1;g=apidiscovery.k8s.io;as=APIGroupDiscoveryList`.
tengqm marked this conversation as resolved.
Show resolved Hide resolved

The endpoint also supports ETag and protobuf encoding.

## API groups and versioning

To make it easier to eliminate fields or restructure resource representations,
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/reference/command-line-tools-reference/feature-gates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ For a reference to old feature gates that are removed, please refer to
| `APIServerIdentity` | `true` | Beta | 1.26 | |
| `APIServerTracing` | `false` | Alpha | 1.22 | 1.26 |
| `APIServerTracing` | `true` | Beta | 1.27 | |
| `AggregatedDiscoveryEndpoint` | `false` | Alpha | 1.26 | |
| `AggregatedDiscoveryEndpoint` | `false` | Alpha | 1.26 | 1.26 |
| `AggregatedDiscoveryEndpoint` | `true` | Beta | 1.27 | |
| `AnyVolumeDataSource` | `false` | Alpha | 1.18 | 1.23 |
| `AnyVolumeDataSource` | `true` | Beta | 1.24 | |
| `AppArmor` | `true` | Beta | 1.4 | |
Expand Down