From 4529d48afe5c80b484bf1f0d892a9a19f1cb1e2a Mon Sep 17 00:00:00 2001 From: Sharpz7 Date: Thu, 25 Jan 2024 21:31:33 +0000 Subject: [PATCH] [codespell] Fixing Spelling Mistakes This is the first in a series of commits to add support for codespell. This is continuning the process completed in ironic-python-agent. Future Commits will add a Tox Target, CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame. Change-Id: I41b2db35cdf21917ac20ed0866af3b9c94789f0b --- README.rst | 2 +- bifrost/inventory.py | 2 +- doc/source/install/index.rst | 2 +- doc/source/user/dhcp.rst | 2 +- playbooks/install.yaml | 2 +- playbooks/roles/bifrost-create-vm-nodes/tasks/create_vm.yml | 2 +- .../roles/bifrost-create-vm-nodes/tasks/prepare_libvirt.yml | 2 +- playbooks/roles/bifrost-ironic-install/README.md | 6 +++--- playbooks/roles/bifrost-ironic-install/defaults/main.yml | 4 ++-- playbooks/roles/bifrost-ironic-install/tasks/bootstrap.yml | 6 +++--- playbooks/roles/bifrost-ironic-install/tasks/install.yml | 2 +- playbooks/roles/bifrost-test-dhcp/README.md | 2 +- .../correct-requirements-ci-path-5ced93013d2c9b02.yaml | 2 +- .../notes/custom-partitioning-78d7ac12d80a993f.yaml | 2 +- .../notes/deprecate-classic-drivers-f88c53fa483aa7d5.yaml | 4 ++-- .../notes/deprecate_node_network_info-8c5e1bc4df6b8097.yaml | 4 ++-- .../notes/introduce-install-dib-1e53da734a878dac.yaml | 2 +- releasenotes/notes/no-install-grub-d39d65a8edbb769e.yaml | 2 +- .../notes/openstacksdk-addition-efec3878ef988295.yaml | 2 +- releasenotes/notes/pin-proliantutils-60f1facf44c223ca.yaml | 2 +- releasenotes/notes/pxe-driver-support-e2d8a769bf910dbc.yaml | 2 +- scripts/split_json.py | 4 ++-- tools/vagrant_dev_env/Vagrantfile | 2 +- tools/vagrant_dev_env/vagrant.yml | 2 +- 24 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.rst b/README.rst index 43964a17a..2e85ee198 100644 --- a/README.rst +++ b/README.rst @@ -12,7 +12,7 @@ with as few operational requirements as reasonably possible. The mission of bifrost is to provide an easy path to deploy ironic in a stand-alone fashion, in order to help facilitate the deployment of -infrastucture, while also being a configurable project that can consume +infrastructure, while also being a configurable project that can consume other OpenStack components to allow users to easily customize the environment to fit their needs, and drive forward the stand-alone perspective. diff --git a/bifrost/inventory.py b/bifrost/inventory.py index 4717b3506..940a1b82d 100755 --- a/bifrost/inventory.py +++ b/bifrost/inventory.py @@ -243,7 +243,7 @@ def _process_sdk(groups, hostvars): machine = cloud.get_machine(machine['uuid']) new_machine = {} for key, value in machine.items(): - # NOTE(TheJulia): We don't want to pass infomrational links + # NOTE(TheJulia): We don't want to pass informational links # nor do we want to pass links about the ports since they # are API endpoint URLs. if key not in ['links', 'ports']: diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index cb44b5c81..b16b65006 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -300,7 +300,7 @@ See the built-in documentation for more details: The Ansible variables generated for installation are stored in a JSON file (``baremetal-install-env.json`` by default) that should be passed via the -``-e`` flag to subsequent playbook or command invokations. +``-e`` flag to subsequent playbook or command invocations. .. _custom-ipa-images: diff --git a/doc/source/user/dhcp.rst b/doc/source/user/dhcp.rst index d79c94ced..ba84f005a 100644 --- a/doc/source/user/dhcp.rst +++ b/doc/source/user/dhcp.rst @@ -35,7 +35,7 @@ systems not managed by ironic. For example, create a file dhcp-match=set:, dhcp-boot=tag:, -The tag, match critera and boot options should be modified for your +The tag, match criteria and boot options should be modified for your environment. Here we use dnsmasq tags to match against hosts that we want to manage. dnsmasq will use the last matching tagged ``dhcp-boot`` option for a host or an untagged default ``dhcp-boot`` option if there were no matches. diff --git a/playbooks/install.yaml b/playbooks/install.yaml index 3df0b0482..f5ec4824f 100644 --- a/playbooks/install.yaml +++ b/playbooks/install.yaml @@ -20,7 +20,7 @@ args: creates: "{{ bifrost_venv_dir }}/bin/python3" - # NOTE(ebbex): (incase it's missing, which it shouldn't normally be) + # NOTE(ebbex): (in case it's missing, which it shouldn't normally be) - name: install setuptools in venv command: "{{ bifrost_venv_dir }}/bin/pip3 install setuptools" args: diff --git a/playbooks/roles/bifrost-create-vm-nodes/tasks/create_vm.yml b/playbooks/roles/bifrost-create-vm-nodes/tasks/create_vm.yml index fa4ce9a9e..54b7e0715 100644 --- a/playbooks/roles/bifrost-create-vm-nodes/tasks/create_vm.yml +++ b/playbooks/roles/bifrost-create-vm-nodes/tasks/create_vm.yml @@ -45,7 +45,7 @@ - when: vm_name not in existing_vms.list_vms block: # NOTE(pas-ha) Ansible still lacks modules to operate on libvirt volumes - # NOTE(pas-ha) adding extra 1G for disk size to accomodate for partition table / configdrive + # NOTE(pas-ha) adding extra 1G for disk size to accommodate for partition table / configdrive - name: create volume for vm command: > virsh --connect {{ test_vm_libvirt_uri }} diff --git a/playbooks/roles/bifrost-create-vm-nodes/tasks/prepare_libvirt.yml b/playbooks/roles/bifrost-create-vm-nodes/tasks/prepare_libvirt.yml index e4ddfd2f4..f5b49c1fd 100644 --- a/playbooks/roles/bifrost-create-vm-nodes/tasks/prepare_libvirt.yml +++ b/playbooks/roles/bifrost-create-vm-nodes/tasks/prepare_libvirt.yml @@ -81,7 +81,7 @@ # NOTE(TheJulia): In order to prevent conflicts, stop # dnsmasq to prevent conflicts with libvirt restarting. # TODO(TheJulia): We shouldn't need to do this, but the -# libvirt dhcp instance conflicts withour specific config +# libvirt dhcp instance conflicts with our specific config # and taking this path allows us to not refactor dhcp at # this moment. Our DHCP serving should be refactored # so we don't need to do this. diff --git a/playbooks/roles/bifrost-ironic-install/README.md b/playbooks/roles/bifrost-ironic-install/README.md index 06aea7642..c8fc07160 100644 --- a/playbooks/roles/bifrost-ironic-install/README.md +++ b/playbooks/roles/bifrost-ironic-install/README.md @@ -302,11 +302,11 @@ ipa_download_headers: HTTP headers to use when downloading IPA. ### Changing Database Configuration -Bifrost utilizes a nested data stucture for the configuration of database. +Bifrost utilizes a nested data structure for the configuration of database. Simply put: - - Values cannot be overrriden via set_fact. - - Values cannot be overrriden via the command line with ``-e``. + - Values cannot be overridden via set_fact. + - Values cannot be overridden via the command line with ``-e``. - The entire data structure must be defined if is modified. Please see defaults/main.yml file for the structure named ``ironic``. diff --git a/playbooks/roles/bifrost-ironic-install/defaults/main.yml b/playbooks/roles/bifrost-ironic-install/defaults/main.yml index d7a2d3c8d..53f0de4f3 100644 --- a/playbooks/roles/bifrost-ironic-install/defaults/main.yml +++ b/playbooks/roles/bifrost-ironic-install/defaults/main.yml @@ -116,7 +116,7 @@ update_ipa: "{{ update_repos }}" ipa_add_ssh_key: false # NOTE(Alex-Welsh): cirros_deploy_image_upstream_url has been deprecated in # favor of custom_deploy_image_upstream_url but is included for backwards -# compatability. It should be swapped permanently to +# compatibility. It should be swapped permanently to # custom_deploy_image_upstream_url in the next major release. custom_deploy_image_upstream_url: "{{ cirros_deploy_image_upstream_url | default('https://download.cirros-cloud.net/0.5.3/cirros-0.5.3-x86_64-disk.img') }}" # By default bifrost will deploy dnsmasq to utilize as an integrated DHCP @@ -227,7 +227,7 @@ inventory_dns: False # Set this to true to configure dnsmasq to populate the NTP servers # setting of dnsmasq. -# Several NTP servers can be specified, seperated by commas. +# Several NTP servers can be specified, separated by commas. # dnsmasq_ntp_servers: # Settings to enable the use of inspector diff --git a/playbooks/roles/bifrost-ironic-install/tasks/bootstrap.yml b/playbooks/roles/bifrost-ironic-install/tasks/bootstrap.yml index 81e951d3e..1c2ca145c 100644 --- a/playbooks/roles/bifrost-ironic-install/tasks/bootstrap.yml +++ b/playbooks/roles/bifrost-ironic-install/tasks/bootstrap.yml @@ -296,12 +296,12 @@ group: "ironic" mode: "0775" -- name: "Retrieve interface IP informations" +- name: "Retrieve interface IP information" set_fact: itf_infos: "{{ internal_interface }}" dhcp_netaddr: "{{ dhcp_pool_start }}/{{ dhcp_static_mask }}" when: enable_dhcp | bool -- name: "Compute interface and DHCP network informations" +- name: "Compute interface and DHCP network information" set_fact: itf_netaddr1: "{{ itf_infos['address'] }}/{{ itf_infos['netmask'] }}" itf_netaddr2: "{{ itf_infos['network'] }}/{{ itf_infos['netmask'] }}" @@ -336,7 +336,7 @@ when: - enable_dhcp | bool - itf_netaddr2 | ansible.utils.ipaddr('network') != dhcp_netaddr | ansible.utils.ipaddr('network') -- name: "Computing new DHCP informations" +- name: "Computing new DHCP information" set_fact: dhcp_start_ip: "{{ dhcp_pool_start.split('.')[-1] }}" dhcp_end_ip: "{{ dhcp_pool_end.split('.')[-1] }}" diff --git a/playbooks/roles/bifrost-ironic-install/tasks/install.yml b/playbooks/roles/bifrost-ironic-install/tasks/install.yml index 3e62c9e05..c7f77abc9 100644 --- a/playbooks/roles/bifrost-ironic-install/tasks/install.yml +++ b/playbooks/roles/bifrost-ironic-install/tasks/install.yml @@ -72,7 +72,7 @@ name: bifrost-nginx-install tasks_from: install -# NOTE(TheJulia) While we don't necessarilly require /opt/stack any longer +# NOTE(TheJulia) While we don't necessarily require /opt/stack any longer # and it should already be created by the Ansible setup, we will leave this # here for the time being. - name: "Ensure /opt/stack is present" diff --git a/playbooks/roles/bifrost-test-dhcp/README.md b/playbooks/roles/bifrost-test-dhcp/README.md index 99f620d1c..335e6854c 100644 --- a/playbooks/roles/bifrost-test-dhcp/README.md +++ b/playbooks/roles/bifrost-test-dhcp/README.md @@ -24,7 +24,7 @@ Example Playbook ---------------- hosts: localhost - name: "Tests DCHP settings" + name: "Tests DHCP settings" become: no gather_facts: yes remote_user: root diff --git a/releasenotes/notes/correct-requirements-ci-path-5ced93013d2c9b02.yaml b/releasenotes/notes/correct-requirements-ci-path-5ced93013d2c9b02.yaml index 984ee8916..291858db4 100644 --- a/releasenotes/notes/correct-requirements-ci-path-5ced93013d2c9b02.yaml +++ b/releasenotes/notes/correct-requirements-ci-path-5ced93013d2c9b02.yaml @@ -1,6 +1,6 @@ --- fixes: - | - The CI test playbook previously looked for the requirements respository in + The CI test playbook previously looked for the requirements repository in ``/opt/git/openstack/``. This has been changed to use the ``WORKSPACE`` environment variable when being executed. diff --git a/releasenotes/notes/custom-partitioning-78d7ac12d80a993f.yaml b/releasenotes/notes/custom-partitioning-78d7ac12d80a993f.yaml index b2bd5c8b1..186c076e2 100644 --- a/releasenotes/notes/custom-partitioning-78d7ac12d80a993f.yaml +++ b/releasenotes/notes/custom-partitioning-78d7ac12d80a993f.yaml @@ -58,7 +58,7 @@ features: options: "rw,nodev,relatime" - For more informations please refer to the following links: + For more information please refer to the following links: `Disk Image Layout Section `_ `Standard Partitioning `_ `LVM Partitioning `_ diff --git a/releasenotes/notes/deprecate-classic-drivers-f88c53fa483aa7d5.yaml b/releasenotes/notes/deprecate-classic-drivers-f88c53fa483aa7d5.yaml index f8f53339f..c0b6ec4e8 100644 --- a/releasenotes/notes/deprecate-classic-drivers-f88c53fa483aa7d5.yaml +++ b/releasenotes/notes/deprecate-classic-drivers-f88c53fa483aa7d5.yaml @@ -10,8 +10,8 @@ deprecations: - | Ironic has deprecated support for classic drivers. These were the drivers that were prepended with ``agent`` or ``pxe``. The new default hardware type, - which superceeds drivers, is ``ipmi``. The default deployment interface is - ``direct``, which superceeds the ``agent`` driver type. Support for classic + which supersedes drivers, is ``ipmi``. The default deployment interface is + ``direct``, which supersedes the ``agent`` driver type. Support for classic Drivers, will be removed from Bifrost in the Rocky release cycle. issues: - | diff --git a/releasenotes/notes/deprecate_node_network_info-8c5e1bc4df6b8097.yaml b/releasenotes/notes/deprecate_node_network_info-8c5e1bc4df6b8097.yaml index 0602aab41..55e6e6b17 100644 --- a/releasenotes/notes/deprecate_node_network_info-8c5e1bc4df6b8097.yaml +++ b/releasenotes/notes/deprecate_node_network_info-8c5e1bc4df6b8097.yaml @@ -1,6 +1,6 @@ --- deprecations: - - The ``node_network_info`` parameter has been deperecated + - The ``node_network_info`` parameter has been deprecated in favor of the ``node_network_data`` parameter as the related configuration drive ``network_info.json`` file was misnamed originally, and should have been named @@ -10,7 +10,7 @@ deprecations: drives will be removed in the Queens cycle. fixes: - When support for passing configuration drive data to the - nodes was originally created, the file was accidently named + nodes was originally created, the file was accidentally named incorrectly as ``network_info.json``. The correct filename is ``network_data.json``. Both files will now be written until support for writing ``network_info.json`` is removed diff --git a/releasenotes/notes/introduce-install-dib-1e53da734a878dac.yaml b/releasenotes/notes/introduce-install-dib-1e53da734a878dac.yaml index e094570e3..a8819972f 100644 --- a/releasenotes/notes/introduce-install-dib-1e53da734a878dac.yaml +++ b/releasenotes/notes/introduce-install-dib-1e53da734a878dac.yaml @@ -1,6 +1,6 @@ --- other: - - A new install_dib varible has been introduced to the ironic install role + - A new install_dib variable has been introduced to the ironic install role to control installation of disk image builder and dib-utils. To maintain the previous behavior install_dib will default to the value of create_image_via_dib. diff --git a/releasenotes/notes/no-install-grub-d39d65a8edbb769e.yaml b/releasenotes/notes/no-install-grub-d39d65a8edbb769e.yaml index 4876e1cda..d1d15c4e0 100644 --- a/releasenotes/notes/no-install-grub-d39d65a8edbb769e.yaml +++ b/releasenotes/notes/no-install-grub-d39d65a8edbb769e.yaml @@ -1,5 +1,5 @@ --- fixes: - | - Bifrost no longers installs GRUB2 and shim on the host system, avoding + Bifrost no longer installs GRUB2 and shim on the host system, avoiding potential issues with a local bootloader. diff --git a/releasenotes/notes/openstacksdk-addition-efec3878ef988295.yaml b/releasenotes/notes/openstacksdk-addition-efec3878ef988295.yaml index 659c6c010..4556bd29d 100644 --- a/releasenotes/notes/openstacksdk-addition-efec3878ef988295.yaml +++ b/releasenotes/notes/openstacksdk-addition-efec3878ef988295.yaml @@ -1,7 +1,7 @@ --- features: - | - Adds the use of the ``openstacksdk`` library which is superceeding the + Adds the use of the ``openstacksdk`` library which is superseding the ``shade`` library for communicating with OpenStack services using the Ansible modules. By default this will attempted to be installed from source. Set the ``openstacksdk_source_install`` option to false diff --git a/releasenotes/notes/pin-proliantutils-60f1facf44c223ca.yaml b/releasenotes/notes/pin-proliantutils-60f1facf44c223ca.yaml index b992f4b30..1c8e09f43 100644 --- a/releasenotes/notes/pin-proliantutils-60f1facf44c223ca.yaml +++ b/releasenotes/notes/pin-proliantutils-60f1facf44c223ca.yaml @@ -2,5 +2,5 @@ fixes: - | Fixes an issue where the proliantutils library version was unconstrained, - potentially resulting in installation of an incompatibile library. The + potentially resulting in installation of an incompatible library. The version has been pinned to 2.8.x. diff --git a/releasenotes/notes/pxe-driver-support-e2d8a769bf910dbc.yaml b/releasenotes/notes/pxe-driver-support-e2d8a769bf910dbc.yaml index 8fba4452c..70aff9248 100644 --- a/releasenotes/notes/pxe-driver-support-e2d8a769bf910dbc.yaml +++ b/releasenotes/notes/pxe-driver-support-e2d8a769bf910dbc.yaml @@ -22,5 +22,5 @@ fixes: This has been tested on Ubuntu 14.04 LTS. issues: - Basic testing has revealed that PXE drivers may not - result in the configurtion drive being written out + result in the configuration drive being written out with the current configuration of bifrost. diff --git a/scripts/split_json.py b/scripts/split_json.py index e1fccd1b9..a07c2b6c0 100644 --- a/scripts/split_json.py +++ b/scripts/split_json.py @@ -35,8 +35,8 @@ Usage: where: N - max number of dict elements to be defined in the JSON file input - path to input JSON file - - path to first output JSON file containig at most N entries - - path to the second output JSON file containig the rest + - path to first output JSON file containing at most N entries + - path to the second output JSON file containing the rest """ % sys.argv[0] diff --git a/tools/vagrant_dev_env/Vagrantfile b/tools/vagrant_dev_env/Vagrantfile index 7a0eae6f8..2af35dff6 100644 --- a/tools/vagrant_dev_env/Vagrantfile +++ b/tools/vagrant_dev_env/Vagrantfile @@ -45,7 +45,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| bifrost.vm.network "public_network", bridge: 'enp3s0', dev: 'enp3s0' - # besure we get the entire bifrost directory tree + # be sure we get the entire bifrost directory tree bifrost.vm.synced_folder "../../.", "/home/vagrant/bifrost", type: "rsync" bifrost.vm.provision 'ansible' do |ansible| diff --git a/tools/vagrant_dev_env/vagrant.yml b/tools/vagrant_dev_env/vagrant.yml index 457444b2e..7cbfe45a8 100644 --- a/tools/vagrant_dev_env/vagrant.yml +++ b/tools/vagrant_dev_env/vagrant.yml @@ -6,7 +6,7 @@ become: yes tasks: ############################################################################ - # Install some reqired bits into the vm + # Install some required bits into the vm ############################################################################ - name: Remove private default route command: ip route del default dev eth0