Skip to content

Commit d34b276

Browse files
committed
Sync content/master -> content/v2.0
Signed-off-by: Nic Cope <nicc@rk0n.org>
1 parent c005bb3 commit d34b276

39 files changed

+130
-42
lines changed

content/v2.0/cli/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
weight: 200
33
title: CLI Reference
4-
description: "Documentation for the Crossplane command-line interface"
4+
description: "Command-line tools for Crossplane development"
55
---
66

77
The Crossplane CLI helps simplify some development and administration aspects of

content/v2.0/composition/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Composition
33
weight: 51
4-
description: Understand Crossplane's core components
4+
description: Build custom APIs by composing Kubernetes resources
55
---
6+
7+
{{< auto-index >}}

content/v2.0/composition/composite-resource-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Composite Resource Definitions
33
weight: 20
4-
description: "Composite Resource Definitions or XRDs define custom API schemas"
4+
description: "Define schemas for composite resources"
55
---
66

77
Composite resource definitions (`XRDs`) define the schema for a custom API.

content/v2.0/composition/composite-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Composite Resources
33
weight: 10
4-
description: "Composite resources, an XR or XRs, represent a collection of related cloud resources."
4+
description: "Custom APIs created by composing Kubernetes resources"
55
---
66

77
A composite resource, or XR, represents a set of Kubernetes resources as a

content/v2.0/composition/composition-revisions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Composition Revisions
33
weight: 35
4+
description: "Manage changes to Compositions with revisions"
45
---
56

67
This guide discusses the use of "Composition Revisions" to make and roll

content/v2.0/composition/compositions.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ aliases:
55
- composition
66
- composition-functions
77
- /knowledge-base/guides/composition-functions
8-
description: "Compositions are a template for creating composite resources"
8+
description: "Define which resources to create and how"
99
---
1010

1111
Compositions are a template for creating multiple Kubernetes resources as a
@@ -140,7 +140,12 @@ reports `True`.
140140

141141
Crossplane calls a Function to determine what resources it should create when
142142
you create a composite resource. The Function also tells Crossplane what to do
143-
with these resources when you update or delete a composite resource.
143+
with these resources when you update a composite resource.
144+
145+
{{<hint "note" >}}
146+
Composition functions don't run when you delete a composite resource.
147+
Crossplane handles deletion of composed resources automatically.
148+
{{< /hint >}}
144149

145150
When Crossplane calls a Function it sends it the current state of the composite
146151
resource. It also sends it the current state of any resources the composite
@@ -576,7 +581,7 @@ sequenceDiagram
576581
Crossplane Pod->>+API Server: Apply desired composed resources
577582
```
578583

579-
When you create, update, or delete a composite resource that uses composition
584+
When you create or update a composite resource that uses composition
580585
functions Crossplane calls each function in the order they appear in the
581586
Composition's pipeline. Crossplane calls each function by sending it a gRPC
582587
RunFunctionRequest. The function must respond with a gRPC RunFunctionResponse.
@@ -769,3 +774,35 @@ that isn't desired state. Functions can use context for this. Any function can
769774
write to the pipeline context. Crossplane passes the context to all following
770775
functions. When Crossplane has called all functions it discards the pipeline
771776
context.
777+
778+
### Function response cache
779+
780+
{{<hint "note" >}}
781+
Function response caching is an alpha feature. Enable it by setting the
782+
`--enable-function-response-cache` feature flag.
783+
{{< /hint >}}
784+
785+
Crossplane can cache function responses to improve performance by reducing
786+
repeated function calls. When enabled, Crossplane caches responses from
787+
composition functions that include a time to live (TTL) value.
788+
789+
The cache works by:
790+
- Storing function responses on disk based on a hash of the request
791+
- Only caching responses with a nonzero TTL
792+
- Automatically removing expired cache entries
793+
- Reusing cached responses for identical requests until they expire
794+
795+
This feature helps functions that:
796+
- Perform expensive computations or external API calls
797+
- Return stable results for the same inputs
798+
- Include appropriate TTL values in their responses
799+
800+
#### Cache configuration
801+
802+
Control the cache behavior with these Crossplane pod arguments:
803+
804+
- `--xfn-cache-max-ttl` - Maximum cache duration (default: 24 hours)
805+
806+
The cache stores files in the `/cache/xfn/` directory in the Crossplane pod.
807+
For better performance, consider using an in-memory cache by mounting an
808+
emptyDir volume with `medium: Memory`.

content/v2.0/composition/environment-configs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 75
44
state: beta
55
alphaVersion: "1.11"
66
betaVersion: "1.18"
7-
description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions"
7+
description: "In-memory data stores for Compositions"
88
---
99

1010
<!--

content/v2.0/get-started/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ weight: 40
44
description: Get started with Crossplane.
55
---
66

7+
{{< auto-index >}}

content/v2.0/get-started/get-started-with-composition.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Get Started With Composition
33
weight: 200
4+
description: "Build custom APIs with Crossplane composition"
45
---
56

67
This guide shows how to create a new kind of custom resource named `App`. When a

content/v2.0/get-started/get-started-with-managed-resources.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Get Started With Managed Resources
33
weight: 300
4+
description: "Manage cloud resources in Kubernetes with Crossplane providers"
45
---
56

67
This guide shows how to install and use a new kind of custom resource called

0 commit comments

Comments
 (0)