luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Better document wildcard specifier interactions

This commit is contained in:
Chris Piraino 2020-05-04 11:47:46 -05:00
parent d8ac79041d
commit 21e0ed8f8d
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
agent/structs/config_entry_gateways.go
View File

@ -50,6 +50,9 @@ type IngressService struct {
// This can either be a specific service, or the wildcard specifier, // This can either be a specific service, or the wildcard specifier,
// "*". If the wildcard specifier is provided, the listener must be of "http" // "*". If the wildcard specifier is provided, the listener must be of "http"
// protocol and means that the listener will forward traffic to all services. // protocol and means that the listener will forward traffic to all services.
//
// A name can be specified on multiple listeners, and will be exposed on both
// of the listeners
Name string Name string
// Hosts is a list of hostnames which should be associated to this service on // Hosts is a list of hostnames which should be associated to this service on
@ -57,6 +60,10 @@ type IngressService struct {
// to route traffic to the service by matching the Host header of the HTTP // to route traffic to the service by matching the Host header of the HTTP
// request. // request.
// //
// If a host is provided for a service that also has a wildcard specifier
// defined, the host will override the wildcard-specifier-provided
// "<service-name>.*" domain for that listener.
//
// This cannot be specified when using the wildcard specifier, "*", or when // This cannot be specified when using the wildcard specifier, "*", or when
// using a "tcp" listener. // using a "tcp" listener.
Hosts []string Hosts []string

9
api/config_entry_gateways.go
View File

@ -52,9 +52,12 @@ type IngressListener struct {
type IngressService struct { type IngressService struct {
// Name declares the service to which traffic should be forwarded. // Name declares the service to which traffic should be forwarded.
// //
// This can either be a specific service instance, or the wildcard specifier, // This can either be a specific service, or the wildcard specifier,
// "*". If the wildcard specifier is provided, the listener must be of "http" // "*". If the wildcard specifier is provided, the listener must be of "http"
// protocol and means that the listener will forward traffic to all services. // protocol and means that the listener will forward traffic to all services.
//
// A name can be specified on multiple listeners, and will be exposed on both
// of the listeners
Name string Name string
// Hosts is a list of hostnames which should be associated to this service on // Hosts is a list of hostnames which should be associated to this service on
@ -62,6 +65,10 @@ type IngressService struct {
// to route traffic to the service by matching the Host header of the HTTP // to route traffic to the service by matching the Host header of the HTTP
// request. // request.
// //
// If a host is provided for a service that also has a wildcard specifier
// defined, the host will override the wildcard-specifier-provided
// "<service-name>.*" domain for that listener.
//
// This cannot be specified when using the wildcard specifier, "*", or when // This cannot be specified when using the wildcard specifier, "*", or when
// using a "tcp" listener. // using a "tcp" listener.
Hosts []string Hosts []string