Use new feature-state component

kubernetes-sigs · Jun 30, 2024 · 01ecae6 · 01ecae6
1 parent 429833d
commit 01ecae6
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 24 deletions.
diff --git a/site/content/en/docs/concepts/cluster_queue.md b/site/content/en/docs/concepts/cluster_queue.md
@@ -349,8 +349,8 @@ To limit the amount of resources that a ClusterQueue can lend in the cohort,
 you can set the `.spec.resourcesGroup[*].flavors[*].resource[*].lendingLimit`
 [quantity](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/) field.
 
+{{< feature-state state="stable" for_version="v0.6.0+" >}}
 {{% alert title="Warning" color="warning" %}}
-_Available in Kueue v0.6.0 and later_
 
 `LendingLimit` is an Alpha feature disabled by default.
 

diff --git a/site/content/en/docs/concepts/multikueue.md b/site/content/en/docs/concepts/multikueue.md
@@ -6,9 +6,8 @@ description: >
   Kueue multi cluster job dispatching.
 ---
 
-{{% alert title="Warning" color="warning" %}}
-_Available in Kueue v0.6.0 and later_
-{{% /alert %}}
+{{< feature-state state="stable" for_version="v0.6.0+" >}}
+
 
 {{% alert title="Warning" color="warning" %}}
 MultiKueue is currently an alpha feature and disabled by default. Check the [Installation](/docs/installation/#change-the-feature-gates-configuration) guide for details on feature gate configuration.

diff --git a/site/content/en/docs/concepts/preemption.md b/site/content/en/docs/concepts/preemption.md
@@ -112,9 +112,7 @@ admitted when accounting back the quota usage of the target Workload.
 
 ## Fair Sharing
 
-{{% alert title="Note" color="primary" %}} 
-Available in Kueue v0.7.0 and newer
-{{% /alert %}} 
+{{< feature-state state="stable" for_version="v0.7.0+" >}}
 
 To enable fair sharing, [use a Kueue Configuration](/docs/installation#install-a-custom-configured-release-version) similar to the following:
 

diff --git a/site/content/en/docs/installation/_index.md b/site/content/en/docs/installation/_index.md
@@ -59,7 +59,8 @@ kubectl apply --server-side -f https://github.com/kubernetes-sigs/kueue/releases
 
 ### Add metrics scraping for prometheus-operator
 
-> _Available in Kueue v0.2.1 and later_
+{{< feature-state state="stable" for_version="v0.2.1+" >}}
+
 
 To allow [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator)
 to scrape metrics from kueue components, run the following command:
@@ -74,7 +75,8 @@ kubectl apply --server-side -f https://github.com/kubernetes-sigs/kueue/releases
 
 ### Add visibility API to monitor pending workloads
 
-> _Available in Kueue v0.6.0 and later_
+{{< feature-state state="stable" for_version="v0.6.0+" >}}
+
 
 To add the visibility API that enables monitoring pending workloads, change [the feature gates configuration](/docs/installation/#change-the-feature-gates-configuration) and set `VisibilityOnDemand=true`, and run the following command
 
@@ -186,7 +188,8 @@ IMAGE_REGISTRY=registry.example.com/my-user make image-local-push deploy
 
 ### Add metrics scraping for prometheus-operator
 
-> _Available in Kueue v0.2.0 and later_
+{{< feature-state state="stable" for_version="v0.2.0+" >}}
+
 
 To allow [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator)
 to scrape metrics from kueue components, run the following command:

diff --git a/site/content/en/docs/tasks/dev/enabling_pprof_endpoints.md b/site/content/en/docs/tasks/dev/enabling_pprof_endpoints.md
@@ -20,7 +20,7 @@ Make sure the following conditions are met:
 
 ## Enabling pprof endpoints
 
-> _Available in Kueue v0.5.0 and later_
+{{< feature-state state="stable" for_version="v0.5.0+" >}}
 
 To enable pprof endpoints, you need to set a `pprofBindAddress` is set in the [manager's configuration](/docs/installation/#install-a-custom-configured-released-version).
 

diff --git a/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_in_status.md b/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_in_status.md
@@ -28,7 +28,7 @@ QueueVisibility is an `Alpha` feature disabled by default, check the [Change the
 
 ## Monitor pending workloads
 
-> _Available in Kueue v0.5.0 and later_
+{{< feature-state state="alpha" for_version="v0.5.0+" >}}
 
 To install a simple setup of cluster queue, run the following command:
 

diff --git a/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand.md b/...t/en/docs/tasks/manage/monitor_pending_workloads/pending_workloads_on_demand.md
@@ -36,7 +36,7 @@ kubectl apply --server-side -f https://github.com/kubernetes-sigs/kueue/releases
 
 ## Monitor pending workloads on demand
 
-> _Available in Kueue v0.6.0 and later_
+{{< feature-state state="stable" for_version="v0.6.0+" >}}
 
 To install a simple setup of ClusterQueue
 
@@ -302,4 +302,4 @@ You should get results similar to
     }
   ]
 }
-```
+```
diff --git a/site/content/en/docs/tasks/manage/setup_sequential_admission.md b/site/content/en/docs/tasks/manage/setup_sequential_admission.md
@@ -75,9 +75,8 @@ the `enable` is overridden to `true`.
 When the `blockAdmission` is set to `true`, admitted Workload with not ready pods block admission for other Workloads.
 
 ### Requeuing Strategy
-{{% alert title="Warning" color="warning" %}}
-Available in Kueue v0.6.0 and later
-{{% /alert %}}
+{{< feature-state state="stable" for_version="v0.6.0+" >}}
+
 {{% alert title="Note" color="primary" %}}
 The `backoffBaseSeconds` and `backodMaxSeconds` are available in Kueue v0.7.0 and later
 {{% /alert %}}

diff --git a/site/layouts/shortcodes/feature-state.html b/site/layouts/shortcodes/feature-state.html
@@ -1,15 +1,13 @@
-
 {{ $valid_states := "alpha, beta, deprecated, stable" }}
 {{ $project := .Get "project" | default "Kueue" }}
 {{ $state := .Get "state" }}
-{{ $for_kueue_version := .Get "for_kueue_version" | default (.Page.Param "version")}}
+{{ $for_version := .Get "for_version" | default (.Page.Param "version")}}
 {{ $is_valid := strings.Contains $valid_states $state }}
 
 {{ if not $is_valid }}
-  {{ errorf "%q is not a valid feature-state, use one of %q" $state $valid_states }}
+{{ errorf "%q is not a valid feature-state, use one of %q" $state $valid_states }}
 {{ else }}
-  <div class="feature-state-notice feature-{{ $state }}">
-  <span class="feature-state-name">FEATURE STATE</span> <code>{{ $project }} {{ $for_kueue_version }} [{{ $state }}]</code>
-  </div>
+<div class="feature-state-notice feature-{{ $state }}">
+  <span class="feature-state-name">FEATURE STATE</span> <code>{{ $project }} {{ $for_version }} [{{ $state }}]</code>
+</div>
 {{ end }}
-