13
13
14
14
(Primary goals of this proposal.)
15
15
16
+ ## Longer Term Goals (optional)
17
+
18
+ (goals that are not covered initially on this proposal but may be considered long term)
19
+
16
20
## Non-Goals
17
21
18
22
(What is out of scope for this proposal.)
19
23
20
- ## Introduction
24
+ ## Introduction/Overview
21
25
22
26
(Can link to external doc -- but we should bias towards copying
23
27
the content into the GEP as online documents are easier to lose
24
28
-- e.g. owner messes up the permissions, accidental deletion)
25
29
30
+ Write here "What" we want to do. What is the proposal aiming to do?
31
+
32
+ ## Purpose (Why and Who)
33
+
34
+ Write here "Why" we want to do it. What problems are being solved? What personas are
35
+ the target of this proposal, and why will this proposal will make their lives better?
36
+
26
37
## API
27
38
(... details, can point to PR with changes)
28
39
@@ -32,6 +43,17 @@ the content into the GEP as online documents are easier to lose
32
43
### Gateway For Mesh (East/West)
33
44
(Include East/West API considerations, examples, and if different - APIs)
34
45
46
+ ## Request flow
47
+ Example on the usage flow of this proposal/enhancement. It is suggested to contain
48
+ at least one manifest as example.
49
+
50
+ Example of a flow description:
51
+
52
+ * A client makes a request to https://foo.example.com .
53
+ * DNS resolves the name to a ` Gateway ` address.
54
+ * The reverse proxy receives the request on a ` Listener ` and does something with it
55
+ * The reverse proxy passes the request through ` XPTORoute ` modifying the headers to contain ` XYZ `
56
+
35
57
## Conformance Details
36
58
37
59
(from https://github.com/kubernetes-sigs/gateway-api/blob/main/geps/gep-2162/index.md#standardize-features-and-conformance-tests-names )
@@ -60,6 +82,11 @@ In any case, the conformance tests file names should be meaningful and easy to u
60
82
61
83
(Make sure to also include conformance tests that cover mesh)
62
84
85
+ When describing the new feature, write down some conformance test scenarios the feature should manage,
86
+ to guarantee that future implementors understand what "Conformance" means and what will be tested.
87
+
88
+ At least _ some_ tests should be added at each phase, starting with Provisional.
89
+
63
90
## Alternatives
64
91
65
92
(List other design alternatives and why we did not go in that
0 commit comments