diff --git a/css/docs.scss b/css/docs.scss index af951082..de87d95f 100644 --- a/css/docs.scss +++ b/css/docs.scss @@ -150,7 +150,7 @@ pre > code { } &.latest select { - padding-right: 94px; + padding-right: 107px; } } } diff --git a/docs/master/README.md b/docs/master/README.md new file mode 100644 index 00000000..a60fe6b0 --- /dev/null +++ b/docs/master/README.md @@ -0,0 +1,29 @@ +--- +title: Welcome +toc: true +weight: 110 +--- +# Crossplane + +Crossplane is an open source multicloud control plane. It introduces workload and resource abstractions on-top of existing managed services that enables a high degree of workload portability across cloud providers. A single crossplane enables the provisioning and full-lifecycle management of services and infrastructure across a wide range of providers, offerings, vendors, regions, and clusters. Crossplane offers a universal API for cloud computing, a workload scheduler, and a set of smart controllers that can automate work across clouds. + +

Crossplane

+ +Crossplane presents a declarative management style API that covers a wide range of portable abstractions including databases, message queues, buckets, data pipelines, serverless, clusters, and many more coming. It’s based on the declarative resource model of the popular [Kubernetes](https://github.com/kubernetes/kubernetes) project, and applies many of the lessons learned in container orchestration to multicloud workload and resource orchestration. + +Crossplane supports a clean separation of concerns between developers and administrators. Developers define workloads without having to worry about implementation details, environment constraints, and policies. Administrators can define environment specifics, and policies. The separation of concern leads to a higher degree of reusability and reduces complexity. + +Crossplane includes a workload scheduler that can factor a number of criteria including capabilities, availability, reliability, cost, regions, and performance while deploying workloads and their resources. The scheduler works alongside specialized resource controllers to ensure policies set by administrators are honored. + +For a deeper dive into Crossplane, see the [architecture](https://docs.google.com/document/d/1whncqdUeU2cATGEJhHvzXWC9xdK29Er45NJeoemxebo/edit?usp=sharing) document. + +* [Quick Start Guide](quick-start.md) +* [Getting Started](getting-started.md) + * [Installing Crossplane Software](install-crossplane.md) + * [Adding Your Cloud Providers](cloud-providers.md) + * [Deploying Workloads](deploy.md) + * [Running Resources](running-resources.md) + * [Troubleshooting](troubleshoot.md) +* [Concepts](concepts.md) +* [FAQs](faqs.md) +* [Contributing](contributing.md) \ No newline at end of file diff --git a/docs/master/cloud-providers.md b/docs/master/cloud-providers.md new file mode 100644 index 00000000..ba64218f --- /dev/null +++ b/docs/master/cloud-providers.md @@ -0,0 +1,17 @@ +--- +title: Adding Your Cloud Providers +toc: true +weight: 330 +indent: true +--- +# Adding Your Cloud Providers + +* [Google Cloud Platform (GCP)](#google-cloud-platform-gcp) +* [Microsoft Azure](#microsoft-azure) +* [Amazon Web Services (AWS)](#amazon-web-services-aws) + +## Google Cloud Platform (GCP) + +## Microsoft Azure + +## Amazon Web Services (AWS) \ No newline at end of file diff --git a/docs/master/concepts.md b/docs/master/concepts.md new file mode 100644 index 00000000..a2136be9 --- /dev/null +++ b/docs/master/concepts.md @@ -0,0 +1,18 @@ +--- +title: Concepts +toc: true +weight: 410 +--- +# Concepts + +## Resources and Workloads + +## Control Plane + +## Resource Claims and Resource Classes + +## Dynamic and Static Provisioning + +## Consuming Connection Secrets + +## Terminology Guide \ No newline at end of file diff --git a/docs/master/contributing.md b/docs/master/contributing.md new file mode 100644 index 00000000..fcf66f89 --- /dev/null +++ b/docs/master/contributing.md @@ -0,0 +1,6 @@ +--- +title: Contributing +toc: true +weight: 610 +--- +# Contributing diff --git a/docs/master/deploy.md b/docs/master/deploy.md new file mode 100644 index 00000000..578d9cc9 --- /dev/null +++ b/docs/master/deploy.md @@ -0,0 +1,17 @@ +--- +title: Deploy +toc: true +weight: 340 +indent: true +--- +# Deploying Workloads + +* [Crossplane Workload on Google Cloud Platform (GCP)](#crossplane-workload-on-google-cloud-platform-gcp) +* [Crossplane Workload on Microsoft Azure](#crossplane-workload-on-microsoft-azure) +* [Crossplane Workload on Amazon Web Services (AWS)](#crossplane-workload-on-amazon-web-services-aws) + +## Crossplane Workload on Google Cloud Platform (GCP) + +## Crossplane Workload on Microsoft Azure + +## Crossplane Workload on Amazon Web Services (AWS) \ No newline at end of file diff --git a/docs/master/faqs.md b/docs/master/faqs.md new file mode 100644 index 00000000..5d2879df --- /dev/null +++ b/docs/master/faqs.md @@ -0,0 +1,6 @@ +--- +title: FAQs +toc: true +weight: 510 +--- +# Frequently Asked Questions (FAQs) \ No newline at end of file diff --git a/docs/master/getting-started.md b/docs/master/getting-started.md new file mode 100644 index 00000000..2de96191 --- /dev/null +++ b/docs/master/getting-started.md @@ -0,0 +1,11 @@ +--- +title: Getting Started +toc: true +weight: 310 +--- +# Getting Started + +* [Installing Crossplane Software](install-crossplane.md) +* [Adding Your Cloud Providers](cloud-providers.md) +* [Deploying Workloads](deploy.md) +* [Troubleshooting](troubleshoot.md) \ No newline at end of file diff --git a/docs/master/install-crossplane.md b/docs/master/install-crossplane.md new file mode 100644 index 00000000..72198f7b --- /dev/null +++ b/docs/master/install-crossplane.md @@ -0,0 +1,7 @@ +--- +title: Install +toc: true +weight: 320 +indent: true +--- +# Installing Crossplane Software \ No newline at end of file diff --git a/docs/master/media/arch.png b/docs/master/media/arch.png new file mode 100644 index 00000000..8205e62e Binary files /dev/null and b/docs/master/media/arch.png differ diff --git a/docs/master/media/logo.svg b/docs/master/media/logo.svg new file mode 100644 index 00000000..3af90369 --- /dev/null +++ b/docs/master/media/logo.svg @@ -0,0 +1,310 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/master/quick-start.md b/docs/master/quick-start.md new file mode 100644 index 00000000..c5cacf46 --- /dev/null +++ b/docs/master/quick-start.md @@ -0,0 +1,8 @@ +--- +title: Quick Start Guide +toc: true +weight: 210 +--- +# Quick Start Guide + +## Deploying a Workload \ No newline at end of file diff --git a/docs/master/running-resources.md b/docs/master/running-resources.md new file mode 100644 index 00000000..f3b84ccb --- /dev/null +++ b/docs/master/running-resources.md @@ -0,0 +1,7 @@ +--- +title: Running Resources +toc: true +weight: 350 +indent: true +--- +# Running Resources \ No newline at end of file diff --git a/docs/master/troubleshoot.md b/docs/master/troubleshoot.md new file mode 100644 index 00000000..91ca47db --- /dev/null +++ b/docs/master/troubleshoot.md @@ -0,0 +1,7 @@ +--- +title: Troubleshooting +toc: true +weight: 360 +indent: true +--- +# Troubleshooting