Skip to content

Commit 0db6f2b

Browse files
committed
Fix IngressClassParams doc instead
1 parent df33c88 commit 0db6f2b

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

apis/elbv2/v1beta1/ingressclassparams_types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ type IngressClassParamsSpec struct {
172172
// +optional
173173
IPAMConfiguration *IPAMConfiguration `json:"ipamConfiguration,omitempty"`
174174

175-
// PrefixListIDs defines the security group prefix lists for all Ingresses that belong to IngressClass with this IngressClassParams.
176-
PrefixListIDs []string `json:"PrefixListIDs,omitempty"`
175+
// PrefixListsIDs defines the security group prefix lists for all Ingresses that belong to IngressClass with this IngressClassParams.
176+
PrefixListsIDs []string `json:"PrefixListsIDs,omitempty"`
177177
}
178178

179179
// +kubebuilder:object:root=true

apis/elbv2/v1beta1/zz_generated.deepcopy.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

config/crd/bases/elbv2.k8s.aws_ingressclassparams.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ spec:
5555
spec:
5656
description: IngressClassParamsSpec defines the desired state of IngressClassParams
5757
properties:
58-
PrefixListIDs:
59-
description: PrefixListIDs defines the security group prefix lists
58+
PrefixListsIDs:
59+
description: PrefixListsIDs defines the security group prefix lists
6060
for all Ingresses that belong to IngressClass with this IngressClassParams.
6161
items:
6262
type: string

docs/guide/ingress/ingress_class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,11 +275,11 @@ The IPAM pool you choose will be the preferred source of public IPv4 addresses.
275275
If the pool is depleted, IPv4 addresses will be assigned by AWS.
276276
To remove the IPAM pool from your ALB, remove `spec.ipv4IPAMPoolId` from the IngressClass definition.
277277

278-
#### spec.prefixListIDs
278+
#### spec.PrefixListsIDs
279279

280-
`prefixListIDs` is an optional setting.
280+
`PrefixListsIDs` is an optional setting.
281281

282-
Cluster administrators can use `prefixListIDs` field to specify the managed prefix lists that are allowed to access the load balancers that belong to this IngressClass. You can specify the list of prefix list IDs in the `spec.prefixListIDs` field.
282+
Cluster administrators can use `PrefixListsIDs` field to specify the managed prefix lists that are allowed to access the load balancers that belong to this IngressClass. You can specify the list of prefix list IDs in the `spec.PrefixListsIDs` field.
283283

284-
1. If `prefixListIDs` is set, the prefix lists defined will be applied to the load balancer that belong to this IngressClass. If you specify invalid prefix list IDs, the controller will fail to reconcile ingresses belonging to the particular ingress class.
285-
2. If `prefixListIDs` un-specified, Ingresses with this IngressClass can continue to use `alb.ingress.kubernetes.io/security-group-prefix-lists` annotation to specify the load balancer prefix lists.
284+
1. If `PrefixListsIDs` is set, the prefix lists defined will be applied to the load balancer that belong to this IngressClass. If you specify invalid prefix list IDs, the controller will fail to reconcile ingresses belonging to the particular ingress class.
285+
2. If `PrefixListsIDs` un-specified, Ingresses with this IngressClass can continue to use `alb.ingress.kubernetes.io/security-group-prefix-lists` annotation to specify the load balancer prefix lists.

helm/aws-load-balancer-controller/crds/crds.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ spec:
5454
spec:
5555
description: IngressClassParamsSpec defines the desired state of IngressClassParams
5656
properties:
57-
prefixListIDs:
58-
description: PrefixListIDs defines the security group prefix lists
57+
PrefixListsIDs:
58+
description: PrefixListsIDs defines the security group prefix lists
5959
for all Ingresses that belong to IngressClass with this IngressClassParams.
6060
items:
6161
type: string

pkg/ingress/model_build_listener.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ func (t *defaultModelBuildTask) computeIngressExplicitSSLPolicy(_ context.Contex
279279
}
280280

281281
func (t *defaultModelBuildTask) computeIngressExplicitPrefixListIDs(_ context.Context, ing *ClassifiedIngress) []string {
282-
if ing.IngClassConfig.IngClassParams != nil && len(ing.IngClassConfig.IngClassParams.Spec.PrefixListIDs) != 0 {
283-
return ing.IngClassConfig.IngClassParams.Spec.PrefixListIDs
282+
if ing.IngClassConfig.IngClassParams != nil && len(ing.IngClassConfig.IngClassParams.Spec.PrefixListsIDs) != 0 {
283+
return ing.IngClassConfig.IngClassParams.Spec.PrefixListsIDs
284284
}
285285
var prefixListIDs []string
286286
t.annotationParser.ParseStringSliceAnnotation(annotations.IngressSuffixSecurityGroupPrefixLists, &prefixListIDs, ing.Ing.Annotations)

pkg/ingress/model_builder_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4022,7 +4022,7 @@ func Test_defaultModelBuilder_Build(t *testing.T) {
40224022
IngClassConfig: ClassConfiguration{
40234023
IngClassParams: &v1beta1.IngressClassParams{
40244024
Spec: v1beta1.IngressClassParamsSpec{
4025-
PrefixListIDs: []string{
4025+
PrefixListsIDs: []string{
40264026
"pl-11111111",
40274027
"pl-22222222",
40284028
},

0 commit comments

Comments
 (0)