Rename from extra to required resources. Add support for bootstrap requirements for functions. Add support for ttl for function responses. Better flexibility in the registration of functions

knutejohKLP · knutejohKLP · commit 863c6e7b3cff · 2026-01-02T13:06:18.000+01:00
Signed-off-by: Knut-Erik Johnsen &lt;knut-erik.johnsen@klp.no&gt;
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositeresourcedefinitions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositeresourcedefinitions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: compositeresourcedefinitions.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositionrevisions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositionrevisions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: compositionrevisions.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: compositions.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_environmentconfigs.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_environmentconfigs.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: environmentconfigs.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_managedresourceactivationpolicies.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_managedresourceactivationpolicies.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: managedresourceactivationpolicies.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_managedresourcedefinitions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_managedresourcedefinitions.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: managedresourcedefinitions.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_usages.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_usages.yaml
@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.18.0
+    controller-gen.kubebuilder.io/version: v0.19.0
   name: usages.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
diff --git a/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneCompositeFunctionBase.java b/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneCompositeFunctionBase.java
@@ -1,8 +1,10 @@
 package io.crossplane.compositefunctions.base;
 
 
+import com.google.protobuf.Duration;
 import io.crossplane.compositefunctions.protobuf.v1.FunctionRunnerServiceGrpc;
 import io.crossplane.compositefunctions.protobuf.v1.Requirements;
+import io.crossplane.compositefunctions.protobuf.v1.ResponseMeta;
 import io.crossplane.compositefunctions.protobuf.v1.RunFunctionRequest;
 import io.crossplane.compositefunctions.protobuf.v1.RunFunctionResponse;
 import io.crossplane.compositefunctions.protobuf.v1.State;
@@ -33,7 +35,7 @@ public void runFunction(RunFunctionRequest request, StreamObserver<RunFunctionRe
             desiredBuilder.putAllResources(desired.getResourcesMap());
 
             CrossplaneFunctionRequest crossplaneFunctionRequest = new CrossplaneFunctionRequest(request.getObserved(),
-                    request.getExtraResourcesMap(), request.getCredentialsMap(),  request.getDesired());
+                    request.getRequiredResourcesMap(), request.getCredentialsMap(),  request.getDesired());
 
 
             logger.debug("Calling method with implemented logic");
