-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Vince Prignano <vincepri@vmware.com>
- Loading branch information
Showing
22 changed files
with
337 additions
and
84 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
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
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
# Developer Guide |
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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
File renamed without changes.
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 @@ | ||
# Tooling |
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 @@ | ||
# 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 |
---|---|---|
@@ -0,0 +1 @@ | ||
# User Guide |
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,152 @@ | ||
# Quick Start | ||
|
||
In this tutorial we'll cover the basics of how to use Cluster API to create one or more Kubernetes clusters. | ||
|
||
## Prerequisites | ||
|
||
- Install and setup [kubectl] in your local environment. | ||
- A Kubernetes cluster to be used as [management cluster](../reference/glossary.md#management-cluster), for the purpose of this quick start, we suggest you to use [kind]. | ||
```bash | ||
kind create cluster --name=clusterapi | ||
export KUBECONFIG="$(kind get kubeconfig-path --name="clusterapi")" | ||
``` | ||
|
||
## Installation | ||
|
||
Using [kubectl], let's create the components on the management cluster: | ||
#### Install Cluster API Components | ||
```bash | ||
kubectl create -f https://github.com/kubernetes-sigs/cluster-api/releases/latest/download/cluster-api-components.yaml | ||
``` | ||
#### Install the Bootstrap Provider Components | ||
{{#tabs name:"tab-installation-bootstrap" tabs:"Kubeadm"}} | ||
{{#tab Kubeadm}} | ||
```bash | ||
kubectl create -f https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm/releases/latest/download/bootstrap-components.yaml | ||
``` | ||
{{#/tab }} | ||
{{#/tabs }} | ||
#### Install Infrastructure Provider Components | ||
{{#tabs name:"tab-installation-infrastructure" tabs:"AWS"}} | ||
{{#tab AWS}} | ||
For more information about prerequisites, credentials management, and or permissions for AWS, visit the [getting started guide](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/master/docs/getting-started.md). | ||
```bash | ||
kubectl create -f https://github.com/kubernetes-sigs/cluster-api-bootstrap-provider-kubeadm/releases/latest/download/infrastructure-components.yaml | ||
``` | ||
{{#/tab }} | ||
{{#/tabs }} | ||
## Usage | ||
The Cluster API resources are now installed. | ||
![](../images/management-cluster.svg) | ||
Now that we've got Cluster API, Bootstrap and Infrastructure resources installed, | ||
let's proceed to create a single node cluster. | ||
For the purpose of this tutorial, we'll name our cluster `capi-quickstart`. | ||
|
||
{{#tabs name:"tab-usage-cluster-resource" tabs:"AWS"}} | ||
{{#tab AWS}} | ||
|
||
```yaml | ||
--- | ||
apiVersion: cluster.x-k8s.io/v1alpha2 | ||
kind: Cluster | ||
metadata: | ||
name: capi-quickstart | ||
spec: | ||
clusterNetwork: | ||
pods: | ||
cidrBlocks: ["192.168.0.0/16"] | ||
infrastructureRef: | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind: AWSCluster | ||
name: capi-quickstart | ||
--- | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind: AWSCluster | ||
metadata: | ||
name: capi-quickstart | ||
spec: | ||
region: | ||
sshKeyName: default | ||
``` | ||
{{#/tab }} | ||
{{#/tabs }} | ||
|
||
Now that we've created the cluster object, we can create the first control plane Machine. | ||
{{#tabs name:"tab-usage-controlplane-resource" tabs:"AWS"}} | ||
{{#tab AWS}} | ||
```yaml | ||
--- | ||
apiVersion: cluster.x-k8s.io/v1alpha2 | ||
kind: Machine | ||
metadata: | ||
name: capi-quickstart-controlplane-0 | ||
labels: | ||
cluster.x-k8s.io/control-plane: "true" | ||
cluster.x-k8s.io/cluster-name: "capi-quickstart" | ||
spec: | ||
version: v1.15.3 | ||
bootstrap: | ||
configRef: | ||
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha2 | ||
kind: KubeadmConfig | ||
name: capi-quickstart-controlplane-0 | ||
infrastructureRef: | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind: AWSMachine | ||
name: capi-quickstart-controlplane-0 | ||
--- | ||
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha2 | ||
kind: AWSMachine | ||
metadata: | ||
name: capi-quickstart-controlplane-0 | ||
spec: | ||
instanceType: t2. | ||
iamInstanceProfile: "controllers.cluster-api-provider-aws.sigs.k8s.io" | ||
sshKeyName: default | ||
--- | ||
apiVersion: bootstrap.cluster.x-k8s.io/v1alpha2 | ||
kind: KubeadmConfig | ||
metadata: | ||
name: capi-quickstart-controlplane-0 | ||
spec: | ||
initConfiguration: | ||
nodeRegistration: | ||
name: '{{ ds.meta_data.hostname }}' | ||
kubeletExtraArgs: | ||
cloud-provider: aws | ||
clusterConfiguration: | ||
apiServer: | ||
extraArgs: | ||
cloud-provider: aws | ||
controllerManager: | ||
extraArgs: | ||
cloud-provider: aws | ||
``` | ||
{{#/tab }} | ||
{{#/tabs }} | ||
<!-- links --> | ||
[kubectl]: https://kubernetes.io/docs/tasks/tools/install-kubectl/ | ||
[components]: ../reference/glossary.md#provider-components | ||
[kind]: https://sigs.k8s.io/kind | ||
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
Oops, something went wrong.