crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs snapshot for crossplane version `v0.4`

This commit is contained in:
Crossplane 2019-10-29 20:45:38 +00:00
parent 630094c4c2
commit ff73ca16b7
8 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/v0.4/install-crossplane.md
View File

@ -55,9 +55,9 @@ helm install --name crossplane --namespace crossplane-system crossplane-master/c
## Installing Cloud Provider Stacks
You can add additional functionality to Crossplane's control plane by installing Crossplane Stacks. For example, each
You can add additional functionality to Crossplane's control plane by installing Crossplane Stacks. For example, each
supported cloud provider has its own corresponding stack that contains all the functionality for that particular cloud.
After a cloud provider's stack is installed, you will be able to provision and manage resources within that cloud
After a cloud provider's stack is installed, you will be able to provision and manage resources within that cloud
from Crossplane.
### Installation with Helm
@ -94,7 +94,7 @@ metadata:
name: stack-gcp
namespace: gcp
spec:
package: "crossplane/stack-gcp:master"
package: "crossplane/stack-gcp:v0.2.0"
```
Then you can install the GCP stack into Crossplane in the `gcp` namespace with the following command:
@ -119,7 +119,7 @@ metadata:
name: stack-aws
namespace: aws
spec:
package: "crossplane/stack-aws:master"
package: "crossplane/stack-aws:v0.2.0"
```
Then you can install the AWS stack into Crossplane in the `aws` namespace with the following command:
@ -144,7 +144,7 @@ metadata:
name: stack-azure
namespace: azure
spec:
package: "crossplane/stack-azure:master"
package: "crossplane/stack-azure:v0.2.0"
```
Then you can install the Azure stack into Crossplane in the `azure` namespace with the following command:
@ -169,7 +169,7 @@ metadata:
name: stack-rook
namespace: rook
spec:
package: "crossplane/stack-rook:master"
package: "crossplane/stack-rook:v0.1.0"
```
Then you can install the Rook stack into Crossplane in the `rook` namespace with the following command:
@ -232,15 +232,15 @@ The following tables lists the configurable parameters of the Crossplane chart a
| `imagePullSecrets` | Names of image pull secrets to use | `dockerhub` |
| `replicas` | The number of replicas to run for the Crossplane operator | `1` |
| `deploymentStrategy` | The deployment strategy for the Crossplane operator | `RollingUpdate` |
| `clusterStacks.aws.deploy` | Deploy AWS stack | `false`
| `clusterStacks.aws.version` | AWS stack version to deploy | `<latest released version>`
| `clusterStacks.gcp.deploy` | Deploy GCP stack | `false`
| `clusterStacks.gcp.version` | GCP stack version to deploy | `<latest released version>`
| `clusterStacks.azure.deploy` | Deploy Azure stack | `false`
| `clusterStacks.azure.version` | Azure stack version to deploy | `<latest released version>`
| `clusterStacks.rook.deploy` | Deploy Rook stack | `false`
| `clusterStacks.rook.version` | Rook stack version to deploy | `<latest released version>`
| `clusterStacks.aws.deploy` | Deploy AWS stack | `false`
| `clusterStacks.aws.version` | AWS stack version to deploy | `<latest released version>`
| `clusterStacks.gcp.deploy` | Deploy GCP stack | `false`
| `clusterStacks.gcp.version` | GCP stack version to deploy | `<latest released version>`
| `clusterStacks.azure.deploy` | Deploy Azure stack | `false`
| `clusterStacks.azure.version` | Azure stack version to deploy | `<latest released version>`
| `clusterStacks.rook.deploy` | Deploy Rook stack | `false`
| `clusterStacks.rook.version` | Rook stack version to deploy | `<latest released version>`
### Command Line
You can pass the settings with helm command line parameters.

2
docs/v0.4/quick-start.md
View File

