From d79c07effbf48138af30930432c969f214ce78cc Mon Sep 17 00:00:00 2001 From: Michal Nasiadka Date: Wed, 10 Apr 2024 12:25:40 -0400 Subject: [PATCH] CI: Add codespell for spell checking Fix existing spell checking Change-Id: Ief7b8f2d427b2557c84fda9b3774ed85ceb105f4 --- .codespell-ignore | 1 + docker/glance/glance-base/etc/glance/rootwrap.conf | 2 +- docker/kolla-toolbox/find_disks.py | 6 +++--- docker/proxysql/kolla_extend_start | 2 +- .../add-use-dumb-init-config-option-26b47f6d97d7585c.yaml | 2 +- releasenotes/notes/bug-1874298-35b7ccffe327f7e4.yaml | 2 +- releasenotes/notes/bug-1934753-98ec4951a0f7373b.yaml | 2 +- .../notes/fix-lock-swift-path-9b743367e4014f92.yaml | 2 +- releasenotes/notes/kolla-host-584270e3aee6dfd6.yaml | 4 ++-- ...le-ironic-inspector-in-bifrost.yml-5e01af1e96528c62.yaml | 2 +- releasenotes/notes/tacker-conductor-246d23f8c4a97de0.yaml | 2 +- specs/kolla-ceph-bluestore.rst | 2 +- specs/kubernetes-deployment.rst | 4 ++-- specs/logging-with-heka.rst | 2 +- specs/template.rst | 2 +- tox.ini | 2 ++ 16 files changed, 21 insertions(+), 18 deletions(-) create mode 100644 .codespell-ignore diff --git a/.codespell-ignore b/.codespell-ignore new file mode 100644 index 0000000000..226c890230 --- /dev/null +++ b/.codespell-ignore @@ -0,0 +1 @@ +solum diff --git a/docker/glance/glance-base/etc/glance/rootwrap.conf b/docker/glance/glance-base/etc/glance/rootwrap.conf index 421dd256e6..56e7529af6 100644 --- a/docker/glance/glance-base/etc/glance/rootwrap.conf +++ b/docker/glance/glance-base/etc/glance/rootwrap.conf @@ -7,7 +7,7 @@ filters_path=/etc/glance/rootwrap.d,/usr/share/glance/rootwrap # List of directories to search executables in, in case filters do not -# explicitely specify a full path (separated by ',') +# explicitly specify a full path (separated by ',') # If not specified, defaults to system PATH environment variable. # These directories MUST all be only writeable by root ! exec_dirs=/sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin,/usr/local/sbin diff --git a/docker/kolla-toolbox/find_disks.py b/docker/kolla-toolbox/find_disks.py index 405852f0b8..c6c0bbef33 100644 --- a/docker/kolla-toolbox/find_disks.py +++ b/docker/kolla-toolbox/find_disks.py @@ -27,7 +27,7 @@ from ansible.module_utils.basic import AnsibleModule DOCUMENTATION = ''' --- module: find_disks -short_description: Return list of devices containing a specfied name or label +short_description: Return list of devices containing a specified name or label description: - This will return a list of all devices with either GPT partition name or filesystem label of the name specified. @@ -61,7 +61,7 @@ author: Sam Yaple EXAMPLES = ''' - hosts: ceph-osd tasks: - - name: Return all valid formated devices with the name KOLLA_CEPH_OSD + - name: Return all valid formatted devices with the name KOLLA_CEPH_OSD find_disks: name: 'KOLLA_CEPH_OSD' register: osds @@ -166,7 +166,7 @@ def extract_disk_info(ct, dev, name, use_udev): if is_dev_matched_by_name(dev, name, 'strict', use_udev): kwargs['external_journal'] = False # NOTE(jeffrey4l): this is only used for bootstrap osd stage and - # there is no journal partion at all. So it is OK to use + # there is no journal partition at all. So it is OK to use # device_node directly. kwargs['journal'] = dev.device_node[:-1] + '2' kwargs['journal_device'] = kwargs['device'] diff --git a/docker/proxysql/kolla_extend_start b/docker/proxysql/kolla_extend_start index d7d20cb8de..9f587c58e3 100644 --- a/docker/proxysql/kolla_extend_start +++ b/docker/proxysql/kolla_extend_start @@ -11,7 +11,7 @@ chown -R proxysql:kolla "${PROXYSQL_LOG_DIR}" # Proxysql has configuration stored in # its own internal DB and config file # is used only for bootstrap DB by default. -# Once DB is bootstraped, config +# Once DB is bootstrapped, config # file is ignored. # # This behaviour is not what we want diff --git a/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml b/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml index cf10b3f43e..cd60b26b6d 100644 --- a/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml +++ b/releasenotes/notes/add-use-dumb-init-config-option-26b47f6d97d7585c.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds configration option ``use_dumb_init``, with default value of ``True``. + Adds configuration option ``use_dumb_init``, with default value of ``True``. This can be use to avoid the of ``dumb-init`` as the container entrypoint, using ``kolla_start`` directly instead. This option can also be disabled via the ``kolla-build --nouse-dumb-init`` CLI argument. diff --git a/releasenotes/notes/bug-1874298-35b7ccffe327f7e4.yaml b/releasenotes/notes/bug-1874298-35b7ccffe327f7e4.yaml index 10ec5faaaf..b677aa78c7 100644 --- a/releasenotes/notes/bug-1874298-35b7ccffe327f7e4.yaml +++ b/releasenotes/notes/bug-1874298-35b7ccffe327f7e4.yaml @@ -4,7 +4,7 @@ security: Fixes a hypothetical security issue related to privilege escalation via rootwrap/privsep. A potential vulnerable service could previously allow writes to its rootwrap/privsep config and thus allow for more commands - to be run with root privileges via rootwrap/privsep. For a succesful + to be run with root privileges via rootwrap/privsep. For a successful attack, this would also require the service to allow to run arbitrary commands via rootwrap/privsep. Thus far, no such vulnerabilities have been reported and thus this fix is simply strengthening the container diff --git a/releasenotes/notes/bug-1934753-98ec4951a0f7373b.yaml b/releasenotes/notes/bug-1934753-98ec4951a0f7373b.yaml index 5a9c679def..70d45926d9 100644 --- a/releasenotes/notes/bug-1934753-98ec4951a0f7373b.yaml +++ b/releasenotes/notes/bug-1934753-98ec4951a0f7373b.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Fixes user uid inconsistency beetween base and openstack-base + Fixes user uid inconsistency between base and openstack-base Debian binary images. `LP#1934753 `__ diff --git a/releasenotes/notes/fix-lock-swift-path-9b743367e4014f92.yaml b/releasenotes/notes/fix-lock-swift-path-9b743367e4014f92.yaml index 281fdee4c0..31f8a9c388 100644 --- a/releasenotes/notes/fix-lock-swift-path-9b743367e4014f92.yaml +++ b/releasenotes/notes/fix-lock-swift-path-9b743367e4014f92.yaml @@ -2,4 +2,4 @@ fixes: - | Fixes "Permission denied" issue for swift-recon tool that appears when - swift-recon tool tries to access deafult recon_lock_path + swift-recon tool tries to access default recon_lock_path diff --git a/releasenotes/notes/kolla-host-584270e3aee6dfd6.yaml b/releasenotes/notes/kolla-host-584270e3aee6dfd6.yaml index 8dca4ca0c4..009019d794 100644 --- a/releasenotes/notes/kolla-host-584270e3aee6dfd6.yaml +++ b/releasenotes/notes/kolla-host-584270e3aee6dfd6.yaml @@ -9,10 +9,10 @@ prelude: > ubuntu 16.04 and centos 7.2 as target servers. See features section for more details. features: - - The kolla-host playbook supports bootrapping + - The kolla-host playbook supports bootstrapping clean os installations to enable them to be used as kolla hosts. When the playbook completes - the bootstraped systems should pass the kolla + the bootstrapped systems should pass the kolla prechecks. - The kolla-host playbook will install docker 1.11 and docker-py on all baremetal nodes. diff --git a/releasenotes/notes/reenable-ironic-inspector-in-bifrost.yml-5e01af1e96528c62.yaml b/releasenotes/notes/reenable-ironic-inspector-in-bifrost.yml-5e01af1e96528c62.yaml index 7dcf4fb51b..774e03bc29 100644 --- a/releasenotes/notes/reenable-ironic-inspector-in-bifrost.yml-5e01af1e96528c62.yaml +++ b/releasenotes/notes/reenable-ironic-inspector-in-bifrost.yml-5e01af1e96528c62.yaml @@ -1,6 +1,6 @@ --- fixes: - | - Re-enables ironic-inspector in bifrost for backwards compatability. See + Re-enables ironic-inspector in bifrost for backwards compatibility. See `LP#2054685 `_ for more details. diff --git a/releasenotes/notes/tacker-conductor-246d23f8c4a97de0.yaml b/releasenotes/notes/tacker-conductor-246d23f8c4a97de0.yaml index 1a593c753a..4e5ec1a87b 100644 --- a/releasenotes/notes/tacker-conductor-246d23f8c4a97de0.yaml +++ b/releasenotes/notes/tacker-conductor-246d23f8c4a97de0.yaml @@ -4,5 +4,5 @@ features: Tacker conductor image is implemented. upgrade: - | - Tacker image has been splitted into tacker-server and tacker-conductor + Tacker image has been split into tacker-server and tacker-conductor to support new conductor service. diff --git a/specs/kolla-ceph-bluestore.rst b/specs/kolla-ceph-bluestore.rst index 8dd121d36e..6fdda7fc19 100644 --- a/specs/kolla-ceph-bluestore.rst +++ b/specs/kolla-ceph-bluestore.rst @@ -65,7 +65,7 @@ There is no security impact introduced. Performance Impact ------------------ -There is no performance imapct introduced. +There is no performance impact introduced. Implementation ============== diff --git a/specs/kubernetes-deployment.rst b/specs/kubernetes-deployment.rst index f96946e343..e451f643c1 100644 --- a/specs/kubernetes-deployment.rst +++ b/specs/kubernetes-deployment.rst @@ -199,7 +199,7 @@ At the broadest level, OpenStack can split up into two main roles, Controller and Compute. With Kubernetes, the role definition layer changes. Kolla-kubernetes will still need to define Compute nodes, but not Controller nodes. Compute nodes hold the libvirt container and the running vms. That -service cannont migrate because the vms associated with it exist on the node. +service cannot migrate because the vms associated with it exist on the node. However, the Controller role is more flexible. The Kubernetes layer provides IP persistence so that APIs will remain active and abstracted from the operator's view [15]. kolla-kubernetes can direct Controller services away from the Compute @@ -245,7 +245,7 @@ kibana as the default logging mechanism. The community will implement centralized logging by using a 'side car' container in the Kubernetes pod [17]. The logging service will trace the logs from the -shared volume of the running serivce and send the data to elastic search. This +shared volume of the running service and send the data to elastic search. This solution is ideal because volumes are shared among the containers in a pod. Implementation diff --git a/specs/logging-with-heka.rst b/specs/logging-with-heka.rst index 7b863db173..ca7ae90e2a 100644 --- a/specs/logging-with-heka.rst +++ b/specs/logging-with-heka.rst @@ -167,7 +167,7 @@ Handling HAProxy and Keepalived As already mentioned HAProxy and Keepalived do not support logging to files. This means that some other mechanism should be used for these two services (and -any other services that only suppport logging to Syslog). +any other services that only support logging to Syslog). Our prototype has demonstrated that we can make Heka act as a Syslog server. This works by using Heka's ``UdpInput`` plugin with its ``net`` option set diff --git a/specs/template.rst b/specs/template.rst index 6b62ec3760..e35db83855 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -45,7 +45,7 @@ Include where in the kolla tree hierarchy this will reside. Security impact --------------- -How does this feature impact the securtiy of the deployed OpenStack. +How does this feature impact the security of the deployed OpenStack. Performance Impact ------------------ diff --git a/tox.ini b/tox.ini index 8e351f6ede..5355573584 100644 --- a/tox.ini +++ b/tox.ini @@ -50,6 +50,7 @@ commands = [testenv:pep8] deps = {[testenv]deps} + codespell yamllint allowlist_externals = bash commands = @@ -59,6 +60,7 @@ commands = python {toxinidir}/tools/validate-all-file.py bandit -r docker kolla tests tools yamllint -s . + codespell -I {toxinidir}/.codespell-ignore [testenv:bandit] commands = bandit -r docker kolla tests tools