|
1 | 1 | ---
|
2 |
| -title: "Overview" |
| 2 | +title: "Welcome" |
3 | 3 | weight: -1
|
4 | 4 | cascade:
|
5 | 5 | version: "2.0-preview"
|
6 | 6 | ---
|
7 | 7 |
|
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. |
9 | 10 |
|
10 |
| -<br /> |
| 11 | +# Using the documentation |
11 | 12 |
|
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: |
14 | 14 |
|
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. |
19 | 17 |
|
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 | +* [Get Started]({{<ref "get-started">}}) explains how to install Crossplane and |
| 19 | + create a control plane. |
24 | 20 |
|
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 | +* [Concepts]({{<ref "concepts">}}) introduces Crossplane's key concepts. |
29 | 22 |
|
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. |
| 23 | +* [Guides]({{<ref "guides">}}) guide you through common use cases, like |
| 24 | + monitoring Crossplane or extending it by writing a composition function. |
36 | 25 |
|
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 | +* [CLI Reference]({{<ref "cli">}}) documents the `crossplane` command-line |
| 27 | + interface that you can use to configure a Crossplane control plane. |
41 | 28 |
|
42 |
| - |
43 |
| -# Get started |
44 |
| -* [Install Crossplane]({{<ref "get-started/install">}}) in your Kubernetes cluster |
45 |
| -* Learn more about how Crossplane works in the |
46 |
| -[Crossplane introduction]({{<ref "get-started" >}}) |
47 |
| -* Join the [Crossplane Slack](https://slack.crossplane.io/) and start a |
48 |
| -conversation with a community of over 7,000 operators. |
49 |
| - |
50 |
| - |
51 |
| -Crossplane is a [Cloud Native Compute Foundation](https://www.cncf.io/) project. |
| 29 | +* [API Reference]({{<ref "api">}}) documents the APIs that you can use to |
| 30 | + configure a Crossplane control plane. |
0 commit comments