Skip to content

Commit 9287a86

Browse files
sjbermansjberman
committed
Fix naming
1 parent cbb9571 commit 9287a86

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
lines changed

‎apis/v1alpha2/nginxproxy_types.go

+11-11
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ type NginxProxySpec struct {
7272
//
7373
// +optional
7474
DisableHTTP2 *bool `json:"disableHTTP2,omitempty"`
75-
// Kubernetes contains the configuration for the nginx deployment and service Kubernetes objects.
75+
// Kubernetes contains the configuration for the NGINX Deployment and Service Kubernetes objects.
7676
//
7777
// +optional
7878
Kubernetes *KubernetesSpec `json:"kubernetes,omitempty"`
@@ -358,23 +358,23 @@ const (
358358
NginxPlusAllowIPAddressType NginxPlusAllowAddressType = "IPAddress"
359359
)
360360

361-
// KubernetesSpec contains the configuration for the nginx deployment and service Kubernetes objects.
361+
// KubernetesSpec contains the configuration for the NGINX Deployment and Service Kubernetes objects.
362362
type KubernetesSpec struct {
363-
// Deployment is the configuration for the nginx Deployment.
363+
// Deployment is the configuration for the NGINX Deployment.
364364
// This is the default deployment option.
365365
//
366366
// +optional
367367
Deployment *DeploymentSpec `json:"deployment,omitempty"`
368368

369-
// Service is the configuration for the nginx Service.
369+
// Service is the configuration for the NGINX Service.
370370
//
371371
// +optional
372372
Service *ServiceSpec `json:"service,omitempty"`
373373
}
374374

375-
// Deployment is the configuration for the nginx Deployment.
375+
// Deployment is the configuration for the NGINX Deployment.
376376
type DeploymentSpec struct {
377-
// Number of desired pods.
377+
// Number of desired Pods.
378378
//
379379
// +optional
380380
Replicas *int32 `json:"replicas,omitempty"`
@@ -384,7 +384,7 @@ type DeploymentSpec struct {
384384
// +optional
385385
Pod PodSpec `json:"pod,omitempty"`
386386

387-
// Container defines container fields for the nginx container.
387+
// Container defines container fields for the NGINX container.
388388
//
389389
// +optional
390390
Container ContainerSpec `json:"container,omitempty"`
@@ -433,9 +433,9 @@ type PodSpec struct {
433433
TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
434434
}
435435

436-
// ContainerSpec defines container fields for the nginx container.
436+
// ContainerSpec defines container fields for the NGINX container.
437437
type ContainerSpec struct {
438-
// Image is the nginx image to use.
438+
// Image is the NGINX image to use.
439439
//
440440
// +optional
441441
Image *Image `json:"image,omitempty"`
@@ -458,7 +458,7 @@ type ContainerSpec struct {
458458
VolumeMounts []corev1.VolumeMount `json:"volumeMounts,omitempty"`
459459
}
460460

461-
// Image is the nginx image to use.
461+
// Image is the NGINX image to use.
462462
type Image struct {
463463
// Repository is the image path.
464464
// Default is ghcr.io/nginx/nginx-gateway-fabric/nginx.
@@ -491,7 +491,7 @@ const (
491491
PullIfNotPresent PullPolicy = PullPolicy(corev1.PullIfNotPresent)
492492
)
493493

494-
// ServiceSpec is the configuration for the nginx Service.
494+
// ServiceSpec is the configuration for the NGINX Service.
495495
type ServiceSpec struct {
496496
// ServiceType describes ingress method for the service.
497497
//

‎config/crd/bases/gateway.nginx.org_nginxproxies.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -67,20 +67,20 @@ spec:
6767
- ipv6
6868
type: string
6969
kubernetes:
70-
description: Kubernetes contains the configuration for the nginx deployment
71-
and service Kubernetes objects.
70+
description: Kubernetes contains the configuration for the NGINX Deployment
71+
and Service Kubernetes objects.
7272
properties:
7373
deployment:
7474
description: |-
75-
Deployment is the configuration for the nginx Deployment.
75+
Deployment is the configuration for the NGINX Deployment.
7676
This is the default deployment option.
7777
properties:
7878
container:
79-
description: Container defines container fields for the nginx
79+
description: Container defines container fields for the NGINX
8080
container.
8181
properties:
8282
image:
83-
description: Image is the nginx image to use.
83+
description: Image is the NGINX image to use.
8484
properties:
8585
pullPolicy:
8686
default: IfNotPresent
@@ -3456,12 +3456,12 @@ spec:
34563456
type: array
34573457
type: object
34583458
replicas:
3459-
description: Number of desired pods.
3459+
description: Number of desired Pods.
34603460
format: int32
34613461
type: integer
34623462
type: object
34633463
service:
3464-
description: Service is the configuration for the nginx Service.
3464+
description: Service is the configuration for the NGINX Service.
34653465
properties:
34663466
annotations:
34673467
additionalProperties:

‎deploy/crds.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -652,20 +652,20 @@ spec:
652652
- ipv6
653653
type: string
654654
kubernetes:
655-
description: Kubernetes contains the configuration for the nginx deployment
656-
and service Kubernetes objects.
655+
description: Kubernetes contains the configuration for the NGINX Deployment
656+
and Service Kubernetes objects.
657657
properties:
658658
deployment:
659659
description: |-
660-
Deployment is the configuration for the nginx Deployment.
660+
Deployment is the configuration for the NGINX Deployment.
661661
This is the default deployment option.
662662
properties:
663663
container:
664-
description: Container defines container fields for the nginx
664+
description: Container defines container fields for the NGINX
665665
container.
666666
properties:
667667
image:
668-
description: Image is the nginx image to use.
668+
description: Image is the NGINX image to use.
669669
properties:
670670
pullPolicy:
671671
default: IfNotPresent
@@ -4041,12 +4041,12 @@ spec:
40414041
type: array
40424042
type: object
40434043
replicas:
4044-
description: Number of desired pods.
4044+
description: Number of desired Pods.
40454045
format: int32
40464046
type: integer
40474047
type: object
40484048
service:
4049-
description: Service is the configuration for the nginx Service.
4049+
description: Service is the configuration for the NGINX Service.
40504050
properties:
40514051
annotations:
40524052
additionalProperties:

‎site/content/reference/api.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1834,7 +1834,7 @@ KubernetesSpec
18341834
</td>
18351835
<td>
18361836
<em>(Optional)</em>
1837-
<p>Kubernetes contains the configuration for the nginx deployment and service Kubernetes objects.</p>
1837+
<p>Kubernetes contains the configuration for the NGINX Deployment and Service Kubernetes objects.</p>
18381838
</td>
18391839
</tr>
18401840
</table>
@@ -1994,7 +1994,7 @@ sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyStatus
19941994
<a href="#gateway.nginx.org/v1alpha2.DeploymentSpec">DeploymentSpec</a>)
19951995
</p>
19961996
<p>
1997-
<p>ContainerSpec defines container fields for the nginx container.</p>
1997+
<p>ContainerSpec defines container fields for the NGINX container.</p>
19981998
</p>
19991999
<table class="table table-bordered table-striped">
20002000
<thead>
@@ -2015,7 +2015,7 @@ Image
20152015
</td>
20162016
<td>
20172017
<em>(Optional)</em>
2018-
<p>Image is the nginx image to use.</p>
2018+
<p>Image is the NGINX image to use.</p>
20192019
</td>
20202020
</tr>
20212021
<tr>
@@ -2072,7 +2072,7 @@ until the action is complete, unless the container process fails, in which case
20722072
<a href="#gateway.nginx.org/v1alpha2.KubernetesSpec">KubernetesSpec</a>)
20732073
</p>
20742074
<p>
2075-
<p>Deployment is the configuration for the nginx Deployment.</p>
2075+
<p>Deployment is the configuration for the NGINX Deployment.</p>
20762076
</p>
20772077
<table class="table table-bordered table-striped">
20782078
<thead>
@@ -2091,7 +2091,7 @@ int32
20912091
</td>
20922092
<td>
20932093
<em>(Optional)</em>
2094-
<p>Number of desired pods.</p>
2094+
<p>Number of desired Pods.</p>
20952095
</td>
20962096
</tr>
20972097
<tr>
@@ -2119,7 +2119,7 @@ ContainerSpec
21192119
</td>
21202120
<td>
21212121
<em>(Optional)</em>
2122-
<p>Container defines container fields for the nginx container.</p>
2122+
<p>Container defines container fields for the NGINX container.</p>
21232123
</td>
21242124
</tr>
21252125
</tbody>
@@ -2211,7 +2211,7 @@ routing only to endpoints on the same node as the traffic was received on
22112211
<a href="#gateway.nginx.org/v1alpha2.ContainerSpec">ContainerSpec</a>)
22122212
</p>
22132213
<p>
2214-
<p>Image is the nginx image to use.</p>
2214+
<p>Image is the NGINX image to use.</p>
22152215
</p>
22162216
<table class="table table-bordered table-striped">
22172217
<thead>
@@ -2270,7 +2270,7 @@ PullPolicy
22702270
<a href="#gateway.nginx.org/v1alpha2.NginxProxySpec">NginxProxySpec</a>)
22712271
</p>
22722272
<p>
2273-
<p>KubernetesSpec contains the configuration for the nginx deployment and service Kubernetes objects.</p>
2273+
<p>KubernetesSpec contains the configuration for the NGINX Deployment and Service Kubernetes objects.</p>
22742274
</p>
22752275
<table class="table table-bordered table-striped">
22762276
<thead>
@@ -2291,7 +2291,7 @@ DeploymentSpec
22912291
</td>
22922292
<td>
22932293
<em>(Optional)</em>
2294-
<p>Deployment is the configuration for the nginx Deployment.
2294+
<p>Deployment is the configuration for the NGINX Deployment.
22952295
This is the default deployment option.</p>
22962296
</td>
22972297
</tr>
@@ -2306,7 +2306,7 @@ ServiceSpec
23062306
</td>
23072307
<td>
23082308
<em>(Optional)</em>
2309-
<p>Service is the configuration for the nginx Service.</p>
2309+
<p>Service is the configuration for the NGINX Service.</p>
23102310
</td>
23112311
</tr>
23122312
</tbody>
@@ -2681,7 +2681,7 @@ KubernetesSpec
26812681
</td>
26822682
<td>
26832683
<em>(Optional)</em>
2684-
<p>Kubernetes contains the configuration for the nginx deployment and service Kubernetes objects.</p>
2684+
<p>Kubernetes contains the configuration for the NGINX Deployment and Service Kubernetes objects.</p>
26852685
</td>
26862686
</tr>
26872687
</tbody>
@@ -3066,7 +3066,7 @@ IP address in the X-Forwarded-For HTTP header.
30663066
<a href="#gateway.nginx.org/v1alpha2.KubernetesSpec">KubernetesSpec</a>)
30673067
</p>
30683068
<p>
3069-
<p>ServiceSpec is the configuration for the nginx Service.</p>
3069+
<p>ServiceSpec is the configuration for the NGINX Service.</p>
30703070
</p>
30713071
<table class="table table-bordered table-striped">
30723072
<thead>

0 commit comments

Comments
 (0)