docs: Add Port Range Information #33389
Conversation
nathanjsweet
added
the
release-note/misc
nathanjsweet
added
the
release-blocker/1.16
nathanjsweet
force-pushed
the
pr/nathanjsweet/port-range-documentation-updates
branch
from
08ac957
to
f183229
Compare
nathanjsweet
force-pushed
the
pr/nathanjsweet/port-range-documentation-updates
branch
from
f183229
to
6df75d8
Compare
nathanjsweet
force-pushed
the
pr/nathanjsweet/port-range-documentation-updates
branch
from
6df75d8
to
a46a3ad
Compare
There was a problem hiding this comment.
I think we should consolidate the restrictions around port ranges into the section where port ranges are introduced and described, and also avoid using notes so much (see this guidance in the docs).
- Port Ranges are now supported so it is removed from
the unsupported features table.
- DNS rules and L7 rules do not support port ranges yet.
Notes are added to call attention to this.
- Add a Port Range example.
Signed-off-by: Nate Sweet <[email protected]>
nathanjsweet
force-pushed
the
pr/nathanjsweet/port-range-documentation-updates
branch
from
a46a3ad
to
8d73d50
Compare
| // parsed as a single uint16. In the future, this field may support | ||
| // ranges in the form "1024-2048" | ||
| // Port can be an L4 port number, or a name in the form of "http" | ||
| // or "http-8080". EndPort is ignored if Port is a named port. |
There was a problem hiding this comment.
Non blocking question: Do we really want to continuing maintaining a mirror of this k8s API struct in docs, feels like it will be easy for this to get out of date easily.
There was a problem hiding this comment.
I guess it's a balance. We don't change the API super often. Those structs are ultimately the source of truth for how the API behaves though. Perhaps in an ideal world we'd have docs tooling to automatically embed the latest API struct definitions in here rather than manually updating them.
Other than that, we can either copy the text over into the docs or we can copy the text plus definitions over, either way we have the question of how to make sure the docs describe the semantics of the API. I don't know if it makes a significant difference between the two.
|
/test |
- SCTP and Port Ranges are now supported, both are removed from the unsupported features table.Edit: