crossplane-function-pythonic 0.4.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

{crossplane_function_pythonic-0.4.2.dist-info → crossplane_function_pythonic-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.4.2
+Version: 0.6.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
@@ -19,7 +19,7 @@ Requires-Dist: inflect==7.5.0
 Requires-Dist: kr8s==0.20.15
 Requires-Dist: pyyaml==6.0.3
 Provides-Extra: packages
-Requires-Dist: kopf==1.43.0; extra == 'packages'
+Requires-Dist: kopf==1.44.4; extra == 'packages'
 Provides-Extra: pip-install
 Requires-Dist: pip==26.0.1; extra == 'pip-install'
 Description-Content-Type: text/markdown
@@ -83,7 +83,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
 ```
 
 ### Crossplane V1
@@ -95,7 +95,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
   runtimeConfigRef:
     name: function-pythonic
 --
@@ -199,6 +199,11 @@ subnet.spec.forProvider.cidrBlock = '10.0.0.0/20'
 ```
 Will generate the appropriate Crossplane Usage resource.
 
+## API Documentation
+
+- [Composite API (`composite.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/composite.md)
+- [Protobuf Wrapper API (`protobuf.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/protobuf.md)
+
 ## Pythonic access of Protobuf Messages
 
 All Protobuf messages are wrapped by a set of python classes which enable using
@@ -287,6 +292,7 @@ The BaseComposite class provides the following fields for manipulating the Compo
 | self.metadata | Map | The composite observed metadata |
 | self.spec | Map | The composite observed spec |
 | self.status | Map | The composite desired and observed status, read from observed if not in desired |
+| self.output | Map | The step output, only used during Operations |
 | 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.connectionSecret | Map | The name, namespace, and resourceName to use when generating the connection secret in Crossplane v2 |
@@ -301,17 +307,31 @@ The BaseComposite also provides access to the following Crossplane Function leve
 | self.request | Message | Low level direct access to the RunFunctionRequest message |
 | self.response | Message | Low level direct access to the RunFunctionResponse message |
 | self.logger | Logger | Python logger to log messages to the running function stdout |
+| self.capabilities | Capabilities | This Crossplane version's Capabilities |
 | self.parameters | Map | The configured step parameters |
 | self.ttl | Integer | Get or set the response TTL, in seconds |
 | self.credentials | Credentials | The request credentials |
 | self.context | Map | The response context, initialized from the request context |
 | self.environment | Map | The response environment, initialized from the request context environment |
 | self.requireds | Requireds | Request and read additional local Kubernetes resources |
+| self.schemas | Schemas | Request and read CustomResourceDefinition schemas |
 | self.resources | Resources | Define and process composed resources |
 | self.usages| Boolean | Generate Crossplane Usages for resource dependencies, default False |
 | self.autoReady | Boolean | Perform auto ready processing on all composed resources, default True |
 | self.unknownsFatal | Boolean | Terminate the composition if already created resources are assigned unknown values, default False |
 
+### Capabiities
+
+The Capabilities of the Crossplane version calling function-pythonic.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| bool(Capabilities) | Boolean | Whether or not the Crossplane version supports Capabilities |
+| Capabiities.requireds | Boolean | Functions can return required resources and Crossplane will fetch the required resources |
+| Capabiities.credentials | Boolean | Functions can receive credentials from secrets specified in the Composition |
+| Capabiities.conditions | Boolean | Functions can return status conditions to be applied to the XR and optionally its claim |
+| Capabiities.schemas | Boolean | Functions can request OpenAPI schemas and Crossplane will return them |
+
 ### Composed Resources
 
 Creating and accessing composed resources is performed using the `BaseComposite.resources` field.
@@ -345,7 +365,7 @@ Resource class:
 
 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
-resource name. The value returned when getting a required resource from BaseComposite is the
+schema name. The value returned when getting a required resource from BaseComposite is the
 following RequiredResources class:
 
 | Field | Type | Description |
@@ -358,9 +378,6 @@ following RequiredResources class:
 | RequiredResources.matchName | String | The names to match when returning the required resources |
 | RequiredResources.matchLabels | Map | The labels to match when returning the required resources |
 
-The current version of crossplane-sdk-python used by function-pythonic does not support namespace
-selection. For now, use matchLabels and filter the results if required.
-
 RequiredResources acts like a Python list to provide access to the found required resources.
 Each resource in the list is the following RequiredResource class:
 
@@ -377,6 +394,22 @@ Each resource in the list is the following RequiredResource class:
 | RequiredResource.conditions | Map | The required resource conditions |
 | RequiredResource.connection | Map | The required resource connection details |
 
+### Required Schemas
+
+Creating and accessing required schemas is performed using the `BaseComposite.schemas` field.
+`BaseComposite.schemas` is a dictionary of the required schema whose key is the required
+resource name. The value returned when getting a required resource from BaseComposite is the
+following Schema class:
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Schema(apiVersion,kind) | Schema | Reset the required schema and set the optional parameters |
+| Schema.name | String | The required schema name |
+| Schema.apiVersion | String | The required schema selector apiVersion |
+| Schema.kind | String | The required schema selector kind |
+| Schema.\_\_getitem\_\_ | Map | The required schema openAPIV3Schema |
+| Schema.\_\_getattr\_\_ | Map | The required schema openAPIV3Schema |
+
 ### Conditions
 
 The `BaseComposite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
@@ -406,25 +439,78 @@ optionally to the Claim.
 | Result.message | String | Human-readable details about the result |
 | Result.claim | Boolean | Also apply the result to the claim |
 
-## Single use Composites
+## Inlined Composites
 
 Tired of creating a CompositeResourceDefinition, a Composition, and a Composite
-just to run that Composition once in a single use or initialize task?
+just to run that Composition once in a setup or initialize task?
 
-function-pythonic installs a `Composite` CompositeResourceDefinition that enables
-creating such tasks using a single Composite resource:
+function-pythonic supports "inlined" Compositions, where the python module
+is obtained from a field in the Composite's spec.
 ```yaml
-apiVersion: pythonic.fn.crossplane.io/v1alpha1
-kind: Composite
+apiVersion: inlined.example.org/v1alpha1
+kind: Step
 metadata:
-  name: composite-example
+  name: inlined-example
 spec:
   composite: |
     class HelloComposite(BaseComposite):
       def compose(self):
-        self.status.composite = 'Hello, World!'
+        self.status.step = 'Hello, World!'
+```
+The CompositeResourceDefinition and Composition to support the above example:
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: CompositeResourceDefinition
+metadata:
+  name: inlined.example.org/v1alpha1
+spec:
+  group: inlined.example.org
+  names:
+    kind: Step
+    plural: steps
+  defaultCompositionRef:
+    name: steps.inlined.example.org
+  versions:
+  - name: v1alpha1
+    served: true
+    referenceable: true
+    schema:
+      openAPIV3Schema:
+        type: object
+        properties:
+          spec:
+            type: object
+            properties:
+              composite:
+                type: string
+                description: 'A Python module that defines a class with the signature: class Composite(BaseComposite)'
+            required:
+            - composite
+          status:
+            type: object
+            properties:
+              composite:
+                x-kubernetes-preserve-unknown-fields: true
+```
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: steps.inlined.example.org
+spec:
+  compositeTypeRef:
+    apiVersion: inlined.example.org/v1alpha1
+    kind: Step
+  mode: Pipeline
+  pipeline:
+  - step: inlined
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.crossplane.io/v1alpha1
+      kind: Composite
+      inlined: composite
 ```
-
 ## Quick Start Development
 
 function-pythonic includes a pure python implementation of the `crossplane render ...`
@@ -442,7 +528,7 @@ $ function-pythonic render --help
 usage: Crossplane Function Pythonic render [-h] [--debug] [--log-name-width WIDTH] [--logger-level LOGGER=LEVEL] [--python-path DIRECTORY]
                                            [--render-unknowns] [--allow-oversize-protos] [--crossplane-v1] [--kube-context CONTEXT]
                                            [--context-files KEY=PATH] [--context-values KEY=VALUE] [--observed-resources PATH]
-                                           [--required-resources PATH] [--secret-store PATH] [--include-full-xr] [--include-connection-xr]
+                                           [--required-resources PATH] [--required-schemas PATH] [--include-full-xr] [--include-connection-xr]
                                            [--include-function-results] [--include-context]
                                            COMPOSITE [COMPOSITION]
 
@@ -474,8 +560,8 @@ options:
                         A YAML file or directory of YAML files specifying the observed state of composed resources.
   --required-resources, -e PATH
                         A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline.
-  --secret-store, -s PATH
-                        A YAML file or directory of YAML files specifying Secrets to use to resolve connections and credentials.
+  --required-schemas, -s PATH
+                        A JSON file or directory of JSON files specifying required schemas to pass to the Function pipeline.
   --include-full-xr, -x
                         Include a direct copy of the input XR's spedc and metadata fields in the rendered output.
   --include-connection-xr
@@ -544,9 +630,15 @@ status:
 Most of the examples contain a `render.sh` command which uses `function-pythonic render` to
 render the example.
 
-## ConfigMap Packages
+## Shared Python Packages
+
+Python packages and modules can be added to the function-pythonic runtime
+by including the python code in any of the following resources: ConfigMap,
+Secret, EnvironmentConfig, or Composition
 
-ConfigMap based python packages are enable using the `--packages` and
+### ConfigMap Packages
+
+ConfigMap based python packages are enable using the `--packages-configmaps` and
 `--packages-namespace` command line options. ConfigMaps with the label
 `function-pythonic.package` will be incorporated in the python path at
 the location configured in the label value. For example, the following
@@ -608,7 +700,7 @@ data:
       composite: example.pythonic.features.FeatureOneComposite
     ...
 ```
-This requires enabling the the packages support using the `--packages` command
+This requires enabling the the packages support using the `--packages-configmaps` command
 line option in the DeploymentRuntimeConfig and configuring the required
 Kubernetes RBAC permissions. For example:
 ```yaml
@@ -617,7 +709,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
   runtimeConfigRef:
     name: function-pythonic
 ---
@@ -679,9 +771,71 @@ ClusterRole permissions. The `--packages-namespace` command line option will res
 to only using the supplied namespace. This option can be invoked multiple times.
 The above RBAC permission can then be per namespace RBAC Role permissions.
 
+### Secret Packages
+
 Secrets can also be used in an identical manner as ConfigMaps by enabling the
 `--packages-secrets` command line option. Secrets permissions need to be
-added to the above RBAC configuration.
+added to the above RBAC configuration. Secret based python packages also enable
+provisioning files with binary data.
+
+### EnvironmentConfig Packages
+
+EnvironmentConfig based provisioning enable an entire package and module
+directory structure. Use the `--packages-environmentconfigs` command line option
+and configure the ClusterRole RBAC access.
+```yaml
+apiVersion: apiextensions.crossplane.io/v1beta1
+kind: EnvironmentConfig
+metadata:
+  name: test
+  labels:
+    function-pythonic.package: 'true'
+data:
+  arootpackage:
+    asubpackage:
+      bmodule.py: |
+        def hello(where):
+          return f"Hello, {where}!"
+    amodule.py: |
+      def goodby(where):
+        return f"Goodby, {where}!"
+```
+### Composition Packages
+
+Composition based provisioning works just like EnvironmentConfig where a
+directory structure is created. Use the `--packages-compositions` command line option
+and configure the ClusterRole RBAC access. The main reason to use Composition
+based provision is because Compositions can be included in a Crossplane
+Configuration Package.
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  labels:
+    function-pythonic.package: 'true'
+  name: test
+spec:
+  compositeTypeRef:
+    apiVersion: code.pythoni.com/v1alpha1
+    kind: Code
+  mode: Pipeline
+  pipeline:
+  - step: render
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.crossplane.io/v1alpha1
+      kind: Composite
+      packages:
+        arootpackage:
+          asubpackage:
+            bmodule.py: |
+              def hello(where):
+                return f"Hello, {where}!"
+          amodule.py: |
+            def goodby(where):
+              return f"Goodby, {where}!"
+```
 
 ## Step Parameters
 

crossplane_function_pythonic-0.6.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+crossplane/pythonic/__about__.py,sha256=v3R2QlL6bK_t2oKW7b96iHro1p7Iag8djZQbp6xQLPE,73
+crossplane/pythonic/__init__.py,sha256=cRk12kc18RLhc9s5dW6sQqZSCEp80fooRO5zxXqc1oA,292
+crossplane/pythonic/__main__.py,sha256=6vYRlYDJtqFgLyiTamnl3htiNOtz8QlDl5WlIP98I8o,31
+crossplane/pythonic/auto_ready.py,sha256=sPetUuJRhwZbg9muaDmbdqmtTIIUDmY4qoadoJA0EtQ,7201
+crossplane/pythonic/command.py,sha256=aT58WBrhU_scaOGeqmsBfofIDnXyW1CQOpCktVGBj5s,4211
+crossplane/pythonic/composite.py,sha256=gQ7DzY0kn8J2lUWH9hYVLZB6NYDBo0IJJwUDBooTNsc,34459
+crossplane/pythonic/function.py,sha256=2f8-J5sgDrtn3z6Fxu2JODnr6VsjBESIVSJ5Hd4LssY,18573
+crossplane/pythonic/grpc.py,sha256=WFyxkIh-nNtOswQhtN1V3e-8Qr79fDcNht8OpvihHYM,5694
+crossplane/pythonic/main.py,sha256=ujUa_FYElQSGqnhZ-0NJrD3kSyYjfRbIp79FV2Yl7hs,599
+crossplane/pythonic/packages.py,sha256=cOlF-wo2CzknwFPAfuwgCiwdT5vDE4n7oBMfQErVzbA,7023
+crossplane/pythonic/protobuf.py,sha256=-HFHlGV1zMi5DmTOxe9qcBMJ0bZKH2hEkJH1CF7nvp4,53128
+crossplane/pythonic/render.py,sha256=qIcUsE6iCka6VwUlhpN1BZhHvbl3GL6X3dPepmdlDV8,33822
+crossplane/pythonic/version.py,sha256=-RiB0p146ayqJj0SXfYxTNv49u9Fx9pPgm59Ji2blhc,214
+crossplane_function_pythonic-0.6.0.dist-info/METADATA,sha256=kaKnXE14jueu5X-kf8k2H904NIg9qV-o4WGOJOaUqqs,36678
+crossplane_function_pythonic-0.6.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+crossplane_function_pythonic-0.6.0.dist-info/entry_points.txt,sha256=jJ4baywFDviB9WyAhyhNYF2VOCb6XtbRSjKf7bnBwhg,68
+crossplane_function_pythonic-0.6.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+crossplane_function_pythonic-0.6.0.dist-info/RECORD,,

{crossplane_function_pythonic-0.4.2.dist-info → crossplane_function_pythonic-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.28.0
+Generator: hatchling 1.29.0
 Root-Is-Purelib: true
 Tag: py3-none-any

crossplane_function_pythonic-0.4.2.dist-info/RECORD

@@ -1,18 +0,0 @@
-crossplane/pythonic/__about__.py,sha256=6nxRspkiSsLkBLqHh-X--3FLozkQy1xfr-6ZG0LORbs,73
-crossplane/pythonic/__init__.py,sha256=cRk12kc18RLhc9s5dW6sQqZSCEp80fooRO5zxXqc1oA,292
-crossplane/pythonic/__main__.py,sha256=6vYRlYDJtqFgLyiTamnl3htiNOtz8QlDl5WlIP98I8o,31
-crossplane/pythonic/auto_ready.py,sha256=sPetUuJRhwZbg9muaDmbdqmtTIIUDmY4qoadoJA0EtQ,7201
-crossplane/pythonic/command.py,sha256=aT58WBrhU_scaOGeqmsBfofIDnXyW1CQOpCktVGBj5s,4211
-crossplane/pythonic/composite.py,sha256=f9SYjtXVqRx7vse7nQ06Ic6EnnfCYVtpoOmBhR9Jv6g,30451
-crossplane/pythonic/function.py,sha256=uILb3XICcWi2JA5W1xuq37nFQA3_TqbdJefo0-gUUNI,18063
-crossplane/pythonic/grpc.py,sha256=9ZQceboDju37NB6AhcUSWpBx_hZQ5W7uo7CZF6ynhfI,4451
-crossplane/pythonic/main.py,sha256=ujUa_FYElQSGqnhZ-0NJrD3kSyYjfRbIp79FV2Yl7hs,599
-crossplane/pythonic/packages.py,sha256=4TxyT6V79R0m4tJbC8R1gwU_vgHGLXKSBzeTTKd8xGo,5120
-crossplane/pythonic/protobuf.py,sha256=YcKqH0Y4Vj63m6pUb1ptL4gIKcdNLU-WR8TaQ5eGW-M,52987
-crossplane/pythonic/render.py,sha256=e_WQF5TlemfsZim2oGkTPAWuU6BDJztexJ9iBbuFQbo,30417
-crossplane/pythonic/version.py,sha256=-RiB0p146ayqJj0SXfYxTNv49u9Fx9pPgm59Ji2blhc,214
-crossplane_function_pythonic-0.4.2.dist-info/METADATA,sha256=KemrVxbVM4-B6I1P-Gq3hDdqE67sPMCRyfu9gjBY4_w,31561
-crossplane_function_pythonic-0.4.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-crossplane_function_pythonic-0.4.2.dist-info/entry_points.txt,sha256=jJ4baywFDviB9WyAhyhNYF2VOCb6XtbRSjKf7bnBwhg,68
-crossplane_function_pythonic-0.4.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-crossplane_function_pythonic-0.4.2.dist-info/RECORD,,