feat: add more examples for crossplane kcl functions

README.md

@@ -24,10 +24,21 @@ $ docker build . --tag=kcllang/crossplane-kcl
 $ crossplane xpkg build -f package --embed-runtime-image=kcllang/crossplane-kcl
 ```
 
-## Quick Start Examples
+## Quick Start Examples and Debug Locally
 
 See [here](./examples/resources/basic/)
 
+## Installing
+
+```yaml
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: kcl-function
+spec:
+  package: kcllang/crossplane-kcl
+```
+
 ## Expected Output
 
 A KRM YAML list which means that each document must have an `apiVersion`, `kind`

examples/patch_desired/patching/Makefile

@@ -0,0 +1,2 @@
+run:
+	crossplane beta render xr.yaml composition.yaml functions.yaml -r

examples/patch_desired/patching/README.md

@@ -0,0 +1,31 @@
+# Example Manifests
+
+You can run your function locally and test it using `crossplane beta render`
+with these example manifests.
+
+```shell
+# Run the function locally
+$ go run . --insecure --debug
+```
+
+```shell
+# Then, in another terminal, call it with these example manifests
+$ crossplane beta render xr.yaml composition.yaml functions.yaml -r
+---
+apiVersion: nopexample.org/v1
+kind: XSubnetwork
+metadata:
+  annotations:
+    nobu.dev/app: someapp
+    nobu.dev/cueified: "true"
+  name: test-xrender
+spec:
+  forProvider:
+    network: somenetwork
+---
+apiVersion: render.crossplane.io/v1beta1
+kind: Result
+message: updated xr ":XSubnetwork"
+severity: SEVERITY_NORMAL
+step: normal
+```

examples/patch_desired/patching/composition.yaml

@@ -0,0 +1,29 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: function-template-go
+spec:
+  compositeTypeRef:
+    apiVersion: example.crossplane.io/v1
+    kind: XR
+  mode: Pipeline
+  pipeline:
+  - step: normal
+    functionRef:
+      name: kcl-function
+    input:
+      apiVersion: krm.kcl.dev/v1alpha1
+      kind: KCLRun
+      metadata:
+        name: basic
+      spec:
+        target: PatchDesired
+        source: |
+          {
+              metadata.name = "test-desired"
+              metadata.annotations: {
+                  "nobu.dev/cueified": "true",
+                  "nobu.dev/app": "someapp",
+              }
+              spec.forProvider.network: "somenetwork"
+          }

examples/patch_desired/patching/functions.yaml

@@ -0,0 +1,9 @@
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: kcl-function
+  annotations:
+    # This tells crossplane beta render to connect to the function locally.
+    render.crossplane.io/runtime: Development
+spec:
+  package: kcllang/crossplane-kcl

examples/patch_desired/patching/xr.yaml

@@ -0,0 +1,5 @@
+# Replace this with your XR!
+apiVersion: nopexample.org/v1
+kind: XSubnetwork
+metadata:
+  name: test-xrender

examples/patch_resources/patching/Makefile

@@ -0,0 +1,2 @@
+run:
+	crossplane beta render xr.yaml composition.yaml functions.yaml -r

examples/patch_resources/patching/README.md

@@ -0,0 +1,47 @@
+# Example Manifests
+
+You can run your function locally and test it using `crossplane beta render`
+with these example manifests.
+
+```shell
+# Run the function locally
+$ go run . --insecure --debug
+```
+
+```shell
+# Then, in another terminal, call it with these example manifests
+$ crossplane beta render xr.yaml composition.yaml functions.yaml -r
+---
+apiVersion: nopexample.org/v1
+kind: XSubnetwork
+metadata:
+  name: test-xrender
+---
+apiVersion: nobu.dev/v1
+kind: Bucket
+metadata:
+  annotations:
+    crossplane.io/composition-resource-name: bucket
+    nobu.dev/app: someapp
+    nobu.dev/cueified: "true"
+  generateName: test-xrender-
+  labels:
+    crossplane.io/composite: test-xrender
+  name: bucket
+  ownerReferences:
+  - apiVersion: nopexample.org/v1
+    blockOwnerDeletion: true
+    controller: true
+    kind: XSubnetwork
+    name: test-xrender
+    uid: ""
+spec:
+  forProvider:
+    network: somenetwork
+---
+apiVersion: render.crossplane.io/v1beta1
+kind: Result
+message: created resource "bucket:"
+severity: SEVERITY_NORMAL
+step: normal
+```

examples/patch_resources/patching/composition.yaml

@@ -0,0 +1,36 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: function-template-go
+spec:
+  compositeTypeRef:
+    apiVersion: example.crossplane.io/v1
+    kind: XR
+  mode: Pipeline
+  pipeline:
+  - step: normal
+    functionRef:
+      name: kcl-function
+    input:
+      apiVersion: krm.kcl.dev/v1alpha1
+      kind: KCLRun
+      metadata:
+        name: basic
+      spec:
+        target: PatchResources
+        resources:
+        - name: bucket
+          base:
+            apiVersion: nobu.dev/v1
+            kind: Bucket
+            metadata:
+              name: bucket
+        source: |
+          {
+              metadata.name = "bucket"
+              metadata.annotations: {
+                  "nobu.dev/cueified": "true",
+                  "nobu.dev/app": "someapp",
+              }
+              spec.forProvider.network: "somenetwork"
+          }

examples/patch_resources/patching/functions.yaml

@@ -0,0 +1,9 @@
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: kcl-function
+  annotations:
+    # This tells crossplane beta render to connect to the function locally.
+    render.crossplane.io/runtime: Development
+spec:
+  package: kcllang/crossplane-kcl

examples/patch_resources/patching/xr.yaml

@@ -0,0 +1,5 @@
+# Replace this with your XR!
+apiVersion: nopexample.org/v1
+kind: XSubnetwork
+metadata:
+  name: test-xrender

examples/patch_resources/patching_multiple/Makefile

@@ -0,0 +1,2 @@
+run:
+	crossplane beta render xr.yaml composition.yaml functions.yaml -r

examples/patch_resources/patching_multiple/README.md

@@ -0,0 +1,104 @@
+# Example Manifests
+
+You can run your function locally and test it using `crossplane beta render`
+with these example manifests.
+
+```shell
+# Run the function locally
+$ go run . --insecure --debug
+```
+
+```shell
+# Then, in another terminal, call it with these example manifests
+$ crossplane beta render xr.yaml composition.yaml functions.yaml -r
+crossplane beta render xr.yaml composition.yaml functions.yaml -r
+---
+apiVersion: nopexample.org/v1
+kind: XSubnetwork
+metadata:
+  name: test-xrender
+---
+apiVersion: nobu.dev/v1
+kind: Bucket
+metadata:
+  annotations:
+    crossplane.io/composition-resource-name: bucket
+    nobu.dev/app: someapp
+    nobu.dev/cueified: "true"
+  generateName: test-xrender-
+  labels:
+    crossplane.io/composite: test-xrender
+  name: bucket
+  ownerReferences:
+  - apiVersion: nopexample.org/v1
+    blockOwnerDeletion: true
+    controller: true
+    kind: XSubnetwork
+    name: test-xrender
+    uid: ""
+spec:
+  forProvider:
+    policy: some-bucket-policy
+---
+apiVersion: nobu.dev/v1
+kind: User
+metadata:
+  annotations:
+    crossplane.io/composition-resource-name: iam-user
+    nobu.dev/app: someapp
+    nobu.dev/cueified: "true"
+  generateName: test-xrender-
+  labels:
+    crossplane.io/composite: test-xrender
+  name: iam-user
+  ownerReferences:
+  - apiVersion: nopexample.org/v1
+    blockOwnerDeletion: true
+    controller: true
+    kind: XSubnetwork
+    name: test-xrender
+    uid: ""
+spec:
+  forProvider:
+    name: somename
+---
+apiVersion: nobu.dev/v1
+kind: Role
+metadata:
+  annotations:
+    crossplane.io/composition-resource-name: iam-role
+    nobu.dev/app: someapp
+    nobu.dev/cueified: "true"
+  generateName: test-xrender-
+  labels:
+    crossplane.io/composite: test-xrender
+  name: iam-role
+  ownerReferences:
+  - apiVersion: nopexample.org/v1
+    blockOwnerDeletion: true
+    controller: true
+    kind: XSubnetwork
+    name: test-xrender
+    uid: ""
+spec:
+  forProvider:
+    policy: some-role-policy
+---
+apiVersion: render.crossplane.io/v1beta1
+kind: Result
+message: created resource "bucket:"
+severity: SEVERITY_NORMAL
+step: normal
+---
+apiVersion: render.crossplane.io/v1beta1
+kind: Result
+message: created resource "iam-role:"
+severity: SEVERITY_NORMAL
+step: normal
+---
+apiVersion: render.crossplane.io/v1beta1
+kind: Result
+message: created resource "iam-user:"
+severity: SEVERITY_NORMAL
+step: normal
+```

examples/patch_resources/patching_multiple/composition.yaml

@@ -0,0 +1,69 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: function-template-go
+spec:
+  compositeTypeRef:
+    apiVersion: example.crossplane.io/v1
+    kind: XR
+  mode: Pipeline
+  pipeline:
+  - step: normal
+    functionRef:
+      name: kcl-function
+    input:
+      apiVersion: krm.kcl.dev/v1alpha1
+      kind: KCLRun
+      metadata:
+        name: basic
+      spec:
+        target: PatchResources
+        resources:
+        - name: bucket
+          base:
+            apiVersion: nobu.dev/v1
+            kind: Bucket
+            metadata:
+              name: bucket
+        - name: iam-user
+          base:
+            apiVersion: nobu.dev/v1
+            kind: User
+            metadata:
+              name: iam-user
+        - name: iam-role
+          base:
+            apiVersion: nobu.dev/v1
+            kind: Role
+            metadata:
+              name: iam-role
+        source: |
+          items = [ 
+              {
+                  # Target the bucket by name
+                  metadata.name = "bucket"
+                  metadata.annotations: {
+                      "nobu.dev/cueified": "true",
+                      "nobu.dev/app": "someapp",
+                  }
+                  spec.forProvider.policy: "some-bucket-policy"
+              }
+              {
+                  # Target the user by name
+                  metadata.name = "iam-user"
+                  metadata.annotations: {
+                      "nobu.dev/cueified": "true",
+                      "nobu.dev/app": "someapp",
+                  }
+                  spec.forProvider.name: "somename"
+              }
+              {
+                  # Target the role by name
+                  metadata.name = "iam-role"
+                  metadata.annotations: {
+                      "nobu.dev/cueified": "true",
+                      "nobu.dev/app": "someapp",
+                  }
+                  spec.forProvider.policy: "some-role-policy"
+              }
+          ]

examples/patch_resources/patching_multiple/functions.yaml

@@ -0,0 +1,9 @@
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: kcl-function
+  annotations:
+    # This tells crossplane beta render to connect to the function locally.
+    render.crossplane.io/runtime: Development
+spec:
+  package: kcllang/crossplane-kcl