Skip to content

Commit 3cfd80f

Browse files
committed
update comments
1 parent 50e518a commit 3cfd80f

10 files changed

+11
-17
lines changed

Diff for: api/configuration/v1/kongconsumer_types.go

-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ import (
3434
// +kubebuilder:printcolumn:name="Programmed",type=string,JSONPath=`.status.conditions[?(@.type=="Programmed")].status`
3535
// +kubebuilder:validation:XValidation:rule="has(self.username) || has(self.custom_id)", message="Need to provide either username or custom_id"
3636
// +kubebuilder:validation:XValidation:rule="!has(oldSelf.spec.controlPlaneRef) || has(self.spec.controlPlaneRef)", message="controlPlaneRef is required once set"
37-
// REVIEW: allow same namespace?
3837
// +kubebuilder:validation:XValidation:rule="!has(self.spec.controlPlaneRef.konnectNamespacedRef) ? true : !has(self.spec.controlPlaneRef.konnectNamespacedRef.__namespace__)", message="spec.controlPlaneRef cannot specify namespace for namespaced resource"
3938
// +kubebuilder:validation:XValidation:rule="(!has(self.status) || !self.status.conditions.exists(c, c.type == 'Programmed' && c.status == 'True')) ? true : oldSelf.spec.controlPlaneRef == self.spec.controlPlaneRef", message="spec.controlPlaneRef is immutable when an entity is already Programmed"
4039

Diff for: api/configuration/v1alpha1/konnect_controlplaneref_types.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,10 @@ type KonnectNamespacedRef struct {
4141

4242
// TODO: Implement cross namespace references:
4343
// https://github.com/Kong/kubernetes-configuration/issues/36
44-
// Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
44+
4545
// Namespace is the namespace where the Konnect Control Plane is in.
46+
// Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
47+
//
4648
// +optional
4749
Namespace string `json:"namespace,omitempty"`
4850
}

Diff for: config/crd/bases/configuration.konghq.com_kongcacertificates.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,8 @@ spec:
6969
type: string
7070
namespace:
7171
description: |-
72-
https://github.com/Kong/kubernetes-configuration/issues/36
73-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7472
Namespace is the namespace where the Konnect Control Plane is in.
73+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7574
type: string
7675
required:
7776
- name

Diff for: config/crd/bases/configuration.konghq.com_kongconsumergroups.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,8 @@ spec:
7070
type: string
7171
namespace:
7272
description: |-
73-
https://github.com/Kong/kubernetes-configuration/issues/36
74-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7573
Namespace is the namespace where the Konnect Control Plane is in.
74+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7675
type: string
7776
required:
7877
- name

Diff for: config/crd/bases/configuration.konghq.com_kongconsumers.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,8 @@ spec:
9595
type: string
9696
namespace:
9797
description: |-
98-
https://github.com/Kong/kubernetes-configuration/issues/36
99-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
10098
Namespace is the namespace where the Konnect Control Plane is in.
99+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
101100
type: string
102101
required:
103102
- name

Diff for: config/crd/bases/configuration.konghq.com_kongpluginbindings.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,8 @@ spec:
7373
type: string
7474
namespace:
7575
description: |-
76-
https://github.com/Kong/kubernetes-configuration/issues/36
77-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7876
Namespace is the namespace where the Konnect Control Plane is in.
77+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
7978
type: string
8079
required:
8180
- name

Diff for: config/crd/bases/configuration.konghq.com_kongservices.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ spec:
7878
type: string
7979
namespace:
8080
description: |-
81-
https://github.com/Kong/kubernetes-configuration/issues/36
82-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
8381
Namespace is the namespace where the Konnect Control Plane is in.
82+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
8483
type: string
8584
required:
8685
- name

Diff for: config/crd/bases/configuration.konghq.com_kongupstreams.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,8 @@ spec:
7575
type: string
7676
namespace:
7777
description: |-
78-
https://github.com/Kong/kubernetes-configuration/issues/36
79-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
8078
Namespace is the namespace where the Konnect Control Plane is in.
79+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
8180
type: string
8281
required:
8382
- name

Diff for: config/crd/bases/configuration.konghq.com_kongvaults.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,8 @@ spec:
9898
type: string
9999
namespace:
100100
description: |-
101-
https://github.com/Kong/kubernetes-configuration/issues/36
102-
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
103101
Namespace is the namespace where the Konnect Control Plane is in.
102+
Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`.
104103
type: string
105104
required:
106105
- name

Diff for: docs/api-reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -965,7 +965,7 @@ KonnectNamespacedRef is the schema for the KonnectNamespacedRef type.
965965
| Field | Description |
966966
| --- | --- |
967967
| `name` _string_ | Name is the name of the Konnect Control Plane. |
968-
| `namespace` _string_ | TODO: Implement cross namespace references: https://github.com/Kong/kubernetes-configuration/issues/36 Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`. Namespace is the namespace where the Konnect Control Plane is in. |
968+
| `namespace` _string_ | Namespace is the namespace where the Konnect Control Plane is in. Currently only cluster scoped resources (KongVault) are allowed to set `konnectNamespacedRef.namespace`. |
969969

970970

971971
_Appears in:_

0 commit comments

Comments
 (0)