Skip to content

Commit 1e11e57

Browse files
stevekuznetsovstevekuznetsov
committed
*: clarify the defaults for identity references
Signed-off-by: Steve Kuznetsov <[email protected]>
1 parent 71d5769 commit 1e11e57

9 files changed

+37
-18
lines changed

‎api/v1beta1/awscluster_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,10 @@ type AWSClusterSpec struct {
8787
// +optional
8888
Bastion Bastion `json:"bastion"`
8989

90-
// IdentityRef is a reference to a identity to be used when reconciling this cluster
9190
// +optional
91+
92+
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
93+
// If no identity is specified, the default identity for this controller will be used.
9294
IdentityRef *AWSIdentityReference `json:"identityRef,omitempty"`
9395

9496
// S3Bucket contains options to configure a supporting S3 bucket for this

‎api/v1beta2/awscluster_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,10 @@ type AWSClusterSpec struct {
9191
// +optional
9292
Bastion Bastion `json:"bastion"`
9393

94-
// IdentityRef is a reference to a identity to be used when reconciling this cluster
9594
// +optional
95+
96+
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
97+
// If no identity is specified, the default identity for this controller will be used.
9698
IdentityRef *AWSIdentityReference `json:"identityRef,omitempty"`
9799

98100
// S3Bucket contains options to configure a supporting S3 bucket for this

‎config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanes.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,9 @@ spec:
258258
type: array
259259
type: object
260260
identityRef:
261-
description: IdentityRef is a reference to a identity to be used when
262-
reconciling the managed control plane.
261+
description: IdentityRef is a reference to an identity to be used
262+
when reconciling the managed control plane. If no identity is specified,
263+
the default identity for this controller will be used.
263264
properties:
264265
kind:
265266
description: Kind of the identity.
@@ -1887,8 +1888,9 @@ spec:
18871888
type: array
18881889
type: object
18891890
identityRef:
1890-
description: IdentityRef is a reference to a identity to be used when
1891-
reconciling the managed control plane.
1891+
description: IdentityRef is a reference to an identity to be used
1892+
when reconciling the managed control plane. If no identity is specified,
1893+
the default identity for this controller will be used.
18921894
properties:
18931895
kind:
18941896
description: Kind of the identity.

‎config/crd/bases/controlplane.cluster.x-k8s.io_rosacontrolplanes.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ spec:
8080
x-kubernetes-map-type: atomic
8181
identityRef:
8282
description: IdentityRef is a reference to an identity to be used
83-
when reconciling the managed control plane.
83+
when reconciling the managed control plane. If no identity is specified,
84+
the default identity for this controller will be used.
8485
properties:
8586
kind:
8687
description: Kind of the identity.

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsclusters.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,9 @@ spec:
167167
type: array
168168
type: object
169169
identityRef:
170-
description: IdentityRef is a reference to a identity to be used when
171-
reconciling this cluster
170+
description: IdentityRef is a reference to an identity to be used
171+
when reconciling the managed control plane. If no identity is specified,
172+
the default identity for this controller will be used.
172173
properties:
173174
kind:
174175
description: Kind of the identity.
@@ -1141,8 +1142,9 @@ spec:
11411142
type: array
11421143
type: object
11431144
identityRef:
1144-
description: IdentityRef is a reference to a identity to be used when
1145-
reconciling this cluster
1145+
description: IdentityRef is a reference to an identity to be used
1146+
when reconciling the managed control plane. If no identity is specified,
1147+
the default identity for this controller will be used.
11461148
properties:
11471149
kind:
11481150
description: Kind of the identity.

‎config/crd/bases/infrastructure.cluster.x-k8s.io_awsclustertemplates.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,10 @@ spec:
183183
type: array
184184
type: object
185185
identityRef:
186-
description: IdentityRef is a reference to a identity to be
187-
used when reconciling this cluster
186+
description: IdentityRef is a reference to an identity to
187+
be used when reconciling the managed control plane. If no
188+
identity is specified, the default identity for this controller
189+
will be used.
188190
properties:
189191
kind:
190192
description: Kind of the identity.
@@ -741,8 +743,10 @@ spec:
741743
type: array
742744
type: object
743745
identityRef:
744-
description: IdentityRef is a reference to a identity to be
745-
used when reconciling this cluster
746+
description: IdentityRef is a reference to an identity to
747+
be used when reconciling the managed control plane. If no
748+
identity is specified, the default identity for this controller
749+
will be used.
746750
properties:
747751
kind:
748752
description: Kind of the identity.

‎controlplane/eks/api/v1beta1/awsmanagedcontrolplane_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ type AWSManagedControlPlaneSpec struct { //nolint: maligned
4040
// +optional
4141
EKSClusterName string `json:"eksClusterName,omitempty"`
4242

43-
// IdentityRef is a reference to a identity to be used when reconciling the managed control plane.
4443
// +optional
44+
45+
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
46+
// If no identity is specified, the default identity for this controller will be used.
4547
IdentityRef *infrav1.AWSIdentityReference `json:"identityRef,omitempty"`
4648

4749
// NetworkSpec encapsulates all things related to AWS network.

‎controlplane/eks/api/v1beta2/awsmanagedcontrolplane_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ type AWSManagedControlPlaneSpec struct { //nolint: maligned
4040
// +optional
4141
EKSClusterName string `json:"eksClusterName,omitempty"`
4242

43-
// IdentityRef is a reference to a identity to be used when reconciling the managed control plane.
4443
// +optional
44+
45+
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
46+
// If no identity is specified, the default identity for this controller will be used.
4547
IdentityRef *infrav1.AWSIdentityReference `json:"identityRef,omitempty"`
4648

4749
// NetworkSpec encapsulates all things related to AWS network.

‎controlplane/rosa/api/v1beta2/rosacontrolplane_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,10 @@ type RosaControlPlaneSpec struct { //nolint: maligned
7676
// +optional
7777
CredentialsSecretRef *corev1.LocalObjectReference `json:"credentialsSecretRef,omitempty"`
7878

79-
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
8079
// +optional
80+
81+
// IdentityRef is a reference to an identity to be used when reconciling the managed control plane.
82+
// If no identity is specified, the default identity for this controller will be used.
8183
IdentityRef *infrav1.AWSIdentityReference `json:"identityRef,omitempty"`
8284
}
8385

0 commit comments

Comments
 (0)