Skip to content

Commit 1a1f216

Browse files
negznegz
authored
Merge pull request #906 from negz/conceptual
[v2] Update concepts for v2
2 parents 89f1d47 + 0fd5e1b commit 1a1f216

28 files changed

+765
-1401
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 "managed-resources">}}) covers the key concepts of
27+
managed resources.
28+
29+
* [Packages]({{<ref "packages">}}) 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: 20 additions & 60 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/configurations">}}) 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/configurations" >}}),
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/configurations">}}) 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/configurations#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/configurations#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
@@ -594,19 +594,19 @@ running the `top` command may produce an error, for example,
594594
### beta trace
595595

596596
Use the `crossplane beta trace` command to display a visual relationship of
597-
Crossplane objects. The `trace` command supports claims, compositions,
597+
Crossplane objects. The `trace` command supports XRs, compositions,
598598
functions, managed resources or packages.
599599

600600
The command requires a resource type and a resource name.
601601

602602
`crossplane beta trace <resource kind> <resource name>`
603603

604-
For example to view a resource named `my-claim` of type `example.crossplane.io`:
605-
`crossplane beta trace example.crossplane.io my-claim`
604+
For example to view a resource named `my-xr` of type `example.crossplane.io`:
605+
`crossplane beta trace example.crossplane.io my-xr`
606606

607607
The command also accepts Kubernetes CLI style `<kind>/<name>` input.
608608
For example,
609-
`crossplane beta trace example.crossplane.io/my-claim`
609+
`crossplane beta trace example.crossplane.io/my-xr`
610610

611611
By default the `crossplane beta trace` command uses the Kubernetes
612612
configuration defined in `~/.kube/config`.
@@ -634,46 +634,6 @@ variable `KUBECONFIG`.
634634
By default `crossplane beta trace` prints directly to the terminal, limiting the
635635
"Ready" condition and "Status" messages to 64 characters.
636636