@ -42,7 +42,7 @@ metadata:
name: stack-gcp
namespace: crossplane-system
spec:
package: "crossplane/stack-gcp:master"
package: "crossplane/stack-gcp:v0.2.0"
```
Save the above as `stack.yaml`, and apply it by running:

2
docs/v0.4/services/aws-services-guide.md
View File

@ -88,7 +88,7 @@ metadata:
name: stack-aws
namespace: crossplane-system
spec:
package: "crossplane/stack-aws:master"
package: "crossplane/stack-aws:v0.2.0"
EOF
kubectl apply -f stack-aws.yaml

2
docs/v0.4/services/azure-services-guide.md
View File

@ -81,7 +81,7 @@ metadata:
name: stack-azure
namespace: crossplane-system
spec:
package: "crossplane/stack-azure:master"
package: "crossplane/stack-azure:v0.2.0"
EOF
kubectl apply -f stack-azure.yaml

16
docs/v0.4/stacks-guide-aws.md
View File

@ -73,7 +73,7 @@ infrastructure stack, we need to specify that it's cluster-scoped by passing the
`--cluster` flag.
```bash
kubectl crossplane stack generate-install --cluster 'crossplane/stack-aws:master' stack-aws | kubectl apply --namespace crossplane-system -f -
kubectl crossplane stack generate-install --cluster 'crossplane/stack-aws:v0.2.0' stack-aws | kubectl apply --namespace crossplane-system -f -
```
The rest of this guide assumes that the AWS stack is installed within
@ -116,13 +116,13 @@ configurations in Crossplane.
Apply the sample network configuration resources:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=release-0.4
```
And you're done! You can check the status of the provisioning by running:
```bash
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=master
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=release-0.4
```
When all resources have the `Ready` condition in `True` state, the provisioning
@ -143,7 +143,7 @@ connectivity][aws-resource-connectivity] design document.
To inspect the resources that we created above, let's run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=master > network-config.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=release-0.4 > network-config.yaml
```
This will save the sample network configuration resources locally in
@ -438,7 +438,7 @@ repository.
Apply the sample AWS resource classes:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=release-0.4
```
And you're done! Note that these resources do not immediately provision external
@ -449,7 +449,7 @@ AWS resources, as they only serve as as template classes.
To inspect the resource classes that we created above, run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=master > resource-classes.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=release-0.4 > resource-classes.yaml
```
This will save the sample resource classes YAML locally in
@ -568,8 +568,8 @@ off.
[resource-claims-docs]: concepts.md#resource-claims-and-resource-classes
[eks-user-guide]: https://docs.aws.amazon.com/eks/latest/userguide/create-public-private-vpc.html
[Cross Resource Referencing]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-cross-resource-referencing.md
[sample AWS network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=master
[sample AWS resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=master
[sample AWS network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/aws/network-config?ref=release-0.4
[sample AWS resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/aws/resource-classes?ref=release-0.4
[RDS Database Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.html
[EKS Cluster]: https://docs.aws.amazon.com/eks/latest/userguide/clusters.html
[resource-classes-docs]: concepts.md#resource-claims-and-resource-classes

16
docs/v0.4/stacks-guide-azure.md
View File

@ -74,7 +74,7 @@ infrastructure stack, we need to specify that it's cluster-scoped by passing the
`--cluster` flag.
```bash
kubectl crossplane stack generate-install --cluster 'crossplane/stack-azure:master' stack-azure | kubectl apply --namespace crossplane-system -f -
kubectl crossplane stack generate-install --cluster 'crossplane/stack-azure:v0.2.0' stack-azure | kubectl apply --namespace crossplane-system -f -
```
The rest of this guide assumes that the Azure stack is installed within
@ -126,13 +126,13 @@ connectivity configurations in Crossplane.
Apply the sample network configuration resources:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=release-0.4
```
And you're done! You can check the status of the provisioning by running:
```bash
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=master
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=release-0.4
```
When all resources have the `Ready` condition in `True` state, the provisioning
@ -155,7 +155,7 @@ connectivity][azure-resource-connectivity] design document.
To inspect the resources that we created above, let's run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=master > network-config.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=release-0.4 > network-config.yaml
```
This will save the sample network configuration resources locally in
@ -263,7 +263,7 @@ repository.
Apply the sample Azure resource classes:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=release-0.4
```
And you're done! Note that these resources do not immediately provision external
@ -274,7 +274,7 @@ Azure resources, as they only serve as template classes.
To inspect the resource classes that we created above, run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=master > resource-classes.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=release-0.4 > resource-classes.yaml
```
This will save the sample resource classes YAML locally in
@ -445,11 +445,11 @@ off.
[azure-virtual-network]: https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-overview
[azure-resource-connectivity]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-resource-connectivity-mvp.md#microsoft-azure
[azure-network-configuration]: https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-using-network-configuration-file
[sample Azure resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=master
[sample Azure resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/azure/resource-classes?ref=release-0.4
[azure-mysql-database]: https://azure.microsoft.com/en-us/services/mysql/
[azure-aks]: https://azure.microsoft.com/en-us/services/kubernetes-service/
[resource-claims-and-classes-docs]: https://github.com/crossplaneio/crossplane/blob/master/docs/concepts.md#resource-claims-and-resource-classes
[sample Azure network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=master
[sample Azure network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/azure/network-config?ref=release-0.4
[Cross Resource Referencing]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-cross-resource-referencing.md
[resource class selection]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-simple-class-selection.md
[azure-provider-guide]: cloud-providers/azure/azure-provider.md

16
docs/v0.4/stacks-guide-gcp.md
View File

@ -74,7 +74,7 @@ infrastructure stack, we need to specify that it's cluster-scoped by passing the
`--cluster` flag.
```bash
kubectl crossplane stack generate-install --cluster 'crossplane/stack-gcp:master' stack-gcp | kubectl apply --namespace crossplane-system -f -
kubectl crossplane stack generate-install --cluster 'crossplane/stack-gcp:v0.2.0' stack-gcp | kubectl apply --namespace crossplane-system -f -
```
The rest of this guide assumes that the GCP stack is installed within
@ -142,13 +142,13 @@ configurations in Crossplane.
Apply the sample network configuration resources:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=release-0.4
```
And you're done! You can check the status of the provisioning by running:
```bash
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=master
kubectl get -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=release-0.4
```
When all resources have the `Ready` condition in `True` state, the provisioning
@ -165,7 +165,7 @@ Kubernetes cluster.
To inspect the resources that we created above, let's run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=master > network-config.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=release-0.4 > network-config.yaml
```
This will save the sample network configuration resources locally in
@ -298,7 +298,7 @@ repository.
Apply the sample GCP resource classes:
```bash
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=master
kubectl apply -k github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=release-0.4
```
And you're done! Note that these resources do not immediately provision external GCP resourcs.
@ -308,7 +308,7 @@ And you're done! Note that these resources do not immediately provision external
To inspect the resource classes that we created above, run:
```bash
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=master > resource-classes.yaml
kubectl kustomize github.com/crossplaneio/crossplane//cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=release-0.4 > resource-classes.yaml
```
This will save the sample resource classes YAML locally in
@ -414,10 +414,10 @@ where we left off.
[cloud-provider-setup-gcp]: https://github.com/crossplaneio/crossplane/blob/master/docs/cloud-providers/gcp/gcp-provider.md
[gcp-network-configuration]: https://cloud.google.com/vpc/docs/vpc
[Cross Resource Referencing]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-cross-resource-referencing.md
[sample GCP resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=master
[sample GCP resource classes]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/gcp/resource-classes?ref=release-0.4
[gcp-cloudsql]: https://cloud.google.com/sql/
[gcp-gke]: https://cloud.google.com/kubernetes-engine/
[sample GCP network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=master
[sample GCP network configuration]: https://github.com/crossplaneio/crossplane/tree/master/cluster/examples/workloads/kubernetes/wordpress/gcp/network-config?ref=release-0.4
[gcp-ip-address]: https://cloud.google.com/compute/docs/ip-addresses/
[gcp-connection]: https://cloud.google.com/vpc/docs/configure-private-services-access
[resource class selection]: https://github.com/crossplaneio/crossplane/blob/master/design/one-pager-simple-class-selection.md

8
docs/v0.4/stacks-guide-rook.md
View File

@ -93,7 +93,7 @@ metadata:
name: stack-gcp
namespace: crossplane-system
spec:
package: "crossplane/stack-gcp:master"
package: "crossplane/stack-gcp:v0.2.0"
EOF
kubectl apply -f stack-gcp.yaml
@ -110,7 +110,7 @@ metadata:
name: stack-rook
namespace: crossplane-system
spec:
package: "crossplane/stack-rook:master"
package: "crossplane/stack-rook:v0.1.0"
EOF
kubectl apply -f stack-rook.yaml
@ -182,13 +182,13 @@ If you want to skip the rest of the guide and just deploy Yugastore, you can
run:
```bash
kubectl apply -k https://github.com/crossplaneio/crossplane//cluster/examples/rook/yugastore?ref=master
kubectl apply -k https://github.com/crossplaneio/crossplane//cluster/examples/rook/yugastore?ref=release-0.4
```
And you're done! You can check the status of the provisioning by running:
```bash
kubectl get -k https://github.com/crossplaneio/crossplane//cluster/examples/rook/yugastore?ref=master
kubectl get -k https://github.com/crossplaneio/crossplane//cluster/examples/rook/yugastore?ref=release-0.4
```
If you did not opt for this shortcut, keep reading.