Skip to content

Commit dc39ca3

Browse files
committed
Break concepts out by component
Ideally these would nest under concepts in the side bar but that's not possible. Signed-off-by: Nic Cope <[email protected]>
1 parent e682261 commit dc39ca3

22 files changed

+81
-68
lines changed

content/v2.0-preview/_index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ Crossplane organizes its documentation into the following sections:
2121
* [Get Started]({{<ref "get-started">}}) explains how to install Crossplane and
2222
create a control plane.
2323

24-
* [Concepts]({{<ref "concepts">}}) introduces Crossplane's key concepts.
24+
* [Composition]({{<ref "composition">}}) covers the key concepts of composition.
25+
26+
* [Managed Resources]({{<ref "composition">}}) covers the key concepts of
27+
managed resources.
28+
29+
* [Packages]({{<ref "composition">}}) covers the key concepts of the Crossplane
30+
package manager.
2531

2632
* [Guides]({{<ref "guides">}}) guide you through common use cases, like
2733
monitoring Crossplane or extending it by writing a composition function.

content/v2.0-preview/api/_index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,3 @@ cascade:
88

99
The Crossplane API describes the types and parameters for the core Crossplane
1010
components.
11-
12-
For details on the components read the [Concepts]({{<ref "../concepts/">}})
13-
section.

content/v2.0-preview/cli/command-reference.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Server Version: v1.17.0
3838
## render
3939

4040
The `crossplane render` command previews the output of a
41-
[composite resource]({{<ref "../concepts/composite-resources">}}) after applying
42-
any [composition functions]({{<ref "../concepts/compositions">}}).
41+
[composite resource]({{<ref "../composition/composite-resources">}}) after applying
42+
any [composition functions]({{<ref "../composition/compositions">}}).
4343

