crossplane-function-pythonic 0.2.0__tar.gz → 0.3.0__tar.gz

{crossplane_function_pythonic-0.2.0 → crossplane_function_pythonic-0.3.0}/.gitignore

@@ -215,3 +215,4 @@ crossplane/pythonic/__version__.py
 pocs/
 pythonic-packages/
 tests/protobuf/pytest_pb2*
+scripts/.aws-credentials

{crossplane_function_pythonic-0.2.0 → crossplane_function_pythonic-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.2.0
+Version: 0.3.0
 Summary: A Python centric Crossplane Function
 Project-URL: Documentation, https://github.com/crossplane-contrib/function-pythonic#readme
 Project-URL: Issues, https://github.com/crossplane-contrib/function-pythonic/issues
@@ -17,7 +17,7 @@ Requires-Python: <3.15,>=3.12
 Requires-Dist: crossplane-function-sdk-python==0.10.0
 Requires-Dist: pyyaml==6.0.3
 Provides-Extra: packages
-Requires-Dist: kopf==1.39.1; extra == 'packages'
+Requires-Dist: kopf==1.40.0; extra == 'packages'
 Provides-Extra: pip-install
 Requires-Dist: pip==25.3; extra == 'pip-install'
 Description-Content-Type: text/markdown
@@ -81,8 +81,39 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.2.0
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
 ```
+
+### Crossplane V1
+When running function-pythonic in Crossplane V1, the `--crossplane-v1` command line
+option should be specified. This requires using a Crossplane DeploymentRuntimeConfig.
+```yaml
+apiVersion: pkg.crossplane.io/v1
+kind: Function
+metadata:
+  name: function-pythonic
+spec:
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
+  runtimeConfigRef:
+    name: function-pythonic
+--
+apiVersion: pkg.crossplane.io/v1beta1
+kind: DeploymentRuntimeConfig
+metadata:
+  name: function-pythonic
+spec:
+  deploymentTemplate:
+    spec:
+      selector: {}
+      template:
+        spec:
+          containers:
+          - name: package-runtime
+            args:
+            - --debug
+            - --crossplane-v1
+```
+
 ## Composed Resource Dependencies
 
 function-pythonic automatically handles dependencies between composed resources.
@@ -228,7 +259,9 @@ The BaseComposite class provides the following fields for manipulating the Compo
 | self.status | Map | The composite desired and observed status, read from observed if not in desired |
 | self.conditions | Conditions | The composite desired and observed conditions, read from observed if not in desired |
 | self.results | Results | Returned results applied to the Composite and optionally on the Claim |
-| self.connection | Connection | The composite desired and observed connection detials, read from observed if not in desired |
+| self.connectionSecret | Map | The name, namespace, and resourceName to use when generating the connection secret in Crossplane v2 |
+| self.connection | Map | The composite desired connection detials |
+| self.connection.observed | Map | The composite observed connection detials |
 | self.ready | Boolean | The composite desired ready state |
 
 The BaseComposite also provides access to the following Crossplane Function level features:
@@ -270,13 +303,13 @@ Resource class:
 | Resource.data | Map | The resource data |
 | Resource.status | Map | The resource status |
 | Resource.conditions | Conditions | The resource conditions |
-| Resource.connection | Connection | The resource connection details |
+| Resource.connection | Map | The resource observed connection details |
 | Resource.ready | Boolean | The resource ready state |
 | Resource.unknownsFatal | Boolean | Terminate the composition if this resource has been created and is assigned unknown values, default is Composite.unknownsFatal |
 | Resource.usages | Boolean | Generate Crossplane Usages for this resource, default is Composite.autoReady |
 | Resource.autoReady | Boolean | Perform auto ready processing on this resource, default is Composite.autoReady |
 
-### Required Resources (AKA Extra Resources)
+### Required Resources
 
 Creating and accessing required resources is performed using the `BaseComposite.requireds` field.
 `BaseComposite.requireds` is a dictionary of the required resources whose key is the required
@@ -310,6 +343,7 @@ Each resource in the list is the following RequiredResource class:
 | RequiredResource.data | Map | The required resource data |
 | RequiredResource.status | Map | The required resource status |
 | RequiredResource.conditions | Map | The required resource conditions |
+| RequiredResource.connection | Map | The required resource connection details |
 
 ### Conditions
 
@@ -372,11 +406,11 @@ $ pip install crossplane-function-pythonic
 Then to render function-pythonic Compositions, use the `function-pythonic render ...`
 command.
 ```shell
-$ function-pythonic render --help
+$ function-pythonic render -h
 usage: Crossplane Function Pythonic render [-h] [--debug] [--log-name-width WIDTH] [--python-path DIRECTORY] [--render-unknowns]
                                            [--allow-oversize-protos] [--context-files KEY=PATH] [--context-values KEY=VALUE]
-                                           [--observed-resources PATH] [--extra-resources PATH] [--required-resources PATH]
-                                           [--function-credentials PATH] [--include-full-xr] [--include-function-results] [--include-context]
+                                           [--observed-resources PATH] [--required-resources PATH] [--secret-store PATH] [--include-full-xr]
+                                           [--include-connection-xr] [--include-function-results] [--include-context]
                                            PATH [PATH/CLASS]
 
 positional arguments:
@@ -400,14 +434,14 @@ options:
                         Context key-value pairs to pass to the Function pipeline. Values must be YAML/JSON. Keys take precedence over --context-files.
   --observed-resources, -o PATH
                         A YAML file or directory of YAML files specifying the observed state of composed resources.
-  --extra-resources PATH
-                        A YAML file or directory of YAML files specifying required resources (deprecated, use --required-resources).
   --required-resources, -e PATH
                         A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline.
-  --function-credentials PATH
-                        A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR.
+  --secret-store, -s PATH
+                        A YAML file or directory of YAML files specifying Secrets to use to resolve connections and credentials.
   --include-full-xr, -x
                         Include a direct copy of the input XR's spedc and metadata fields in the rendered output.
+  --include-connection-xr
+                        Include the Composite connection values in the rendered output as a resource of kind: Connection.
   --include-function-results, -r
                         Include informational and warning messages from Functions in the rendered output as resources of kind: Result..
   --include-context, -c
@@ -545,7 +579,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.2.0
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
   runtimeConfigRef:
     name: function-pythonic
 ---

{crossplane_function_pythonic-0.2.0 → crossplane_function_pythonic-0.3.0}/README.md

@@ -57,8 +57,39 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.2.0
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
 ```
+
+### Crossplane V1
+When running function-pythonic in Crossplane V1, the `--crossplane-v1` command line
+option should be specified. This requires using a Crossplane DeploymentRuntimeConfig.
+```yaml
+apiVersion: pkg.crossplane.io/v1
+kind: Function
+metadata:
+  name: function-pythonic
+spec:
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
+  runtimeConfigRef:
+    name: function-pythonic
+--
+apiVersion: pkg.crossplane.io/v1beta1
+kind: DeploymentRuntimeConfig
+metadata:
+  name: function-pythonic
+spec:
+  deploymentTemplate:
+    spec:
+      selector: {}
+      template:
+        spec:
+          containers:
+          - name: package-runtime
+            args:
+            - --debug
+            - --crossplane-v1
+```
+
 ## Composed Resource Dependencies
 
 function-pythonic automatically handles dependencies between composed resources.
@@ -204,7 +235,9 @@ The BaseComposite class provides the following fields for manipulating the Compo
 | self.status | Map | The composite desired and observed status, read from observed if not in desired |
 | self.conditions | Conditions | The composite desired and observed conditions, read from observed if not in desired |
 | self.results | Results | Returned results applied to the Composite and optionally on the Claim |
-| self.connection | Connection | The composite desired and observed connection detials, read from observed if not in desired |
+| self.connectionSecret | Map | The name, namespace, and resourceName to use when generating the connection secret in Crossplane v2 |
+| self.connection | Map | The composite desired connection detials |
+| self.connection.observed | Map | The composite observed connection detials |
 | self.ready | Boolean | The composite desired ready state |
 
 The BaseComposite also provides access to the following Crossplane Function level features:
@@ -246,13 +279,13 @@ Resource class:
 | Resource.data | Map | The resource data |
 | Resource.status | Map | The resource status |
 | Resource.conditions | Conditions | The resource conditions |
-| Resource.connection | Connection | The resource connection details |
+| Resource.connection | Map | The resource observed connection details |
 | Resource.ready | Boolean | The resource ready state |
 | Resource.unknownsFatal | Boolean | Terminate the composition if this resource has been created and is assigned unknown values, default is Composite.unknownsFatal |
 | Resource.usages | Boolean | Generate Crossplane Usages for this resource, default is Composite.autoReady |
 | Resource.autoReady | Boolean | Perform auto ready processing on this resource, default is Composite.autoReady |
 
-### Required Resources (AKA Extra Resources)
+### Required Resources
 
 Creating and accessing required resources is performed using the `BaseComposite.requireds` field.
 `BaseComposite.requireds` is a dictionary of the required resources whose key is the required
@@ -286,6 +319,7 @@ Each resource in the list is the following RequiredResource class:
 | RequiredResource.data | Map | The required resource data |
 | RequiredResource.status | Map | The required resource status |
 | RequiredResource.conditions | Map | The required resource conditions |
+| RequiredResource.connection | Map | The required resource connection details |
 
 ### Conditions
 
@@ -348,11 +382,11 @@ $ pip install crossplane-function-pythonic
 Then to render function-pythonic Compositions, use the `function-pythonic render ...`
 command.
 ```shell
-$ function-pythonic render --help
+$ function-pythonic render -h
 usage: Crossplane Function Pythonic render [-h] [--debug] [--log-name-width WIDTH] [--python-path DIRECTORY] [--render-unknowns]
                                            [--allow-oversize-protos] [--context-files KEY=PATH] [--context-values KEY=VALUE]
-                                           [--observed-resources PATH] [--extra-resources PATH] [--required-resources PATH]
-                                           [--function-credentials PATH] [--include-full-xr] [--include-function-results] [--include-context]
+                                           [--observed-resources PATH] [--required-resources PATH] [--secret-store PATH] [--include-full-xr]
+                                           [--include-connection-xr] [--include-function-results] [--include-context]
                                            PATH [PATH/CLASS]
 
 positional arguments:
@@ -376,14 +410,14 @@ options:
                         Context key-value pairs to pass to the Function pipeline. Values must be YAML/JSON. Keys take precedence over --context-files.
   --observed-resources, -o PATH
                         A YAML file or directory of YAML files specifying the observed state of composed resources.
-  --extra-resources PATH
-                        A YAML file or directory of YAML files specifying required resources (deprecated, use --required-resources).
   --required-resources, -e PATH
                         A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline.
-  --function-credentials PATH
-                        A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR.
+  --secret-store, -s PATH
+                        A YAML file or directory of YAML files specifying Secrets to use to resolve connections and credentials.
   --include-full-xr, -x
                         Include a direct copy of the input XR's spedc and metadata fields in the rendered output.
+  --include-connection-xr
+                        Include the Composite connection values in the rendered output as a resource of kind: Connection.
   --include-function-results, -r
                         Include informational and warning messages from Functions in the rendered output as resources of kind: Result..
   --include-context, -c
@@ -521,7 +555,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.2.0
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.3.0
   runtimeConfigRef:
     name: function-pythonic
 ---

{crossplane_function_pythonic-0.2.0 → crossplane_function_pythonic-0.3.0}/crossplane/pythonic/__about__.py

@@ -1,2 +1,2 @@
 # This is set at build time, using "hatch version"
-__version__ = "0.2.0"
+__version__ = "0.3.0"

crossplane_function_pythonic-0.3.0/crossplane/pythonic/auto_ready.py

@@ -0,0 +1,153 @@
+
+
+def process(composite):
+    for name, resource in composite.resources:
+        if resource.observed:
+            if resource.autoReady or (resource.autoReady is None and composite.autoReady):
+                if resource.ready is None:
+                    if _checks.get((resource.apiVersion, resource.kind), _check_default).ready(resource):
+                        resource.ready = True
+
+
+class ConditionReady:
+    def ready(self, resource):
+        return bool(resource.conditions.Ready.status)
+
+_checks = {}
+_check_default = ConditionReady()
+
+class Check:
+    @classmethod
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        if hasattr(cls, 'apiVersion'):
+            _checks[(cls.apiVersion, cls.__name__)] = cls()
+
+    def ready(self, resource):
+        raise NotImplementedError()
+
+class AlwaysReady(Check):
+    def ready(self, resource):
+        return True
+
+
+class ClusterRole(AlwaysReady):
+    apiVersion = 'rbac.authorization.k8s.io/v1'
+
+class ClusterRoleBinding(AlwaysReady):
+    apiVersion = 'rbac.authorization.k8s.io/v1'
+
+class ConfigMap(AlwaysReady):
+    apiVersion = 'v1'
+
+class CronJob(Check):
+    apiVersion = 'batch/v1'
+    def ready(self, resource):
+        if resource.observed.spec.suspend and len(resource.observed.spec.suspend):
+            return True
+        if not resource.status.lastScheduleTime:
+            return False
+        if resource.status.active:
+            return True
+        if not resource.status.lastSuccessfulTime:
+            return False
+        return str(resource.status.lastSuccessfulTime) >= str(resource.status.lastScheduleTime)
+
+class DaemonSet(Check):
+    apiVersion = 'apps/v1'
+    def ready(self, resource):
+        if not resource.status.desiredNumberScheduled:
+            return False
+        scheduled = resource.status.desiredNumberScheduled
+        return (scheduled == resource.status.numberReady and
+                scheduled == resource.status.updatedNumberScheduled and
+                scheduled == resource.status.numberAvailable
+                )
+
+class Deployment(Check):
+    apiVersion = 'apps/v1'
+    def ready(self, resource):
+        replicas = resource.observed.spec.replicas or 1
+        if resource.status.updatedReplicas != replicas or resource.status.availableReplicas != replicas:
+            return False
+        return bool(resource.conditions.Available.status)
+
+class HorizontalPodAutoscaler(Check):
+    apiVersion = 'autoscaling/v2'
+    def ready(self, resource):
+        for type in ('FailedGetScale', 'FailedUpdateScale', 'FailedGetResourceMetric', 'InvalidSelector'):
+            if resource.conditions[type].status:
+                return False
+        for type in ('ScalingActive', 'ScalingLimited'):
+            if resource.conditions[type].status:
+                return True
+        return False
+
+class Ingress(Check):
+    apiVersion = 'networking.k8s.io/v1'
+    def ready(self, resource):
+        return len(resource.status.loadBalancer.ingress) > 0
+
+class Job(Check):
+    apiVersion = 'batch/v1'
+    def ready(self, resource):
+        for type in ('Failed', 'Suspended'):
+            if resource.conditions[type].status:
+                return False
+        return bool(resource.conditions.Complete.status)
+
+class Namespace(AlwaysReady):
+    apiVersion = 'v1'
+
+class PersistentVolumeClaim(Check):
+    apiVersion = 'v1'
+    def ready(self, resource):
+        return resource.status.phase == 'Bound'
+
+class Pod(Check):
+    apiVersion = 'v1'
+    def ready(self, resource):
+        if resource.status.phase == 'Succeeded':
+            return True
+        if resource.status.phase == 'Running':
+            if resource.observed.spec.restartPolicy == 'Always':
+                if resource.conditions.Ready.status:
+                    return True
+        return False
+
+class ReplicaSet(Check):
+    apiVersion = 'v1'
+    def ready(self, resource):
+        if int(resource.status.observedGeneration) < int(resource.observed.metadata.generation):
+            return False
+        if resource.conditions.ReplicaFailure.status:
+            return False
+        return int(resource.status.availableReplicas) >= int(resource.observed.spec.replicas or 1)
+
+class Role(AlwaysReady):
+    apiVersion = 'rbac.authorization.k8s.io/v1'
+
+class RoleBinding(AlwaysReady):
+    apiVersion = 'rbac.authorization.k8s.io/v1'
+
+class Secret(AlwaysReady):
+    apiVersion = 'v1'
+
+class Service(Check):
+    apiVersion = 'v1'
+    def ready(self, resource):
+        if resource.observed.spec.type != 'LoadBalancer':
+            return True
+        return len(resource.status.loadBalancer.ingress) > 0
+
+class ServiceAccount(AlwaysReady):
+    apiVersion = 'v1'
+
+class StatefulSet(Check):
+    apiVersion = 'apps/v1'
+    def ready(self, resource):
+        replicas = resource.observed.spec.replicas or 1
+        return (resource.status.readyReplicas == replicas and
+                resource.status.currentReplicas == replicas and
+                resource.status.currentRevision == resource.status.updateRevision
+                )

{crossplane_function_pythonic-0.2.0 → crossplane_function_pythonic-0.3.0}/crossplane/pythonic/command.py

@@ -50,6 +50,11 @@ class Command:
             action='store_true',
             help='Allow oversized protobuf messages',
         )
+        parser.add_argument(
+            '--crossplane-v1',
+            action='store_true',
+            help='Enable Crossplane V1 compatibility mode',
+        )
 
     def __init__(self, args):
         self.args = args