mirror of https://github.com/crossplane/docs.git
Tweak page descriptions
* Keep them concise (~50 chars) for rendering on index pages * Adjust them for clarity and accuracy * Add descriptions to pages that were missing them Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
parent
2f68349f93
commit
dc1c242c5f
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "Welcome"
|
||||
weight: -1
|
||||
description: "Control plane framework for building cloud native platforms"
|
||||
cascade:
|
||||
version: "master"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Composition
|
||||
weight: 51
|
||||
description: Understand Crossplane's core components
|
||||
description: Build custom APIs by composing Kubernetes resources
|
||||
---
|
||||
|
||||
{{< auto-index >}}
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
---
|
||||
|
||||
<!--
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 -->
|
||||
|
|
|
|||
|
|
@ -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 -->
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 -->
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: Troubleshoot Crossplane
|
||||
weight: 306
|
||||
description: "Debug common Crossplane issues"
|
||||
---
|
||||
## Requested resource not found
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: Uninstall Crossplane
|
||||
weight: 500
|
||||
description: "Remove Crossplane from your cluster"
|
||||
---
|
||||
|
||||
{{<hint "warning" >}}
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ title: Feature Lifecycle
|
|||
toc: true
|
||||
weight: 309
|
||||
indent: true
|
||||
description: "Crossplane's feature development process"
|
||||
---
|
||||
|
||||
# Feature lifecycle
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Managed Resources
|
||||
weight: 52
|
||||
description: Understand Crossplane's managed resources and selective activation
|
||||
description: Manage cloud resources in Kubernetes
|
||||
---
|
||||
|
||||
{{< auto-index >}}
|
||||
{{< auto-index >}}
|
||||
|
|
|
|||
|
|
@ -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">}}
|
||||
|
|
|
|||
|
|
@ -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">}}
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -288,4 +288,4 @@ spec:
|
|||
resourceRef:
|
||||
name: importantresources.example.crossplane.io
|
||||
reason: "Very important CRD - should never be deleted!"
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -3,7 +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 >}}
|
||||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Packages
|
||||
weight: 53
|
||||
description: Understand Crossplane's core components
|
||||
description: Extend Crossplane with packages
|
||||
---
|
||||
|
||||
{{< auto-index >}}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Configurations
|
||||
description: "Packages combine multiple Crossplane resources into a single, portable, OCI image."
|
||||
description: "Portable packages of Crossplane resources"
|
||||
altTitle: "Crossplane Packages"
|
||||
weight: 200
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Image Configs
|
||||
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 -->
|
||||
|
|
|
|||
Loading…
Reference in New Issue