4444
{{< hint "important" >}}
4545
The `crossplane render` command requires you to use composition functions.
@@ -178,7 +178,7 @@ built-in support in [function-go-templating](https://github.com/crossplane-contr
178178
## xpkg
179179

180180
The `crossplane xpkg` commands create, install and update Crossplane
181-
[packages]({{<ref "../concepts/packages">}}) as well as enable authentication
181+
[packages]({{<ref "../packages/packages">}}) as well as enable authentication
182182
and publishing of Crossplane packages to a Crossplane package registry.
183183

184184
### xpkg build
@@ -193,9 +193,9 @@ The CLI applies the required annotations and values to meet the
193193
[Crossplane XPKG specification](https://github.com/crossplane/crossplane/blob/main/contributing/specifications/xpkg.md).
194194

195195
The `crossplane` CLI supports building
196-
[configuration]({{< ref "../concepts/packages" >}}),
197-
[function]({{<ref "../concepts/compositions">}}) and
198-
[provider]({{<ref "../concepts/providers" >}}) package types.
196+
[configuration]({{< ref "../packages/packages" >}}),
197+
[function]({{<ref "../composition/compositions">}}) and
198+
[provider]({{<ref "../packages/providers" >}}) package types.
199199

200200
#### Flags
201201

@@ -270,9 +270,9 @@ with the command
270270
The `<name>` input isn't used. Crossplane reserves the `<name>` for future releases.
271271

272272
The `<template>` value may be one of four well known templates:
273-
* `configuration-template` - A template to build a Crossplane [Configuration]({{<ref "../concepts/packages">}}) from the [crossplane/configuration-template](https://github.com/crossplane/configuration-template) repository.
274-
* `function-template-go` - A template to build Crossplane Go [composition functions]({{<ref "../concepts/compositions">}}) from the [crossplane/function-template-go](https://github.com/crossplane/function-template-go) repository.
275-
* `function-template-python` - A template to build Crossplane Python [composition functions]({{<ref "../concepts/compositions">}}) from the [crossplane/function-template-python](https://github.com/crossplane/function-template-go) repository.
273+
* `configuration-template` - A template to build a Crossplane [Configuration]({{<ref "../packages/packages">}}) from the [crossplane/configuration-template](https://github.com/crossplane/configuration-template) repository.
274+
* `function-template-go` - A template to build Crossplane Go [composition functions]({{<ref "../composition/compositions">}}) from the [crossplane/function-template-go](https://github.com/crossplane/function-template-go) repository.
275+
* `function-template-python` - A template to build Crossplane Python [composition functions]({{<ref "../composition/compositions">}}) from the [crossplane/function-template-python](https://github.com/crossplane/function-template-go) repository.
276276
* `provider-template` - A template to build a basic Crossplane provider from the [Crossplane/provider-template](https://github.com/crossplane/provider-template) repository.
277277
* `provider-template-upjet` - A template for building [Upjet](https://github.com/crossplane/upjet) based Crossplane providers from existing Terraform providers. Copies from the [upbound/upjet-provider-template](https://github.com/upbound/upjet-provider-template) repository.
278278

@@ -352,7 +352,7 @@ returns an error if the `wait` time expires before the package is `HEALTHY`.
352352
#### Require manual package activation
353353

354354
Set the package to require
355-
[manual activation]({{<ref "../concepts/packages#revision-activation-policy" >}}),
355+
[manual activation]({{<ref "../packages/packages#revision-activation-policy" >}}),
356356
preventing an automatic upgrade of a package with `--manual-activation`
357357

358358
#### Authenticate to a private registry
@@ -372,7 +372,7 @@ cache.
372372
Store more inactive copies of a package with `--revision-history-limit`.
373373

374374
Read more about
375-
[package revisions]({{< ref "../concepts/packages#configuration-revisions" >}})
375+
[package revisions]({{< ref "../packages/packages#configuration-revisions" >}})
376376
in the package documentation.
377377

378378
### xpkg login
@@ -515,9 +515,9 @@ migration to the new APIs and resources, the `crossplane beta convert` command
515515
converts a Crossplane resource to a new version or kind.
516516

517517
Use the `crossplane beta convert` command to convert a
518-
ControllerConfig to a [DeploymentRuntimeConfig]({{<ref "../concepts/providers#runtime-configuration">}})
518+
ControllerConfig to a [DeploymentRuntimeConfig]({{<ref "../packages/providers#runtime-configuration">}})
519519
or a legacy Composition using `mode: Resources` to a
520-
[Composition pipeline function]({{< ref "../concepts/compositions" >}}).
520+
[Composition pipeline function]({{< ref "../composition/compositions" >}}).
521521

522522
Provide the `crossplane beta convert` command the conversion type, the input
523523
file and optionally, an output file. By default the command writes the output to
@@ -829,7 +829,7 @@ Configuration/platform-ref-aws v0.9.0 True
829829
### beta validate
830830

831831
The `crossplane beta validate` command validates
832-
[compositions]({{<ref "../concepts/compositions">}}) against provider or XRD
832+
[compositions]({{<ref "../composition/compositions">}}) against provider or XRD
833833
schemas using the Kubernetes API server's validation library
834834
with extra validation such as checking for unknown fields,
835835
a common source of difficult to debug issues in Crossplane.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Composition
3+
weight: 51
4+
description: Understand Crossplane's core components
5+
---

content/v2.0-preview/concepts/composite-resource-definitions.md renamed to content/v2.0-preview/composition/composite-resource-definitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ Changing or expanding the XRD schema requires restarting the [Crossplane pod]({{
483483
### Manage connection secrets
484484

485485
When a composite resource creates managed resources, Crossplane provides any
486-
[connection secrets]({{<ref "./managed-resources#writeconnectionsecrettoref">}})
486+
[connection secrets]({{<ref "../managed-resources/managed-resources#writeconnectionsecrettoref">}})
487487
to the composite resource. This requires the creators of composite resources to
488488
know the secrets provided by a managed resource. In other cases, Crossplane
489489
administrators may not want to expose some or all the generated connection
@@ -542,7 +542,7 @@ recreate the XRD to change the `connectionSecretKeys`.
542542
{{</hint >}}
543543

544544
For more information on connection secrets read the
545-
[Connection Secrets knowledge base article]({{<ref "connection-details">}}).
545+
[Connection Secrets knowledge base article]({{<ref "../managed-resources/connection-details">}}).
546546

547547
### Set composite resource defaults
548548
XRDs can set default parameters for composite resources.

content/v2.0-preview/concepts/composite-resources.md renamed to content/v2.0-preview/composition/composite-resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ spec:
284284
### Manage connection secrets
285285

286286
When a composite resource creates resources, Crossplane provides any
287-
[connection secrets]({{<ref "./managed-resources#writeconnectionsecrettoref">}})
287+
[connection secrets]({{<ref "../managed-resources/managed-resources#writeconnectionsecrettoref">}})
288288
to the composite resource.
289289

290290
{{<hint "important" >}}
@@ -317,7 +317,7 @@ spec:
317317
# Removed for brevity
318318
```
319319

320-
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "connection-details">}}).
320+
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "../managed-resources/connection-details">}}).
321321

322322
### Pausing composite resources
323323

@@ -395,7 +395,7 @@ The conditions of composite resources match the conditions of their managed
395395
resources.
396396

397397
Read the
398-
[conditions section]({{<ref "./managed-resources#conditions">}}) of the
398+
[conditions section]({{<ref "../managed-resources/managed-resources#conditions">}}) of the
399399
managed resources documentation for details.
400400

401401
## Composite resource labels
File renamed without changes.

content/v2.0-preview/concepts/compositions.md renamed to content/v2.0-preview/composition/compositions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ spec:
137137

138138
{{< hint "tip" >}}
139139
Functions are Crossplane Packages. Read more about Packages in the
140-
[Packages documentation]({{<ref "packages" >}}).
140+
[Packages documentation]({{<ref "../packages/packages" >}}).
141141
{{< /hint >}}
142142

143143
By default, the Function pod installs in the same namespace as Crossplane
File renamed without changes.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -694,7 +694,7 @@ my-app True True app-yaml 56s
694694
The `COMPOSITION` column shows what composition the `App` is using.
695695

696696
You can create multiple compositions for each kind of XR.
697-
[Read the XR page]({{<ref "../concepts/composite-resources">}}) to learn how to
697+
[Read the XR page]({{<ref "../composition/composite-resources">}}) to learn how to
698698
select which composition Crossplane uses.
699699
{{</hint>}}
700700

0 commit comments

Comments
 (0)