add kubespray to the XTesting as it provides newer version of kubenetes and can be...
[it/test.git] / XTesting / kubespray / docs / bootstrap-os.md
1 # bootstrap-os
2
3 Bootstrap an Ansible host to be able to run Ansible modules.
4
5 This role will:
6
7 * configure the package manager (if applicable) to be able to fetch packages
8 * install Python
9 * install the necessary packages to use Ansible's package manager modules
10 * set the hostname of the host to `{{ inventory_hostname }}` when requested
11
12 ## Requirements
13
14 A host running an operating system that is supported by Kubespray.
15 See [Supported Linux Distributions](https://github.com/kubernetes-sigs/kubespray#supported-linux-distributions) for a current list.
16
17 SSH access to the host.
18
19 ## Role Variables
20
21 Variables are listed with their default values, if applicable.
22
23 ### General variables
24
25 * `http_proxy`/`https_proxy`
26   The role will configure the package manager (if applicable) to download packages via a proxy.
27
28 * `override_system_hostname: true`
29   The role will set the hostname of the machine to the name it has according to Ansible's inventory (the variable `{{ inventory_hostname }}`).
30
31 ### Per distribution variables
32
33 #### Flatcar Container Linux
34
35 * `coreos_locksmithd_disable: false`
36   Whether `locksmithd` (responsible for rolling restarts) should be disabled or be left alone.
37
38 #### CentOS/RHEL/AlmaLinux/Rocky Linux
39
40 * `centos_fastestmirror_enabled: false`
41   Whether the [fastestmirror](https://wiki.centos.org/PackageManagement/Yum/FastestMirror) yum plugin should be enabled.
42
43 ## Dependencies
44
45 The `kubespray-defaults` role is expected to be run before this role.
46
47 ## Example Playbook
48
49 Remember to disable fact gathering since Python might not be present on hosts.
50
51     - hosts: all
52       gather_facts: false  # not all hosts might be able to run modules yet
53       roles:
54          - kubespray-defaults
55          - bootstrap-os
56
57 ## License
58
59 Apache 2.0