forked from crossplane/crossplane
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
services guide and overall docs update part 1
Signed-off-by: Phil Prasek <prasek@gmail.com>
- Loading branch information
Showing
16 changed files
with
1,064 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: Adding Your Cloud Providers | ||
toc: true | ||
weight: 330 | ||
weight: 230 | ||
indent: true | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: Concepts | ||
toc: true | ||
weight: 410 | ||
weight: 1510 | ||
--- | ||
# Concepts | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
--- | ||
title: Contributing | ||
toc: true | ||
weight: 710 | ||
weight: 5110 | ||
--- | ||
# Contributing | ||
|
||
Crossplane is a community driven project and we welcome contributions. | ||
That includes [opening issues](https://github.com/crossplaneio/crossplane/issues) for improvements you'd like to see as well as submitting changes to the code base. | ||
|
||
For more information about the contribution process, please see the [contribution guide](https://github.com/crossplaneio/crossplane/blob/master/CONTRIBUTING.md). | ||
For more information about the contribution process, please see the [contribution guide](https://github.com/crossplaneio/crossplane/blob/master/CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: Deploying Workloads | ||
toc: true | ||
weight: 340 | ||
weight: 240 | ||
indent: true | ||
--- | ||
# Deploying Workloads | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
title: Developer Guide | ||
toc: true | ||
weight: 5010 | ||
--- | ||
# Developer Guide | ||
Welcome to the Crossplane Developer Guide! | ||
|
||
## Overview | ||
Infra Stacks like | ||
[stack-gcp][stack-gcp], [stack-aws][stack-aws], and [stack-azure][stack-azure] extend Crossplane | ||
to support managed service provisioning (databases, caches, buckets), secure | ||
connectivity (VPCs, subnets, peering, ACLs, secrets), and provisioning managed | ||
Kubernetes clusters on demand to further isolate the blast radius of | ||
applications. | ||
|
||
Infra Stacks are typically pre-built and published to the [Stacks | ||
registry][stack-registry], where they can | ||
be installed by a cluster administrator using a | ||
[`ClusterStackInstall`][stack-install-docs] | ||
kind via the Kubernetes API or with the [`stack | ||
install`][crossplane-cli-usage] command. | ||
|
||
App Stacks depend on Infra Stacks like | ||
[stack-gcp][stack-gcp], [stack-aws][stack-aws], or [stack-azure][stack-azure] | ||
to provide the managed services they depend on via the Kubernetes API. | ||
|
||
App Stacks may also be pre-built and published to the [Stacks | ||
registry][stack-registry] where they can | ||
be deployed by application teams using a | ||
[`StackInstall`][crossplane-cli-usage]] | ||
kind via the Kubernetes API or with the [`stack | ||
install`][crossplane-cli-usage]) command. | ||
|
||
## Infra Stacks | ||
### Using Infra Stacks | ||
The [Crossplane Services Guide][services-user-guide] | ||
shows how to use existing Infra Stacks to deploy a Wordpress `Deployment` | ||
that securely consumes a MySQL instance from GCP, AWS, or Azure all from | ||
`kubectl`. | ||
|
||
### Building Infra Stacks | ||
Infra Stacks are out-of-tree Crossplane extensions | ||
that can be built and published on their own schedule separate from the core | ||
Crossplane repos. | ||
|
||
Crossplane enables the community to build a modular, open cloud control plane | ||
where any cloud service or capability can be added using the [Stack | ||
Manager][stack-manager], | ||
an extension manager for the Kubernetes API. Crossplane Stacks simplify the work | ||
required to build, publish, install and manage control plane extensions with a | ||
powerful RBAC permission model, integrated dependency management, and more. | ||
|
||
The [Infra Stack Developer Guide][infra-stack-developer-guide] shows how to: | ||
* Extend existing Infra Stacks ([stack-gcp][stack-gcp], [stack-aws][stack-aws], | ||
[stack-azure][stack-azure]) to add more cloud services. | ||
* Build a new Infra Stack to add more cloud providers. | ||
* Make independent cloud offerings available via the Kubernetes API, so | ||
application teams can use them just like standard Kubernetes resources. | ||
|
||
## App Stacks | ||
### Using App Stacks | ||
The [Crossplane Stacks Guide][stacks-user-guide] guide | ||
shows how to use a [portable App | ||
Stack][stack-wordpress-registry] that can | ||
deploy with any Infra Stack including: | ||
[stack-gcp][stack-gcp], [stack-aws][stack-aws], or [stack-azure][stack-azure]. | ||
|
||
### Building App Stacks | ||
To learn how to build a "Hello World" Stack see the | ||
[Stacks Quick Start][stacks-quick-start]. | ||
|
||
For a complete App Stack, see the [portable Wordpress App | ||
Stack][stack-wordpress] with a | ||
kubebuilder-based app | ||
[`Controller`][kubernetes-controller] | ||
that owns a `WordressInstance` CRD, builds a complete `KubernetesApplication`, | ||
and automates much of what's covered in the [Crossplane Services | ||
Guide][services-user-guide] plus dynamic cluster provisioning, so you can | ||
provision a complete Wordpress app instance from `kubectl` using a single Kubernetes object. | ||
|
||
|
||
## Learn More | ||
If you have any questions, please drop us a note on [Crossplane Slack][join-crossplane-slack] or [contact us][contact-us]! | ||
|
||
To [learn more][learn-more] checkout these [useful links][learn-more]. | ||
|
||
<!-- Named links --> | ||
[services-user-guide]: services-guide.md | ||
[stack-user-guide]: stacks-guide.md | ||
[stack-registry]: https://hub.docker.com/search?q=crossplane&type=image | ||
[crossplane-cli-usage]: https://github.com/crossplaneio/crossplane-cli#usage | ||
[stack-install-docs]: https://github.com/crossplaneio/crossplane/blob/master/design/design-doc-stacks.md#installation-flow | ||
[stack-gcp]: https://github.com/crossplaneio/stack-gcp | ||
[stack-aws]: https://github.com/crossplaneio/stack-aws | ||
[stack-azure]: https://github.com/crossplaneio/stack-azure | ||
[stack-wordpress]: https://github.com/crossplaneio/sample-stack-wordpress | ||
[stack-wordpress-registry]: https://hub.docker.com/r/crossplane/sample-stack-wordpress | ||
[stack-manager]: https://github.com/crossplaneio/crossplane/blob/master/design/design-doc-stacks.md#terminology | ||
[infra-stack-developer-guide]: developer-guide.md | ||
[stack-quick-start]: https://github.com/crossplaneio/crossplane-cli#quick-start-stacks | ||
[kubernetes-controller]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-controllers | ||
[join-crossplane-slack]: https://slack.crossplane.io | ||
[contact-us]: https://github.com/crossplaneio/crossplane#contact | ||
[learn-more]: learn-more.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: FAQs | ||
toc: true | ||
weight: 610 | ||
weight: 2110 | ||
--- | ||
# Frequently Asked Questions (FAQs) | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: Install | ||
toc: true | ||
weight: 320 | ||
weight: 220 | ||
indent: true | ||
--- | ||
# Installing Crossplane | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.