From 89cde6ed162c9787c173e9fa79274189ee429ae6 Mon Sep 17 00:00:00 2001 From: Crossplane Date: Mon, 20 Sep 2021 21:08:45 +0000 Subject: [PATCH] docs snapshot for crossplane version `master` --- docs/master/README.md | 52 +++++++++---------------------------------- 1 file changed, 11 insertions(+), 41 deletions(-) diff --git a/docs/master/README.md b/docs/master/README.md index d56688be..327a2a66 100644 --- a/docs/master/README.md +++ b/docs/master/README.md @@ -3,50 +3,20 @@ ![Crossplane](media/banner.png) Crossplane is an open source Kubernetes add-on that enables platform teams to -assemble infrastructure from multiple vendors, and expose higher level -self-service APIs for application teams to consume. Crossplane effectively -enables platform teams to quickly put together their own opinionated platform -declaratively without having to write any code, and offer it to their -application teams as a self-service Kubernetes-style declarative API. +Crossplane is an open source Kubernetes add-on that transforms your cluster into +a **universal control plane**. Crossplane enables platform teams to assemble +infrastructure from multiple vendors, and expose higher level self-service APIs +for application teams to consume, without having to write any code. -Both the higher level abstractions as well as the granular resources they are -composed of are represented simply as objects in the Kubernetes API, meaning -they can all be provisioned and managed by kubectl, GitOps, or any tools that -can talk with the Kubernetes API. To facilitate reuse and sharing of these APIs, -Crossplane supports packaging them in a standard OCI image and distributing via -any compliant registry. +Crossplane extends your Kubernetes cluster to support orchestrating any +infrastructure or managed service. Compose Crossplane's granular resources into +higher level abstractions that can be versioned, managed, deployed and consumed +using your favorite tools and existing processes. [Install Crossplane] into any +Kubernetes cluster to get started. -Platform engineers are able to define organizational policies and guardrails -behind these self-service API abstractions. The developer is presented with the -limited set of configuration that they need to tune for their use-case and is -not exposed to any of the complexities of the low-level infrastructure below the -API. Access to these APIs is managed with Kubernetes-native RBAC, thus enabling -the level of permissioning to be at the level of abstraction. - -While extending the Kubernetes control plane with a diverse set of vendors, -resources, and abstractions, Crossplane recognized the need for a single -consistent API across all of them. To this end, we have created the Crossplane -Resource Model (XRM). XRM extends the Kubernetes Resource Model (KRM) in an -opinionated way, resulting in a universal experience for managing resources, -regardless of where they reside. When interacting with the XRM, things like -credentials, workload identity, connection secrets, status conditions, deletion -policies, and references to other resources work the same no matter what -provider or level of abstraction they are a part of. - -The functionality and value of the Crossplane project can be summarized at a -very high level by these two main areas: - -1. Enabling infrastructure owners to build custom platform abstractions (APIs) - composed of granular resources that allow developer self-service and service - catalog use cases -2. Providing a universal experience for managing infrastructure, resources, and - abstractions consistently across all vendors and environments in a uniform - way, called the Crossplane Resource Model (XRM) - -## Getting Started - -[Install Crossplane] into any Kubernetes cluster to get started. +Crossplane is a [Cloud Native Compute Foundation][cncf] project. [Install Crossplane]: getting-started/install-configure.md +[cncf]: https://www.cncf.io/ \ No newline at end of file