Skip to content

Commit fb6f050

Browse files
author
Patrick J. McNerthney
committed
Update README and enable autoReady per composed resource
1 parent 9f77565 commit fb6f050

File tree

8 files changed

+216
-197
lines changed

8 files changed

+216
-197
lines changed

README.md

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -170,35 +170,35 @@ class Composite(BaseComposite):
170170

171171
The BaseComposite class provides the following fields for manipulating the Composite itself:
172172

173-
| Field | Description |
174-
| ----- | ----------- |
175-
| self.observed | Low level direct access to the observed composite |
176-
| self.desired | Low level direct access to the desired composite |
177-
| self.apiVersion | The composite observed apiVersion |
178-
| self.kind | The composite observed kind |
179-
| self.metadata | The composite observed metadata |
180-
| self.spec | The composite observed spec |
181-
| self.status | The composite desired and observed status, read from observed if not in desired |
182-
| self.conditions | The composite desired and observed conditions, read from observed if not in desired |
183-
| self.connection | The composite desired and observed connection detials, read from observed if not in desired |
184-
| self.ready | The composite desired ready state |
173+
| Field | Type | Description |
174+
| ----- | ---- | ----------- |
175+
| self.observed | Map | Low level direct access to the observed composite |
176+
| self.desired | Map | Low level direct access to the desired composite |
177+
| self.apiVersion | String | The composite observed apiVersion |
178+
| self.kind | String | The composite observed kind |
179+
| self.metadata | Map | The composite observed metadata |
180+
| self.spec | Map | The composite observed spec |
181+
| self.status | Map | The composite desired and observed status, read from observed if not in desired |
182+
| self.conditions | Conditions | The composite desired and observed conditions, read from observed if not in desired |
183+
| self.connection | Connection | The composite desired and observed connection detials, read from observed if not in desired |
184+
| self.results | Results | Returned results on the Composite and optionally on the Claim |
185+
| self.ready | Boolean | The composite desired ready state |
185186

186187
The BaseComposite also provides access to the following Crossplane Function level features:
187188

188-
| Field | Description |
189-
| ----- | ----------- |
190-
| self.request | Low level direct access to the RunFunctionRequest message |
191-
| self.response | Low level direct access to the RunFunctionResponse message |
192-
| self.logger | Python logger to log messages to the running function stdout |
193-
| self.ttl | Get or set the response TTL, in seconds |
194-
| self.credentials | The request credentials |
195-
| self.context | The response context, initialized from the request context |
196-
| self.environment | The response environment, initialized from the request context environment |
197-
| self.requireds | Request and read additional local Kubernetes resources |
198-
| self.resources | Define and process composed resources |
199-
| self.results | Returned results on the Composite and optionally on the Claim |
200-
| self.unknownsFatal | Terminate the composition if already created resources are assigned unknown values, default True |
201-
| self.autoReady | Perform auto ready processing after the compose method returns, default True |
189+
| Field | Type | Description |
190+
| ----- | ---- | ----------- |
191+
| self.request | Message | Low level direct access to the RunFunctionRequest message |
192+
| self.response | Message | Low level direct access to the RunFunctionResponse message |
193+
| self.logger | Logger | Python logger to log messages to the running function stdout |
194+
| self.ttl | Integer | Get or set the response TTL, in seconds |
195+
| self.credentials | Credentials | The request credentials |
196+
| self.context | Map | The response context, initialized from the request context |
197+
| self.environment | Map | The response environment, initialized from the request context environment |
198+
| self.requireds | Requireds | Request and read additional local Kubernetes resources |
199+
| self.resources | Resources | Define and process composed resources |
200+
| self.unknownsFatal | Boolean | Terminate the composition if already created resources are assigned unknown values, default True |
201+
| self.autoReady | Boolean | Perform auto ready processing on all composed resources, default True |
202202

203203
### Composed Resources
204204

