Merge pull request #34 from Avarei/docs/add-https-git-example

add https example using git references without pkl package releases

README.md

@@ -40,7 +40,10 @@ spec:
 
 ### Example
 see [examples](./example/)
-and see [pkl/crossplane.contrib.example/DEPLOY.md](pkl/crossplane.contrib.example/DEPLOY.md) on instructions how to deploy it.
+and see [pkl/crossplane.contrib.example/DEPLOY.md](pkl/crossplane.contrib.example/DEPLOY.md) on instructions how to deploy using Pkl Packages.
+
+Alternatively [example/git/README.md](example/git/README.md) shows an appraoch without releasing Packages.
+
 ## Creating a new Composition Function
 see [pkl/crossplane.contrib.example/DEVELOP.md](pkl/crossplane.contrib.example/DEVELOP.md)
 

example/README.md

@@ -10,5 +10,5 @@ $ go run . --insecure --debug
 
 ```shell
 # Then, in another terminal, call it with these example manifests
-$ crossplane beta render xr.yaml composition.yaml functions.yaml --observed-resources=observed.yaml
+$ crossplane beta render xr.yaml composition.yaml functions.yaml
 ```

example/git/README.md

@@ -0,0 +1,14 @@
+# Using Raw Git References
+Instead of releasing a Pkl Package this approach reads directly from a git repository.
+
+Currently this method does ot support PklProject dependencies, meaning all dependencies must be declared explicitely.
+
+```pkl
+// e.g.
+amends "package://pkg.pkl-lang.org/github.com/crossplane-contrib/function-pkl/[email protected]#/CompositionResponse.pkl"
+
+// instead of
+amends "@crossplane.contrib/CompositionResponse.pkl"
+```
+
+For more information about Generating the Pkl Modules, XRDs, and Compositions see [DEVELOP.md](../../pkl/crossplane.contrib.example/DEVELOP.md)

example/git/composition.yaml

@@ -0,0 +1,19 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: pkl-git-example
+spec:
+  compositeTypeRef:
+    apiVersion: example.crossplane.io/v1
+    kind: XR
+  mode: Pipeline
+  pipeline:
+  - functionRef:
+      name: function-pkl
+    input:
+      apiVersion: pkl.fn.crossplane.io/v1beta1
+      kind: Pkl
+      spec:
+        type: uri
+        uri: https://raw.githubusercontent.com/crossplane-contrib/function-pkl/main/example/git/pkl/step.pkl
+    step: pkl-template

example/git/extraresources.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kubernetes.crossplane.io/v1alpha2
+kind: Object
+metadata:
+  name: required

example/git/functions.yaml

@@ -0,0 +1,11 @@
+---
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: function-pkl
+  annotations:
+    # This tells crossplane beta render to connect to the function locally.
+    render.crossplane.io/runtime: Development
+spec:
+  # This is ignored when using the Development runtime.
+  package: function-pkl