Skip to content

Commit bf1e277

Browse files
authored
Merge pull request #19747 from Miouge1/update-kubespray
Update kubespray page
2 parents ad4505d + 98f9a48 commit bf1e277

File tree

1 file changed

+27
-26
lines changed
  • content/en/docs/setup/production-environment/tools

1 file changed

+27
-26
lines changed

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

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ weight: 30
66

77
{{% capture overview %}}
88

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

11-
Kubespray is a composition of [Ansible](http://docs.ansible.com/) playbooks, [inventory](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/ansible.md), provisioning tools, and domain knowledge for generic OS/Kubernetes clusters configuration management tasks. Kubespray provides:
11+
Kubespray is a composition of [Ansible](http://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:
1212

1313
* a highly available cluster
1414
* composable attributes
1515
* support for most popular Linux distributions
1616
* Container Linux by CoreOS
17-
* Debian Jessie, Stretch, Wheezy
17+
* Debian Buster, Jessie, Stretch, Wheezy
1818
* Ubuntu 16.04, 18.04
19-
* CentOS/RHEL 7
20-
* Fedora/CentOS Atomic
21-
* openSUSE Leap 42.3/Tumbleweed
19+
* CentOS/RHEL/Oracle Linux 7
20+
* Fedora 28
21+
* openSUSE Leap 15
2222
* continuous integration tests
2323

24-
To choose a tool which best fits your use case, read [this comparison](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/comparisons.md) to [kubeadm](/docs/admin/kubeadm/) and [kops](../kops).
24+
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 [kubeadm](/docs/admin/kubeadm/) and [kops](../kops).
2525

2626
{{% /capture %}}
2727

@@ -31,11 +31,11 @@ To choose a tool which best fits your use case, read [this comparison](https://g
3131

3232
### (1/5) Meet the underlay requirements
3333

34-
Provision servers with the following [requirements](https://github.com/kubernetes-incubator/kubespray#requirements):
34+
Provision servers with the following [requirements](https://github.com/kubernetes-sigs/kubespray#requirements):
3535

36-
* **Ansible v2.5 (or newer) and python-netaddr is installed on the machine that will run Ansible commands**
36+
* **Ansible v2.7.8 and python-netaddr is installed on the machine that will run Ansible commands**
3737
* **Jinja 2.9 (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
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/downloads.md#offline-environment))
3939
* The target servers are configured to allow **IPv4 forwarding**
4040
* **Your ssh key must be copied** to all the servers part of your inventory
4141
* 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
@@ -44,12 +44,13 @@ Provision servers with the following [requirements](https://github.com/kubernete
4444
Kubespray provides the following utilities to help provision your environment:
4545

4646
* [Terraform](https://www.terraform.io/) scripts for the following cloud providers:
47-
* [AWS](https://github.com/kubernetes-incubator/kubespray/tree/master/contrib/terraform/aws)
48-
* [OpenStack](https://github.com/kubernetes-incubator/kubespray/tree/master/contrib/terraform/openstack)
47+
* [AWS](https://github.com/kubernetes-sigs/kubespray/tree/master/contrib/terraform/aws)
48+
* [OpenStack](https://github.com/kubernetes-sigs/kubespray/tree/master/contrib/terraform/openstack)
49+
* [Packet](https://github.com/kubernetes-sigs/kubespray/tree/master/contrib/terraform/packet)
4950

5051
### (2/5) Compose an inventory file
5152

52-
After you provision your servers, create an [inventory file for Ansible](http://docs.ansible.com/ansible/intro_inventory.html). You can do this manually or via a dynamic inventory script. For more information, see "[Building your own inventory](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/getting-started.md#building-your-own-inventory)".
53+
After you provision your servers, create an [inventory file for Ansible](http://docs.ansible.com/ansible/intro_inventory.html). You can do this manually or via a dynamic inventory script. For more information, see "[Building your own inventory](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/getting-started.md#building-your-own-inventory)".
5354

5455
### (3/5) Plan your cluster deployment
5556

@@ -58,64 +59,64 @@ Kubespray provides the ability to customize many aspects of the deployment:
5859
* Choice deployment mode: kubeadm or non-kubeadm
5960
* CNI (networking) plugins
6061
* DNS configuration
61-
* Choice of control plane: native/binary or containerized with docker or rkt
62+
* Choice of control plane: native/binary or containerized
6263
* Component versions
6364
* Calico route reflectors
6465
* Component runtime options
6566
* {{< glossary_tooltip term_id="docker" >}}
66-
* {{< glossary_tooltip term_id="rkt" >}}
67+
* {{< glossary_tooltip term_id="containerd" >}}
6768
* {{< glossary_tooltip term_id="cri-o" >}}
68-
* Certificate generation methods (**Vault being discontinued**)
69+
* Certificate generation methods
6970

7071
Kubespray customizations can be made to a [variable file](http://docs.ansible.com/ansible/playbooks_variables.html). If you are just getting started with Kubespray, consider using the Kubespray defaults to deploy your cluster and explore Kubernetes.
7172

7273
### (4/5) Deploy a Cluster
7374

7475
Next, deploy your cluster:
7576

76-
Cluster deployment using [ansible-playbook](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/getting-started.md#starting-custom-deployment).
77+
Cluster deployment using [ansible-playbook](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/getting-started.md#starting-custom-deployment).
7778

7879
```shell
7980
ansible-playbook -i your/inventory/inventory.ini cluster.yml -b -v \
8081
--private-key=~/.ssh/private_key
8182
```
8283

83-
Large deployments (100+ nodes) may require [specific adjustments](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/large-deployments.md) for best results.
84+
Large deployments (100+ nodes) may require [specific adjustments](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/large-deployments.md) for best results.
8485

8586
### (5/5) Verify the deployment
8687

87-
Kubespray provides a way to verify inter-pod connectivity and DNS resolve with [Netchecker](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/netcheck.md). Netchecker ensures the netchecker-agents pods can resolve DNS requests and ping each over within the default namespace. Those pods mimic similar behavior of the rest of the workloads and serve as cluster health indicators.
88+
Kubespray provides a way to verify inter-pod connectivity and DNS resolve with [Netchecker](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/netcheck.md). Netchecker ensures the netchecker-agents pods can resolve DNS requests and ping each over within the default namespace. Those pods mimic similar behavior of the rest of the workloads and serve as cluster health indicators.
8889

8990
## Cluster operations
9091

9192
Kubespray provides additional playbooks to manage your cluster: _scale_ and _upgrade_.
9293

9394
### Scale your cluster
9495

95-
You can add worker nodes from your cluster by running the scale playbook. For more information, see "[Adding nodes](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/getting-started.md#adding-nodes)".
96-
You can remove worker nodes from your cluster by running the remove-node playbook. For more information, see "[Remove nodes](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/getting-started.md#remove-nodes)".
96+
You can add worker nodes from your cluster by running the scale playbook. For more information, see "[Adding nodes](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/getting-started.md#adding-nodes)".
97+
You can remove worker nodes from your cluster by running the remove-node playbook. For more information, see "[Remove nodes](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/getting-started.md#remove-nodes)".
9798

9899
### Upgrade your cluster
99100

100-
You can upgrade your cluster by running the upgrade-cluster playbook. For more information, see "[Upgrades](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/upgrades.md)".
101+
You can upgrade your cluster by running the upgrade-cluster playbook. For more information, see "[Upgrades](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/upgrades.md)".
101102

102103
## Cleanup
103104

104-
You can reset your nodes and wipe out all components installed with Kubespray via the [reset playbook](https://github.com/kubernetes-incubator/kubespray/blob/master/reset.yml).
105+
You can reset your nodes and wipe out all components installed with Kubespray via the [reset playbook](https://github.com/kubernetes-sigs/kubespray/blob/master/reset.yml).
105106

106107
{{< caution >}}
107108
When running the reset playbook, be sure not to accidentally target your production cluster!
108109
{{< /caution >}}
109110

110111
## Feedback
111112

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

115116
{{% /capture %}}
116117

117118
{{% capture whatsnext %}}
118119

119-
Check out planned work on Kubespray's [roadmap](https://github.com/kubernetes-incubator/kubespray/blob/master/docs/roadmap.md).
120+
Check out planned work on Kubespray's [roadmap](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/roadmap.md).
120121

121122
{{% /capture %}}

0 commit comments

Comments
 (0)