Skip to content

Commit e5bb334

Browse files
MoortiiiMoortiii
authored
feat: Add support for 'object' type in spec, which is used to represent objects with unstructured data (#627)
This commit allows users to specify 'object' as a type when defining their spec. This annotates the key with `x-kubernetes-preserve-unknown-fields: true` and allows us to pass unstructured data, such as values for Helm charts, to CRDs managed by KRO.
1 parent 6bb6098 commit e5bb334

File tree

9 files changed

+312
-1
lines changed

9 files changed

+312
-1
lines changed

‎pkg/simpleschema/transform.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ import (
2121
"strings"
2222

2323
extv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
24+
"k8s.io/utils/ptr"
2425
)
2526

2627
const (
2728
keyTypeString = string(AtomicTypeString)
2829
keyTypeInteger = string(AtomicTypeInteger)
2930
keyTypeBoolean = string(AtomicTypeBool)
3031
keyTypeNumber = "number"
32+
keyTypeObject = "object"
3133
)
3234

3335
// A predefinedType is a type that is predefined in the schema.
@@ -128,6 +130,9 @@ func (tf *transformer) parseFieldSchema(key, fieldValue string, parentSchema *ex
128130

129131
if isAtomicType(fieldType) {
130132
fieldJSONSchemaProps.Type = fieldType
133+
} else if fieldType == keyTypeObject {
134+
fieldJSONSchemaProps.Type = fieldType
135+
fieldJSONSchemaProps.XPreserveUnknownFields = ptr.To(true)
131136
} else if isCollectionType(fieldType) {
132137
if isMapType(fieldType) {
133138
fieldJSONSchemaProps, err = tf.handleMapType(key, fieldType)

‎pkg/simpleschema/transform_test.go‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222

2323
"github.com/stretchr/testify/assert"
2424
extv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
25+
"k8s.io/utils/ptr"
2526
)
2627

2728
func TestBuildOpenAPISchema(t *testing.T) {
@@ -373,6 +374,57 @@ func TestBuildOpenAPISchema(t *testing.T) {
373374
want: nil,
374375
wantErr: true,
375376
},
377+
{
378+
name: "Object with unknown fields",
379+
obj: map[string]interface{}{
380+
"values": "object",
381+
},
382+
want: &extv1.JSONSchemaProps{
383+
Type: "object",
384+
Properties: map[string]extv1.JSONSchemaProps{
385+
"values": {
386+
Type: "object",
387+
XPreserveUnknownFields: ptr.To(true),
388+
},
389+
},
390+
},
391+
wantErr: false,
392+
},
393+
{
394+
name: "Object with unknown fields in combination with required marker",
395+
obj: map[string]interface{}{
396+
"values": "object | required=true",
397+
},
398+
want: &extv1.JSONSchemaProps{
399+
Type: "object",
400+
Properties: map[string]extv1.JSONSchemaProps{
401+
"values": {
402+
Type: "object",
403+
XPreserveUnknownFields: ptr.To(true),
404+
},
405+
},
406+
Required: []string{"values"},
407+
},
408+
wantErr: false,
409+
},
410+
{
411+
name: "Object with unknown fields in combination with default marker",
412+
obj: map[string]interface{}{
413+
"values": "object | default={\"a\": \"b\"}",
414+
},
415+
want: &extv1.JSONSchemaProps{
416+
Type: "object",
417+
Properties: map[string]extv1.JSONSchemaProps{
418+
"values": {
419+
Type: "object",
420+
XPreserveUnknownFields: ptr.To(true),
421+
Default: &extv1.JSON{Raw: []byte("{\"a\": \"b\"}")},
422+
},
423+
},
424+
Default: &extv1.JSON{Raw: []byte("{}")},
425+
},
426+
wantErr: false,
427+
},
376428
{
377429
name: "Simple string validation",
378430
obj: map[string]interface{}{

‎test/e2e/chainsaw/check-arbitary-objects/chainsaw-test.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
apiVersion: chainsaw.kyverno.io/v1alpha1
2+
kind: Test
3+
metadata:
4+
name: check-arbitrary-objects
5+
spec:
6+
description: |
7+
Tests if an instance with a key of type 'object' allows passing unstructured data
8+
steps:
9+
- name: install-rgd
10+
try:
11+
#description: Install the RGD that creates an Instance CRD
12+
- apply:
13+
file: rgd.yaml
14+
description: Apply RGD
15+
- assert:
16+
file: rgd-assert.yaml
17+
description: Verify RGD state
18+
- assert:
19+
file: instancecrd-assert.yaml
20+
description: Verify Instance CRD state
21+
catch:
22+
- description: kro controller pod logs collector
23+
podLogs:
24+
selector: app.kubernetes.io/instance=kro
25+
namespace: kro-system
26+
finally:
27+
- description: sleep operation
28+
sleep:
29+
duration: 5s
30+
- name: create-instance
31+
try:
32+
#description: Create instance
33+
- apply:
34+
file: instance.yaml
35+
description: Create ArbitraryObjectNoOp Instance
36+
- assert:
37+
file: instance-create-assert.yaml
38+
description: Verify Instance state
39+
catch:
40+
- description: kro controller pod logs collector
41+
podLogs:
42+
selector: app.kubernetes.io/instance=kro
43+
namespace: kro-system

‎test/e2e/chainsaw/check-arbitary-objects/instance-create-assert.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
apiVersion: kro.run/v1alpha1
2+
kind: CheckArbitraryObjectsNoOp
3+
metadata:
4+
finalizers:
5+
- kro.run/finalizer
6+
generation: 1
7+
labels:
8+
kro.run/owned: "true"
9+
name: test-instance
10+
spec:
11+
values:
12+
bool-value: true
13+
numeric-value: 42
14+
structural-type:
15+
with-additional:
16+
nested: fields
17+
string-value: my-string
18+
mapping-value:
19+
- item1
20+
- item2
21+
- item3
22+
status:
23+
conditions:
24+
- message: Instance reconciled successfully
25+
observedGeneration: 1
26+
reason: ReconciliationSucceeded
27+
status: "True"
28+
type: InstanceSynced
29+
state: ACTIVE
30+

‎test/e2e/chainsaw/check-arbitary-objects/instance.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: kro.run/v1alpha1
2+
kind: CheckArbitraryObjectsNoOp
3+
metadata:
4+
name: test-instance
5+
spec:
6+
values:
7+
bool-value: true
8+
numeric-value: 42
9+
structural-type:
10+
with-additional:
11+
nested: fields
12+
string-value: my-string
13+
mapping-value:
14+
- item1
15+
- item2
16+
- item3
17+

‎test/e2e/chainsaw/check-arbitary-objects/instancecrd-assert.yaml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
apiVersion: apiextensions.k8s.io/v1
2+
kind: CustomResourceDefinition
3+
metadata:
4+
generation: 1
5+
name: checkarbitraryobjectsnoops.kro.run
6+
spec:
7+
conversion:
8+
strategy: None
9+
group: kro.run
10+
names:
11+
kind: CheckArbitraryObjectsNoOp
12+
listKind: CheckArbitraryObjectsNoOpList
13+
plural: checkarbitraryobjectsnoops
14+
singular: checkarbitraryobjectsnoop
15+
scope: Namespaced
16+
versions:
17+
- additionalPrinterColumns:
18+
- description: The state of a ResourceGraphDefinition instance
19+
jsonPath: .status.state
20+
name: State
21+
type: string
22+
- description: Whether a ResourceGraphDefinition instance have all it's subresources
23+
ready
24+
jsonPath: .status.conditions[?(@.type=="InstanceSynced")].status
25+
name: Synced
26+
type: string
27+
- description: Age of the resource
28+
jsonPath: .metadata.creationTimestamp
29+
name: Age
30+
type: date
31+
name: v1alpha1
32+
schema:
33+
openAPIV3Schema:
34+
properties:
35+
apiVersion:
36+
type: string
37+
kind:
38+
type: string
39+
metadata:
40+
type: object
41+
spec:
42+
properties:
43+
values:
44+
type: object
45+
x-kubernetes-preserve-unknown-fields: true
46+
type: object
47+
required:
48+
- values
49+
status:
50+
properties:
51+
conditions:
52+
items:
53+
properties:
54+
lastTransitionTime:
55+
type: string
56+
message:
57+
type: string
58+
observedGeneration:
59+
type: integer
60+
reason:
61+
type: string
62+
status:
63+
type: string
64+
type:
65+
type: string
66+
type: object
67+
type: array
68+
state:
69+
type: string
70+
type: object
71+
type: object
72+
served: true
73+
storage: true
74+
subresources:
75+
status: {}
76+
status:
77+
acceptedNames:
78+
kind: CheckArbitraryObjectsNoOp
79+
listKind: CheckArbitraryObjectsNoOpList
80+
plural: checkarbitraryobjectsnoops
81+
singular: checkarbitraryobjectsnoop
82+
conditions:
83+
- message: no conflicts found
84+
reason: NoConflicts
85+
status: "True"
86+
type: NamesAccepted
87+
- message: the initial names have been accepted
88+
reason: InitialNamesAccepted
89+
status: "True"
90+
type: Established
91+
storedVersions:
92+
- v1alpha1
93+

‎test/e2e/chainsaw/check-arbitary-objects/rgd-assert.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: kro.run/v1alpha1
2+
kind: ResourceGraphDefinition
3+
metadata:
4+
name: check-arbitrary-objects
5+
finalizers:
6+
- kro.run/finalizer
7+
generation: 1
8+
status:
9+
# filter conditions array to keep elements where `type == 'Ready'`
10+
# and assert there's a single element matching the filter
11+
# and that this element status is `True`
12+
(conditions[?type == 'Ready']):
13+
- status: 'True'
14+
observedGeneration: 1
15+
state: Active
16+

‎test/e2e/chainsaw/check-arbitary-objects/rgd.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
apiVersion: kro.run/v1alpha1
2+
kind: ResourceGraphDefinition
3+
metadata:
4+
name: check-arbitrary-objects
5+
spec:
6+
schema:
7+
apiVersion: v1alpha1
8+
kind: CheckArbitraryObjectsNoOp
9+
spec:
10+
values: object | required=true
11+
resources: []
12+

‎website/docs/docs/concepts/10-simple-schema.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ spec:
2323
replicas: integer | default=1 minimum=1 maximum=100
2424
image: string | required=true
2525

26+
# Unstructured objects
27+
values: object | required=true
28+
2629
# Structured type
2730
ingress:
2831
enabled: boolean | default=false
@@ -88,6 +91,46 @@ user:
8891
contacts: "[]string" # Array of strings
8992
```
9093

94+
### Unstructured Objects
95+
96+
Unstructured objects are declared using `object` as a type.
97+
98+
:::warning
99+
100+
This disables the field-validation normally offered by kro, and forwards the values to your RGD as-is. This is generally discouraged and should therefore be used with caution. In most cases, using a structured object is a better approach.
101+
102+
:::
103+
104+
```yaml
105+
kind: ResourceGraphDefintion
106+
metadata: {}
107+
spec:
108+
schema:
109+
spec:
110+
additionalHelmChartValues: object
111+
```
112+
113+
This allows you to pass data to your CRDs directly in cases where the schema is not known in advance. This type supports any valid object, and can mix and match different primitives as well as structured types.
114+
115+
```yaml
116+
apiVersion: kro.run/v1alpha1
117+
kind: CRDWithUnstructuredObjects
118+
metadata:
119+
name: test-instance
120+
spec:
121+
additionalHelmChartValues:
122+
boolean-value: true
123+
numeric-value: 42
124+
structural-type:
125+
with-additional:
126+
nested: fields
127+
string-value: my-string
128+
mapping-value:
129+
- item1
130+
- item2
131+
- item3
132+
```
133+
91134
### Array Types
92135

93136
Arrays are denoted using `[]` syntax:
@@ -228,7 +271,7 @@ schema:
228271
spec:
229272
image: string | default="nginx"
230273
status:
231-
availableReplicas: ${deployment.status.availableReplicas}
274+
availableReplicas: ${deployment.status.availableReplicas}
232275
additionalPrinterColumns:
233276
- jsonPath: .status.availableReplicas
234277
name: Available replicas

0 commit comments

Comments
 (0)