You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

757 lines
28 KiB

  1. # Kubernetes on OpenStack with Terraform
  2. Provision a Kubernetes cluster with [Terraform](https://www.terraform.io) on
  3. OpenStack.
  4. ## Status
  5. This will install a Kubernetes cluster on an OpenStack Cloud. It should work on
  6. most modern installs of OpenStack that support the basic services.
  7. ### Known compatible public clouds
  8. - [Auro](https://auro.io/)
  9. - [Betacloud](https://www.betacloud.io/)
  10. - [CityCloud](https://www.citycloud.com/)
  11. - [DreamHost](https://www.dreamhost.com/cloud/computing/)
  12. - [ELASTX](https://elastx.se/)
  13. - [EnterCloudSuite](https://www.entercloudsuite.com/)
  14. - [FugaCloud](https://fuga.cloud/)
  15. - [Open Telekom Cloud](https://cloud.telekom.de/)
  16. - [OVH](https://www.ovh.com/)
  17. - [Rackspace](https://www.rackspace.com/)
  18. - [Safespring](https://www.safespring.com)
  19. - [Ultimum](https://ultimum.io/)
  20. - [VexxHost](https://vexxhost.com/)
  21. - [Zetta](https://www.zetta.io/)
  22. ## Approach
  23. The terraform configuration inspects variables found in
  24. [variables.tf](variables.tf) to create resources in your OpenStack cluster.
  25. There is a [python script](../terraform.py) that reads the generated`.tfstate`
  26. file to generate a dynamic inventory that is consumed by the main ansible script
  27. to actually install kubernetes and stand up the cluster.
  28. ### Networking
  29. The configuration includes creating a private subnet with a router to the
  30. external net. It will allocate floating IPs from a pool and assign them to the
  31. hosts where that makes sense. You have the option of creating bastion hosts
  32. inside the private subnet to access the nodes there. Alternatively, a node with
  33. a floating IP can be used as a jump host to nodes without.
  34. #### Using an existing router
  35. It is possible to use an existing router instead of creating one. To use an
  36. existing router set the router\_id variable to the uuid of the router you wish
  37. to use.
  38. For example:
  39. ```ShellSession
  40. router_id = "00c542e7-6f46-4535-ae95-984c7f0391a3"
  41. ```
  42. ### Kubernetes Nodes
  43. You can create many different kubernetes topologies by setting the number of
  44. different classes of hosts. For each class there are options for allocating
  45. floating IP addresses or not.
  46. - Master nodes with etcd
  47. - Master nodes without etcd
  48. - Standalone etcd hosts
  49. - Kubernetes worker nodes
  50. Note that the Ansible script will report an invalid configuration if you wind up
  51. with an even number of etcd instances since that is not a valid configuration. This
  52. restriction includes standalone etcd nodes that are deployed in a cluster along with
  53. master nodes with etcd replicas. As an example, if you have three master nodes with
  54. etcd replicas and three standalone etcd nodes, the script will fail since there are
  55. now six total etcd replicas.
  56. ### GlusterFS shared file system
  57. The Terraform configuration supports provisioning of an optional GlusterFS
  58. shared file system based on a separate set of VMs. To enable this, you need to
  59. specify:
  60. - the number of Gluster hosts (minimum 2)
  61. - Size of the non-ephemeral volumes to be attached to store the GlusterFS bricks
  62. - Other properties related to provisioning the hosts
  63. Even if you are using Flatcar Container Linux by Kinvolk for your cluster, you will still
  64. need the GlusterFS VMs to be based on either Debian or RedHat based images.
  65. Flatcar Container Linux by Kinvolk cannot serve GlusterFS, but can connect to it through
  66. binaries available on hyperkube v1.4.3_coreos.0 or higher.
  67. ## Requirements
  68. - [Install Terraform](https://www.terraform.io/intro/getting-started/install.html) 0.12 or later
  69. - [Install Ansible](http://docs.ansible.com/ansible/latest/intro_installation.html)
  70. - you already have a suitable OS image in Glance
  71. - you already have a floating IP pool created
  72. - you have security groups enabled
  73. - you have a pair of keys generated that can be used to secure the new hosts
  74. ## Module Architecture
  75. The configuration is divided into three modules:
  76. - Network
  77. - IPs
  78. - Compute
  79. The main reason for splitting the configuration up in this way is to easily
  80. accommodate situations where floating IPs are limited by a quota or if you have
  81. any external references to the floating IP (e.g. DNS) that would otherwise have
  82. to be updated.
  83. You can force your existing IPs by modifying the compute variables in
  84. `kubespray.tf` as follows:
  85. ```ini
  86. k8s_master_fips = ["151.101.129.67"]
  87. k8s_node_fips = ["151.101.129.68"]
  88. ```
  89. ## Terraform
  90. Terraform will be used to provision all of the OpenStack resources with base software as appropriate.
  91. ### Configuration
  92. #### Inventory files
  93. Create an inventory directory for your cluster by copying the existing sample and linking the `hosts` script (used to build the inventory based on Terraform state):
  94. ```ShellSession
  95. cp -LRp contrib/terraform/openstack/sample-inventory inventory/$CLUSTER
  96. cd inventory/$CLUSTER
  97. ln -s ../../contrib/terraform/openstack/hosts
  98. ln -s ../../contrib
  99. ```
  100. This will be the base for subsequent Terraform commands.
  101. #### OpenStack access and credentials
  102. No provider variables are hardcoded inside `variables.tf` because Terraform
  103. supports various authentication methods for OpenStack: the older script and
  104. environment method (using `openrc`) as well as a newer declarative method, and
  105. different OpenStack environments may support Identity API version 2 or 3.
  106. These are examples and may vary depending on your OpenStack cloud provider,
  107. for an exhaustive list on how to authenticate on OpenStack with Terraform
  108. please read the [OpenStack provider documentation](https://www.terraform.io/docs/providers/openstack/).
  109. ##### Declarative method (recommended)
  110. The recommended authentication method is to describe credentials in a YAML file `clouds.yaml` that can be stored in:
  111. - the current directory
  112. - `~/.config/openstack`
  113. - `/etc/openstack`
  114. `clouds.yaml`:
  115. ```yaml
  116. clouds:
  117. mycloud:
  118. auth:
  119. auth_url: https://openstack:5000/v3
  120. username: "username"
  121. project_name: "projectname"
  122. project_id: projectid
  123. user_domain_name: "Default"
  124. password: "password"
  125. region_name: "RegionOne"
  126. interface: "public"
  127. identity_api_version: 3
  128. ```
  129. If you have multiple clouds defined in your `clouds.yaml` file you can choose
  130. the one you want to use with the environment variable `OS_CLOUD`:
  131. ```ShellSession
  132. export OS_CLOUD=mycloud
  133. ```
  134. ##### Openrc method
  135. When using classic environment variables, Terraform uses default `OS_*`
  136. environment variables. A script suitable for your environment may be available
  137. from Horizon under *Project* -> *Compute* -> *Access & Security* -> *API Access*.
  138. With identity v2:
  139. ```ShellSession
  140. source openrc
  141. env | grep OS
  142. OS_AUTH_URL=https://openstack:5000/v2.0
  143. OS_PROJECT_ID=projectid
  144. OS_PROJECT_NAME=projectname
  145. OS_USERNAME=username
  146. OS_PASSWORD=password
  147. OS_REGION_NAME=RegionOne
  148. OS_INTERFACE=public
  149. OS_IDENTITY_API_VERSION=2
  150. ```
  151. With identity v3:
  152. ```ShellSession
  153. source openrc
  154. env | grep OS
  155. OS_AUTH_URL=https://openstack:5000/v3
  156. OS_PROJECT_ID=projectid
  157. OS_PROJECT_NAME=username
  158. OS_PROJECT_DOMAIN_ID=default
  159. OS_USERNAME=username
  160. OS_PASSWORD=password
  161. OS_REGION_NAME=RegionOne
  162. OS_INTERFACE=public
  163. OS_IDENTITY_API_VERSION=3
  164. OS_USER_DOMAIN_NAME=Default
  165. ```
  166. Terraform does not support a mix of DomainName and DomainID, choose one or the other:
  167. - provider.openstack: You must provide exactly one of DomainID or DomainName to authenticate by Username
  168. ```ShellSession
  169. unset OS_USER_DOMAIN_NAME
  170. export OS_USER_DOMAIN_ID=default
  171. ```
  172. or
  173. ```ShellSession
  174. unset OS_PROJECT_DOMAIN_ID
  175. set OS_PROJECT_DOMAIN_NAME=Default
  176. ```
  177. #### Cluster variables
  178. The construction of the cluster is driven by values found in
  179. [variables.tf](variables.tf).
  180. For your cluster, edit `inventory/$CLUSTER/cluster.tfvars`.
  181. |Variable | Description |
  182. |---------|-------------|
  183. |`cluster_name` | All OpenStack resources will use the Terraform variable`cluster_name` (default`example`) in their name to make it easier to track. For example the first compute resource will be named`example-kubernetes-1`. |
  184. |`az_list` | List of Availability Zones available in your OpenStack cluster. |
  185. |`network_name` | The name to be given to the internal network that will be generated |
  186. |`network_dns_domain` | (Optional) The dns_domain for the internal network that will be generated |
  187. |`dns_nameservers`| An array of DNS name server names to be used by hosts in the internal subnet. |
  188. |`floatingip_pool` | Name of the pool from which floating IPs will be allocated |
  189. |`k8s_master_fips` | A list of floating IPs that you have already pre-allocated; they will be attached to master nodes instead of creating new random floating IPs. |
  190. |`bastion_fips` | A list of floating IPs that you have already pre-allocated; they will be attached to bastion node instead of creating new random floating IPs. |
  191. |`external_net` | UUID of the external network that will be routed to |
  192. |`flavor_k8s_master`,`flavor_k8s_node`,`flavor_etcd`, `flavor_bastion`,`flavor_gfs_node` | Flavor depends on your openstack installation, you can get available flavor IDs through `openstack flavor list` |
  193. |`image`,`image_gfs` | Name of the image to use in provisioning the compute resources. Should already be loaded into glance. |
  194. |`ssh_user`,`ssh_user_gfs` | The username to ssh into the image with. This usually depends on the image you have selected |
  195. |`public_key_path` | Path on your local workstation to the public key file you wish to use in creating the key pairs |
  196. |`number_of_k8s_masters`, `number_of_k8s_masters_no_floating_ip` | Number of nodes that serve as both master and etcd. These can be provisioned with or without floating IP addresses|
  197. |`number_of_k8s_masters_no_etcd`, `number_of_k8s_masters_no_floating_ip_no_etcd` | Number of nodes that serve as just master with no etcd. These can be provisioned with or without floating IP addresses |
  198. |`number_of_etcd` | Number of pure etcd nodes |
  199. |`number_of_k8s_nodes`, `number_of_k8s_nodes_no_floating_ip` | Kubernetes worker nodes. These can be provisioned with or without floating ip addresses. |
  200. |`number_of_bastions` | Number of bastion hosts to create. Scripts assume this is really just zero or one |
  201. |`number_of_gfs_nodes_no_floating_ip` | Number of gluster servers to provision. |
  202. | `gfs_volume_size_in_gb` | Size of the non-ephemeral volumes to be attached to store the GlusterFS bricks |
  203. |`supplementary_master_groups` | To add ansible groups to the masters, such as `kube_node` for tainting them as nodes, empty by default. |
  204. |`supplementary_node_groups` | To add ansible groups to the nodes, such as `kube_ingress` for running ingress controller pods, empty by default. |
  205. |`bastion_allowed_remote_ips` | List of CIDR allowed to initiate a SSH connection, `["0.0.0.0/0"]` by default |
  206. |`master_allowed_remote_ips` | List of CIDR blocks allowed to initiate an API connection, `["0.0.0.0/0"]` by default |
  207. |`k8s_allowed_remote_ips` | List of CIDR allowed to initiate a SSH connection, empty by default |
  208. |`worker_allowed_ports` | List of ports to open on worker nodes, `[{ "protocol" = "tcp", "port_range_min" = 30000, "port_range_max" = 32767, "remote_ip_prefix" = "0.0.0.0/0"}]` by default |
  209. |`master_allowed_ports` | List of ports to open on master nodes, expected format is `[{ "protocol" = "tcp", "port_range_min" = 443, "port_range_max" = 443, "remote_ip_prefix" = "0.0.0.0/0"}]`, empty by default |
  210. |`node_root_volume_size_in_gb` | Size of the root volume for nodes, 0 to use ephemeral storage |
  211. |`master_root_volume_size_in_gb` | Size of the root volume for masters, 0 to use ephemeral storage |
  212. |`master_volume_type` | Volume type of the root volume for control_plane, 'Default' by default |
  213. |`node_volume_type` | Volume type of the root volume for nodes, 'Default' by default |
  214. |`gfs_root_volume_size_in_gb` | Size of the root volume for gluster, 0 to use ephemeral storage |
  215. |`etcd_root_volume_size_in_gb` | Size of the root volume for etcd nodes, 0 to use ephemeral storage |
  216. |`bastion_root_volume_size_in_gb` | Size of the root volume for bastions, 0 to use ephemeral storage |
  217. |`master_server_group_policy` | Enable and use openstack nova servergroups for masters with set policy, default: "" (disabled) |
  218. |`node_server_group_policy` | Enable and use openstack nova servergroups for nodes with set policy, default: "" (disabled) |
  219. |`etcd_server_group_policy` | Enable and use openstack nova servergroups for etcd with set policy, default: "" (disabled) |
  220. |`use_access_ip` | If 1, nodes with floating IPs will transmit internal cluster traffic via floating IPs; if 0 private IPs will be used instead. Default value is 1. |
  221. |`port_security_enabled` | Allow to disable port security by setting this to `false`. `true` by default |
  222. |`k8s_nodes` | Map containing worker node definition, see explanation below |
  223. ##### k8s_nodes
  224. Allows a custom definition of worker nodes giving the operator full control over individual node flavor and
  225. availability zone placement. To enable the use of this mode set the `number_of_k8s_nodes` and
  226. `number_of_k8s_nodes_no_floating_ip` variables to 0. Then define your desired worker node configuration
  227. using the `k8s_nodes` variable.
  228. For example:
  229. ```ini
  230. k8s_nodes = {
  231. "1" = {
  232. "az" = "sto1"
  233. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  234. "floating_ip" = true
  235. },
  236. "2" = {
  237. "az" = "sto2"
  238. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  239. "floating_ip" = true
  240. },
  241. "3" = {
  242. "az" = "sto3"
  243. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  244. "floating_ip" = true
  245. }
  246. }
  247. ```
  248. Would result in the same configuration as:
  249. ```ini
  250. number_of_k8s_nodes = 3
  251. flavor_k8s_node = "83d8b44a-26a0-4f02-a981-079446926445"
  252. az_list = ["sto1", "sto2", "sto3"]
  253. ```
  254. And:
  255. ```ini
  256. k8s_nodes = {
  257. "ing-1" = {
  258. "az" = "sto1"
  259. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  260. "floating_ip" = true
  261. },
  262. "ing-2" = {
  263. "az" = "sto2"
  264. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  265. "floating_ip" = true
  266. },
  267. "ing-3" = {
  268. "az" = "sto3"
  269. "flavor" = "83d8b44a-26a0-4f02-a981-079446926445"
  270. "floating_ip" = true
  271. },
  272. "big-1" = {
  273. "az" = "sto1"
  274. "flavor" = "3f73fc93-ec61-4808-88df-2580d94c1a9b"
  275. "floating_ip" = false
  276. },
  277. "big-2" = {
  278. "az" = "sto2"
  279. "flavor" = "3f73fc93-ec61-4808-88df-2580d94c1a9b"
  280. "floating_ip" = false
  281. },
  282. "big-3" = {
  283. "az" = "sto3"
  284. "flavor" = "3f73fc93-ec61-4808-88df-2580d94c1a9b"
  285. "floating_ip" = false
  286. },
  287. "small-1" = {
  288. "az" = "sto1"
  289. "flavor" = "7a6a998f-ac7f-4fb8-a534-2175b254f75e"
  290. "floating_ip" = false
  291. },
  292. "small-2" = {
  293. "az" = "sto2"
  294. "flavor" = "7a6a998f-ac7f-4fb8-a534-2175b254f75e"
  295. "floating_ip" = false
  296. },
  297. "small-3" = {
  298. "az" = "sto3"
  299. "flavor" = "7a6a998f-ac7f-4fb8-a534-2175b254f75e"
  300. "floating_ip" = false
  301. }
  302. }
  303. ```
  304. Would result in three nodes in each availability zone each with their own separate naming,
  305. flavor and floating ip configuration.
  306. The "schema":
  307. ```ini
  308. k8s_nodes = {
  309. "key | node name suffix, must be unique" = {
  310. "az" = string
  311. "flavor" = string
  312. "floating_ip" = bool
  313. },
  314. }
  315. ```
  316. All values are required.
  317. #### Terraform state files
  318. In the cluster's inventory folder, the following files might be created (either by Terraform
  319. or manually), to prevent you from pushing them accidentally they are in a
  320. `.gitignore` file in the `terraform/openstack` directory :
  321. - `.terraform`
  322. - `.tfvars`
  323. - `.tfstate`
  324. - `.tfstate.backup`
  325. You can still add them manually if you want to.
  326. ### Initialization
  327. Before Terraform can operate on your cluster you need to install the required
  328. plugins. This is accomplished as follows:
  329. ```ShellSession
  330. cd inventory/$CLUSTER
  331. terraform -chdir="../../contrib/terraform/openstack" init
  332. ```
  333. This should finish fairly quickly telling you Terraform has successfully initialized and loaded necessary modules.
  334. ### Customizing with cloud-init
  335. You can apply cloud-init based customization for the openstack instances before provisioning your cluster.
  336. One common template is used for all instances. Adjust the file shown below:
  337. `contrib/terraform/openstack/modules/compute/templates/cloudinit.yaml`
  338. For example, to enable openstack novnc access and ansible_user=root SSH access:
  339. ```ShellSession
  340. #cloud-config
  341. ## in some cases novnc console access is required
  342. ## it requires ssh password to be set
  343. ssh_pwauth: yes
  344. chpasswd:
  345. list: |
  346. root:secret
  347. expire: False
  348. ## in some cases direct root ssh access via ssh key is required
  349. disable_root: false
  350. ```
  351. ### Provisioning cluster
  352. You can apply the Terraform configuration to your cluster with the following command
  353. issued from your cluster's inventory directory (`inventory/$CLUSTER`):
  354. ```ShellSession
  355. terraform -chdir="../../contrib/terraform/openstack" apply -var-file=cluster.tfvars
  356. ```
  357. if you chose to create a bastion host, this script will create
  358. `contrib/terraform/openstack/k8s_cluster.yml` with an ssh command for Ansible to
  359. be able to access your machines tunneling through the bastion's IP address. If
  360. you want to manually handle the ssh tunneling to these machines, please delete
  361. or move that file. If you want to use this, just leave it there, as ansible will
  362. pick it up automatically.
  363. ### Destroying cluster
  364. You can destroy your new cluster with the following command issued from the cluster's inventory directory:
  365. ```ShellSession
  366. terraform -chdir="../../contrib/terraform/openstack" destroy -var-file=cluster.tfvars
  367. ```
  368. If you've started the Ansible run, it may also be a good idea to do some manual cleanup:
  369. - remove SSH keys from the destroyed cluster from your `~/.ssh/known_hosts` file
  370. - clean up any temporary cache files: `rm /tmp/$CLUSTER-*`
  371. ### Debugging
  372. You can enable debugging output from Terraform by setting
  373. `OS_DEBUG` to 1 and`TF_LOG` to`DEBUG` before running the Terraform command.
  374. ### Terraform output
  375. Terraform can output values that are useful for configure Neutron/Octavia LBaaS or Cinder persistent volume provisioning as part of your Kubernetes deployment:
  376. - `private_subnet_id`: the subnet where your instances are running is used for `openstack_lbaas_subnet_id`
  377. - `floating_network_id`: the network_id where the floating IP are provisioned is used for `openstack_lbaas_floating_network_id`
  378. ## Ansible
  379. ### Node access
  380. #### SSH
  381. Ensure your local ssh-agent is running and your ssh key has been added. This
  382. step is required by the terraform provisioner:
  383. ```ShellSession
  384. eval $(ssh-agent -s)
  385. ssh-add ~/.ssh/id_rsa
  386. ```
  387. If you have deployed and destroyed a previous iteration of your cluster, you will need to clear out any stale keys from your SSH "known hosts" file ( `~/.ssh/known_hosts`).
  388. #### Metadata variables
  389. The [python script](../terraform.py) that reads the
  390. generated`.tfstate` file to generate a dynamic inventory recognizes
  391. some variables within a "metadata" block, defined in a "resource"
  392. block (example):
  393. ```ini
  394. resource "openstack_compute_instance_v2" "example" {
  395. ...
  396. metadata {
  397. ssh_user = "ubuntu"
  398. prefer_ipv6 = true
  399. python_bin = "/usr/bin/python3"
  400. }
  401. ...
  402. }
  403. ```
  404. As the example shows, these let you define the SSH username for
  405. Ansible, a Python binary which is needed by Ansible if
  406. `/usr/bin/python` doesn't exist, and whether the IPv6 address of the
  407. instance should be preferred over IPv4.
  408. #### Bastion host
  409. Bastion access will be determined by:
  410. - Your choice on the amount of bastion hosts (set by `number_of_bastions` terraform variable).
  411. - The existence of nodes/masters with floating IPs (set by `number_of_k8s_masters`, `number_of_k8s_nodes`, `number_of_k8s_masters_no_etcd` terraform variables).
  412. If you have a bastion host, your ssh traffic will be directly routed through it. This is regardless of whether you have masters/nodes with a floating IP assigned.
  413. If you don't have a bastion host, but at least one of your masters/nodes have a floating IP, then ssh traffic will be tunneled by one of these machines.
  414. So, either a bastion host, or at least master/node with a floating IP are required.
  415. #### Test access
  416. Make sure you can connect to the hosts. Note that Flatcar Container Linux by Kinvolk will have a state `FAILED` due to Python not being present. This is okay, because Python will be installed during bootstrapping, so long as the hosts are not `UNREACHABLE`.
  417. ```ShellSession
  418. $ ansible -i inventory/$CLUSTER/hosts -m ping all
  419. example-k8s_node-1 | SUCCESS => {
  420. "changed": false,
  421. "ping": "pong"
  422. }
  423. example-etcd-1 | SUCCESS => {
  424. "changed": false,
  425. "ping": "pong"
  426. }
  427. example-k8s-master-1 | SUCCESS => {
  428. "changed": false,
  429. "ping": "pong"
  430. }
  431. ```
  432. If it fails try to connect manually via SSH. It could be something as simple as a stale host key.
  433. ### Configure cluster variables
  434. Edit `inventory/$CLUSTER/group_vars/all/all.yml`:
  435. - **bin_dir**:
  436. ```yml
  437. # Directory where the binaries will be installed
  438. # Default:
  439. # bin_dir: /usr/local/bin
  440. # For Flatcar Container Linux by Kinvolk:
  441. bin_dir: /opt/bin
  442. ```
  443. - and **cloud_provider**:
  444. ```yml
  445. cloud_provider: openstack
  446. ```
  447. Edit `inventory/$CLUSTER/group_vars/k8s_cluster/k8s_cluster.yml`:
  448. - Set variable **kube_network_plugin** to your desired networking plugin.
  449. - **flannel** works out-of-the-box
  450. - **calico** requires [configuring OpenStack Neutron ports](/docs/openstack.md) to allow service and pod subnets
  451. ```yml
  452. # Choose network plugin (calico, weave or flannel)
  453. # Can also be set to 'cloud', which lets the cloud provider setup appropriate routing
  454. kube_network_plugin: flannel
  455. ```
  456. - Set variable **resolvconf_mode**
  457. ```yml
  458. # Can be docker_dns, host_resolvconf or none
  459. # Default:
  460. # resolvconf_mode: docker_dns
  461. # For Flatcar Container Linux by Kinvolk:
  462. resolvconf_mode: host_resolvconf
  463. ```
  464. - Set max amount of attached cinder volume per host (default 256)
  465. ```yml
  466. node_volume_attach_limit: 26
  467. ```
  468. ### Deploy Kubernetes
  469. ```ShellSession
  470. ansible-playbook --become -i inventory/$CLUSTER/hosts cluster.yml
  471. ```
  472. This will take some time as there are many tasks to run.
  473. ## Kubernetes
  474. ### Set up kubectl
  475. 1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) on your workstation
  476. 2. Add a route to the internal IP of a master node (if needed):
  477. ```ShellSession
  478. sudo route add [master-internal-ip] gw [router-ip]
  479. ```
  480. or
  481. ```ShellSession
  482. sudo route add -net [internal-subnet]/24 gw [router-ip]
  483. ```
  484. 1. List Kubernetes certificates & keys:
  485. ```ShellSession
  486. ssh [os-user]@[master-ip] sudo ls /etc/kubernetes/ssl/
  487. ```
  488. 1. Get `admin`'s certificates and keys:
  489. ```ShellSession
  490. ssh [os-user]@[master-ip] sudo cat /etc/kubernetes/ssl/admin-kube-master-1-key.pem > admin-key.pem
  491. ssh [os-user]@[master-ip] sudo cat /etc/kubernetes/ssl/admin-kube-master-1.pem > admin.pem
  492. ssh [os-user]@[master-ip] sudo cat /etc/kubernetes/ssl/ca.pem > ca.pem
  493. ```
  494. 1. Configure kubectl:
  495. ```ShellSession
  496. $ kubectl config set-cluster default-cluster --server=https://[master-internal-ip]:6443 \
  497. --certificate-authority=ca.pem
  498. $ kubectl config set-credentials default-admin \
  499. --certificate-authority=ca.pem \
  500. --client-key=admin-key.pem \
  501. --client-certificate=admin.pem
  502. $ kubectl config set-context default-system --cluster=default-cluster --user=default-admin
  503. $ kubectl config use-context default-system
  504. ```
  505. 1. Check it:
  506. ```ShellSession
  507. kubectl version
  508. ```
  509. ## GlusterFS
  510. GlusterFS is not deployed by the standard `cluster.yml` playbook, see the
  511. [GlusterFS playbook documentation](../../network-storage/glusterfs/README.md)
  512. for instructions.
  513. Basically you will install Gluster as
  514. ```ShellSession
  515. ansible-playbook --become -i inventory/$CLUSTER/hosts ./contrib/network-storage/glusterfs/glusterfs.yml
  516. ```
  517. ## What's next
  518. Try out your new Kubernetes cluster with the [Hello Kubernetes service](https://kubernetes.io/docs/tasks/access-application-cluster/service-access-application-cluster/).
  519. ## Appendix
  520. ### Migration from `number_of_k8s_nodes*` to `k8s_nodes`
  521. If you currently have a cluster defined using the `number_of_k8s_nodes*` variables and wish
  522. to migrate to the `k8s_nodes` style you can do it like so:
  523. ```ShellSession
  524. $ terraform state list
  525. module.compute.data.openstack_images_image_v2.gfs_image
  526. module.compute.data.openstack_images_image_v2.vm_image
  527. module.compute.openstack_compute_floatingip_associate_v2.k8s_master[0]
  528. module.compute.openstack_compute_floatingip_associate_v2.k8s_node[0]
  529. module.compute.openstack_compute_floatingip_associate_v2.k8s_node[1]
  530. module.compute.openstack_compute_floatingip_associate_v2.k8s_node[2]
  531. module.compute.openstack_compute_instance_v2.k8s_master[0]
  532. module.compute.openstack_compute_instance_v2.k8s_node[0]
  533. module.compute.openstack_compute_instance_v2.k8s_node[1]
  534. module.compute.openstack_compute_instance_v2.k8s_node[2]
  535. module.compute.openstack_compute_keypair_v2.k8s
  536. module.compute.openstack_compute_servergroup_v2.k8s_etcd[0]
  537. module.compute.openstack_compute_servergroup_v2.k8s_master[0]
  538. module.compute.openstack_compute_servergroup_v2.k8s_node[0]
  539. module.compute.openstack_networking_secgroup_rule_v2.bastion[0]
  540. module.compute.openstack_networking_secgroup_rule_v2.egress[0]
  541. module.compute.openstack_networking_secgroup_rule_v2.k8s
  542. module.compute.openstack_networking_secgroup_rule_v2.k8s_allowed_remote_ips[0]
  543. module.compute.openstack_networking_secgroup_rule_v2.k8s_allowed_remote_ips[1]
  544. module.compute.openstack_networking_secgroup_rule_v2.k8s_allowed_remote_ips[2]
  545. module.compute.openstack_networking_secgroup_rule_v2.k8s_master[0]
  546. module.compute.openstack_networking_secgroup_rule_v2.worker[0]
  547. module.compute.openstack_networking_secgroup_rule_v2.worker[1]
  548. module.compute.openstack_networking_secgroup_rule_v2.worker[2]
  549. module.compute.openstack_networking_secgroup_rule_v2.worker[3]
  550. module.compute.openstack_networking_secgroup_rule_v2.worker[4]
  551. module.compute.openstack_networking_secgroup_v2.bastion[0]
  552. module.compute.openstack_networking_secgroup_v2.k8s
  553. module.compute.openstack_networking_secgroup_v2.k8s_master
  554. module.compute.openstack_networking_secgroup_v2.worker
  555. module.ips.null_resource.dummy_dependency
  556. module.ips.openstack_networking_floatingip_v2.k8s_master[0]
  557. module.ips.openstack_networking_floatingip_v2.k8s_node[0]
  558. module.ips.openstack_networking_floatingip_v2.k8s_node[1]
  559. module.ips.openstack_networking_floatingip_v2.k8s_node[2]
  560. module.network.openstack_networking_network_v2.k8s[0]
  561. module.network.openstack_networking_router_interface_v2.k8s[0]
  562. module.network.openstack_networking_router_v2.k8s[0]
  563. module.network.openstack_networking_subnet_v2.k8s[0]
  564. $ terraform state mv 'module.compute.openstack_compute_floatingip_associate_v2.k8s_node[0]' 'module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes["1"]'
  565. Move "module.compute.openstack_compute_floatingip_associate_v2.k8s_node[0]" to "module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes[\"1\"]"
  566. Successfully moved 1 object(s).
  567. $ terraform state mv 'module.compute.openstack_compute_floatingip_associate_v2.k8s_node[1]' 'module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes["2"]'
  568. Move "module.compute.openstack_compute_floatingip_associate_v2.k8s_node[1]" to "module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes[\"2\"]"
  569. Successfully moved 1 object(s).
  570. $ terraform state mv 'module.compute.openstack_compute_floatingip_associate_v2.k8s_node[2]' 'module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes["3"]'
  571. Move "module.compute.openstack_compute_floatingip_associate_v2.k8s_node[2]" to "module.compute.openstack_compute_floatingip_associate_v2.k8s_nodes[\"3\"]"
  572. Successfully moved 1 object(s).
  573. $ terraform state mv 'module.compute.openstack_compute_instance_v2.k8s_node[0]' 'module.compute.openstack_compute_instance_v2.k8s_node["1"]'
  574. Move "module.compute.openstack_compute_instance_v2.k8s_node[0]" to "module.compute.openstack_compute_instance_v2.k8s_node[\"1\"]"
  575. Successfully moved 1 object(s).
  576. $ terraform state mv 'module.compute.openstack_compute_instance_v2.k8s_node[1]' 'module.compute.openstack_compute_instance_v2.k8s_node["2"]'
  577. Move "module.compute.openstack_compute_instance_v2.k8s_node[1]" to "module.compute.openstack_compute_instance_v2.k8s_node[\"2\"]"
  578. Successfully moved 1 object(s).
  579. $ terraform state mv 'module.compute.openstack_compute_instance_v2.k8s_node[2]' 'module.compute.openstack_compute_instance_v2.k8s_node["3"]'
  580. Move "module.compute.openstack_compute_instance_v2.k8s_node[2]" to "module.compute.openstack_compute_instance_v2.k8s_node[\"3\"]"
  581. Successfully moved 1 object(s).
  582. $ terraform state mv 'module.ips.openstack_networking_floatingip_v2.k8s_node[0]' 'module.ips.openstack_networking_floatingip_v2.k8s_node["1"]'
  583. Move "module.ips.openstack_networking_floatingip_v2.k8s_node[0]" to "module.ips.openstack_networking_floatingip_v2.k8s_node[\"1\"]"
  584. Successfully moved 1 object(s).
  585. $ terraform state mv 'module.ips.openstack_networking_floatingip_v2.k8s_node[1]' 'module.ips.openstack_networking_floatingip_v2.k8s_node["2"]'
  586. Move "module.ips.openstack_networking_floatingip_v2.k8s_node[1]" to "module.ips.openstack_networking_floatingip_v2.k8s_node[\"2\"]"
  587. Successfully moved 1 object(s).
  588. $ terraform state mv 'module.ips.openstack_networking_floatingip_v2.k8s_node[2]' 'module.ips.openstack_networking_floatingip_v2.k8s_node["3"]'
  589. Move "module.ips.openstack_networking_floatingip_v2.k8s_node[2]" to "module.ips.openstack_networking_floatingip_v2.k8s_node[\"3\"]"
  590. Successfully moved 1 object(s).
  591. ```
  592. Of course for nodes without floating ips those steps can be omitted.