8000 update snippet field name · nginx/kubernetes-ingress@e4fbb9e · GitHub
[go: up one dir, main page]
Skip to content

Commit e4fbb9e

Browse files
LorcanMcVeighLorcanMcVeigh
committed
update snippet field name
1 parent 6f00de0 commit e4fbb9e

File tree

7 files changed

+27
-60
lines changed

7 files changed

+27
-60
lines changed

‎deployments/common/crds-v1beta1/k8s.nginx.org_transportservers.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,14 @@ spec:
4949
type: string
5050
protocol:
5151
type: string
52+
server-snippets:
53+
type: string
5254
sessionParameters:
5355
description: SessionParameters defines session parameters.
5456
type: object
5557
properties:
5658
timeout:
5759
type: string
58-
snippets:
59-
type: string
6060
upstreamParameters:
6161
description: UpstreamParameters defines parameters for an upstream.
6262
type: object

‎deployments/common/crds/k8s.nginx.org_transportservers.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ spec:
5050
type: string
5151
protocol:
5252
type: string
53+
server-snippets:
54+
type: string
5355
sessionParameters:
5456
description: SessionParameters defines session parameters.
5557
type: object
5658
properties:
5759
timeout:
5860
type: string
59-
snippets:
60-
type: string
6161
upstreamParameters:
6262
description: UpstreamParameters defines parameters for an upstream.
6363
type: object

‎deployments/helm-chart/crds/k8s.nginx.org_transportservers.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ spec:
5050
type: string
5151
protocol:
5252
type: string
53+
server-snippets:
54+
type: string
5355
sessionParameters:
5456
description: SessionParameters defines session parameters.
5557
type: object
5658
properties:
5759
timeout:
5860
type: string
59-
snippets:
60-
type: string
6161
upstreamParameters:
6262
description: UpstreamParameters defines parameters for an upstream.
6363
type: object

