Merge pull request #974 from negz/index

Auto-generate child page indexes
This commit is contained in:
Nic Cope 2025-08-14 13:06:18 -07:00 committed by GitHub
commit 0314e647e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
82 changed files with 215 additions and 85 deletions

View File

@ -1,6 +1,7 @@
--- ---
title: "Welcome" title: "Welcome"
weight: -1 weight: -1
description: "Control plane framework for building cloud native platforms"
cascade: cascade:
version: "master" version: "master"
--- ---

View File

@ -1,7 +1,7 @@
--- ---
weight: 200 weight: 200
title: CLI Reference 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 The Crossplane CLI helps simplify some development and administration aspects of

View File

@ -1,5 +1,7 @@
--- ---
title: Composition title: Composition
weight: 51 weight: 51
description: Understand Crossplane's core components description: Build custom APIs by composing Kubernetes resources
--- ---
{{< auto-index >}}

View File

@ -1,7 +1,7 @@
--- ---
title: Composite Resource Definitions title: Composite Resource Definitions
weight: 20 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. Composite resource definitions (`XRDs`) define the schema for a custom API.

View File

@ -1,7 +1,7 @@
--- ---
title: Composite Resources title: Composite Resources
weight: 10 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 A composite resource, or XR, represents a set of Kubernetes resources as a

View File

@ -1,6 +1,7 @@
--- ---
title: Composition Revisions title: Composition Revisions
weight: 35 weight: 35
description: "Manage changes to Compositions with revisions"
--- ---
This guide discusses the use of "Composition Revisions" to make and roll This guide discusses the use of "Composition Revisions" to make and roll

View File

