Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/master/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Welcome"
weight: -1
description: "Control plane framework for building cloud native platforms"
cascade:
version: "master"
---
Expand Down
2 changes: 1 addition & 1 deletion content/master/cli/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
weight: 200
title: CLI Reference
description: "Documentation for the Crossplane command-line interface"
description: "Command-line tools for Crossplane development"
---

The Crossplane CLI helps simplify some development and administration aspects of
Expand Down
4 changes: 3 additions & 1 deletion content/master/composition/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Composition
weight: 51
description: Understand Crossplane's core components
description: Build custom APIs by composing Kubernetes resources
---

{{< auto-index >}}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Composite Resource Definitions
weight: 20
description: "Composite Resource Definitions or XRDs define custom API schemas"
description: "Define schemas for composite resources"
---

Composite resource definitions (`XRDs`) define the schema for a custom API.
Expand Down
2 changes: 1 addition & 1 deletion content/master/composition/composite-resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Composite Resources
weight: 10
description: "Composite resources, an XR or XRs, represent a collection of related cloud resources."
description: "Custom APIs created by composing Kubernetes resources"
---

A composite resource, or XR, represents a set of Kubernetes resources as a
Expand Down
1 change: 1 addition & 0 deletions content/master/composition/composition-revisions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Composition Revisions
weight: 35
description: "Manage changes to Compositions with revisions"
---

This guide discusses the use of "Composition Revisions" to make and roll
Expand Down
10 changes: 5 additions & 5 deletions content/master/composition/compositions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ aliases:
- composition
- composition-functions
- /knowledge-base/guides/composition-functions
description: "Compositions are a template for creating composite resources"
description: "Define which resources to create and how"
---

Compositions are a template for creating multiple Kubernetes resources as a
Expand Down Expand Up @@ -784,15 +784,15 @@ Function response caching is an alpha feature. Enable it by setting the

Crossplane can cache function responses to improve performance by reducing
repeated function calls. When enabled, Crossplane caches responses from
composition functions that include a Time-To-Live (TTL) value.
composition functions that include a time to live (TTL) value.

The cache works by:
- Storing function responses on disk based on a hash of the request
- Only caching responses with a non-zero TTL
- Only caching responses with a nonzero TTL
- Automatically removing expired cache entries
- Reusing cached responses for identical requests until they expire

This feature is particularly useful for functions that:
This feature helps functions that:
- Perform expensive computations or external API calls
- Return stable results for the same inputs
- Include appropriate TTL values in their responses
Expand All @@ -803,6 +803,6 @@ Control the cache behavior with these Crossplane pod arguments:

- `--xfn-cache-max-ttl` - Maximum cache duration (default: 24 hours)

The cache stores files in the `/cache/xfn/` directory within the Crossplane pod.
The cache stores files in the `/cache/xfn/` directory in the Crossplane pod.
For better performance, consider using an in-memory cache by mounting an
emptyDir volume with `medium: Memory`.
2 changes: 1 addition & 1 deletion content/master/composition/environment-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 75
state: beta
alphaVersion: "1.11"
betaVersion: "1.18"
description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions"
description: "In-memory data stores for Compositions"
---

<!--
Expand Down
1 change: 1 addition & 0 deletions content/master/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ weight: 40
description: Get started with Crossplane.
---

{{< auto-index >}}
1 change: 1 addition & 0 deletions content/master/get-started/get-started-with-composition.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Get Started With Composition
weight: 200
description: "Build custom APIs with Crossplane composition"
---

This guide shows how to create a new kind of custom resource named `App`. When a
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Get Started With Managed Resources
weight: 300
description: "Manage cloud resources in Kubernetes with Crossplane providers"
---

This guide shows how to install and use a new kind of custom resource called
Expand Down
1 change: 1 addition & 0 deletions content/master/get-started/get-started-with-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Get Started With Operations
weight: 300
state: alpha
alphaVersion: 2.0
description: "Run operational tasks with Crossplane operations"
---

