add feature maturity level record (#755)

* add feature maturity level record Signed-off-by: spacewander <[email protected]> * update according to review Signed-off-by: spacewander <[email protected]> --------- Signed-off-by: spacewander <[email protected]>
mosn · Oct 8, 2024 · f93abb7 · f93abb7
1 parent 8e6f150
commit f93abb7
Show file tree

Hide file tree

Showing 55 changed files with 487 additions and 185 deletions.
diff --git a/maintainer/feature_maturity_level.yaml b/maintainer/feature_maturity_level.yaml
@@ -0,0 +1,91 @@
+# Definition of feature: a feature is a plugin or a registry.
+#
+# Feature maturity grading rules:
+# 1. A feature's maturity level is `experimental` when its implementation is complete.
+# 2. A feature is `stable` when it meets both of the following conditions:
+#   2.1 It has been in a release version for more than 6 months.
+#   2.2 There are no bugfixes on this feature in the last three months.
+# 3. If a breaking change occurs or the maintainer thinks it is not stable enough, it returns to `experimental`.
+#
+# When creating new release, please update the maturity level of the features in this file, according to
+# the above rules.
+#
+# When adding a new feature, please set the experimental_since field to the next release.
+
+plugins:
+  - name: bandwidth_limit
+    status: experimental
+    experimental_since: 0.4.0
+  - name: buffer
+    status: experimental
+    experimental_since: 0.4.0
+  - name: casbin
+    status: experimental
+    experimental_since: 0.4.0
+  - name: cel_script
+    status: experimental
+    experimental_since: 0.4.0
+  - name: consumer_restriction
+    status: experimental
+    experimental_since: 0.4.0
+  - name: cors
+    status: stable
+    stable_since: 0.4.0
+  - name: debug_mode
+    status: experimental
+    experimental_since: 0.4.0
+  - name: demo
+    status: experimental
+    experimental_since: 0.4.0
+  - name: ext_auth
+    status: stable
+    stable_since: 0.4.0
+  - name: fault
+    status: stable
+    stable_since: 0.4.0
+  - name: hmac_auth
+    status: experimental
+    experimental_since: 0.4.0
+  - name: inner_ext_proc
+    status: experimental
+    experimental_since: 0.4.0
+  - name: inner_lua
+    status: experimental
+    experimental_since: 0.4.0
+  - name: key_auth
+    status: stable
+    stable_since: 0.4.0
+  - name: limit_count_redis
+    status: stable
+    stable_since: 0.4.0
+  - name: limit_req
+    status: experimental
+    experimental_since: 0.4.0
+  - name: listener_patch
+    status: experimental
+    experimental_since: 0.4.0
+  - name: local_ratelimit
+    status: stable
+    stable_since: 0.4.0
+  - name: oidc
+    status: experimental
+    experimental_since: 0.4.0
+  - name: opa
+    status: experimental
+    experimental_since: 0.4.0
+  - name: outer_ext_proc
+    status: experimental
+    experimental_since: 0.4.0
+  - name: outer_lua
+    status: experimental
+    experimental_since: 0.4.0
+  - name: tls_inspector
+    status: experimental
+    experimental_since: 0.4.0
+registries:
+  - name: consul
+    status: experimental
+    experimental_since: 0.4.0
+  - name: nacos
+    status: experimental
+    experimental_since: 0.4.0
diff --git a/MAINTAIN.md → maintainer/guide.md b/MAINTAIN.md → maintainer/guide.md
@@ -13,6 +13,7 @@ To release a new version, please follow the steps below:
     * Once the image is ready, update the version in the `manifests/charts/*/Chart.yaml`.
     * Update the `./examples/dev_your_plugin` to use the released version.
     * Run `make fmt-go`.
+    * Promote the maturity of plugins that meet the criteria to stable by updating `maintainer/feature_maturity_level.yaml` and plugin documentation.
 6. Create a release branch `release/v${version}` from the main branch, like `release/v0.3.2`. The CI will create a new chart package.
 
 ## Upgrade components

diff --git a/site/content/en/docs/reference/plugins/bandwidth_limit.md b/site/content/en/docs/reference/plugins/bandwidth_limit.md
@@ -8,10 +8,11 @@ The `bandwidthLimit` plugin restricts the maximum bandwidth of the data stream b
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | Traffic |
-| Order | Outer   |
+|        |              |
+|--------|--------------|
+| Type   | Traffic      |
+| Order  | Outer        |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/buffer.md b/site/content/en/docs/reference/plugins/buffer.md
@@ -11,10 +11,11 @@ The `buffer` plugin fully buffers the complete request, by leveraging Envoy's `b
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | General |
-| Order | Outer   |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Outer        |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/casbin.md b/site/content/en/docs/reference/plugins/casbin.md
@@ -8,10 +8,11 @@ The `casbin` plugin embeds the powerful and efficient open-source access control
 
 ## Attribute
 
-|       |       |
-| ----- | ----- |
-| Type  | Authz |
-| Order | Authz |
+|        |              |
+|--------|--------------|
+| Type   | Authz        |
+| Order  | Authz        |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/cel_script.md b/site/content/en/docs/reference/plugins/cel_script.md
@@ -8,10 +8,11 @@ The `celScript` plugin determines whether the current request can access the ups
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | Traffic |
-| Order | Traffic |
+|        |              |
+|--------|--------------|
+| Type   | Traffic      |
+| Order  | Traffic      |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/consumer_restriction.md b/site/content/en/docs/reference/plugins/consumer_restriction.md
@@ -8,10 +8,11 @@ The `consumerRestriction` plugin determines whether the current consumer has acc
 
 ## Attribute
 
-|       |       |
-|-------|-------|
-| Type  | Authz |
-| Order | Authz |
+|        |              |
+|--------|--------------|
+| Type   | Authz        |
+| Order  | Authz        |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/cors.md b/site/content/en/docs/reference/plugins/cors.md
@@ -8,10 +8,11 @@ The `cors` plugin handles Cross-Origin Resource Sharing requests by leveraging E
 
 ## Attribute
 
-|       |          |
-|-------|----------|
-| Type  | Security |
-| Order | Outer    |
+|        |          |
+|--------|----------|
+| Type   | Security |
+| Order  | Outer    |
+| Status | Stable   |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/debug_mode.md b/site/content/en/docs/reference/plugins/debug_mode.md
@@ -8,10 +8,11 @@ The `debugMode` plugin is used to enable debug mode on the targeted Route.
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | General |
-| Order | Access  |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Access       |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/demo.md b/site/content/en/docs/reference/plugins/demo.md
@@ -8,10 +8,11 @@ The `demo` plugin is used to show how to add a plugin to htnn.
 
 ## Attribute
 
-|       |             |
-|-------|-------------|
-| Type  | General     |
-| Order | Unspecified |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Unspecified  |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/ext_auth.md b/site/content/en/docs/reference/plugins/ext_auth.md
@@ -8,10 +8,11 @@ The `extAuth` plugin sends an authorization request to an authorization service
 
 ## Attribute
 
-|       |       |
-| ----- | ----- |
-| Type  | Authz |
-| Order | Authz |
+|        |        |
+|--------|--------|
+| Type   | Authz  |
+| Order  | Authz  |
+| Status | Stable |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/fault.md b/site/content/en/docs/reference/plugins/fault.md
@@ -8,10 +8,11 @@ The `fault` plugin supports response and delay injections by leveraging Envoy's
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | General |
-| Order | Outer   |
+|        |         |
+|--------|---------|
+| Type   | General |
+| Order  | Outer   |
+| Status | Stable  |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/hmac_auth.md b/site/content/en/docs/reference/plugins/hmac_auth.md
@@ -8,10 +8,11 @@ The `hmacAuth` plugin authenticates the client based on the consumer configurati
 
 ## Attribute
 
-|       |       |
-|-------|-------|
-| Type  | Authn |
-| Order | Authn |
+|        |              |
+|--------|--------------|
+| Type   | Authn        |
+| Order  | Authn        |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/inner_ext_proc.md b/site/content/en/docs/reference/plugins/inner_ext_proc.md
@@ -20,7 +20,8 @@ Please refer to the [outerExtProc](./outer_ext_proc.md) plugin documentation to
 
 ## Attribute
 
-|       |         |
-| ----- | ------- |
-| Type  | General |
-| Order | Inner   |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Inner        |
+| Status | Experimental |
diff --git a/site/content/en/docs/reference/plugins/inner_lua.md b/site/content/en/docs/reference/plugins/inner_lua.md
@@ -20,7 +20,8 @@ Please refer to [outerLua](./outer_lua.md) plugin documentation to know how to u
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | General |
-| Order | Inner   |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Inner        |
+| Status | Experimental |
diff --git a/site/content/en/docs/reference/plugins/key_auth.md b/site/content/en/docs/reference/plugins/key_auth.md
@@ -8,10 +8,11 @@ The `keyAuth` plugin authenticates the client according to the consumers and the
 
 ## Attribute
 
-|       |       |
-| ----- | ----- |
-| Type  | Authn |
-| Order | Authn |
+|        |        |
+|--------|--------|
+| Type   | Authn  |
+| Order  | Authn  |
+| Status | Stable |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/limit_count_redis.md b/site/content/en/docs/reference/plugins/limit_count_redis.md
@@ -8,10 +8,11 @@ The `limitCountRedis` plugin implements a global fixed window rate-limiting by s
 
 ## Attribute
 
-|       |         |
-| ----- | ------- |
-| Type  | Traffic |
-| Order | Traffic |
+|        |         |
+|--------|---------|
+| Type   | Traffic |
+| Order  | Traffic |
+| Status | Stable  |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/limit_req.md b/site/content/en/docs/reference/plugins/limit_req.md
@@ -8,10 +8,11 @@ The `limitReq` plugin limits the number of requests per second to this proxy. Th
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | Traffic |
-| Order | Traffic |
+|        |              |
+|--------|--------------|
+| Type   | Traffic      |
+| Order  | Traffic      |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/listener_patch.md b/site/content/en/docs/reference/plugins/listener_patch.md
@@ -8,10 +8,11 @@ The `listenerPatch` plugin allows users to directly patch the Listener resource
 
 ## Attribute
 
-|       |          |
-|-------|----------|
-| Type  | General  |
-| Order | Listener |
+|        |              |
+|--------|--------------|
+| Type   | General      |
+| Order  | Listener     |
+| Status | Experimental |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/local_ratelimit.md b/site/content/en/docs/reference/plugins/local_ratelimit.md
@@ -8,10 +8,11 @@ The `localRatelimit` plugin limits the number of requests per second, by leverag
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | Traffic |
-| Order | Outer   |
+|        |         |
+|--------|---------|
+| Type   | Traffic |
+| Order  | Outer   |
+| Status | Stable  |
 
 ## Configuration
 

diff --git a/site/content/en/docs/reference/plugins/oidc.md b/site/content/en/docs/reference/plugins/oidc.md
@@ -8,10 +8,11 @@ The `OIDC` plugin supports integration with any OpenID Connect Provider (OP) by
 
 ## Attribute
 
-|       |         |
-|-------|---------|
-| Type  | Authn   |
-| Order | Authn   |
+|        |              |
+|--------|--------------|
+| Type   | Authn        |
+| Order  | Authn        |
+| Status | Experimental |
 
 ## Configuration