‎internal/configs/configurator.go‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -557,9 +557,12 @@ func (cnf *Configurator) AddOrUpdateTransportServer(transportServerEx *Transport
557557
func (cnf *Configurator) addOrUpdateTransportServer(transportServerEx *TransportServerEx) error {
558558
name := getFileNameForTransportServer(transportServerEx.TransportServer)
559559

560-
tsCfg, _ := generateTransportServerConfig(transportServerEx, transportServerEx.ListenerPort, cnf.isPlus, cnf.staticCfgParams.EnableSnippets)
560+
tsCfg, err := generateTransportServerConfig(transportServerEx, transportServerEx.ListenerPort, cnf.isPlus, cnf.staticCfgParams.EnableSnippets)
561+
if err != nil {
562+
return fmt.Errorf("Error generating TransportServer config %v: %v", name, err)
563+
}
561564

562-
content, err := cnf.templateExecutorV2.ExecuteTransportServerTemplate(&tsCfg)
565+
content, err := cnf.templateExecutorV2.ExecuteTransportServerTemplate(tsCfg)
563566
if err != nil {
564567
return fmt.Errorf("Error generating TransportServer config %v: %v", name, err)
565568
}

‎internal/configs/transportserver.go‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ func (tsEx *TransportServerEx) String() string {
3030
}
3131

3232
// generateTransportServerConfig generates a full configuration for a TransportServer.
33-
func generateTransportServerConfig(transportServerEx *TransportServerEx, listenerPort int, isPlus bool, snippetsEnabled bool) (version2.TransportServerConfig, Warnings) {
34-
warn := newWarnings()
33+
func generateTransportServerConfig(transportServerEx *TransportServerEx, listenerPort int, isPlus bool, snippetsEnabled bool) (*version2.TransportServerConfig, error) {
3534
upstreamNamer := newUpstreamNamerForTransportServer(transportServerEx.TransportServer)
3635

3736
upstreams := generateStreamUpstreams(transportServerEx, upstreamNamer, isPlus)
@@ -60,17 +59,17 @@ func generateTransportServerConfig(transportServerEx *TransportServerEx, listene
6059
proxyTimeout = transportServerEx.TransportServer.Spec.SessionParameters.Timeout
6160
}
6261

63-
serverSnippets := generateSnippets(snippetsEnabled, transportServerEx.TransportServer.Spec.Snippets, []string{})
64-
if !snippetsEnabled && (transportServerEx.TransportServer.Spec.Snippets != "") {
65-
warn.AddWarning(transportServerEx.TransportServer, "snippet specified but snippets feature is not enabled")
62+
serverSnippets := generateSnippets(snippetsEnabled, transportServerEx.TransportServer.Spec.ServerSnippets, []string{})
63+
if !snippetsEnabled && (transportServerEx.TransportServer.Spec.ServerSnippets != "") {
64+
return nil, fmt.Errorf("snippet specified but snippets feature is not enabled")
6665
}
6766

6867
statusZone := transportServerEx.TransportServer.Spec.Listener.Name
6968
if transportServerEx.TransportServer.Spec.Listener.Name == conf_v1alpha1.TLSPassthroughListenerName {
7069
statusZone = transportServerEx.TransportServer.Spec.Host
7170
}
7271

73-
tsConfig := version2.TransportServerConfig{
72+
tsConfig := &version2.TransportServerConfig{
7473
Server: version2.StreamServer{
7574
TLSPassthrough: transportServerEx.TransportServer.Spec.Listener.Name == conf_v1alpha1.TLSPassthroughListenerName,
7675
UnixSocket: generateUnixSocket(transportServerEx),
@@ -93,7 +92,7 @@ func generateTransportServerConfig(transportServerEx *TransportServerEx, listene
9392
Upstreams: upstreams,
9493
}
9594

96-
return tsConfig, warn
95+
return tsConfig, nil
9796
}
9897

9998
func generateUnixSocket(transportServerEx *TransportServerEx) string {

‎internal/configs/transportserver_test.go‎

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func TestGenerateTransportServerConfigForTCPSnippets(t *testing.T) {
8383
Action: &conf_v1alpha1.Action{
8484
Pass: "tcp-app",
8585
},
86-
Snippets: "deny 192.168.1.1;\nallow 192.168.1.0/24;",
86+
ServerSnippets: "deny 192.168.1.1;\nallow 192.168.1.0/24;",
8787
},
8888
},
8989
Endpoints: map[string][]string{
@@ -95,7 +95,7 @@ func TestGenerateTransportServerConfigForTCPSnippets(t *testing.T) {
9595

9696
listenerPort := 2020
9797

98-
expected := version2.TransportServerConfig{
98+
expected := &version2.TransportServerConfig{
9999
Upstreams: []version2.StreamUpstream{
100100
{
101101
Name: "ts_default_tcp-server_tcp-app",
@@ -159,7 +159,7 @@ func TestGenerateTransportServerConfigForTCPSnippetsNotEnabled(t *testing.T) {
159159
Action: &conf_v1alpha1.Action{
160160
Pass: "tcp-app",
161161
},
162-
Snippets: "deny 192.168.1.1;\nallow 192.168.1.0/24;",
162+
ServerSnippets: "deny 192.168.1.1;\nallow 192.168.1.0/24;",
163163
},
164164
},
165165
Endpoints: map[string][]string{
@@ -171,44 +171,9 @@ func TestGenerateTransportServerConfigForTCPSnippetsNotEnabled(t *testing.T) {
171171

172172
listenerPort := 2020
173173

174-
expected := version2.TransportServerConfig{
175-
Upstreams: []version2.StreamUpstream{
176-
{
177-
Name: "ts_default_tcp-server_tcp-app",
178-
Servers: []version2.StreamUpstreamServer{
179-
{
180-
Address: "10.0.0.20:5001",
181-
MaxFails: 1,
182-
FailTimeout: "10s",
183-
},
184-
},
185-
UpstreamLabels: version2.UpstreamLabels{
186-
ResourceName: "tcp-server",
187-
ResourceType: "transportserver",
188-
ResourceNamespace: "default",
189-
Service: "tcp-app-svc",
190-
},
191-
},
192-
},
193-
Server: version2.StreamServer{
194-
Port: 2020,
195-
UDP: false,
196-
StatusZone: "tcp-listener",
197-
ProxyPass: "ts_default_tcp-server_tcp-app",
198-
Name: "tcp-server",
199-
Namespace: "default",
200-
ProxyConnectTimeout: "60s",
201-
ProxyNextUpstream: false,
202-
ProxyNextUpstreamTries: 0,
203-
ProxyNextUpstreamTimeout: "0s",
204-
ProxyTimeout: "10m",
205-
Snippets: []string{},
206-
},
207-
}
208-
209-
result, _ := generateTransportServerConfig(&transportServerEx, listenerPort, true, false)
210-
if diff := cmp.Diff(expected, result); diff != "" {
211-
t.Errorf("generateTransportServerConfig() mismatch (-want +got):\n%s", diff)
174+
_, err := generateTransportServerConfig(&transportServerEx, listenerPort, true, false)
175+
if err == nil {
176+
t.Errorf("generateTransportServerConfig() returned nil, expected an error when snippets used but not enabled")
212177
}
213178
}
214179

@@ -254,7 +219,7 @@ func TestGenerateTransportServerConfigForTCP(t *testing.T) {
254219

255220
listenerPort := 2020
256221

257-
expected := version2.TransportServerConfig{
222+
expected := &version2.TransportServerConfig{
258223
Upstreams: []version2.StreamUpstream{
259224
{
260225
Name: "ts_default_tcp-server_tcp-app",
@@ -337,7 +302,7 @@ func TestGenerateTransportServerConfigForTLSPasstrhough(t *testing.T) {
337302

338303
listenerPort := 2020
339304

340-
expected := version2.TransportServerConfig{
305+
expected := &version2.TransportServerConfig{
341306
Upstreams: []version2.StreamUpstream{
342307
{
343308
Name: "ts_default_tcp-server_tcp-app",
@@ -426,7 +391,7 @@ func TestGenerateTransportServerConfigForUDP(t *testing.T) {
426391

427392
listenerPort := 2020
428393

429-
expected := version2.TransportServerConfig{
394+
expected := &version2.TransportServerConfig{
430395
Upstreams: []version2.StreamUpstream{
431396
{
432397
Name: "ts_default_udp-server_udp-app",

‎pkg/apis/configuration/v1alpha1/types.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type TransportServer struct {
6262
// TransportServerSpec is the spec of the TransportServer resource.
6363
type TransportServerSpec struct {
6464
Listener TransportServerListener `json:"listener"`
65-
Snippets string `json:"snippets"`
65+
ServerSnippets string `json:"server-snippets"`
6666
Host string `json:"host"`
6767
Upstreams []Upstream `json:"upstreams"`
6868
UpstreamParameters *UpstreamParameters `json:"upstreamParameters"`

0 commit comments

Comments
 (0)
< 2A6C /main>
0