Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document NamedAddress #374

Merged
merged 2 commits into from
Dec 3, 2020
Merged

document NamedAddress #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb4d668
docstrings: elaborate on NamedAddress
rosenhouse Dec 1, 2020
2587aaa
regenerate docs
rosenhouse Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions apis/v1alpha1/gateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,8 +484,14 @@ type GatewayAddress struct {
// AddressType defines how a network address is represented as a text string.
// Valid AddressType values are:
//
// * "IPAddress"
// * "NamedAddress"
// * "IPAddress": an IPv4 or IPv6 address
// * "NamedAddress": an opaque identifier. The interpretation
// of the name is dependent on the controller. If a NamedAddress is
// requested but unsupported by an implementation, the controller
// should raise the "Detached" listener status condition on the Gateway
// with the "UnsupportedAddress" reason.
//
// A NamedAddress might be a cloud-dependent ID for a "static" or "elastic" IP
//
// +kubebuilder:validation:Enum=IPAddress;NamedAddress
type AddressType string
Expand All @@ -503,7 +509,7 @@ const (
// Support: Extended.
IPAddressType AddressType = "IPAddress"

// NamedAddressType is an address selected by name. The interpretation
// NamedAddressType is an opaque identifier. The interpretation
// of the name is dependent on the controller. If a NamedAddress is
// requested but unsupported by an implementation, the controller
// should raise the "Detached" listener status condition on the Gateway
Expand Down
9 changes: 7 additions & 2 deletions docs-src/spec.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions docs/spec/index.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.