Skip to content

Commit e20862c

Browse files
sjbermansjberman
committed
Fix naming again
1 parent 9287a86 commit e20862c

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

‎apis/v1alpha2/nginxproxy_types.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ type PodSpec struct {
415415
// +optional
416416
NodeSelector map[string]string `json:"nodeSelector,omitempty"`
417417

418-
// Tolerations allow the scheduler to schedule pods with matching taints.
418+
// Tolerations allow the scheduler to schedule Pods with matching taints.
419419
//
420420
// +optional
421421
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
@@ -425,8 +425,8 @@ type PodSpec struct {
425425
// +optional
426426
Volumes []corev1.Volume `json:"volumes,omitempty"`
427427

428-
// TopologySpreadConstraints describes how a group of pods ought to spread across topology
429-
// domains. Scheduler will schedule pods in a way which abides by the constraints.
428+
// TopologySpreadConstraints describes how a group of Pods ought to spread across topology
429+
// domains. Scheduler will schedule Pods in a way which abides by the constraints.
430430
// All topologySpreadConstraints are ANDed.
431431
//
432432
// +optional
@@ -493,7 +493,7 @@ const (
493493

494494
// ServiceSpec is the configuration for the NGINX Service.
495495
type ServiceSpec struct {
496-
// ServiceType describes ingress method for the service.
496+
// ServiceType describes ingress method for the Service.
497497
//
498498
// +optional
499499
// +kubebuilder:default:=LoadBalancer
@@ -524,20 +524,20 @@ type ServiceSpec struct {
524524
LoadBalancerSourceRanges []string `json:"loadBalancerSourceRanges,omitempty"`
525525
}
526526

527-
// ServiceType describes ingress method for the service.
527+
// ServiceType describes ingress method for the Service.
528528
// +kubebuilder:validation:Enum=ClusterIP;LoadBalancer;NodePort
529529
type ServiceType corev1.ServiceType
530530

531531
const (
532-
// ServiceTypeClusterIP means a service will only be accessible inside the
532+
// ServiceTypeClusterIP means a Service will only be accessible inside the
533533
// cluster, via the cluster IP.
534534
ServiceTypeClusterIP ServiceType = ServiceType(corev1.ServiceTypeClusterIP)
535535

536-
// ServiceTypeNodePort means a service will be exposed on one port of
536+
// ServiceTypeNodePort means a Service will be exposed on one port of
537537
// every node, in addition to 'ClusterIP' type.
538538
ServiceTypeNodePort ServiceType = ServiceType(corev1.ServiceTypeNodePort)
539539

540-
// ServiceTypeLoadBalancer means a service will be exposed via an
540+
// ServiceTypeLoadBalancer means a Service will be exposed via an
541541
// external load balancer (if the cloud provider supports it), in addition
542542
// to 'NodePort' type.
543543
ServiceTypeLoadBalancer ServiceType = ServiceType(corev1.ServiceTypeLoadBalancer)

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -1416,7 +1416,7 @@ spec:
14161416
type: integer
14171417
tolerations:
14181418
description: Tolerations allow the scheduler to schedule
1419-
pods with matching taints.
1419+
Pods with matching taints.
14201420
items:
14211421
description: |-
14221422
The pod this Toleration is attached to tolerates any taint that matches
@@ -1456,8 +1456,8 @@ spec:
14561456
type: array
14571457
topologySpreadConstraints:
14581458
description: |-
1459-
TopologySpreadConstraints describes how a group of pods ought to spread across topology
1460-
domains. Scheduler will schedule pods in a way which abides by the constraints.
1459+
TopologySpreadConstraints describes how a group of Pods ought to spread across topology
1460+
domains. Scheduler will schedule Pods in a way which abides by the constraints.
14611461
All topologySpreadConstraints are ANDed.
14621462
items:
14631463
description: TopologySpreadConstraint specifies how
@@ -3492,7 +3492,7 @@ spec:
34923492
type:
34933493
default: LoadBalancer
34943494
description: ServiceType describes ingress method for the
3495-
service.
3495+
Service.
34963496
enum:
34973497
- ClusterIP
34983498
- LoadBalancer

‎deploy/crds.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -2001,7 +2001,7 @@ spec:
20012001
type: integer
20022002
tolerations:
20032003
description: Tolerations allow the scheduler to schedule
2004-
pods with matching taints.
2004+
Pods with matching taints.
20052005
items:
20062006
description: |-
20072007
The pod this Toleration is attached to tolerates any taint that matches
@@ -2041,8 +2041,8 @@ spec:
20412041
type: array
20422042
topologySpreadConstraints:
20432043
description: |-
2044-
TopologySpreadConstraints describes how a group of pods ought to spread across topology
2045-
domains. Scheduler will schedule pods in a way which abides by the constraints.
2044+
TopologySpreadConstraints describes how a group of Pods ought to spread across topology
2045+
domains. Scheduler will schedule Pods in a way which abides by the constraints.
20462046
All topologySpreadConstraints are ANDed.
20472047
items:
20482048
description: TopologySpreadConstraint specifies how
@@ -4077,7 +4077,7 @@ spec:
40774077
type:
40784078
default: LoadBalancer
40794079
description: ServiceType describes ingress method for the
4080-
service.
4080+
Service.
40814081
enum:
40824082
- ClusterIP
40834083
- LoadBalancer

‎site/content/reference/api.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2812,7 +2812,7 @@ Selector which must match a node’s labels for the pod to be scheduled on t
28122812
</td>
28132813
<td>
28142814
<em>(Optional)</em>
2815-
<p>Tolerations allow the scheduler to schedule pods with matching taints.</p>
2815+
<p>Tolerations allow the scheduler to schedule Pods with matching taints.</p>
28162816
</td>
28172817
</tr>
28182818
<tr>
@@ -2840,8 +2840,8 @@ Selector which must match a node&rsquo;s labels for the pod to be scheduled on t
28402840
</td>
28412841
<td>
28422842
<em>(Optional)</em>
2843-
<p>TopologySpreadConstraints describes how a group of pods ought to spread across topology
2844-
domains. Scheduler will schedule pods in a way which abides by the constraints.
2843+
<p>TopologySpreadConstraints describes how a group of Pods ought to spread across topology
2844+
domains. Scheduler will schedule Pods in a way which abides by the constraints.
28452845
All topologySpreadConstraints are ANDed.</p>
28462846
</td>
28472847
</tr>
@@ -3087,7 +3087,7 @@ ServiceType
30873087
</td>
30883088
<td>
30893089
<em>(Optional)</em>
3090-
<p>ServiceType describes ingress method for the service.</p>
3090+
<p>ServiceType describes ingress method for the Service.</p>
30913091
</td>
30923092
</tr>
30933093
<tr>
@@ -3153,7 +3153,7 @@ Requires service type to be LoadBalancer.</p>
31533153
<a href="#gateway.nginx.org/v1alpha2.ServiceSpec">ServiceSpec</a>)
31543154
</p>
31553155
<p>
3156-
<p>ServiceType describes ingress method for the service.</p>
3156+
<p>ServiceType describes ingress method for the Service.</p>
31573157
</p>
31583158
<table class="table table-bordered table-striped">
31593159
<thead>
@@ -3163,16 +3163,16 @@ Requires service type to be LoadBalancer.</p>
31633163
</tr>
31643164
</thead>
31653165
<tbody><tr><td><p>&#34;ClusterIP&#34;</p></td>
3166-
<td><p>ServiceTypeClusterIP means a service will only be accessible inside the
3166+
<td><p>ServiceTypeClusterIP means a Service will only be accessible inside the
31673167
cluster, via the cluster IP.</p>
31683168
</td>
31693169
</tr><tr><td><p>&#34;LoadBalancer&#34;</p></td>
3170-
<td><p>ServiceTypeLoadBalancer means a service will be exposed via an
3170+
<td><p>ServiceTypeLoadBalancer means a Service will be exposed via an
31713171
external load balancer (if the cloud provider supports it), in addition
31723172
to &lsquo;NodePort&rsquo; type.</p>
31733173
</td>
31743174
</tr><tr><td><p>&#34;NodePort&#34;</p></td>
3175-
<td><p>ServiceTypeNodePort means a service will be exposed on one port of
3175+
<td><p>ServiceTypeNodePort means a Service will be exposed on one port of
31763176
every node, in addition to &lsquo;ClusterIP&rsquo; type.</p>
31773177
</td>
31783178
</tr></tbody>

0 commit comments

Comments
 (0)