This guide shows how to use Crossplane Operations to automate day-two
Expand Down
1 change: 1 addition & 0 deletions content/master/get-started/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Install Crossplane
weight: 100
description: "Install Crossplane in a Kubernetes cluster"
---

Crossplane installs into an existing Kubernetes cluster, creating the
Expand Down
4 changes: 3 additions & 1 deletion content/master/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
title: Guides
weight: 100
description: Crossplane integrations and detailed examples.
---
---

{{< auto-index >}}
1 change: 1 addition & 0 deletions content/master/guides/crossplane-with-argo-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
---
title: Configuring Crossplane with Argo CD
weight: 270
description: "Deploy Crossplane resources with GitOps"
---
<!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES -->
Expand Down
3 changes: 1 addition & 2 deletions content/master/guides/extensions-release-process.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Releasing Crossplane Extensions
weight: 80
description: "Configuring build pipelines for Crossplane extensions with GitHub
Actions"
description: "Build pipelines for Crossplane extensions"
---

<!-- vale Google.Headings = NO -->
Expand Down
2 changes: 1 addition & 1 deletion content/master/guides/function-patch-and-transform.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Function Patch and Transform
weight: 70
description: "A function that use patches and transforms to change inputs from composite resources before creating managed resources"
description: "Write legacy Compositions"
---

Function Patch and Transform allows you to write a Composition that specifies
Expand Down
3 changes: 1 addition & 2 deletions content/master/guides/implementing-safe-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ title: Implementing safe-start in Providers
weight: 90
state: alpha
alphaVersion: 2.0
description: Guide for provider developers to add safe-start capability for
selective resource activation
description: Add selective resource activation to providers
---

This guide shows provider developers how to implement safe-start capability in
Expand Down
2 changes: 1 addition & 1 deletion content/master/guides/metrics.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Metrics
weight: 60
description: "Metrics are essential for monitoring Crossplane's operations, helping to identify and resolve potential issues."
description: "Monitor Crossplane operations with metrics"
---

Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment.
Expand Down
4 changes: 2 additions & 2 deletions content/master/guides/pods.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Crossplane Pods
weight: 1
description: Background on the components installed with Crossplane and their functions.
description: Components installed with Crossplane
---

The base Crossplane installation consists of two pods, the `crossplane` pod and
Expand Down Expand Up @@ -137,7 +137,7 @@ Kubernetes API server when a composed resource changes. For example, when
a provider sets the `Ready` condition to `true`.

{{<hint "important" >}}
Real time compositions are a beta feature. Beta features are enabled by
Real time compositions are a beta feature. Crossplane enables beta features by
default.
{{< /hint >}}

Expand Down
3 changes: 2 additions & 1 deletion content/master/guides/self-signed-ca-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<!-- vale Microsoft.HeadingAcronyms = NO -->
---
title: Self-signed CA certs
weight: 270
weight: 270
description: "Configure Crossplane with self-signed certificates"
---
<!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES -->
Expand Down
1 change: 1 addition & 0 deletions content/master/guides/troubleshoot-crossplane.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Troubleshoot Crossplane
weight: 306
description: "Debug common Crossplane issues"
---
## Requested resource not found

Expand Down
1 change: 1 addition & 0 deletions content/master/guides/uninstall-crossplane.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Uninstall Crossplane
weight: 500
description: "Remove Crossplane from your cluster"
---

{{<hint "warning" >}}
Expand Down
1 change: 1 addition & 0 deletions content/master/guides/upgrade-crossplane.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Upgrade Crossplane
weight: 400
description: "Upgrade Crossplane to newer versions"
---

The recommended upgrade method for an existing Crossplane install is to use
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Write a Composition Function in Go
weight: 80
description: "Composition functions allow you to template resources using Go"
description: "Build composition functions in Go"
---

Composition functions (or just functions, for short) are custom programs that
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Write a Composition Function in Python
weight: 81
description: "Composition functions allow you to template resources using Python"
description: "Build composition functions in Python"
---

Composition functions (or just functions, for short) are custom programs that
Expand Down
1 change: 1 addition & 0 deletions content/master/learn/feature-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Feature Lifecycle
toc: true
weight: 309
indent: true
description: "Crossplane's feature development process"
---