637-
The following an example output a "cluster" claim from the AWS reference
638-
platform, which includes multiple Compositions and composed resources:
639-
640-
```shell {copy-lines="1"}
641-
crossplane beta trace cluster.aws.platformref.upbound.io platform-ref-aws
642-
NAME VERSION INSTALLED HEALTHY STATE STATUS
643-
Configuration/platform-ref-aws v0.9.0 True True - HealthyPackageRevision
644-
├─ ConfigurationRevision/platform-ref-aws-9ad7b5db2899 v0.9.0 - True Active HealthyPackageRevision
645-
├─ Configuration/upbound-configuration-aws-network v0.7.0 True True - HealthyPackageRevision
646-
│ ├─ ConfigurationRevision/upbound-configuration-aws-network-97be9100cfe1 v0.7.0 - True Active HealthyPackageRevision
647-
│ ├─ Provider/upbound-provider-aws-ec2 v0.47.0 True True - HealthyPackageRevision
648-
│ │ ├─ ProviderRevision/upbound-provider-aws-ec2-cfeb0cd0f1d2 v0.47.0 - True Active HealthyPackageRevision
649-
│ │ └─ Provider/upbound-provider-family-aws v1.0.0 True True - HealthyPackageRevision
650-
│ │ └─ ProviderRevision/upbound-provider-family-aws-48b3b5ccf964 v1.0.0 - True Active HealthyPackageRevision
651-
│ └─ Function/upbound-function-patch-and-transform v0.2.1 True True - HealthyPackageRevision
652-
│ └─ FunctionRevision/upbound-function-patch-and-transform-a2f88f8d8715 v0.2.1 - True Active HealthyPackageRevision
653-
├─ Configuration/upbound-configuration-aws-database v0.5.0 True True - HealthyPackageRevision
654-
│ ├─ ConfigurationRevision/upbound-configuration-aws-database-3112f0a765c5 v0.5.0 - True Active HealthyPackageRevision
655-
│ └─ Provider/upbound-provider-aws-rds v0.47.0 True True - HealthyPackageRevision
656-
│ └─ ProviderRevision/upbound-provider-aws-rds-58f96aa9fc4b v0.47.0 - True Active HealthyPackageRevision
657-
├─ Configuration/upbound-configuration-aws-eks v0.5.0 True True - HealthyPackageRevision
658-
│ ├─ ConfigurationRevision/upbound-configuration-aws-eks-83c9d65f4a47 v0.5.0 - True Active HealthyPackageRevision
659-
│ ├─ Provider/crossplane-contrib-provider-helm v0.16.0 True True - HealthyPackageRevision
660-
│ │ └─ ProviderRevision/crossplane-contrib-provider-helm-b4cc4c2c8db3 v0.16.0 - True Active HealthyPackageRevision
661-
│ ├─ Provider/crossplane-contrib-provider-kubernetes v0.10.0 True True - HealthyPackageRevision
662-
│ │ └─ ProviderRevision/crossplane-contrib-provider-kubernetes-63506a3443e0 v0.10.0 - True Active HealthyPackageRevision
663-
│ ├─ Provider/upbound-provider-aws-eks v0.47.0 True True - HealthyPackageRevision
664-
│ │ └─ ProviderRevision/upbound-provider-aws-eks-641a096d79d8 v0.47.0 - True Active HealthyPackageRevision
665-
│ └─ Provider/upbound-provider-aws-iam v0.47.0 True True - HealthyPackageRevision
666-
│ └─ ProviderRevision/upbound-provider-aws-iam-438eac423037 v0.47.0 - True Active HealthyPackageRevision
667-
├─ Configuration/upbound-configuration-app v0.2.0 True True - HealthyPackageRevision
668-
│ └─ ConfigurationRevision/upbound-configuration-app-5d95726dba8c v0.2.0 - True Active HealthyPackageRevision
669-
├─ Configuration/upbound-configuration-observability-oss v0.2.0 True True - HealthyPackageRevision
670-
│ ├─ ConfigurationRevision/upbound-configuration-observability-oss-a51529457ad7 v0.2.0 - True Active HealthyPackageRevision
671-
│ └─ Provider/grafana-provider-grafana v0.8.0 True True - HealthyPackageRevision
672-
│ └─ ProviderRevision/grafana-provider-grafana-ac529c8ce1c6 v0.8.0 - True Active HealthyPackageRevision
673-
└─ Configuration/upbound-configuration-gitops-flux v0.2.0 True True - HealthyPackageRevision
674-
└─ ConfigurationRevision/upbound-configuration-gitops-flux-2e80ec62738d v0.2.0 - True Active HealthyPackageRevision
675-
```
676-
677637
#### Wide outputs
678638
Print the entire "Ready" or "Status" message if they're longer than
679639
64 characters with `--output=wide`.
@@ -683,15 +643,15 @@ For example, the output truncates the "Status" message that's too long.
683643
```shell {copy-lines="1"
684644
crossplane trace cluster.aws.platformref.upbound.io platform-ref-aws
685645
NAME SYNCED READY STATUS
686-
Cluster/platform-ref-aws (default) True False Waiting: ...resource claim is waiting for composite resource to become Ready
646+
Cluster/platform-ref-aws (default) True False Unready resources: cluster
687647
```
688648

689649
Use `--output=wide` to see the full message.
690650

691651
```shell {copy-lines="1"
692652
crossplane trace cluster.aws.platformref.upbound.io platform-ref-aws --output=wide
693653
NAME SYNCED READY STATUS
694-
Cluster/platform-ref-aws (default) True False Waiting: Composite resource claim is waiting for composite resource to become Ready
654+
Cluster/platform-ref-aws (default) True False Unready resources: cluster
695655
```
696656

697657
#### Graphviz dot file output
@@ -869,7 +829,7 @@ Configuration/platform-ref-aws v0.9.0 True
869829
### beta validate
870830

871831
The `crossplane beta validate` command validates
872-
[compositions]({{<ref "../concepts/compositions">}}) against provider or XRD
832+
[compositions]({{<ref "../composition/compositions">}}) against provider or XRD
873833
schemas using the Kubernetes API server's validation library
874834
with extra validation such as checking for unknown fields,
875835
a common source of difficult to debug issues in Crossplane.

‎content/v2.0-preview/composition/_index.md‎

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+
---

0 commit comments

Comments
 (0)