Skip to content

Commit f18b7f2

Browse files
authored
add TargetGroupBinding docs (#1540)
1 parent c732fb3 commit f18b7f2

File tree

9 files changed

+779
-2
lines changed

9 files changed

+779
-2
lines changed

apis/elbv2/v1beta1/targetgroupbinding_types.go

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ import (
2222
)
2323

2424
// +kubebuilder:validation:Enum=instance;ip
25+
// TargetType is the targetType of your ELBV2 TargetGroup.
26+
//
27+
// * with `instance` TargetType, nodes with nodePort for your service will be registered as targets
28+
// * with `ip` TargetType, Pods with containerPort for your service will be registered as targets
2529
type TargetType string
2630

2731
const (
@@ -65,6 +69,7 @@ type NetworkingPeer struct {
6569
}
6670

6771
// +kubebuilder:validation:Enum=TCP;UDP
72+
// NetworkingProtocol defines the protocol for networking rules.
6873
type NetworkingProtocol string
6974

7075
const (
@@ -75,6 +80,7 @@ const (
7580
NetworkingProtocolUDP NetworkingProtocol = "UDP"
7681
)
7782

83+
// NetworkingPort defines the port and protocol for networking rules.
7884
type NetworkingPort struct {
7985
// The protocol which traffic must match.
8086
// If protocol is unspecified, it defaults to TCP.
@@ -88,6 +94,7 @@ type NetworkingPort struct {
8894
Port *intstr.IntOrString `json:"port,omitempty"`
8995
}
9096

97+
// NetworkingIngressRule defines a particular set of traffic that is allowed to access TargetGroup's targets.
9198
type NetworkingIngressRule struct {
9299
// List of peers which should be able to access the targets in TargetGroup.
93100
// At least one NetworkingPeer should be specified.
@@ -98,6 +105,7 @@ type NetworkingIngressRule struct {
98105
Ports []NetworkingPort `json:"ports"`
99106
}
100107

108+
// TargetGroupBindingNetworking defines the networking rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.
101109
type TargetGroupBindingNetworking struct {
102110
// List of ingress rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.
103111
// +optional
@@ -116,7 +124,7 @@ type TargetGroupBindingSpec struct {
116124
// serviceRef is a reference to a Kubernetes Service and ServicePort.
117125
ServiceRef ServiceReference `json:"serviceRef"`
118126

119-
// networking provides the networking setup for ELBV2 LoadBalancer to access targets in TargetGroup.
127+
// networking defines the networking rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.
120128
// +optional
121129
Networking *TargetGroupBindingNetworking `json:"networking,omitempty"`
122130
}

docs/guide/ingress/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ingress specification
22
This document covers how ingress resources work in relation to The AWS Load Balancer Controller.
33

4-
An example ingress, from [example](../../examples/2048/2048-ingress.yaml) is as follows.
4+
An example ingress, from [example](../../examples/2048/2048_full.yaml) is as follows.
55

66
```yaml
77
apiVersion: extensions/v1beta1

0 commit comments

Comments
 (0)