diff --git a/.gitlab-ci/lint.yml b/.gitlab-ci/lint.yml index 53f73e5123961604f48f011b6b38e678ee330444..c9e1bdea49e87115bc8fb52cee40d2cde5e3abd2 100644 --- a/.gitlab-ci/lint.yml +++ b/.gitlab-ci/lint.yml @@ -75,6 +75,13 @@ check-readme-versions: script: - tests/scripts/check_readme_versions.sh +check-typo: + stage: unit-tests + tags: [light] + image: python:3 + script: + - tests/scripts/check_typo.sh + ci-matrix: stage: unit-tests tags: [light] diff --git a/docs/ansible.md b/docs/ansible.md index e1fb9a688555bcc9c054aa4a012859891495c99f..980b13650cfe72be3bd36a81021c923241665f99 100644 --- a/docs/ansible.md +++ b/docs/ansible.md @@ -281,7 +281,7 @@ For more information about Ansible and bastion hosts, read ## Mitogen -Mitogen support is deprecated, please see [mitogen related docs](/docs/mitogen.md) for useage and reasons for deprecation. +Mitogen support is deprecated, please see [mitogen related docs](/docs/mitogen.md) for usage and reasons for deprecation. ## Beyond ansible 2.9 diff --git a/docs/centos.md b/docs/centos.md index 6be5fb48b28f22f3968553b93d252b5ff968c73d..67a1f174bf34b573b08337461971e509fb1057d0 100644 --- a/docs/centos.md +++ b/docs/centos.md @@ -2,7 +2,7 @@ ## CentOS 7 -The maximum python version offically supported in CentOS is 3.6. Ansible as of version 5 (ansible core 2.12.x) increased their python requirement to python 3.8 and above. +The maximum python version officially supported in CentOS is 3.6. Ansible as of version 5 (ansible core 2.12.x) increased their python requirement to python 3.8 and above. Kubespray supports multiple ansible versions but only the default (5.x) gets wide testing coverage. If your deployment host is CentOS 7 it is recommended to use one of the earlier versions still supported. ## CentOS 8 diff --git a/docs/vars.md b/docs/vars.md index 97f0a710a5fbe881636af104e8ab961a6912d329..f75ff0069e2aa8fd6fc809a9925c5e11145a3096 100644 --- a/docs/vars.md +++ b/docs/vars.md @@ -183,7 +183,7 @@ Stack](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/dns-stack.m * *containerd_default_runtime* - If defined, changes the default Containerd runtime used by the Kubernetes CRI plugin. * *containerd_additional_runtimes* - Sets the additional Containerd runtimes used by the Kubernetes CRI plugin. - [Default config](https://github.com/kubernetes-sigs/kubespray/blob/master/roles/container-engine/containerd/defaults/main.yml) can be overriden in inventory vars. + [Default config](https://github.com/kubernetes-sigs/kubespray/blob/master/roles/container-engine/containerd/defaults/main.yml) can be overridden in inventory vars. * *http_proxy/https_proxy/no_proxy/no_proxy_exclude_workers/additional_no_proxy* - Proxy variables for deploying behind a proxy. Note that no_proxy defaults to all internal cluster IPs and hostnames diff --git a/roles/container-engine/containerd-common/defaults/main.yml b/roles/container-engine/containerd-common/defaults/main.yml index 3a85d7f05d4a8670baf128a3438429aa321ee95b..ae1c6e05a0cbb5f130b2a881835ff62fc9483455 100644 --- a/roles/container-engine/containerd-common/defaults/main.yml +++ b/roles/container-engine/containerd-common/defaults/main.yml @@ -4,7 +4,7 @@ containerd_package: 'containerd.io' yum_repo_dir: /etc/yum.repos.d -# Keep minimal repo information arround for cleanup +# Keep minimal repo information around for cleanup containerd_repo_info: repos: diff --git a/roles/container-engine/kata-containers/templates/configuration-qemu.toml.j2 b/roles/container-engine/kata-containers/templates/configuration-qemu.toml.j2 index f64647bdfc897421096011607c1801bedc93164e..40382423d3e0c45a5e22e4ff539cda02fcd32fa7 100644 --- a/roles/container-engine/kata-containers/templates/configuration-qemu.toml.j2 +++ b/roles/container-engine/kata-containers/templates/configuration-qemu.toml.j2 @@ -459,7 +459,7 @@ enable_debug = {{ kata_containers_qemu_debug }} # # If enabled, the default trace mode is "dynamic" and the # default trace type is "isolated". The trace mode and type are set -# explicity with the `trace_type=` and `trace_mode=` options. +# explicitly with the `trace_type=` and `trace_mode=` options. # # Notes: # diff --git a/roles/kubernetes/preinstall/templates/chrony.conf.j2 b/roles/kubernetes/preinstall/templates/chrony.conf.j2 index 226f9bc9920b3deda0bfb59914856d804b21b32a..7931f435d718dbbc18d830ac6658af5340f57b0e 100644 --- a/roles/kubernetes/preinstall/templates/chrony.conf.j2 +++ b/roles/kubernetes/preinstall/templates/chrony.conf.j2 @@ -12,7 +12,7 @@ driftfile /var/lib/chrony/drift {% if ntp_tinker_panic is sameas true %} # Force time sync if the drift exceeds the threshold specified -# Usefull for VMs that can be paused and much later resumed. +# Useful for VMs that can be paused and much later resumed. makestep 1.0 -1 {% else %} # Allow the system clock to be stepped in the first three updates diff --git a/roles/kubernetes/preinstall/templates/ntp.conf.j2 b/roles/kubernetes/preinstall/templates/ntp.conf.j2 index b49c2e4b2599c48fef071559e314ee3de7455da1..abeb8996acfe90ea2f03aa9459d90e6b53dee63a 100644 --- a/roles/kubernetes/preinstall/templates/ntp.conf.j2 +++ b/roles/kubernetes/preinstall/templates/ntp.conf.j2 @@ -6,7 +6,7 @@ driftfile {{ ntp_driftfile }} {% if ntp_tinker_panic is sameas true %} # Always reset the clock, even if the new time is more than 1000s away -# from the current system time. Usefull for VMs that can be paused +# from the current system time. Useful for VMs that can be paused # and much later resumed. tinker panic 0 {% endif %} diff --git a/tests/scripts/check_typo.sh b/tests/scripts/check_typo.sh new file mode 100755 index 0000000000000000000000000000000000000000..cdcf49bc7530bde36cd38c752c8a4e0a38f06462 --- /dev/null +++ b/tests/scripts/check_typo.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +# cd to the root directory of kubespray +cd $(dirname $0)/../../ + +rm ./misspell* + +set -e +wget https://github.com/client9/misspell/releases/download/v0.3.4/misspell_0.3.4_linux_64bit.tar.gz +tar -zxvf ./misspell_0.3.4_linux_64bit.tar.gz +chmod 755 ./misspell +git ls-files | xargs ./misspell -error