@@ -49,7 +51,7 @@ public void runFunction(RunFunctionRequest request, StreamObserver<RunFunctionRe
 
             if (! crossplaneFunctionResponse.resourceSelectors().isEmpty()) {
                 Requirements requirements = Requirements.newBuilder()
-                        .putAllExtraResources(crossplaneFunctionResponse.resourceSelectors())
+                        .putAllResources(crossplaneFunctionResponse.resourceSelectors())
                         .build();
                 responseBuilder.setRequirements(requirements);
             }
@@ -62,6 +64,14 @@ public void runFunction(RunFunctionRequest request, StreamObserver<RunFunctionRe
                 responseBuilder.addAllConditions(crossplaneFunctionResponse.conditions());
             }
 
+            if (crossplaneFunctionResponse.ttl() > 0) {
+                ResponseMeta.Builder responseMetaBuilder = ResponseMeta.newBuilder();
+                Duration.Builder durationBuilder = Duration.newBuilder();
+                durationBuilder.setSeconds(crossplaneFunctionResponse.ttl());
+                responseMetaBuilder.setTtl(durationBuilder);
+                responseBuilder.setMeta(responseMetaBuilder);
+            }
+
             if (desiredBuilder.getResourcesCount() > 0) {
                 responseBuilder.setDesired(desiredBuilder.build());
             }
diff --git a/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionResponse.java b/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionResponse.java
@@ -14,10 +14,13 @@
  * @param desiredResources Map of the desired resources
  * @param resourceSelectors Map of the resource selectors for any extra resources
  * @param results List of the results
+ * @param conditions List of the conditions of the function response
+ * @param ttl Time to live for the response in positive seconds. This is an alpha feature, and needs to be explicitly enabled in Crossplane.
  */
 public record CrossplaneFunctionResponse(Map<String, Object> desiredResources,
                                          Map<String, ResourceSelector> resourceSelectors,
-                                         List<Result> results, List<Condition> conditions) {
+                                         List<Result> results, List<Condition> conditions,
+                                         long ttl) {
 
     //
     //
@@ -27,6 +30,6 @@ public record CrossplaneFunctionResponse(Map<String, Object> desiredResources,
      * Create an empty response with all fields initiated
       */
     public CrossplaneFunctionResponse() {
-        this(new HashMap<>(), new HashMap<>(), new ArrayList<>(), new ArrayList<>());
+        this(new HashMap<>(), new HashMap<>(), new ArrayList<>(), new ArrayList<>(), 0);
     }
 }
diff --git a/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneExtraResourcesService.java b/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneExtraResourcesService.java
@@ -24,6 +24,7 @@
  * Commented out in 1.14
  *
  * @since 1.15
+ * @deprecated Use CrossplaneRequiredResourcesService instead since resource has been renamed from extra to required
  */
 public class CrossplaneExtraResourcesService {
 
diff --git a/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneRequiredResourcesService.java b/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneRequiredResourcesService.java
@@ -0,0 +1,103 @@
+package io.crossplane.compositefunctions.starter.conversion;
+
+import com.google.protobuf.util.JsonFormat;
+import io.crossplane.compositefunctions.protobuf.v1.ResourceSelector;
+import io.crossplane.compositefunctions.protobuf.v1.Resources;
+import io.crossplane.compositefunctions.starter.exception.CrossplaneUnmarshallException;
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.client.utils.Serialization;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+
+/**
+ * Class that helps with the required resources map and also to create ResourceSelector in order to get required resources
+ * to the function
+ *
+ *
+ * @since 2.0
+ */
+public class CrossplaneRequiredResourcesService {
+
+    private static final Logger logger = LoggerFactory.getLogger(CrossplaneRequiredResourcesService.class);
+    private final JsonFormat.Printer printer = JsonFormat.printer();
+
+
+    public <T> Optional<T> getRequiredResource(Map<String, Resources> requiredResources, String resourceName, Class<T> clazz) {
+        List<Optional<T>> resources = getRequiredResources(requiredResources, resourceName, 1, clazz);
+
+        if (resources.isEmpty()) {
+            return Optional.empty();
+        }
+        return resources.get(0);
+    }
+
+    public <T> List<Optional<T>> getRequiredResources(Map<String, Resources> requiredResources, String resourceName, int expectedResources, Class<T> clazz) {
+        List<Optional<T>> result = new ArrayList<>();
+        Resources resources = requiredResources.get(resourceName);
+
+        if (resources != null &&  resources.getItemsCount() == expectedResources) {
+            for (int i = 0; i < expectedResources; i++) {
+                try {
+                    logger.debug("We have an extra resource " + clazz.getSimpleName());
+                    result.add(Optional.ofNullable(Serialization.unmarshal(printer.print(resources.getItems(i).getResource()), clazz)));
+                } catch (Exception e) {
+                    throw new CrossplaneUnmarshallException("Error when unmarshalling the extra resource " + clazz.getName(), e);
+                }
+            }
+
+        }
+        return result;
+    }
+
+    public Map<String, String> getConnectionDetails(Map<String, Resources> requiredResources, String resourceName) {
+        List<Map<String, String>> resources = getConnectionDetails(requiredResources, resourceName, 1);
+
+        if (resources.isEmpty()) {
+            return new HashMap<>();
+        }
+        return resources.get(0);
+    }
+
+    public List<Map<String, String>> getConnectionDetails(Map<String, Resources> requiredResources, String resourceName, int expectedResources) {
+        List<Map<String, String>> result = new ArrayList<>();
+        Resources resources = requiredResources.get(resourceName);
+
+        if (resources != null &&  resources.getItemsCount() == expectedResources) {
+            for (int i = 0; i < expectedResources; i++) {
+                try {
+                    logger.debug("We have connectiondetails " + resourceName);
+                    Map<String, String> currentDetails = new HashMap<>();
+                    resources.getItems(i).getConnectionDetailsMap().forEach((key, value) ->
+                            currentDetails.put(key, value.toStringUtf8())
+                    );
+                    result.add(currentDetails);
+                } catch (Exception e) {
+                    throw new CrossplaneUnmarshallException("Error when unmarshalling the connectionDetails", e);
+                }
+            }
+
+        }
+        return result;
+    }
+
+
+
+    public Map<String, ResourceSelector> createRequiredResourcesSelector(String resourceName, HasMetadata type) {
+        ResourceSelector resourceSelector = ResourceSelector.newBuilder()
+                .setApiVersion(type.getApiVersion())
+                .setKind(type.getKind())
+                .setMatchName(resourceName)
+                .build();
+
+        return Map.of(resourceName, resourceSelector);
+    }
+
+
+}
diff --git a/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/model/CrossplanePipeline.java b/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/model/CrossplanePipeline.java
@@ -0,0 +1,18 @@
+package io.crossplane.compositefunctions.starter.model;
+
+import io.crossplane.apiextensions.v1.compositionspec.pipeline.Requirements;
+
+public record CrossplanePipeline(String name, String functionReference, Requirements requirements) {
+
+    public CrossplanePipeline(String name) {
+        this(name, name, null);
+    }
+
+    public CrossplanePipeline(String name, String functionReference) {
+        this(name, functionReference, null);
+    }
+
+    public CrossplanePipeline(String name, Requirements requirements) {
+        this(name, name, requirements);
+    }
+}
diff --git a/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/registration/CrossplaneCompositeResourceService.java b/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/registration/CrossplaneCompositeResourceService.java
@@ -4,13 +4,13 @@
 import io.crossplane.apiextensions.v1.CompositeResourceDefinitionSpec;
 import io.crossplane.apiextensions.v1.Composition;
 import io.crossplane.apiextensions.v1.CompositionSpec;
-import io.crossplane.apiextensions.v1.compositeresourcedefinitionspec.ClaimNames;
 import io.crossplane.apiextensions.v1.compositeresourcedefinitionspec.Names;
 import io.crossplane.apiextensions.v1.compositeresourcedefinitionspec.Versions;
 import io.crossplane.apiextensions.v1.compositeresourcedefinitionspec.versions.Schema;
 import io.crossplane.apiextensions.v1.compositionspec.CompositeTypeRef;
 import io.crossplane.apiextensions.v1.compositionspec.Pipeline;
 import io.crossplane.apiextensions.v1.compositionspec.pipeline.FunctionRef;
+import io.crossplane.compositefunctions.starter.model.CrossplanePipeline;
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.KubernetesClient;
@@ -40,11 +40,29 @@ public class CrossplaneCompositeResourceService {
     public static <T extends CustomResource<?, Void>> void registerOrUpdateCompositeResource(List<String> pipelineFunctions,
                                                                                              T compositionDefinition,
                                                                                              KubernetesClient kubernetesClient) {
-        registerOrUpdateCompositeResource(pipelineFunctions, compositionDefinition, kubernetesClient, false);
+        List<CrossplanePipeline> crossplanePipelines = pipelineFunctions.stream().map(CrossplanePipeline::new).toList();
+        registerOrUpdateCompositeResource(compositionDefinition, crossplanePipelines, false, kubernetesClient);
     }
+
+    public static <T extends CustomResource<?, Void>> void registerOrUpdateCompositeResource(T compositionDefinition,
+                                                                                             List<CrossplanePipeline> crossplanePipelines,
+                                                                                             KubernetesClient kubernetesClient) {
+        registerOrUpdateCompositeResource(compositionDefinition, crossplanePipelines, false, kubernetesClient);
+    }
+
+
     public static <T extends CustomResource<?, Void>> void registerOrUpdateCompositeResource(List<String> pipelineFunctions,
                                                                                              T compositionDefinition,
-                                                                                             KubernetesClient kubernetesClient, boolean legacy) {
+                                                                                             KubernetesClient kubernetesClient,
+                                                                                             boolean legacy) {
+        List<CrossplanePipeline> crossplanePipelines = pipelineFunctions.stream().map(CrossplanePipeline::new).toList();
+        registerOrUpdateCompositeResource(compositionDefinition, crossplanePipelines, legacy, kubernetesClient);
+    }
+
+    public static <T extends CustomResource<?, Void>> void registerOrUpdateCompositeResource(T compositionDefinition,
+                                                                                             List<CrossplanePipeline> pipelineFunctions,
+                                                                                             boolean legacy,
+                                                                                             KubernetesClient kubernetesClient) {
 
         CompositeResourceDefinition compositeResourceDefinition = createCompositeResourceDefinition(compositionDefinition, legacy);
 
@@ -144,7 +162,7 @@ private static void registerOrUpdateCompositeResourceDefinition(Composition comp
     }
 
     private static <T extends CustomResource<?, Void>> Composition createCompositionDefinition(
-            List<String> pipelineFunctions, T compositionDefinition) {
+            List<CrossplanePipeline> pipelineFunctions, T compositionDefinition) {
 
         Composition composition = new Composition();
 
@@ -167,11 +185,14 @@ private static <T extends CustomResource<?, Void>> Composition createComposition
         return composition;
     }
 
-    private static Pipeline createPipeline(String pipelineName) {
+    private static Pipeline createPipeline(CrossplanePipeline crossplanePipeline) {
         Pipeline pipeline = new Pipeline();
-        pipeline.setStep(pipelineName);
+        pipeline.setStep(crossplanePipeline.name());
+        if (crossplanePipeline.requirements() != null) {
+            pipeline.setRequirements(crossplanePipeline.requirements());
+        }
         FunctionRef functionRef = new FunctionRef();
-        functionRef.setName(pipelineName);
+        functionRef.setName(crossplanePipeline.functionReference());
         pipeline.setFunctionRef(functionRef);
         return pipeline;
     }
diff --git a/pom.xml b/pom.xml
@@ -19,7 +19,7 @@
     <description>Crossplane parent pom for composite functions</description>
 
     <properties>
-        <revision>2.0.0-SNAPSHOT</revision>
+        <revision>2.1.0-SNAPSHOT</revision>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <maven.compiler.target>17</maven.compiler.target>
@@ -267,4 +267,4 @@
             </build>
         </profile>
     </profiles>
-</project>
+</project>

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`* Commented out in 1.14`
`25`	`25`	`*`
`26`	`26`	`* @since 1.15`
	`27`	`+ * @deprecated Use CrossplaneRequiredResourcesService instead since resource has been renamed from extra to required`
`27`	`28`	`*/`
`28`	`29`	`public class CrossplaneExtraResourcesService {`
`29`	`30`