Skip to content

Commit 4edda58

Browse files
authored
Merge pull request #35122 from ydFu/update-Kubespray
Updated the 'Installing Kubernetes with Kubespray'
2 parents a46aa00 + f8d84ce commit 4edda58

File tree

1 file changed

+29
-25
lines changed
  • content/en/docs/setup/production-environment/tools

1 file changed

+29
-25
lines changed

content/en/docs/setup/production-environment/tools/kubespray.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,24 @@ weight: 30
88

99
This quickstart helps to install a Kubernetes cluster hosted on GCE, Azure, OpenStack, AWS, vSphere, Equinix Metal (formerly Packet), Oracle Cloud Infrastructure (Experimental) or Baremetal with [Kubespray](https://github.com/kubernetes-sigs/kubespray).
1010

11-
Kubespray is a composition of [Ansible](https://docs.ansible.com/) playbooks, [inventory](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ansible.md), provisioning tools, and domain knowledge for generic OS/Kubernetes clusters configuration management tasks. Kubespray provides:
12-
13-
* a highly available cluster
14-
* composable attributes
15-
* support for most popular Linux distributions
16-
* Ubuntu 16.04, 18.04, 20.04, 22.04
17-
* CentOS/RHEL/Oracle Linux 7, 8
18-
* Debian Buster, Jessie, Stretch, Wheezy
19-
* Fedora 34, 35
20-
* Fedora CoreOS
21-
* openSUSE Leap 15
22-
* Flatcar Container Linux by Kinvolk
23-
* continuous integration tests
11+
Kubespray is a composition of [Ansible](https://docs.ansible.com/) playbooks, [inventory](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ansible.md#inventory), provisioning tools, and domain knowledge for generic OS/Kubernetes clusters configuration management tasks.
12+
13+
Kubespray provides:
14+
* Highly available cluster.
15+
* Composable (Choice of the network plugin for instance).
16+
* Supports most popular Linux distributions:
17+
- Flatcar Container Linux by Kinvolk
18+
- Debian Bullseye, Buster, Jessie, Stretch
19+
- Ubuntu 16.04, 18.04, 20.04, 22.04
20+
- CentOS/RHEL 7, 8
21+
- Fedora 34, 35
22+
- Fedora CoreOS
23+
- openSUSE Leap 15.x/Tumbleweed
24+
- Oracle Linux 7, 8
25+
- Alma Linux 8
26+
- Rocky Linux 8
27+
- Amazon Linux 2
28+
* Continuous integration tests.
2429

2530
To choose a tool which best fits your use case, read [this comparison](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/comparisons.md) to
2631
[kubeadm](/docs/reference/setup-tools/kubeadm/) and [kops](/docs/setup/production-environment/tools/kops/).
@@ -33,13 +38,13 @@ To choose a tool which best fits your use case, read [this comparison](https://g
3338

3439
Provision servers with the following [requirements](https://github.com/kubernetes-sigs/kubespray#requirements):
3540

36-
* **Ansible v2.11 and python-netaddr are installed on the machine that will run Ansible commands**
37-
* **Jinja 2.11 (or newer) is required to run the Ansible Playbooks**
38-
* The target servers must have access to the Internet in order to pull docker images. Otherwise, additional configuration is required ([See Offline Environment](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/offline-environment.md))
39-
* The target servers are configured to allow **IPv4 forwarding**
40-
* **Your ssh key must be copied** to all the servers in your inventory
41-
* **Firewalls are not managed by kubespray**. You'll need to implement appropriate rules as needed. You should disable your firewall in order to avoid any issues during deployment
42-
* If kubespray is run from a non-root user account, correct privilege escalation method should be configured in the target servers and the `ansible_become` flag or command parameters `--become` or `-b` should be specified
41+
* **Minimum required version of Kubernetes is v1.22**
42+
* **Ansible v2.11+, Jinja 2.11+ and python-netaddr is installed on the machine that will run Ansible commands**
43+
* The target servers must have **access to the Internet** in order to pull docker images. Otherwise, additional configuration is required See ([Offline Environment](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/offline-environment.md))
44+
* The target servers are configured to allow **IPv4 forwarding**.
45+
* If using IPv6 for pods and services, the target servers are configured to allow **IPv6 forwarding**.
46+
* The **firewalls are not managed**, you'll need to implement your own rules the way you used to. in order to avoid any issue during deployment you should disable your firewall.
47+
* If kubespray is run from non-root user account, correct privilege escalation method should be configured in the target servers. Then the `ansible_become` flag or command parameters `--become` or `-b` should be specified.
4348

4449
Kubespray provides the following utilities to help provision your environment:
4550

@@ -110,11 +115,10 @@ When running the reset playbook, be sure not to accidentally target your product
110115

111116
## Feedback
112117

113-
* Slack Channel: [#kubespray](https://kubernetes.slack.com/messages/kubespray/) (You can get your invite [here](https://slack.k8s.io/))
114-
* [GitHub Issues](https://github.com/kubernetes-sigs/kubespray/issues)
118+
* Slack Channel: [#kubespray](https://kubernetes.slack.com/messages/kubespray/) (You can get your invite [here](https://slack.k8s.io/)).
119+
* [GitHub Issues](https://github.com/kubernetes-sigs/kubespray/issues).
115120

116121
## {{% heading "whatsnext" %}}
117122

118-
119-
Check out planned work on Kubespray's [roadmap](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/roadmap.md).
120-
123+
* Check out planned work on Kubespray's [roadmap](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/roadmap.md).
124+
* Learn more about [Kubespray](https://github.com/kubernetes-sigs/kubespray).

0 commit comments

Comments
 (0)