Skip to content

Commit 92e4d9f

Browse files
authored
Merge pull request kubernetes-sigs#639 from bowei/doc-impl-spec
Add note about "implementation-specific" vs conformance levels
2 parents 9eaf897 + 3f24c64 commit 92e4d9f

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

site-src/concepts/guidelines.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,31 @@ different providers in the early days of this API. Users can use the
8484
results of the conformance tests to understand areas where there may
8585
be differences in behavior from the spec.
8686

87+
### Implementation-specific
88+
89+
In some aspects of the API, we give the user an ability to specify usage of the
90+
feature, however, the exact behavior may depend on the underlying
91+
implementation. For example, regular expression matching is present in all
92+
implementations but specifying an exact behavior is impossible due to
93+
subtle differences between the underlying libraries used (e.g. PCRE, ECMA,
94+
Re2). It is still useful for our users to spec out the feature as much as
95+
possible, but we acknowledge that the behavior for some subset of the API may
96+
still vary (and that's ok).
97+
98+
These cases will be specified as defining delimited parts of the API
99+
"implementation-specific".
100+
101+
The "implementation-specific" designation allows a CORE or EXTENDED feature to
102+
be well-defined taking into account the realities of some features that are
103+
mostly but not entirely portable.
104+
87105
## API Conventions
88106

89107
Service APIs follow Kubernetes API [conventions][1]. These conventions
90108
are intended to ease client development and ensure that configuration
91109
mechanisms can consistently be implemented across a diverse set of use
92110
cases. One variation from the Kubernetes conventions is for fields with
93111
default values. These fields are considered optional but are not pointers
94-
since they will never be empty.
112+
since they will never be empty.
95113

96114
[1]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md

0 commit comments

Comments
 (0)