-
Notifications
You must be signed in to change notification settings - Fork 233
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: Marko Mudrinić <mudrinic.mare@gmail.com>
- Loading branch information
1 parent
e5ee73e
commit 86e1648
Showing
1 changed file
with
212 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # How To Install Kubernetes On OpenStack Cluster Using KubeOne | ||
|
|
||
| In this quick start we're going to show how to get started with KubeOne on OpenStack. We'll cover how to create the needed infrastructure using our example Terraform scripts and then install Kubernetes. Finally, we're going to show how to destroy the cluster along with the infrastructure. | ||
|
|
||
| As a result, you'll get Kubernetes 1.13.4 High-Available (HA) clusters with three control plane nodes and two worker nodes. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| To follow this quick start, you'll need: | ||
|
|
||
| * `kubeone` installed, which can be done by following the `Installing KubeOne` section of [the README](https://github.com/kubermatic/kubeone/blob/master/README.md), | ||
| * `terraform` installed. The binaries for `terraform` can be found on the [Terraform website](https://www.terraform.io/downloads.html) | ||
|
|
||
| ## Setting Up Credentials | ||
|
|
||
| In order for Terraform to successfully create the infrastructure and for KubeOne to install Kubernetes and create worker nodes you need to setup credentials for your OpenStack instance. | ||
|
|
||
| The following environment variables should be set: | ||
|
|
||
| ```bash | ||
| export OS_AUTH_URL=... | ||
| export OS_IDENTITY_API_VERSION=3 | ||
| export OS_USERNAME=... | ||
| export OS_PASSWORD=... | ||
| export OS_REGION_NAME=... | ||
| export OS_INTERFACE=public | ||
| export OS_ENDPOINT_TYPE=public | ||
| export OS_USER_DOMAIN_NAME=... | ||
| export OS_PROJECT_ID=... | ||
| ``` | ||
|
|
||
| **Note:** The credentials are deployed to the cluster to be used by `machine-controller` for creating worker nodes. | ||
|
|
||
| ## Creating Infrastructure | ||
|
|
||
| KubeOne is based on the Bring-Your-Own-Infra approach, which means that you have to provide machines and needed resources yourself. To make this task easier we are providing Terraform scripts that you can use to get started. You're free to use your own scripts or any other preferred approach. | ||
|
|
||
| The Terraform scripts for OpenStack are located in the [`./examples/terraform/openstack`](https://github.com/kubermatic/kubeone/tree/master/examples/terraform/openstack) directory. | ||
|
|
||
| **Note:** KubeOne comes with Terraform integration that is capable of reading information about the infrastructure from Terraform output. If you decide not to use our Terraform scripts but want to use Terraform integration, make sure variable names in the output match variable names used by KubeOne. Alternatively, if you decide not to use Terraform, you can provide needed information about the infrastructure manually in the KubeOne configuration file. | ||
|
|
||
| First, we need to switch to the directory with Terraform scripts: | ||
|
|
||
| ```bash | ||
| cd ./examples/terraform/openstack | ||
| ``` | ||
|
|
||
| Before we can use Terraform to create the infrastructure for us Terraform needs to download the OpenStack plugin and setup it's environment. This is done by running the `init` command: | ||
|
|
||
| ```bash | ||
| terraform init | ||
| ``` | ||
|
|
||
| **Note:** You need to run this command only the first time before using scripts. | ||
|
|
||
| You may want to configure the provisioning process by setting variables defining the cluster name, image to be used, instance size and similar. The easiest way is to create the `terraform.tfvars` file and store variables there. This file is automatically read by Terraform. | ||
|
|
||
| ```bash | ||
| nano terraform.tfvars | ||
| ``` | ||
|
|
||
| For the list of available settings along with their names please see the [`variables.tf`](https://github.com/kubermatic/kubeone/blob/master/examples/terraform/openstack/variables.tf) file. You should consider setting: | ||
|
|
||
| * `cluster_name` (required) - prefix for cloud resources | ||
| * `image` - (default: Ubuntu 18.04 LTS) image to be used for provisioning instances | ||
| * `ssh_public_key_file` (default: `~/.ssh/id_rsa.pub`) - path to your SSH public key that's deployed on instances | ||
| * `control_plane_flavor` (default: m1.small) - instance size of control plane nodes | ||
| * `worker_flavor` (default: m1.small) - instance size of worker nodes | ||
|
|
||
| The `terraform.tfvars` file can look like: | ||
|
|
||
| ``` | ||
| cluster_name = "demo" | ||
| ssh_public_key_file = "~/.ssh/openstack_rsa.pub" | ||
| ``` | ||
|
|
||
| Now that you configured Terraform you can use the `plan` command to see what changes will be made: | ||
|
|
||
| ```bash | ||
| terraform plan | ||
| ``` | ||
|
|
||
| Finally, if you agree with changes you can proceed and provision the infrastructure: | ||
|
|
||
| ```bash | ||
| terraform apply | ||
| ``` | ||
|
|
||
| Shortly after you'll be asked to enter `yes` to confirm your intention to provision the infrastructure. | ||
|
|
||
| Infrastructure provisioning takes around 5 minutes. Once it's done you need to create a Terraform state file that is parsed by KubeOne: | ||
|
|
||
| ```bash | ||
| terraform output -json > tf.json | ||
| ``` | ||
|
|
||
| ## Installing Kubernetes | ||
|
|
||
| Now that you have infrastructure you can proceed with installing Kubernetes using KubeOne. | ||
|
|
||
| Before you start you'll need a configuration file that defines how Kubernetes will be installed, e.g. what version will be used and what features will be enabled. For the configuration file reference see [`config.yaml.dist`](https://github.com/kubermatic/kubeone/blob/master/config.yaml.dist). | ||
|
|
||
| To get started you can use the following configuration. It'll install Kubernetes 1.13.4 and create 2 worker nodes. KubeOne automatically populates information about image, instance size and networking settings for worker nodes from the Terraform output. Alternatively, you can set those information manually. As KubeOne is using [Kubermatic `machine-controller`](https://github.com/kubermatic/machine-controller) for creating worker nodes, see [OpenStack example manifest](https://github.com/kubermatic/machine-controller/blob/master/examples/openstack-machinedeployment.yaml) for available options. | ||
|
|
||
| For OpenStack you also need to provide a `cloud-config` file containing credentials, so OpenStack Cloud Controller Manager works as expected. Make sure to replace sample values with real values. | ||
|
|
||
| ```yaml | ||
| name: demo | ||
| versions: | ||
| kubernetes: '1.13.4' | ||
| provider: | ||
| name: 'openstack' | ||
| cloud_config: | | ||
| [Global] | ||
| username=OS_USERNAME | ||
| password=OS_PASSWORD | ||
| auth-url=https://OS_AUTH_URL/identity/v3 | ||
| tenant-id=OS_TENANT_ID | ||
| domain-id=OS_DOMAIN_ID | ||
| [LoadBalancer] | ||
| subnet-id=SUBNET_ID | ||
| workers: | ||
| - name: nodes1 | ||
| replicas: 2 | ||
| config: | ||
| labels: | ||
| mylabel: 'nodes1' | ||
| cloudProviderSpec: | ||
| tags: | ||
| tagKey: tagValue | ||
| operatingSystem: 'ubuntu' | ||
| operatingSystemSpec: | ||
| distUpgradeOnBoot: true | ||
| ``` | ||
| Finally, we're going to install Kubernetes by using the `install` command and providing the configuration file and the Terraform output: | ||
|
|
||
| ```bash | ||
| kubeone install config.yaml --tfjson tf.json | ||
| ``` | ||
|
|
||
| The installation process takes some time, usually 5-10 minutes. The output should look like the following one: | ||
|
|
||
| ``` | ||
| time="11:59:19 UTC" level=info msg="Installing prerequisites…" | ||
| time="11:59:20 UTC" level=info msg="Determine operating system…" node=157.230.114.40 | ||
| time="11:59:20 UTC" level=info msg="Determine operating system…" node=157.230.114.39 | ||
| time="11:59:20 UTC" level=info msg="Determine operating system…" node=157.230.114.42 | ||
| time="11:59:21 UTC" level=info msg="Determine hostname…" node=157.230.114.40 | ||
| time="11:59:21 UTC" level=info msg="Creating environment file…" node=157.230.114.40 | ||
| time="11:59:21 UTC" level=info msg="Installing kubeadm…" node=157.230.114.40 os=ubuntu | ||
| time="11:59:21 UTC" level=info msg="Determine hostname…" node=157.230.114.39 | ||
| time="11:59:21 UTC" level=info msg="Creating environment file…" node=157.230.114.39 | ||
| time="11:59:21 UTC" level=info msg="Installing kubeadm…" node=157.230.114.39 os=ubuntu | ||
| time="11:59:22 UTC" level=info msg="Determine hostname…" node=157.230.114.42 | ||
| time="11:59:22 UTC" level=info msg="Creating environment file…" node=157.230.114.42 | ||
| time="11:59:22 UTC" level=info msg="Installing kubeadm…" node=157.230.114.42 os=ubuntu | ||
| time="11:59:59 UTC" level=info msg="Deploying configuration files…" node=157.230.114.39 os=ubuntu | ||
| time="12:00:03 UTC" level=info msg="Deploying configuration files…" node=157.230.114.42 os=ubuntu | ||
| time="12:00:04 UTC" level=info msg="Deploying configuration files…" node=157.230.114.40 os=ubuntu | ||
| time="12:00:05 UTC" level=info msg="Generating kubeadm config file…" | ||
| time="12:00:06 UTC" level=info msg="Configuring certs and etcd on first controller…" | ||
| time="12:00:06 UTC" level=info msg="Ensuring Certificates…" node=157.230.114.39 | ||
| time="12:00:09 UTC" level=info msg="Generating PKI…" | ||
| time="12:00:09 UTC" level=info msg="Running kubeadm…" node=157.230.114.39 | ||
| time="12:00:09 UTC" level=info msg="Downloading PKI files…" node=157.230.114.39 | ||
| time="12:00:10 UTC" level=info msg="Creating local backup…" node=157.230.114.39 | ||
| time="12:00:10 UTC" level=info msg="Deploying PKI…" | ||
| time="12:00:10 UTC" level=info msg="Uploading files…" node=157.230.114.42 | ||
| time="12:00:10 UTC" level=info msg="Uploading files…" node=157.230.114.40 | ||
| time="12:00:13 UTC" level=info msg="Configuring certs and etcd on consecutive controller…" | ||
| time="12:00:13 UTC" level=info msg="Ensuring Certificates…" node=157.230.114.40 | ||
| time="12:00:13 UTC" level=info msg="Ensuring Certificates…" node=157.230.114.42 | ||
| time="12:00:15 UTC" level=info msg="Initializing Kubernetes on leader…" | ||
| time="12:00:15 UTC" level=info msg="Running kubeadm…" node=157.230.114.39 | ||
| time="12:01:47 UTC" level=info msg="Joining controlplane node…" | ||
| time="12:03:01 UTC" level=info msg="Copying Kubeconfig to home directory…" node=157.230.114.39 | ||
| time="12:03:01 UTC" level=info msg="Copying Kubeconfig to home directory…" node=157.230.114.40 | ||
| time="12:03:01 UTC" level=info msg="Copying Kubeconfig to home directory…" node=157.230.114.42 | ||
| time="12:03:03 UTC" level=info msg="Building Kubernetes clientset…" | ||
| time="12:03:04 UTC" level=info msg="Applying canal CNI plugin…" | ||
| time="12:03:06 UTC" level=info msg="Installing machine-controller…" | ||
| time="12:03:28 UTC" level=info msg="Installing machine-controller webhooks…" | ||
| time="12:03:28 UTC" level=info msg="Waiting for machine-controller to come up…" | ||
| time="12:04:08 UTC" level=info msg="Creating worker machines…" | ||
| time="12:04:10 UTC" level=info msg="Skipping Ark deployment because no backup provider was configured." | ||
| ``` | ||
|
|
||
| KubeOne automatically downloads the Kubeconfig file for the cluster. It's named as `cluster-name-kubeconfig`. You can use it with kubectl such as `kubectl --kubeconfig cluster-name-kubeconfig` or export the `KUBECONFIG` variable environment variable: | ||
| ```bash | ||
| export KUBECONFIG=$PWD/cluster-name-kubeconfig | ||
| ``` | ||
|
|
||
| ## Deleting The Cluster | ||
|
|
||
| Before deleting a cluster you should clean up all MachineDeployments, so all worker nodes are deleted. You can do it with the `kubeone reset` command: | ||
|
|
||
| ```bash | ||
| kubeone reset config.yaml --tfjson tf.json | ||
| ``` | ||
|
|
||
| This command will wait for all worker nodes to be gone. Once it's done you can proceed and destroy the OpenStack infrastructure using Terraform: | ||
|
|
||
| ```bash | ||
| terraform destroy | ||
| ``` | ||
|
|
||
| You'll be asked to enter `yes` to confirm your intention to destroy the cluster. | ||
|
|
||
| Congratulations! You're now running Kubernetes 1.13.4 HA cluster with three control plane nodes and two worker nodes. If you want to learn more about KubeOne and its features, such as [upgrades](upgrading_cluster.md), make sure to check our [documentation](https://github.com/kubermatic/kubeone/tree/master/docs). |