@ -5,7 +5,7 @@ aliases:
- composition - composition
- composition-functions - composition-functions
- /knowledge-base/guides/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 Compositions are a template for creating multiple Kubernetes resources as a
@ -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 Crossplane can cache function responses to improve performance by reducing
repeated function calls. When enabled, Crossplane caches responses from 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: The cache works by:
- Storing function responses on disk based on a hash of the request - 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 - Automatically removing expired cache entries
- Reusing cached responses for identical requests until they expire - 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 - Perform expensive computations or external API calls
- Return stable results for the same inputs - Return stable results for the same inputs
- Include appropriate TTL values in their responses - Include appropriate TTL values in their responses
@ -803,6 +803,6 @@ Control the cache behavior with these Crossplane pod arguments:
- `--xfn-cache-max-ttl` - Maximum cache duration (default: 24 hours) - `--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 For better performance, consider using an in-memory cache by mounting an
emptyDir volume with `medium: Memory`. emptyDir volume with `medium: Memory`.

View File

@ -4,7 +4,7 @@ weight: 75
state: beta state: beta
alphaVersion: "1.11" alphaVersion: "1.11"
betaVersion: "1.18" betaVersion: "1.18"
description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions" description: "In-memory data stores for Compositions"
--- ---
<!-- <!--

View File

@ -4,3 +4,4 @@ weight: 40
description: Get started with Crossplane. description: Get started with Crossplane.
--- ---
{{< auto-index >}}

View File

@ -1,6 +1,7 @@
--- ---
title: Get Started With Composition title: Get Started With Composition
weight: 200 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 This guide shows how to create a new kind of custom resource named `App`. When a

View File

@ -1,6 +1,7 @@
--- ---
title: Get Started With Managed Resources title: Get Started With Managed Resources
weight: 300 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 This guide shows how to install and use a new kind of custom resource called

View File

@ -3,6 +3,7 @@ title: Get Started With Operations
weight: 300 weight: 300
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: "Run operational tasks with Crossplane operations"
--- ---
This guide shows how to use Crossplane Operations to automate day-two This guide shows how to use Crossplane Operations to automate day-two

View File

@ -1,6 +1,7 @@
--- ---
title: Install Crossplane title: Install Crossplane
weight: 100 weight: 100
description: "Install Crossplane in a Kubernetes cluster"
--- ---
Crossplane installs into an existing Kubernetes cluster, creating the Crossplane installs into an existing Kubernetes cluster, creating the

View File

@ -2,4 +2,6 @@
title: Guides title: Guides
weight: 100 weight: 100
description: Crossplane integrations and detailed examples. description: Crossplane integrations and detailed examples.
--- ---
{{< auto-index >}}

View File

@ -3,6 +3,7 @@
--- ---
title: Configuring Crossplane with Argo CD title: Configuring Crossplane with Argo CD
weight: 270 weight: 270
description: "Deploy Crossplane resources with GitOps"
--- ---
<!-- vale Google.Headings = YES --> <!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES --> <!-- vale Microsoft.HeadingAcronyms = YES -->

View File

@ -1,8 +1,7 @@
--- ---
title: Releasing Crossplane Extensions title: Releasing Crossplane Extensions
weight: 80 weight: 80
description: "Configuring build pipelines for Crossplane extensions with GitHub description: "Build pipelines for Crossplane extensions"
Actions"
--- ---
<!-- vale Google.Headings = NO --> <!-- vale Google.Headings = NO -->

View File

@ -1,7 +1,7 @@
--- ---
title: Function Patch and Transform title: Function Patch and Transform
weight: 70 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 Function Patch and Transform allows you to write a Composition that specifies

View File

@ -3,8 +3,7 @@ title: Implementing safe-start in Providers
weight: 90 weight: 90
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: Guide for provider developers to add safe-start capability for description: Add selective resource activation to providers
selective resource activation
--- ---
This guide shows provider developers how to implement safe-start capability in This guide shows provider developers how to implement safe-start capability in

View File

@ -1,7 +1,7 @@
--- ---
title: Metrics title: Metrics
weight: 60 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. Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment.

View File

@ -1,7 +1,7 @@
--- ---
title: Crossplane Pods title: Crossplane Pods
weight: 1 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 The base Crossplane installation consists of two pods, the `crossplane` pod and
@ -137,7 +137,7 @@ Kubernetes API server when a composed resource changes. For example, when
a provider sets the `Ready` condition to `true`. a provider sets the `Ready` condition to `true`.
{{<hint "important" >}} {{<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. default.
{{< /hint >}} {{< /hint >}}

View File

@ -2,7 +2,8 @@
<!-- vale Microsoft.HeadingAcronyms = NO --> <!-- vale Microsoft.HeadingAcronyms = NO -->
--- ---
title: Self-signed CA certs title: Self-signed CA certs
weight: 270 weight: 270
description: "Configure Crossplane with self-signed certificates"
--- ---
<!-- vale Google.Headings = YES --> <!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES --> <!-- vale Microsoft.HeadingAcronyms = YES -->

View File

@ -1,6 +1,7 @@
--- ---
title: Troubleshoot Crossplane title: Troubleshoot Crossplane
weight: 306 weight: 306
description: "Debug common Crossplane issues"
--- ---
## Requested resource not found ## Requested resource not found

View File

@ -1,6 +1,7 @@
--- ---
title: Uninstall Crossplane title: Uninstall Crossplane
weight: 500 weight: 500
description: "Remove Crossplane from your cluster"
--- ---
{{<hint "warning" >}} {{<hint "warning" >}}

View File

@ -1,6 +1,7 @@
--- ---
title: Upgrade Crossplane title: Upgrade Crossplane
weight: 400 weight: 400
description: "Upgrade Crossplane to newer versions"
--- ---
The recommended upgrade method for an existing Crossplane install is to use The recommended upgrade method for an existing Crossplane install is to use

View File

@ -1,7 +1,7 @@
--- ---
title: Write a Composition Function in Go title: Write a Composition Function in Go
weight: 80 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 Composition functions (or just functions, for short) are custom programs that

View File

@ -1,7 +1,7 @@
--- ---
title: Write a Composition Function in Python title: Write a Composition Function in Python
weight: 81 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 Composition functions (or just functions, for short) are custom programs that

View File

@ -3,6 +3,7 @@ title: Feature Lifecycle
toc: true toc: true
weight: 309 weight: 309
indent: true indent: true
description: "Crossplane's feature development process"
--- ---
# Feature lifecycle # Feature lifecycle

View File

@ -1,6 +1,7 @@
--- ---
title: Release Cycle title: Release Cycle
weight: 308 weight: 308
description: "When and how Crossplane releases are cut"
--- ---
Starting with the v1.10.0 release, Crossplane releases on a quarterly (13 Starting with the v1.10.0 release, Crossplane releases on a quarterly (13

View File

@ -1,5 +1,7 @@
--- ---
title: Managed Resources title: Managed Resources
weight: 52 weight: 52
description: Understand Crossplane's managed resources and selective activation description: Manage cloud resources in Kubernetes
--- ---
{{< auto-index >}}

View File

@ -3,9 +3,7 @@ title: Managed Resource Activation Policies
weight: 20 weight: 20
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: ManagedResourceActivationPolicies control which description: Choose which provider resources Crossplane activates
ManagedResourceDefinitions activate for selective provider resource
installation
--- ---
{{<hint "important">}} {{<hint "important">}}

View File

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

View File

@ -1,7 +1,7 @@
--- ---
title: Managed Resources title: Managed Resources
weight: 10 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 A _managed resource_ (`MR`) represents an external service in a Provider. When

View File

@ -4,7 +4,7 @@ weight: 30
state: beta state: beta
alphaVersion: "1.14" alphaVersion: "1.14"
betaVersion: "1.19" 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 A `Usage` indicates a resource is in use. Two main use cases for Usages are
@ -288,4 +288,4 @@ spec:
resourceRef: resourceRef:
name: importantresources.example.crossplane.io name: importantresources.example.crossplane.io
reason: "Very important CRD - should never be deleted!" reason: "Very important CRD - should never be deleted!"
``` ```

View File

@ -3,5 +3,7 @@ title: Operations
weight: 52 weight: 52
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: Understand Crossplane's Operations feature description: Run operational tasks with Crossplane
--- ---
{{< auto-index >}}

View File

@ -3,7 +3,7 @@ title: Cron Operations
weight: 120 weight: 120
state: alpha state: alpha
alphaVersion: 2.0 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, A `CronOperation` creates [Operations]({{<ref "operation">}}) on a schedule,

View File

@ -3,7 +3,7 @@ title: Operations
weight: 110 weight: 110
state: alpha state: alpha
alphaVersion: 2.0 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 An `Operation` runs a function pipeline once to completion to perform operational
@ -304,17 +304,17 @@ Function response caching is an alpha feature. Enable it by setting the
`--enable-function-response-cache` feature flag. `--enable-function-response-cache` feature flag.
{{< /hint >}} {{< /hint >}}
Operations can benefit from function response caching to improve performance, Operations can use function response caching to improve performance
especially for operations that: for operations that:
- Call the same functions repeatedly with identical inputs - Call the same functions often with identical inputs
- Use functions that perform expensive computations or external API calls - Use functions that perform expensive computations or external API calls
- Run frequently through CronOperation or WatchOperation - Run frequently through CronOperation or WatchOperation
The cache works the same way as for Compositions - function responses with 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. they expire.
This is particularly useful for Operations that: Function response caching helps Operations that:
- Validate configurations using expensive checks - Validate configurations using expensive checks
- Query external systems for status information - Query external systems for status information
- Perform complex calculations that don't change frequently - Perform complex calculations that don't change frequently

View File

@ -3,7 +3,7 @@ title: Watch Operations
weight: 130 weight: 130
state: alpha state: alpha
alphaVersion: 2.0 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 A `WatchOperation` creates [Operations]({{<ref "operation">}}) when watched

View File

@ -1,5 +1,7 @@
--- ---
title: Packages title: Packages
weight: 53 weight: 53
description: Understand Crossplane's core components description: Extend Crossplane with packages
--- ---
{{< auto-index >}}

View File

@ -1,6 +1,6 @@
--- ---
title: Configurations title: Configurations
description: "Packages combine multiple Crossplane resources into a single, portable, OCI image." description: "Portable packages of Crossplane resources"
altTitle: "Crossplane Packages" altTitle: "Crossplane Packages"
weight: 200 weight: 200
--- ---

View File

@ -1,7 +1,7 @@
--- ---
title: Image Configs title: Image Configs
weight: 400 weight: 400
description: "Image Configs is an API for centralized control of the configuration of Crossplane package images." description: "Centralized control of package image configuration"
--- ---
<!-- vale write-good.Passive = NO --> <!-- vale write-good.Passive = NO -->

View File

@ -1,7 +1,7 @@
--- ---
weight: 200 weight: 200
title: CLI Reference 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 The Crossplane CLI helps simplify some development and administration aspects of

View File

@ -1,5 +1,7 @@
--- ---
title: Composition title: Composition
weight: 51 weight: 51
description: Understand Crossplane's core components description: Build custom APIs by composing Kubernetes resources
--- ---
{{< auto-index >}}

View File

@ -1,7 +1,7 @@
--- ---
title: Composite Resource Definitions title: Composite Resource Definitions
weight: 20 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. Composite resource definitions (`XRDs`) define the schema for a custom API.

View File

@ -1,7 +1,7 @@
--- ---
title: Composite Resources title: Composite Resources
weight: 10 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 A composite resource, or XR, represents a set of Kubernetes resources as a

View File

@ -1,6 +1,7 @@
--- ---
title: Composition Revisions title: Composition Revisions
weight: 35 weight: 35
description: "Manage changes to Compositions with revisions"
--- ---
This guide discusses the use of "Composition Revisions" to make and roll This guide discusses the use of "Composition Revisions" to make and roll

View File

@ -5,7 +5,7 @@ aliases:
- composition - composition
- composition-functions - composition-functions
- /knowledge-base/guides/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 Compositions are a template for creating multiple Kubernetes resources as a
@ -140,7 +140,12 @@ reports `True`.
Crossplane calls a Function to determine what resources it should create when Crossplane calls a Function to determine what resources it should create when
you create a composite resource. The Function also tells Crossplane what to do you create a composite resource. The Function also tells Crossplane what to do
with these resources when you update or delete a composite resource. with these resources when you update a composite resource.
{{<hint "note" >}}
Composition functions don't run when you delete a composite resource.
Crossplane handles deletion of composed resources automatically.
{{< /hint >}}
When Crossplane calls a Function it sends it the current state of the composite When Crossplane calls a Function it sends it the current state of the composite
resource. It also sends it the current state of any resources the composite resource. It also sends it the current state of any resources the composite
@ -576,7 +581,7 @@ sequenceDiagram
Crossplane Pod->>+API Server: Apply desired composed resources Crossplane Pod->>+API Server: Apply desired composed resources
``` ```
When you create, update, or delete a composite resource that uses composition When you create or update a composite resource that uses composition
functions Crossplane calls each function in the order they appear in the functions Crossplane calls each function in the order they appear in the
Composition's pipeline. Crossplane calls each function by sending it a gRPC Composition's pipeline. Crossplane calls each function by sending it a gRPC
RunFunctionRequest. The function must respond with a gRPC RunFunctionResponse. 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
write to the pipeline context. Crossplane passes the context to all following write to the pipeline context. Crossplane passes the context to all following
functions. When Crossplane has called all functions it discards the pipeline functions. When Crossplane has called all functions it discards the pipeline
context. context.
### Function response cache
{{<hint "note" >}}
Function response caching is an alpha feature. Enable it by setting the
`--enable-function-response-cache` feature flag.
{{< /hint >}}
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.
The cache works by:
- Storing function responses on disk based on a hash of the request
- Only caching responses with a nonzero TTL
- Automatically removing expired cache entries
- Reusing cached responses for identical requests until they expire
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
#### Cache configuration
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 in the Crossplane pod.
For better performance, consider using an in-memory cache by mounting an
emptyDir volume with `medium: Memory`.

View File

@ -4,7 +4,7 @@ weight: 75
state: beta state: beta
alphaVersion: "1.11" alphaVersion: "1.11"
betaVersion: "1.18" betaVersion: "1.18"
description: "Environment Configs or EnvironmentConfigs are an in-memory datastore used in Compositions" description: "In-memory data stores for Compositions"
--- ---
<!-- <!--

View File

@ -4,3 +4,4 @@ weight: 40
description: Get started with Crossplane. description: Get started with Crossplane.
--- ---
{{< auto-index >}}

View File

@ -1,6 +1,7 @@
--- ---
title: Get Started With Composition title: Get Started With Composition
weight: 200 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 This guide shows how to create a new kind of custom resource named `App`. When a

View File

@ -1,6 +1,7 @@
--- ---
title: Get Started With Managed Resources title: Get Started With Managed Resources
weight: 300 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 This guide shows how to install and use a new kind of custom resource called

View File

@ -3,6 +3,7 @@ title: Get Started With Operations
weight: 300 weight: 300
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: "Run operational tasks with Crossplane operations"
--- ---
This guide shows how to use Crossplane Operations to automate day-two This guide shows how to use Crossplane Operations to automate day-two

View File

@ -1,6 +1,7 @@
--- ---
title: Install Crossplane title: Install Crossplane
weight: 100 weight: 100
description: "Install Crossplane in a Kubernetes cluster"
--- ---
Crossplane installs into an existing Kubernetes cluster, creating the Crossplane installs into an existing Kubernetes cluster, creating the
@ -106,8 +107,9 @@ at the table below.
| --- | --- | --- | | --- | --- | --- |
| Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. | | Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. |
| Beta | `--enable-usages` | Enable support for Usages. | | Beta | `--enable-usages` | Enable support for Usages. |
| Alpha | `--enable-realtime-compositions` | Enable support for real time compositions. | | Beta | `--enable-realtime-compositions` | Enable support for real time compositions. |
| Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. | | Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. |
| Alpha | `--enable-function-response-cache` | Enable caching of composition function responses to improve performance. |
| Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. | | Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. |
{{< /table >}} {{< /table >}}
{{< /expand >}} {{< /expand >}}

View File

@ -2,4 +2,6 @@
title: Guides title: Guides
weight: 100 weight: 100
description: Crossplane integrations and detailed examples. description: Crossplane integrations and detailed examples.
--- ---
{{< auto-index >}}

View File

@ -3,6 +3,7 @@
--- ---
title: Configuring Crossplane with Argo CD title: Configuring Crossplane with Argo CD
weight: 270 weight: 270
description: "Deploy Crossplane resources with GitOps"
--- ---
<!-- vale Google.Headings = YES --> <!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES --> <!-- vale Microsoft.HeadingAcronyms = YES -->

View File

@ -1,8 +1,7 @@
--- ---
title: Releasing Crossplane Extensions title: Releasing Crossplane Extensions
weight: 80 weight: 80
description: "Configuring build pipelines for Crossplane extensions with GitHub description: "Build pipelines for Crossplane extensions"
Actions"
--- ---
<!-- vale Google.Headings = NO --> <!-- vale Google.Headings = NO -->

View File

@ -1,7 +1,7 @@
--- ---
title: Function Patch and Transform title: Function Patch and Transform
weight: 70 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 Function Patch and Transform allows you to write a Composition that specifies
@ -424,7 +424,7 @@ environment:
patches: patches:
- type: ToCompositeFieldPath - type: ToCompositeFieldPath
fromFieldPath: tags fromFieldPath: tags
toFieldPath: metadata.labels[envTag] toFieldPath: status.envTag
- type: FromCompositeFieldPath - type: FromCompositeFieldPath
fromFieldPath: metadata.name fromFieldPath: metadata.name
toFieldPath: newEnvironmentKey toFieldPath: newEnvironmentKey
@ -667,7 +667,12 @@ Composition and use it in a second composed resource in the same Composition.
{{< /hint >}} {{< /hint >}}
For example, after Crossplane creates a new managed resource, take the value For example, after Crossplane creates a new managed resource, take the value
`hostedZoneID` and apply it as a `label` in the composite resource. `hostedZoneID` and store it in the composite resource's status.
{{< hint "important" >}}
To patch to composite resource status fields, you must first define the custom
status fields in the CompositeResourceDefinition.
{{< /hint >}}
```yaml {label="toComposite",copy-lines="9-11"} ```yaml {label="toComposite",copy-lines="9-11"}
apiVersion: pt.fn.crossplane.io/v1beta1 apiVersion: pt.fn.crossplane.io/v1beta1
@ -683,7 +688,7 @@ resources:
patches: patches:
- type: ToCompositeFieldPath - type: ToCompositeFieldPath
fromFieldPath: status.atProvider.hostedZoneId fromFieldPath: status.atProvider.hostedZoneId
toFieldPath: metadata.labels['ZoneID'] toFieldPath: status.hostedZoneId
``` ```
View the created managed resource to see the View the created managed resource to see the
@ -698,12 +703,14 @@ Status:
# Removed for brevity # Removed for brevity
``` ```
Next view the composite resource and confirm the patch applied the `label` Next view the composite resource and confirm the patch applied to the status
```yaml {label="toCompositeXR",copy-lines="none"} ```yaml {label="toCompositeXR",copy-lines="none"}
$ kubectl describe composite $ kubectl describe composite
Name: my-example-p5pxf Name: my-example-p5pxf
Labels: ZoneID=Z2O1EMRO9K5GLX # Removed for brevity
Status:
Hosted Zone Id: Z2O1EMRO9K5GLX
``` ```
<!-- vale Google.Headings = NO --> <!-- vale Google.Headings = NO -->

View File

@ -3,8 +3,7 @@ title: Implementing safe-start in Providers
weight: 90 weight: 90
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: Guide for provider developers to add safe-start capability for description: Add selective resource activation to providers
selective resource activation
--- ---
This guide shows provider developers how to implement safe-start capability in This guide shows provider developers how to implement safe-start capability in

View File

@ -1,7 +1,7 @@
--- ---
title: Metrics title: Metrics
weight: 60 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. Crossplane produces [Prometheus style metrics](https://prometheus.io/docs/introduction/overview/#what-are-metrics) for effective monitoring and alerting in your environment.

View File

@ -1,7 +1,7 @@
--- ---
title: Crossplane Pods title: Crossplane Pods
weight: 1 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 The base Crossplane installation consists of two pods, the `crossplane` pod and
@ -137,7 +137,7 @@ Kubernetes API server when a composed resource changes. For example, when
a provider sets the `Ready` condition to `true`. a provider sets the `Ready` condition to `true`.
{{<hint "important" >}} {{<hint "important" >}}
Real time compositions are an alpha feature. Alpha features aren't enabled by Real time compositions are a beta feature. Crossplane enables beta features by
default. default.
{{< /hint >}} {{< /hint >}}

View File

@ -2,7 +2,8 @@
<!-- vale Microsoft.HeadingAcronyms = NO --> <!-- vale Microsoft.HeadingAcronyms = NO -->
--- ---
title: Self-signed CA certs title: Self-signed CA certs
weight: 270 weight: 270
description: "Configure Crossplane with self-signed certificates"
--- ---
<!-- vale Google.Headings = YES --> <!-- vale Google.Headings = YES -->
<!-- vale Microsoft.HeadingAcronyms = YES --> <!-- vale Microsoft.HeadingAcronyms = YES -->

View File

@ -1,6 +1,7 @@
--- ---
title: Troubleshoot Crossplane title: Troubleshoot Crossplane
weight: 306 weight: 306
description: "Debug common Crossplane issues"
--- ---
## Requested resource not found ## Requested resource not found

View File

@ -1,6 +1,7 @@
--- ---
title: Uninstall Crossplane title: Uninstall Crossplane
weight: 500 weight: 500
description: "Remove Crossplane from your cluster"
--- ---
{{<hint "warning" >}} {{<hint "warning" >}}

View File

@ -1,6 +1,7 @@
--- ---
title: Upgrade Crossplane title: Upgrade Crossplane
weight: 400 weight: 400
description: "Upgrade Crossplane to newer versions"
--- ---
The recommended upgrade method for an existing Crossplane install is to use The recommended upgrade method for an existing Crossplane install is to use

View File

@ -1,7 +1,7 @@
--- ---
title: Write a Composition Function in Go title: Write a Composition Function in Go
weight: 80 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 Composition functions (or just functions, for short) are custom programs that

View File

@ -1,7 +1,7 @@
--- ---
title: Write a Composition Function in Python title: Write a Composition Function in Python
weight: 81 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 Composition functions (or just functions, for short) are custom programs that

View File

@ -3,6 +3,7 @@ title: Feature Lifecycle
toc: true toc: true
weight: 309 weight: 309
indent: true indent: true
description: "Crossplane's feature development process"
--- ---
# Feature lifecycle # Feature lifecycle

View File

@ -1,6 +1,7 @@
--- ---
title: Release Cycle title: Release Cycle
weight: 308 weight: 308
description: "When and how Crossplane releases are cut"
--- ---
Starting with the v1.10.0 release, Crossplane releases on a quarterly (13 Starting with the v1.10.0 release, Crossplane releases on a quarterly (13

View File

@ -1,5 +1,7 @@
--- ---
title: Managed Resources title: Managed Resources
weight: 52 weight: 52
description: Understand Crossplane's managed resources and selective activation description: Manage cloud resources in Kubernetes
--- ---
{{< auto-index >}}

View File

@ -3,9 +3,7 @@ title: Managed Resource Activation Policies
weight: 20 weight: 20
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: ManagedResourceActivationPolicies control which description: Choose which provider resources Crossplane activates
ManagedResourceDefinitions activate for selective provider resource
installation
--- ---
{{<hint "important">}} {{<hint "important">}}

View File

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

View File

@ -1,7 +1,7 @@
--- ---
title: Managed Resources title: Managed Resources
weight: 10 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 A _managed resource_ (`MR`) represents an external service in a Provider. When

View File

@ -4,7 +4,7 @@ weight: 30
state: beta state: beta
alphaVersion: "1.14" alphaVersion: "1.14"
betaVersion: "1.19" 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 A `Usage` indicates a resource is in use. Two main use cases for Usages are
@ -288,4 +288,4 @@ spec:
resourceRef: resourceRef:
name: importantresources.example.crossplane.io name: importantresources.example.crossplane.io
reason: "Very important CRD - should never be deleted!" reason: "Very important CRD - should never be deleted!"
``` ```

View File

@ -3,5 +3,7 @@ title: Operations
weight: 52 weight: 52
state: alpha state: alpha
alphaVersion: 2.0 alphaVersion: 2.0
description: Understand Crossplane's Operations feature description: Run operational tasks with Crossplane
--- ---
{{< auto-index >}}

View File

@ -3,7 +3,7 @@ title: Cron Operations
weight: 120 weight: 120
state: alpha state: alpha
alphaVersion: 2.0 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, A `CronOperation` creates [Operations]({{<ref "operation">}}) on a schedule,

View File

@ -3,7 +3,7 @@ title: Operations
weight: 110 weight: 110
state: alpha state: alpha
alphaVersion: 2.0 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 An `Operation` runs a function pipeline once to completion to perform operational
@ -297,6 +297,31 @@ For more details on RBAC configuration, see the
[Compositions RBAC documentation]({{<ref "../composition/compositions#grant-access-to-composed-resources">}}). [Compositions RBAC documentation]({{<ref "../composition/compositions#grant-access-to-composed-resources">}}).
{{</hint>}} {{</hint>}}
### Function response cache
{{<hint "note" >}}
Function response caching is an alpha feature. Enable it by setting the
`--enable-function-response-cache` feature flag.
{{< /hint >}}
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 cache and reuse identical requests until
they expire.
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
For cache configuration details, see the
[Function response cache documentation]({{<ref "../composition/compositions#function-response-cache">}}).
### Required resources ### Required resources
Operations can preload resources for functions to access: Operations can preload resources for functions to access:

View File

@ -3,7 +3,7 @@ title: Watch Operations
weight: 130 weight: 130
state: alpha state: alpha
alphaVersion: 2.0 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 A `WatchOperation` creates [Operations]({{<ref "operation">}}) when watched

View File

@ -1,5 +1,7 @@
--- ---
title: Packages title: Packages
weight: 53 weight: 53
description: Understand Crossplane's core components description: Extend Crossplane with packages
--- ---
{{< auto-index >}}

View File

@ -1,6 +1,6 @@
--- ---
title: Configurations title: Configurations
description: "Packages combine multiple Crossplane resources into a single, portable, OCI image." description: "Portable packages of Crossplane resources"
altTitle: "Crossplane Packages" altTitle: "Crossplane Packages"
weight: 200 weight: 200
--- ---

View File

@ -1,7 +1,7 @@
--- ---
title: Image Configs title: Image Configs
weight: 400 weight: 400
description: "Image Configs is an API for centralized control of the configuration of Crossplane package images." description: "Centralized control of package image configuration"
--- ---
<!-- vale write-good.Passive = NO --> <!-- vale write-good.Passive = NO -->

View File

@ -0,0 +1,17 @@
{{/*
Auto-generates an index page with links to child pages, ordered by weight.
Usage: {{ partial "auto-index" . }}
*/}}
{{ if .RegularPages }}
<div class="auto-index">
{{ if .Params.description }}
<p>{{ .Params.description }}</p>
{{ end }}
<p>Topics in this section:</p>
<ul>
{{ range .RegularPages.ByWeight }}
<li><a href="{{ .Permalink }}">{{ .Title }}</a>{{ if .Params.description }} - {{ .Params.description }}{{ end }}</li>
{{ end }}
</ul>
</div>
{{ end }}

View File

@ -0,0 +1,5 @@
{{/*
Shortcode to auto-generate an index of child pages.
Usage: {{< auto-index >}}
*/}}
{{ partial "auto-index" .Page }}

View File

@ -108,6 +108,7 @@ syscall
templated templated
TLS TLS
tolerations tolerations
TTL
UI UI
VM VM
walkthrough walkthrough