Skip to content

Commit fe508db

Browse files
committed
Replace content/master with a copy of content/v2.0-preview
Signed-off-by: Nic Cope <[email protected]>
1 parent 431e87a commit fe508db

File tree

72 files changed

+3794
-17070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+3794
-17070
lines changed

content/master/_index.md

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,39 @@
11
---
2-
title: "Overview"
2+
title: "Welcome"
33
weight: -1
44
cascade:
55
version: "master"
66
---
77

8-
{{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}
8+
Welcome to the Crossplane documentation. Crossplane is a control plane framework
9+
for platform engineering.
910

10-
<br />
11+
# Using the documentation
1112

12-
Crossplane is an open source Kubernetes extension that transforms your Kubernetes
13-
cluster into a **universal control plane**.
13+
Crossplane organizes its documentation into the following sections:
1414

15-
Crossplane lets you manage anything, anywhere, all through standard Kubernetes
16-
APIs. Crossplane can even let you
17-
[order a pizza](https://blog.crossplane.io/providers-101-ordering-pizza-with-kubernetes-and-crossplane/)
18-
directly from Kubernetes. If it has an API, Crossplane can connect to it.
15+
* [What's Crossplane?]({{<ref "whats-crossplane">}}) introduces Crossplane
16+
and explains why you should use it.
1917

20-
With Crossplane, platform teams can create new abstractions and custom
21-
APIs with the full power of Kubernetes policies, namespaces, role based access
22-
controls and more. Crossplane brings all your non-Kubernetes resources under
23-
one roof.
18+
* [What's New in v2?]({{<ref "whats-new">}}) highlights what's changed in
19+
Crossplane v2.
2420

25-
Custom APIs, created by platform teams, allow security and compliance
26-
enforcement across resources or clouds, without exposing any complexity to the
27-
developers. A single API call can create multiple resources, in multiple clouds
28-
and use Kubernetes as the control plane for everything.
21+
* [Get Started]({{<ref "get-started">}}) explains how to install Crossplane and
22+
create a control plane.
2923

30-
{{< hint "tip" >}}
31-
**What's a control plane?**
32-
<!-- vale Google.WordList = NO -->
33-
Control planes create and manage the lifecycle of resources. Control planes
34-
constantly _check_ that the intended resources exist, _report_ when the intended
35-
state doesn't match reality and _act_ to make things right.
24+
* [Composition]({{<ref "composition">}}) covers the key concepts of composition.
3625

37-
Crossplane extends the Kubernetes control plane to be a **universal control
38-
plane** to check, report and act on any resource, anywhere.
39-
<!-- vale Google.WordList = YES -->
40-
{{< /hint >}}
26+
* [Managed Resources]({{<ref "managed-resources">}}) covers the key concepts of
27+
managed resources.
4128

29+
* [Packages]({{<ref "packages">}}) covers the key concepts of the Crossplane
30+
package manager.
4231

43-
# Get started
44-
* [Install Crossplane]({{<ref "software/install">}}) in your Kubernetes cluster
45-
* Learn more about how Crossplane works in the
46-
[Crossplane introduction]({{<ref "getting-started/introduction" >}})
47-
* Join the [Crossplane Slack](https://slack.crossplane.io/) and start a
48-
conversation with a community of over 7,000 operators.
32+
* [Guides]({{<ref "guides">}}) guide you through common use cases, like
33+
monitoring Crossplane or extending it by writing a composition function.
4934

35+
* [CLI Reference]({{<ref "cli">}}) documents the `crossplane` command-line
36+
interface that you can use to configure a Crossplane control plane.
5037

51-
Crossplane is a [Cloud Native Compute Foundation](https://www.cncf.io/) project.
38+
* [API Reference]({{<ref "api">}}) documents the APIs that you can use to
39+
configure a Crossplane control plane.

content/master/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/master/api/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml

Lines changed: 606 additions & 0 deletions
Large diffs are not rendered by default.

content/master/api/crds/apiextensions.crossplane.io_compositionrevisions.yaml

Lines changed: 4 additions & 2017 deletions
Large diffs are not rendered by default.

content/master/api/crds/apiextensions.crossplane.io_compositions.yaml

Lines changed: 9 additions & 893 deletions
Large diffs are not rendered by default.

content/master/api/crds/apiextensions.crossplane.io_environmentconfigs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ spec:
5858
type: object
5959
type: object
6060
served: true
61-
storage: false
61+
storage: true
6262
subresources: {}
6363
- additionalPrinterColumns:
6464
- jsonPath: .metadata.creationTimestamp
@@ -100,5 +100,5 @@ spec:
100100
type: object
101101
type: object
102102
served: true
103-
storage: true
103+
storage: false
104104
subresources: {}

content/master/api/crds/apiextensions.crossplane.io_usages.yaml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ spec:
2626
- jsonPath: .metadata.creationTimestamp
2727
name: AGE
2828
type: date
29+
deprecated: true
30+
deprecationWarning: apiextensions.crossplane.io Usage is deprecated; migrate to
31+
protection.crossplane.io Usage or ClusterUsage
2932
name: v1alpha1
3033
schema:
3134
openAPIV3Schema:
@@ -36,7 +39,9 @@ spec:
3639
resources with dependent resources.
3740
3841
Read the Crossplane documentation for
39-
[more information about Compositions](https://docs.crossplane.io/latest/concepts/usages).
42+
[more information about Usages](https://docs.crossplane.io/latest/concepts/usages).
43+
44+
Deprecated: Use protection.crossplane.io Usage or ClusterUsage.
4045
properties:
4146
apiVersion:
4247
description: |-
@@ -223,6 +228,9 @@ spec:
223228
- jsonPath: .metadata.creationTimestamp
224229
name: AGE
225230
type: date
231+
deprecated: true
232+
deprecationWarning: apiextensions.crossplane.io Usage is deprecated; migrate to
233+
protection.crossplane.io Usage or ClusterUsage
226234
name: v1beta1
227235
schema:
228236
openAPIV3Schema:
@@ -233,7 +241,9 @@ spec:
233241
resources with dependent resources.
234242
235243
Read the Crossplane documentation for
236-
[more information about Compositions](https://docs.crossplane.io/latest/concepts/usages).
244+
[more information about Usages](https://docs.crossplane.io/latest/concepts/usages).
245+
246+
Deprecated: Use protection.crossplane.io Usage or ClusterUsage.
237247
properties:
238248
apiVersion:
239249
description: |-

content/master/api/crds/pkg.crossplane.io_configurationrevisions.yaml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -146,27 +146,6 @@ spec:
146146
description: PackageRevisionStatus represents the observed state of a
147147
PackageRevision.
148148
properties:
149-
appliedImageConfigRefs:
150-
description: |-
151-
AppliedImageConfigRefs records any image configs that were applied in
152-
reconciling this revision, and what they were used for.
153-
items:
154-
description: |-
155-
ImageConfigRef is a reference to an image config that indicates how the
156-
referenced image config was used by the package manager.
157-
properties:
158-
name:
159-
description: Name is the name of the image config.
160-
type: string
161-
reason:
162-
description: Reason indicates what the image config was used
163-
for.
164-
type: string
165-
required:
166-
- name
167-
- reason
168-
type: object
169-
type: array
170149
conditions:
171150
description: Conditions of the resource.
172151
items:
@@ -302,12 +281,6 @@ spec:
302281
- verbs
303282
type: object
304283
type: array
305-
resolvedImage:
306-
description: |-
307-
ResolvedPackage is the name of the package that was installed. It may be
308-
different from spec.image if the package path was rewritten using an
309-
image config.
310-
type: string
311284
type: object
312285
type: object
313286
served: true

content/master/api/crds/pkg.crossplane.io_configurations.yaml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -138,27 +138,6 @@ spec:
138138
status:
139139
description: ConfigurationStatus represents the observed state of a Configuration.
140140
properties:
141-
appliedImageConfigRefs:
142-
description: |-
143-
AppliedImageConfigRefs records any image configs that were applied in
144-
reconciling this package, and what they were used for.
145-
items:
146-
description: |-
147-
ImageConfigRef is a reference to an image config that indicates how the
148-
referenced image config was used by the package manager.
149-
properties:
150-
name:
151-
description: Name is the name of the image config.
152-
type: string
153-
reason:
154-
description: Reason indicates what the image config was used
155-
for.
156-
type: string
157-
required:
158-
- name
159-
- reason
160-
type: object
161-
type: array
162141
conditions:
163142
description: Conditions of the resource.
164143
items:
@@ -220,12 +199,6 @@ spec:
220199
reflect the most up to date revision, whether it has been activated or
221200
not.
222201
type: string
223-
resolvedPackage:
224-
description: |-
225-
ResolvedPackage is the name of the package that was used for version
226-
resolution. It may be different from spec.package if the package path was
227-
rewritten using an image config.
228-
type: string
229202
type: object
230203
type: object
231204
served: true

0 commit comments

Comments
 (0)