# Feature lifecycle
Expand Down
1 change: 1 addition & 0 deletions content/master/learn/release-cycle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Release Cycle
weight: 308
description: "When and how Crossplane releases are cut"
---

Starting with the v1.10.0 release, Crossplane releases on a quarterly (13
Expand Down
4 changes: 3 additions & 1 deletion content/master/managed-resources/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Managed Resources
weight: 52
description: Understand Crossplane's managed resources and selective activation
description: Manage cloud resources in Kubernetes
---

{{< auto-index >}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Managed Resource Activation Policies
weight: 20
state: alpha
alphaVersion: 2.0
description: ManagedResourceActivationPolicies control which
ManagedResourceDefinitions activate for selective provider resource
installation
description: Choose which provider resources Crossplane activates
---

{{<hint "important">}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ title: Managed Resource Definitions
weight: 15
state: alpha
alphaVersion: 2.0
description: ManagedResourceDefinitions enable selective activation of provider
resources and reduce CRD overhead
description: Enable selective activation of provider resources
---

{{<hint "important">}}
Expand Down
2 changes: 1 addition & 1 deletion content/master/managed-resources/managed-resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Managed Resources
weight: 10
description: "Managed resources are the Crossplane representation of external provider resources"
description: "Kubernetes representations of cloud resources"
---

A _managed resource_ (`MR`) represents an external service in a Provider. When
Expand Down
4 changes: 2 additions & 2 deletions content/master/managed-resources/usages.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 30
state: beta
alphaVersion: "1.14"
betaVersion: "1.19"
description: "Usage indicates a resource is in use"
description: "Block deletion of in-use resources"
---

A `Usage` indicates a resource is in use. Two main use cases for Usages are
Expand Down Expand Up @@ -288,4 +288,4 @@ spec:
resourceRef:
name: importantresources.example.crossplane.io
reason: "Very important CRD - should never be deleted!"
```
```
4 changes: 3 additions & 1 deletion content/master/operations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ title: Operations
weight: 52
state: alpha
alphaVersion: 2.0
description: Understand Crossplane's Operations feature
description: Run operational tasks with Crossplane
---

{{< auto-index >}}
2 changes: 1 addition & 1 deletion content/master/operations/cronoperation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Cron Operations
weight: 120
state: alpha
alphaVersion: 2.0
description: CronOperations create Operations on a schedule for recurring tasks
description: Run function pipelines on a schedule
---

A `CronOperation` creates [Operations]({{<ref "operation">}}) on a schedule,
Expand Down
12 changes: 6 additions & 6 deletions content/master/operations/operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Operations
weight: 110
state: alpha
alphaVersion: 2.0
description: Operations run function pipelines once to completion for operational tasks
description: Run function pipelines once to completion
---

An `Operation` runs a function pipeline once to completion to perform operational
Expand Down Expand Up @@ -304,17 +304,17 @@ Function response caching is an alpha feature. Enable it by setting the
`--enable-function-response-cache` feature flag.
{{< /hint >}}

Operations can benefit from function response caching to improve performance,
especially for operations that:
- Call the same functions repeatedly with identical inputs
Operations can use function response caching to improve performance
for operations that:
- Call the same functions often with identical inputs
- Use functions that perform expensive computations or external API calls
- Run frequently through CronOperation or WatchOperation

The cache works the same way as for Compositions - function responses with
time to live values are cached and reused for identical requests until
time to live values cache and reuse identical requests until
they expire.

This is particularly useful for Operations that:
Function response caching helps Operations that:
- Validate configurations using expensive checks
- Query external systems for status information
- Perform complex calculations that don't change frequently
Expand Down
2 changes: 1 addition & 1 deletion content/master/operations/watchoperation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Watch Operations
weight: 130
state: alpha
alphaVersion: 2.0
description: WatchOperations create Operations when watched resources change
description: Run function pipelines on resource changes
---

A `WatchOperation` creates [Operations]({{<ref "operation">}}) when watched
Expand Down
Loading