@@ -207,23 +207,24 @@ Creating and accessing composed resources is performed using the `BaseComposite.
207207
resource name. The value returned when getting a resource from BaseComposite is the following
208208
Resource class:
209209

210-
| Field | Description |
211-
| ----- | ----------- |
212-
| Resource(apiVersion,kind,namespace,name) | Reset the resource and set the optional parameters |
213-
| Resource.name | The composition resource name of the composed resource |
214-
| Resource.observed | Low level direct access to the observed composed resource |
215-
| Resource.desired | Low level direct access to the desired composed resource |
216-
| Resource.apiVersion | The composed resource apiVersion |
217-
| Resource.kind | The composed resource kind |
218-
| Resource.externalName | The composed resource external name |
219-
| Resource.metadata | The composed resource desired metadata |
220-
| Resource.spec | The resource spec |
221-
| Resource.data | The resource data |
222-
| Resource.status | The resource status |
223-
| Resource.conditions | The resource conditions |
224-
| Resource.connection | The resource connection details |
225-
| Resource.ready | The resource ready state |
226-
| Resource.unknownsFatal | Terminate the composition if this resource has been created and is assigned unknown values, default is Composite.unknownsFatal |
210+
| Field | Type | Description |
211+
| ----- | ---- | ----------- |
212+
| Resource(apiVersion,kind,namespace,name) | Resource | Reset the resource and set the optional parameters |
213+
| Resource.name | String | The composition composed resource name |
214+
| Resource.observed | Map | Low level direct access to the observed composed resource |
215+
| Resource.desired | Map | Low level direct access to the desired composed resource |
216+
| Resource.apiVersion | String | The composed resource apiVersion |
217+
| Resource.kind | String | The composed resource kind |
218+
| Resource.externalName | String | The composed resource external name |
219+
| Resource.metadata | Map | The composed resource desired metadata |
220+
| Resource.spec | Map | The resource spec |
221+
| Resource.data | Map | The resource data |
222+
| Resource.status | Map | The resource status |
223+
| Resource.conditions | Conditions | The resource conditions |
224+
| Resource.connection | Connection | The resource connection details |
225+
| Resource.ready | Boolean | The resource ready state |
226+
| Resource.unknownsFatal | Boolean | Terminate the composition if this resource has been created and is assigned unknown values, default is Composite.unknownsFatal |
227+
| Resource.autoReady | Boolean | Perform auto ready processing on this resource, default is Composite.autoReady |
227228

228229
### Required Resources (AKA Extra Resources)
229230

@@ -232,15 +233,15 @@ Creating and accessing required resources is performed using the `BaseComposite.
232233
resource name. The value returned when getting a required resource from BaseComposite is the
233234
following RequiredResources class:
234235

235-
| Field | Description |
236-
| ----- | ----------- |
237-
| RequiredResource(apiVersion,kind,namespace,name,labels) | Reset the required resource and set the optional parameters |
238-
| RequiredResources.name | The required resources name |
239-
| RequiredResources.apiVersion | The required resources apiVersion |
240-
| RequiredResources.kind | The required resources kind |
241-
| RequiredResources.namespace | The namespace to match when returning the required resources, see note below |
242-
| RequiredResources.matchName | The names to match when returning the required resources |
243-
| RequiredResources.matchLabels | The labels to match when returning the required resources |
236+
| Field | Type | Description |
237+
| ----- | ---- | ----------- |
238+
| RequiredResource(apiVersion,kind,namespace,name,labels) | RequiredResource | Reset the required resource and set the optional parameters |
239+
| RequiredResources.name | String | The required resources name |
240+
| RequiredResources.apiVersion | String | The required resources apiVersion |
241+
| RequiredResources.kind | String | The required resources kind |
242+
| RequiredResources.namespace | String | The namespace to match when returning the required resources, see note below |
243+
| RequiredResources.matchName | String | The names to match when returning the required resources |
244+
| RequiredResources.matchLabels | Map | The labels to match when returning the required resources |
244245

245246
The current version of crossplane-sdk-python used by function-pythonic does not support namespace
246247
selection. For now, use matchLabels and filter the results if required.
@@ -260,6 +261,23 @@ Each resource in the list is the following RequiredResource class:
260261
| RequiredResource.status | The required resource status |
261262
| RequiredResource.conditions | The required resource conditions |
262263

264+
### Conditions
265+
266+
The `conditions` field is a map of the resource's status conditions array, with
267+
the map key being the condition type.
268+
269+
| Field | Description |
270+
| ----- | ----------- |
271+
| Condition.type | The condtion type |
272+
| Condition.status | RequiredResource.observed | Low level direct access to the observed required resource |
273+
| RequiredResource.apiVersion | The required resource apiVersion |
274+
| RequiredResource.kind | The required resource kind |
275+
| RequiredResource.metadata | The required resource metadata |
276+
| RequiredResource.spec | The required resource spec |
277+
| RequiredResource.data | The required resource data |
278+
| RequiredResource.status | The required resource status |
279+
| RequiredResource.conditions | The required resource conditions |
280+
263281
## Single use Composites
264282

265283
Tired of creating a CompositeResourceDefinition, a Composition, and a Composite

0 commit comments

Comments
 (0)