Skip to content

Commit 9d53cb1

Browse files
bjee19bjee19
committed
Add small feedback
1 parent 6f95494 commit 9d53cb1

File tree

5 files changed

+66
-59
lines changed

5 files changed

+66
-59
lines changed

‎charts/nginx-gateway-fabric/templates/deployment.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ spec:
104104
- --nginx-scc={{ include "nginx-gateway.scc-name" . }}-nginx
105105
{{- end}}
106106
{{- if .Values.nginx.nginxOneConsole.dataplaneKeySecretName }}
107-
- --nginx-one-console-dataplane-key-secret={{ .Values.nginx.nginxOneConsole.dataplaneKeySecretName }}
107+
- --nginx-one-dataplane-key-secret={{ .Values.nginx.nginxOneConsole.dataplaneKeySecretName }}
108108
{{- if .Values.nginx.nginxOneConsole.endpointHost }}
109-
- --nginx-one-console-telemetry-endpoint-host={{ .Values.nginx.nginxOneConsole.endpointHost }}
109+
- --nginx-one-telemetry-endpoint-host={{ .Values.nginx.nginxOneConsole.endpointHost }}
110110
{{- end }}
111111
{{- if .Values.nginx.nginxOneConsole.endpointPort }}
112-
- --nginx-one-console-telemetry-endpoint-port={{ .Values.nginx.nginxOneConsole.endpointPort }}
112+
- --nginx-one-telemetry-endpoint-port={{ .Values.nginx.nginxOneConsole.endpointPort }}
113113
{{- end }}
114114
{{- if .Values.nginx.nginxOneConsole.tlsSkipVerify }}
115-
- --nginx-one-console-tls-skip-verify
115+
- --nginx-one-tls-skip-verify
116116
{{- end }}
117117
{{- end }}
118118
env:

