Runtime Library
The runtime library helps to facilitate the implementation of go functions. It allows to operate on underlying managed resources and composites.
For more information on how composition functions operate check the documentation from Crossplane.
Desired Objects
The desired objects are tracked in the ServiceRuntime
until all steps finished.
The ServiceRuntime
will then generate the response GRPC object for Crossplane.All objects that have been added to the desired objects map will be applied by Crossplane.
If an object is not added to the desired map, and it exists on the cluster, it will be removed.
So always add all necessary objects on each reconcile.
Observed Objects
Are the objects as applied to the cluster. They contain any external injected information, as well as the status object.
Result Object
Any service step expects a *xfnproto.Result
return object.
This object type is Crossplane’s own Result type.
The runtime library has simple functions that allows creation of *xfnproto.Result
objects
in various states - fatal
, warning
or normal
.
Please note that a fatal result will mark the whole composition as failed.
It should only be used if the error is sever enough for the composition to actually work properly.
For further information, please consult the Crossplane docs. consult crossplane documentation.