From 6cbe18f597130c1c9d4a36427084a49aa092afe6 Mon Sep 17 00:00:00 2001 From: Robert Fratto Date: Thu, 28 Mar 2024 13:13:31 -0400 Subject: [PATCH] docs: document --stability.level (#94) Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> --- docs/sources/reference/cli/run.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/sources/reference/cli/run.md b/docs/sources/reference/cli/run.md index f91ff7eafd..d10d5adcbc 100644 --- a/docs/sources/reference/cli/run.md +++ b/docs/sources/reference/cli/run.md @@ -54,6 +54,7 @@ The following flags are supported: * `--config.format`: The format of the source file. Supported formats: `alloy`, `prometheus`, `promtail`, `static` (default `"alloy"`). * `--config.bypass-conversion-errors`: Enable bypassing errors when converting (default `false`). * `--config.extra-args`: Extra arguments from the original format used by the converter. +* `--stability.level`: The minimum permitted stability level of functionality to run. Supported values: `experimental`, `public-preview`, `generally-available` (default `"generally-available"`). ## Update the configuration file @@ -67,6 +68,28 @@ Components that are no longer defined in the configuration file after reloading All components managed by the component controller are reevaluated after reloading. +## Permitted stability levels + +By default, {{< param "PRODUCT_NAME" >}} only allows you to use functionality that is marked _Generally available_. + +To use [Experimental][stability] or [Public preview][stability] functionality, set the `--stability.level` flag to the level you want to use: + +* `--stability.level=experimental`: Use functionality marked as _Experimental_ and above. +* `--stability.level=public-preview`: Use functionality marked as _Public preview_ and above. +* `--stability.level=generally-available`: Use functionality marked as _Generally available_. + +{{< admonition type="caution" >}} +Setting `--stability.level` to `experimental` or `public-preview` may enable _Experimental_ or _Public preview_ behavior for items otherwise marked _Generally available_, such as: + +* The component controller +* Components in the main configuration or in imported modules +* Configuration blocks in the main configuration +{{< /admonition >}} + +[stability]: https://grafana.com/docs/release-life-cycle/ + +Refer to [Release life cycle for Grafana Labs](https://grafana.com/docs/release-life-cycle/) for the definition of each stability level. + ## Clustering The `--cluster.enabled` command-line argument starts {{< param "PRODUCT_NAME" >}} in [clustering][] mode.