1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
package api
import (
"net"
"strings"
)
// NetworkLoadBalancerBackend represents a target backend specification in a network load balancer
//
// swagger:model
//
// API extension: network_load_balancer.
type NetworkLoadBalancerBackend struct {
// Name of the load balancer backend
// Example: c1-http
Name string `json:"name" yaml:"name"`
// Description of the load balancer backend
// Example: C1 webserver
Description string `json:"description" yaml:"description"`
// TargetPort(s) to forward ListenPorts to (allows for many-to-one)
// Example: 80,81,8080-8090
TargetPort string `json:"target_port" yaml:"target_port"`
// TargetAddress to forward ListenPorts to
// Example: 198.51.100.2
TargetAddress string `json:"target_address" yaml:"target_address"`
}
// Normalise normalises the fields in the load balancer backend so that they are comparable with ones stored.
func (p *NetworkLoadBalancerBackend) Normalise() {
p.Description = strings.TrimSpace(p.Description)
p.TargetAddress = strings.TrimSpace(p.TargetAddress)
ip := net.ParseIP(p.TargetAddress)
if ip != nil {
p.TargetAddress = ip.String() // Replace with canonical form if specified.
}
// Remove space from TargetPort list.
subjects := strings.Split(p.TargetPort, ",")
for i, s := range subjects {
subjects[i] = strings.TrimSpace(s)
}
p.TargetPort = strings.Join(subjects, ",")
}
// NetworkLoadBalancerPort represents a port specification in a network load balancer
//
// swagger:model
//
// API extension: network_load_balancer.
type NetworkLoadBalancerPort struct {
// Description of the load balancer port
// Example: My web server load balancer
Description string `json:"description" yaml:"description"`
// Protocol for load balancer port (either tcp or udp)
// Example: tcp
Protocol string `json:"protocol" yaml:"protocol"`
// ListenPort(s) of load balancer (comma delimited ranges)
// Example: 80,81,8080-8090
ListenPort string `json:"listen_port" yaml:"listen_port"`
// TargetBackend backend names to load balance ListenPorts to
// Example: ["c1-http","c2-http"]
TargetBackend []string `json:"target_backend" yaml:"target_backend"`
}
// Normalise normalises the fields in the load balancer port so that they are comparable with ones stored.
func (p *NetworkLoadBalancerPort) Normalise() {
p.Description = strings.TrimSpace(p.Description)
p.Protocol = strings.TrimSpace(p.Protocol)
// Remove space from ListenPort list.
subjects := strings.Split(p.ListenPort, ",")
for i, s := range subjects {
subjects[i] = strings.TrimSpace(s)
}
p.ListenPort = strings.Join(subjects, ",")
}
// NetworkLoadBalancersPost represents the fields of a new network load balancer
//
// swagger:model
//
// API extension: network_load_balancer.
type NetworkLoadBalancersPost struct {
NetworkLoadBalancerPut `yaml:",inline"`
// The listen address of the load balancer
// Example: 192.0.2.1
ListenAddress string `json:"listen_address" yaml:"listen_address"`
}
// NetworkLoadBalancerPut represents the modifiable fields of a network load balancer
//
// swagger:model
//
// API extension: network_load_balancer.
type NetworkLoadBalancerPut struct {
// Description of the load balancer listen IP
// Example: My public IP load balancer
Description string `json:"description" yaml:"description"`
// Load balancer configuration map (refer to doc/network-load-balancers.md)
// Example: {"user.mykey": "foo"}
Config map[string]string `json:"config" yaml:"config"`
// Backends (optional)
Backends []NetworkLoadBalancerBackend `json:"backends" yaml:"backends"`
// Port forwards (optional)
Ports []NetworkLoadBalancerPort `json:"ports" yaml:"ports"`
}
// Normalise normalises the fields in the load balancer so that they are comparable with ones stored.
func (f *NetworkLoadBalancerPut) Normalise() {
f.Description = strings.TrimSpace(f.Description)
for i := range f.Backends {
f.Backends[i].Normalise()
}
for i := range f.Ports {
f.Ports[i].Normalise()
}
}
// NetworkLoadBalancer used for displaying a network load balancer
//
// swagger:model
//
// API extension: network_load_balancer.
type NetworkLoadBalancer struct {
NetworkLoadBalancerPut `yaml:",inline"`
// The listen address of the load balancer
// Example: 192.0.2.1
ListenAddress string `json:"listen_address" yaml:"listen_address"`
// What cluster member this record was found on
// Example: server01
Location string `json:"location" yaml:"location"`
}
// Etag returns the values used for etag generation.
func (f *NetworkLoadBalancer) Etag() []any {
return []any{f.ListenAddress, f.Description, f.Config, f.Backends, f.Ports}
}
// Writable converts a full NetworkLoadBalancer struct into a NetworkLoadBalancerPut struct (filters read-only fields).
func (f *NetworkLoadBalancer) Writable() NetworkLoadBalancerPut {
return f.NetworkLoadBalancerPut
}
// NetworkLoadBalancerState is used for showing current state of a load balancer
//
// swagger:model
//
// API extension: network_load_balancer_state.
type NetworkLoadBalancerState struct {
BackendHealth map[string]NetworkLoadBalancerStateBackendHealth `json:"backend_health" yaml:"backend_health"`
}
// NetworkLoadBalancerStateBackendHealth represents the health of a particular load-balancer backend
//
// swagger:model
//
// API extension: network_load_balancer_state.
type NetworkLoadBalancerStateBackendHealth struct {
Address string `json:"address" yaml:"address"`
Ports []NetworkLoadBalancerStateBackendHealthPort `json:"ports" yaml:"ports"`
}
// NetworkLoadBalancerStateBackendHealthPort represents the health status of a particular load-balancer backend port.
//
// swagger:model
//
// API extension: network_load_balancer_state.
type NetworkLoadBalancerStateBackendHealthPort struct {
Protocol string `json:"protocol" yaml:"protocol"`
Port int `json:"port" yaml:"port"`
Status string `json:"status" yaml:"status"`
}
|