From 840c234052a365a12a883cdbd5bbc0a320e6a69a Mon Sep 17 00:00:00 2001 From: joshmeranda Date: Thu, 12 Jun 2025 21:43:48 -0400 Subject: [PATCH 1/5] update do inidicate that the aggregate layer is required --- docs/api/extension-apiserver.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/api/extension-apiserver.md b/docs/api/extension-apiserver.md index 8f8786bd328..ea0ab5cfc35 100644 --- a/docs/api/extension-apiserver.md +++ b/docs/api/extension-apiserver.md @@ -8,8 +8,14 @@ title: Extension API Server Rancher extends Kubernetes with additional APIs by registering an extension API server using the [Kubernetes API Aggregation Layer](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/). -## Disabling the extension API server +## Aggregation Layer is Required -The [aggregation layer must be configured](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) on the local Kubernetes cluster for the `imperative-api-extension` feature to be enabled and to work correctly. The feature assumes this is configured and is enabled by default. If it is not possible to configure the aggregation layer for your local Kubernetes cluster, then you must disable the feature. The `imperative-api-extension` feature flag can be disabled by either using the [Rancher UI](../how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md#disabling-features-with-the-rancher-ui) or [Rancher API](../how-to-guides/advanced-user-guides/enable-experimental-features/enable-experimental-features.md#disabling-features-with-the-rancher-api). +The [aggregation layer must be configured](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. -It will still be possible to access the additional APIs when the feature is disabled. The additional APIs are available at `https:///ext` and they are compatible with the Kubernetes apiserver. This means you can use `curl` or `kubectl` to interact with the APIs. +See the [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. + +:::note + +If the underlying kubernetes distro does not support the aggregation layer, you must migrate to a distro that does before upgrading. + +::: From 2822dc9c30c5c79cfe622ab02f23573bf4a4675a Mon Sep 17 00:00:00 2001 From: joshmeranda Date: Mon, 7 Jul 2025 09:39:57 -0400 Subject: [PATCH 2/5] remove duplicate link to k8s docs --- docs/api/extension-apiserver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/extension-apiserver.md b/docs/api/extension-apiserver.md index ea0ab5cfc35..f0da4f8d901 100644 --- a/docs/api/extension-apiserver.md +++ b/docs/api/extension-apiserver.md @@ -10,7 +10,7 @@ Rancher extends Kubernetes with additional APIs by registering an extension API ## Aggregation Layer is Required -The [aggregation layer must be configured](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. +The API aggregation layer must be configured on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. See the [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. From dbb4e369007c0786321043411e3a86808120ada0 Mon Sep 17 00:00:00 2001 From: joshmeranda Date: Mon, 7 Jul 2025 10:00:31 -0400 Subject: [PATCH 3/5] add not on supported versions --- docs/api/extension-apiserver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/extension-apiserver.md b/docs/api/extension-apiserver.md index f0da4f8d901..7bc9c0048d3 100644 --- a/docs/api/extension-apiserver.md +++ b/docs/api/extension-apiserver.md @@ -12,7 +12,7 @@ Rancher extends Kubernetes with additional APIs by registering an extension API The API aggregation layer must be configured on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. -See the [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. +All versions of k8s supported by Rancher with the feature will have the aggregation layer configured by default. If you suspect you cluster may not be configured properlly see [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. :::note From 022c36838b08472da03cc5278b524ea224298c76 Mon Sep 17 00:00:00 2001 From: Josh Meranda Date: Tue, 8 Jul 2025 08:29:01 -0400 Subject: [PATCH 4/5] Update docs/api/extension-apiserver.md to fix typos Co-authored-by: Petr Kovar --- docs/api/extension-apiserver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/extension-apiserver.md b/docs/api/extension-apiserver.md index 7bc9c0048d3..da504f5b056 100644 --- a/docs/api/extension-apiserver.md +++ b/docs/api/extension-apiserver.md @@ -12,7 +12,7 @@ Rancher extends Kubernetes with additional APIs by registering an extension API The API aggregation layer must be configured on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. -All versions of k8s supported by Rancher with the feature will have the aggregation layer configured by default. If you suspect you cluster may not be configured properlly see [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. +All versions of k8s supported by Rancher with the feature will have the aggregation layer configured by default. If you suspect your cluster may not be configured properly, see the [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer. :::note From 89b1997eb710974c43c2d7d1873e3c79d0fffebf Mon Sep 17 00:00:00 2001 From: Josh Meranda Date: Fri, 11 Jul 2025 10:47:02 -0400 Subject: [PATCH 5/5] Update docs/api/extension-apiserver.md Co-authored-by: Tom Lebreux --- docs/api/extension-apiserver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/extension-apiserver.md b/docs/api/extension-apiserver.md index da504f5b056..2172d3504d8 100644 --- a/docs/api/extension-apiserver.md +++ b/docs/api/extension-apiserver.md @@ -10,7 +10,7 @@ Rancher extends Kubernetes with additional APIs by registering an extension API ## Aggregation Layer is Required -The API aggregation layer must be configured on the local Kubernetes cluster for the `imperative-api-extension` `APISertvice` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. +The API aggregation layer must be configured on the local Kubernetes cluster for the `v1.ext.cattle.io` `APIService` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in helm. All versions of k8s supported by Rancher with the feature will have the aggregation layer configured by default. If you suspect your cluster may not be configured properly, see the [Kubernetes Aggregation Layer docs](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer.