diff --git a/docs/eventing/experimental-features.md b/docs/eventing/experimental-features.md new file mode 100644 index 00000000000..9d42911d516 --- /dev/null +++ b/docs/eventing/experimental-features.md @@ -0,0 +1,54 @@ +# Experimental features + +In Knative we want to keep the innovation alive, experimenting and delivering new features without affecting the stability of the project. + +In order to achieve that goal in Knative Eventing, we have a process to include new features. +This allows users like you to try out new features and provide feedback back to the project. + +This document explains how to enable experimental features and which ones are available today. + +For more details about the process, the feature phases, quality requirements and guarantees, check out the [Experimental features process documentation](https://github.com/knative/eventing/blob/main/docs/experimental-features.md). + +## Before you begin + +You must have a Knative cluster running with the Eventing component installed. [Learn more](../install/) + +## Experimental features configuration + +When installing Eventing, the `config-features` ConfigMap is added to your cluster in the `knative-eventing` namespace. +In order to enable a feature, you just need to add it to the config map and set its value to `"enabled"`. +For example, to enable `new-cool-feature`: + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: config-features + namespace: knative-eventing + labels: + eventing.knative.dev/release: devel + knative.dev/config-propagation: original + knative.dev/config-category: eventing +data: + new-cool-feature: "enabled" +``` + +In order to disable it, you can either remove the flag or set it to `"disabled"`: + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: config-features + namespace: knative-eventing + labels: + eventing.knative.dev/release: devel + knative.dev/config-propagation: original + knative.dev/config-category: eventing +data: + new-cool-feature: "disabled" +``` + +## Features list + + diff --git a/mkdocs.yml b/mkdocs.yml index bf10cb1348a..2746cb09f1c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -187,6 +187,7 @@ nav: - Debugging: eventing/debugging/index.md - Accessing CloudEvent traces: eventing/accessing-traces.md - Metrics API: eventing/metrics.md + - Experimental Features: eventing/experimental-features.md - Code samples: - Overview: eventing/samples/README.md - Container source: eventing/sources/container-source/README.md