Skip to content

Commit f93abb7

Browse files
spacewanderspacewander
authored
add feature maturity level record (#755)
* add feature maturity level record Signed-off-by: spacewander <spacewanderlzx@gmail.com> * update according to review Signed-off-by: spacewander <spacewanderlzx@gmail.com> --------- Signed-off-by: spacewander <spacewanderlzx@gmail.com>
1 parent 8e6f150 commit f93abb7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+487
-185
lines changed

‎maintainer/feature_maturity_level.yaml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Definition of feature: a feature is a plugin or a registry.
2+
#
3+
# Feature maturity grading rules:
4+
# 1. A feature's maturity level is `experimental` when its implementation is complete.
5+
# 2. A feature is `stable` when it meets both of the following conditions:
6+
# 2.1 It has been in a release version for more than 6 months.
7+
# 2.2 There are no bugfixes on this feature in the last three months.
8+
# 3. If a breaking change occurs or the maintainer thinks it is not stable enough, it returns to `experimental`.
9+
#
10+
# When creating new release, please update the maturity level of the features in this file, according to
11+
# the above rules.
12+
#
13+
# When adding a new feature, please set the experimental_since field to the next release.
14+
15+
plugins:
16+
- name: bandwidth_limit
17+
status: experimental
18+
experimental_since: 0.4.0
19+
- name: buffer
20+
status: experimental
21+
experimental_since: 0.4.0
22+
- name: casbin
23+
status: experimental
24+
experimental_since: 0.4.0
25+
- name: cel_script
26+
status: experimental
27+
experimental_since: 0.4.0
28+
- name: consumer_restriction
29+
status: experimental
30+
experimental_since: 0.4.0
31+
- name: cors
32+
status: stable
33+
stable_since: 0.4.0
34+
- name: debug_mode
35+
status: experimental
36+
experimental_since: 0.4.0
37+
- name: demo
38+
status: experimental
39+
experimental_since: 0.4.0
40+
- name: ext_auth
41+
status: stable
42+
stable_since: 0.4.0
43+
- name: fault
44+
status: stable
45+
stable_since: 0.4.0
46+
- name: hmac_auth
47+
status: experimental
48+
experimental_since: 0.4.0
49+
- name: inner_ext_proc
50+
status: experimental
51+
experimental_since: 0.4.0
52+
- name: inner_lua
53+
status: experimental
54+
experimental_since: 0.4.0
55+
- name: key_auth
56+
status: stable
57+
stable_since: 0.4.0
58+
- name: limit_count_redis
59+
status: stable
60+
stable_since: 0.4.0
61+
- name: limit_req
62+
status: experimental
63+
experimental_since: 0.4.0
64+
- name: listener_patch
65+
status: experimental
66+
experimental_since: 0.4.0
67+
- name: local_ratelimit
68+
status: stable
69+
stable_since: 0.4.0
70+
- name: oidc
71+
status: experimental
72+
experimental_since: 0.4.0
73+
- name: opa
74+
status: experimental
75+
experimental_since: 0.4.0
76+
- name: outer_ext_proc
77+
status: experimental
78+
experimental_since: 0.4.0
79+
- name: outer_lua
80+
status: experimental
81+
experimental_since: 0.4.0
82+
- name: tls_inspector
83+
status: experimental
84+
experimental_since: 0.4.0
85+
registries:
86+
- name: consul
87+
status: experimental
88+
experimental_since: 0.4.0
89+
- name: nacos
90+
status: experimental
91+
experimental_since: 0.4.0

MAINTAIN.md renamed to maintainer/guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ To release a new version, please follow the steps below:
1313
* Once the image is ready, update the version in the `manifests/charts/*/Chart.yaml`.
1414
* Update the `./examples/dev_your_plugin` to use the released version.
1515
* Run `make fmt-go`.
16+
* Promote the maturity of plugins that meet the criteria to stable by updating `maintainer/feature_maturity_level.yaml` and plugin documentation.
1617
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.
1718

1819
## Upgrade components

‎site/content/en/docs/reference/plugins/bandwidth_limit.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `bandwidthLimit` plugin restricts the maximum bandwidth of the data stream b
88

99
## Attribute
1010

11-
| | |
12-
|-------|---------|
13-
| Type | Traffic |
14-
| Order | Outer |
11+
| | |
12+
|--------|--------------|
13+
| Type | Traffic |
14+
| Order | Outer |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/buffer.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ The `buffer` plugin fully buffers the complete request, by leveraging Envoy's `b
1111

1212
## Attribute
1313

14-
| | |
15-
|-------|---------|
16-
| Type | General |
17-
| Order | Outer |
14+
| | |
15+
|--------|--------------|
16+
| Type | General |
17+
| Order | Outer |
18+
| Status | Experimental |
1819

1920
## Configuration
2021

‎site/content/en/docs/reference/plugins/casbin.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `casbin` plugin embeds the powerful and efficient open-source access control
88

99
## Attribute
1010

11-
| | |
12-
| ----- | ----- |
13-
| Type | Authz |
14-
| Order | Authz |
11+
| | |
12+
|--------|--------------|
13+
| Type | Authz |
14+
| Order | Authz |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/cel_script.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `celScript` plugin determines whether the current request can access the ups
88

99
## Attribute
1010

11-
| | |
12-
|-------|---------|
13-
| Type | Traffic |
14-
| Order | Traffic |
11+
| | |
12+
|--------|--------------|
13+
| Type | Traffic |
14+
| Order | Traffic |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/consumer_restriction.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `consumerRestriction` plugin determines whether the current consumer has acc
88

99
## Attribute
1010

11-
| | |
12-
|-------|-------|
13-
| Type | Authz |
14-
| Order | Authz |
11+
| | |
12+
|--------|--------------|
13+
| Type | Authz |
14+
| Order | Authz |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/cors.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `cors` plugin handles Cross-Origin Resource Sharing requests by leveraging E
88

99
## Attribute
1010

11-
| | |
12-
|-------|----------|
13-
| Type | Security |
14-
| Order | Outer |
11+
| | |
12+
|--------|----------|
13+
| Type | Security |
14+
| Order | Outer |
15+
| Status | Stable |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/debug_mode.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `debugMode` plugin is used to enable debug mode on the targeted Route.
88

99
## Attribute
1010

11-
| | |
12-
|-------|---------|
13-
| Type | General |
14-
| Order | Access |
11+
| | |
12+
|--------|--------------|
13+
| Type | General |
14+
| Order | Access |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

‎site/content/en/docs/reference/plugins/demo.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The `demo` plugin is used to show how to add a plugin to htnn.
88

99
## Attribute
1010

11-
| | |
12-
|-------|-------------|
13-
| Type | General |
14-
| Order | Unspecified |
11+
| | |
12+
|--------|--------------|
13+
| Type | General |
14+
| Order | Unspecified |
15+
| Status | Experimental |
1516

1617
## Configuration
1718

0 commit comments

Comments
 (0)