‎charts/nginx-gateway-fabric/values.schema.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,8 @@
465465
"endpointPort": {
466466
"default": 443,
467467
"description": "The endpoint port that the NGINX One Console telemetry metrics will be sent to.",
468+
"maximum": 65535,
469+
"minimum": 1,
468470
"required": [],
469471
"title": "endpointPort",
470472
"type": "integer"

‎charts/nginx-gateway-fabric/values.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,11 @@ nginx:
222222
# -- The Endpoint host that the NGINX One Console telemetry metrics will be sent to.
223223
endpointHost: "agent.connect.nginx.com"
224224

225+
# @schema
226+
# type: integer
227+
# minimum: 1
228+
# maximum: 65535
229+
# @schema
225230
# -- The endpoint port that the NGINX One Console telemetry metrics will be sent to.
226231
endpointPort: 443
227232

‎cmd/gateway/commands.go‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -57,31 +57,31 @@ func createRootCommand() *cobra.Command {
5757
func createControllerCommand() *cobra.Command {
5858
// flag names
5959
const (
60-
configFlag = "config"
61-
serviceFlag = "service"
62-
agentTLSSecretFlag = "agent-tls-secret"
63-
nginxOneConsoleDataplaneKeySecretFlag = "nginx-one-console-dataplane-key-secret" //nolint:gosec // not credentials
64-
nginxOneConsoleTelemetryEndpointHostFlag = "nginx-one-console-telemetry-endpoint-host"
65-
nginxOneConsoleTelemetryEndpointPortFlag = "nginx-one-console-telemetry-endpoint-port"
66-
nginxOneConsoleTLSSkipVerifyFlag = "nginx-one-console-tls-skip-verify"
67-
metricsDisableFlag = "metrics-disable"
68-
metricsSecureFlag = "metrics-secure-serving"
69-
metricsPortFlag = "metrics-port"
70-
healthDisableFlag = "health-disable"
71-
healthPortFlag = "health-port"
72-
leaderElectionDisableFlag = "leader-election-disable"
73-
leaderElectionLockNameFlag = "leader-election-lock-name"
74-
productTelemetryDisableFlag = "product-telemetry-disable"
75-
gwAPIExperimentalFlag = "gateway-api-experimental-features"
76-
nginxDockerSecretFlag = "nginx-docker-secret" //nolint:gosec // not credentials
77-
usageReportSecretFlag = "usage-report-secret"
78-
usageReportEndpointFlag = "usage-report-endpoint"
79-
usageReportResolverFlag = "usage-report-resolver"
80-
usageReportSkipVerifyFlag = "usage-report-skip-verify"
81-
usageReportClientSSLSecretFlag = "usage-report-client-ssl-secret" //nolint:gosec // not credentials
82-
usageReportCASecretFlag = "usage-report-ca-secret" //nolint:gosec // not credentials
83-
snippetsFiltersFlag = "snippets-filters"
84-
nginxSCCFlag = "nginx-scc"
60+
configFlag = "config"
61+
serviceFlag = "service"
62+
agentTLSSecretFlag = "agent-tls-secret"
63+
nginxOneDataplaneKeySecretFlag = "nginx-one-dataplane-key-secret" //nolint:gosec // not credentials
64+
nginxOneTelemetryEndpointHostFlag = "nginx-one-telemetry-endpoint-host"
65+
nginxOneTelemetryEndpointPortFlag = "nginx-one-telemetry-endpoint-port"
66+
nginxOneTLSSkipVerifyFlag = "nginx-one-tls-skip-verify"
67+
metricsDisableFlag = "metrics-disable"
68+
metricsSecureFlag = "metrics-secure-serving"
69+
metricsPortFlag = "metrics-port"
70+
healthDisableFlag = "health-disable"
71+
healthPortFlag = "health-port"
72+
leaderElectionDisableFlag = "leader-election-disable"
73+
leaderElectionLockNameFlag = "leader-election-lock-name"
74+
productTelemetryDisableFlag = "product-telemetry-disable"
75+
gwAPIExperimentalFlag = "gateway-api-experimental-features"
76+
nginxDockerSecretFlag = "nginx-docker-secret" //nolint:gosec // not credentials
77+
usageReportSecretFlag = "usage-report-secret"
78+
usageReportEndpointFlag = "usage-report-endpoint"
79+
usageReportResolverFlag = "usage-report-resolver"
80+
usageReportSkipVerifyFlag = "usage-report-skip-verify"
81+
usageReportClientSSLSecretFlag = "usage-report-client-ssl-secret" //nolint:gosec // not credentials
82+
usageReportCASecretFlag = "usage-report-ca-secret" //nolint:gosec // not credentials
83+
snippetsFiltersFlag = "snippets-filters"
84+
nginxSCCFlag = "nginx-scc"
8585
)
8686

8787
// flag values
@@ -327,26 +327,26 @@ func createControllerCommand() *cobra.Command {
327327

328328
cmd.Flags().Var(
329329
&nginxOneConsoleDataplaneKeySecretName,
330-
nginxOneConsoleDataplaneKeySecretFlag,
330+
nginxOneDataplaneKeySecretFlag,
331331
`The name of the Secret containing the NGINX One Console's dataplane key. Must exist in the same namespace that `+
332332
`the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway).`,
333333
)
334334

335335
cmd.Flags().Var(
336336
&nginxOneConsoleTelemetryEndpointHost,
337-
nginxOneConsoleTelemetryEndpointHostFlag,
337+
nginxOneTelemetryEndpointHostFlag,
338338
`The host of the NGINX One Console's telemetry endpoint.`,
339339
)
340340

341341
cmd.Flags().Var(
342342
&nginxOneConsoleTelemetryEndpointPort,
343-
nginxOneConsoleTelemetryEndpointPortFlag,
343+
nginxOneTelemetryEndpointPortFlag,
344344
`The port of the NGINX One Console's telemetry endpoint.`,
345345
)
346346

347347
cmd.Flags().BoolVar(
348348
&nginxOneConsoleTLSSkipVerify,
349-
nginxOneConsoleTLSSkipVerifyFlag,
349+
nginxOneTLSSkipVerifyFlag,
350350
false,
351351
"Disable client verification of the NGINX One Console's telemetry endpoint server certificate.",
352352
)

‎cmd/gateway/commands_test.go‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,10 @@ func TestControllerCmdFlagValidation(t *testing.T) {
156156
"--usage-report-client-ssl-secret=client-secret",
157157
"--snippets-filters",
158158
"--nginx-scc=nginx-sscc-name",
159-
"--nginx-one-console-dataplane-key-secret=dataplane-key-secret",
160-
"--nginx-one-console-telemetry-endpoint-host=telemetry-endpoint-host",
161-
"--nginx-one-console-telemetry-endpoint-port=443",
162-
"--nginx-one-console-tls-skip-verify",
159+
"--nginx-one-dataplane-key-secret=dataplane-key-secret",
160+
"--nginx-one-telemetry-endpoint-host=telemetry-endpoint-host",
161+
"--nginx-one-telemetry-endpoint-port=443",
162+
"--nginx-one-tls-skip-verify",
163163
},
164164
wantErr: false,
165165
},
@@ -431,62 +431,62 @@ func TestControllerCmdFlagValidation(t *testing.T) {
431431
expectedErrPrefix: `invalid argument "!@#$" for "--nginx-scc" flag: invalid format: `,
432432
},
433433
{
434-
name: "nginx-one-console-dataplane-key-secret is set to empty string",
434+
name: "nginx-one-dataplane-key-secret is set to empty string",
435435
args: []string{
436-
"--nginx-one-console-dataplane-key-secret=",
436+
"--nginx-one-dataplane-key-secret=",
437437
},
438438
wantErr: true,
439-
expectedErrPrefix: `invalid argument "" for "--nginx-one-console-dataplane-key-secret" flag: must be set`,
439+
expectedErrPrefix: `invalid argument "" for "--nginx-one-dataplane-key-secret" flag: must be set`,
440440
},
441441
{
442-
name: "nginx-one-console-dataplane-key-secret is invalid",
442+
name: "nginx-one-dataplane-key-secret is invalid",
443443
args: []string{
444-
"--nginx-one-console-dataplane-key-secret=!@#$",
444+
"--nginx-one-dataplane-key-secret=!@#$",
445445
},
446446
wantErr: true,
447-
expectedErrPrefix: `invalid argument "!@#$" for "--nginx-one-console-dataplane-key-secret" flag: invalid format: `,
447+
expectedErrPrefix: `invalid argument "!@#$" for "--nginx-one-dataplane-key-secret" flag: invalid format: `,
448448
},
449449
{
450-
name: "nginx-one-console-telemetry-endpoint-host is set to empty string",
450+
name: "nginx-one-telemetry-endpoint-host is set to empty string",
451451
args: []string{
452-
"--nginx-one-console-telemetry-endpoint-host=",
452+
"--nginx-one-telemetry-endpoint-host=",
453453
},
454454
wantErr: true,
455-
expectedErrPrefix: `invalid argument "" for "--nginx-one-console-telemetry-endpoint-host" flag: must be set`,
455+
expectedErrPrefix: `invalid argument "" for "--nginx-one-telemetry-endpoint-host" flag: must be set`,
456456
},
457457
{
458-
name: "nginx-one-console-telemetry-endpoint-host is invalid",
458+
name: "nginx-one-telemetry-endpoint-host is invalid",
459459
args: []string{
460-
"--nginx-one-console-telemetry-endpoint-host=!@#$",
460+
"--nginx-one-telemetry-endpoint-host=!@#$",
461461
},
462462
wantErr: true,
463-
expectedErrPrefix: `invalid argument "!@#$" for "--nginx-one-console-telemetry-endpoint-host" ` +
463+
expectedErrPrefix: `invalid argument "!@#$" for "--nginx-one-telemetry-endpoint-host" ` +
464464
`flag: invalid format: `,
465465
},
466466
{
467-
name: "nginx-one-console-telemetry-endpoint-port is invalid type",
467+
name: "nginx-one-telemetry-endpoint-port is invalid type",
468468
args: []string{
469-
"--nginx-one-console-telemetry-endpoint-port=invalid", // not an int
469+
"--nginx-one-telemetry-endpoint-port=invalid", // not an int
470470
},
471471
wantErr: true,
472-
expectedErrPrefix: `invalid argument "invalid" for "--nginx-one-console-telemetry-endpoint-port" ` +
472+
expectedErrPrefix: `invalid argument "invalid" for "--nginx-one-telemetry-endpoint-port" ` +
473473
`flag: failed to parse int value: strconv.ParseInt: parsing "invalid": invalid syntax`,
474474
},
475475
{
476-
name: "nginx-one-console-telemetry-endpoint-port is outside of range",
476+
name: "nginx-one-telemetry-endpoint-port is outside of range",
477477
args: []string{
478-
"--nginx-one-console-telemetry-endpoint-port=65536", // outside of range
478+
"--nginx-one-telemetry-endpoint-port=65536", // outside of range
479479
},
480480
wantErr: true,
481-
expectedErrPrefix: `invalid argument "65536" for "--nginx-one-console-telemetry-endpoint-port" flag:` +
481+
expectedErrPrefix: `invalid argument "65536" for "--nginx-one-telemetry-endpoint-port" flag:` +
482482
` port outside of valid port range [1 - 65535]: 65536`,
483483
},
484484
{
485-
name: "nginx-one-console-tls-skip-verify is not a bool",
486-
expectedErrPrefix: `invalid argument "not-a-bool" for "--nginx-one-console-tls-skip-verify" flag:` +
487-
`strconv.ParseBool: parsing "not-a-bool": invalid syntax`,
485+
name: "nginx-one-tls-skip-verify is not a bool",
486+
expectedErrPrefix: `invalid argument "not-a-bool" for "--nginx-one-tls-skip-verify" flag:` +
487+
` strconv.ParseBool: parsing "not-a-bool": invalid syntax`,
488488
args: []string{
489-
"--nginx-one-console-tls-skip-verify=not-a-bool",
489+
"--nginx-one-tls-skip-verify=not-a-bool",
490490
},
491491
wantErr: true,
492492
},

0 commit comments

Comments
 (0)