Merge pull request #402 from lewisdenny/fix_typos

Fix various typos

CONTRIBUTING.md

@@ -11,7 +11,7 @@ $ make create_new_role ROLE_NAME=my_wonderful_role
 ### Consuming install_yamls varibles
 CI Framework sets a couple of facts that are useful enough to mention, the
 `cifmw_install_yamls_vars`, that contains all the install_yamls variables
-that should be passed to any instal_yaml target, and the `cifmw_install_yamls_default`,
+that should be passed to any install_yamls target, and the `cifmw_install_yamls_default`,
 that contains the default values of every possible parameter of the install_yamls
 Makefiles.
 

ci_framework/plugins/README.md

@@ -86,7 +86,7 @@ Description: Generate task file per Makefile target.
   * required: True
   * type: str
 * `output_directory`:
-  * description: Absolute path to the output directory. It must exists
+  * description: Absolute path to the output directory. It must exist
   * required: True
   * type: str
 
@@ -151,7 +151,7 @@ may call the generated task file for the desired `make` target. For instance:
     tasks_from: 'make_crc_storage'
 ```
 This block will call the `make crc_storage` command, passing some variables
-that will then be transfered to the `ci_make` call.
+that will then be transferred to the `ci_make` call.
 
 ### Available parameters
 * `make_TARGET_env`: (List) Allows to pass `environment` parameter to the task.

ci_framework/roles/artifacts/README.md

@@ -9,7 +9,7 @@ None - writes happen only in the user home.
 * `cifmw_artifacts_basedir`: (String) Base directory. Defaults to `cifmw_basedir` which defaults to `~/ci-framework-data`.
 * `cifmw_artifacts_crc_host`: (String) Hostname of the CRC instance. Defaults to `api.crc.testing`.
 * `cifmw_artifacts_crc_user`: (String) Username to connect to the CRC instance. Defaults to `core`.
-* `cifmw_artifacts_crc_sshkey`: (String) Path to the privage SSH key to connect to CRC. Defaults to `~/.crc/machines/crc/id_ecdsa`.
+* `cifmw_artifacts_crc_sshkey`: (String) Path to the private SSH key to connect to CRC. Defaults to `~/.crc/machines/crc/id_ecdsa`.
 
 ## Examples
 Usually we'll import the role as-is at the very start of the playbook, and
@@ -22,9 +22,9 @@ import the tasks from `packages.yml` at the very end:
     - artifacts
     - (some other roles)
   tasks:
-    - name: Do some other tasks:
+    - name: Do some other tasks
       block:
-        - name: Taks 1
+        - name: Tasks 1
           ansible.builtin.file:
             path: /tmp/foo
             state: present

ci_framework/roles/build_openstack_packages/README.md

@@ -14,9 +14,9 @@ An Ansible role for generating custom RPMSs of OpenStack Projects using DLRN
 * `cifmw_bop_use_components`: (Integer) Build the openstack rpm packages under component. Defaults to `1`. Set `0` to avoid using it.
 * `cifmw_bop_yum_repos_dir`: (String) The path to repos generated by repo-setup tool.
 * `cifmw_bop_openstack_release`: (String) The default release of OpenStack project. Defaults to `master`.
-* `cifmw_bop_openstack_project_path`: (String) The full path of openstack clonned project to be built.
+* `cifmw_bop_openstack_project_path`: (String) The full path of openstack cloned project to be built.
 * `cifmw_bop_gating_repo`: (String) The path of directory to store the generated rpms.
-* `cifmw_bop_dlrn_cleanup`: (Boolean) Clean up the DLRN aftifacts. Defaults to `False`.
+* `cifmw_bop_dlrn_cleanup`: (Boolean) Clean up the DLRN artifacts. Defaults to `False`.
 
 ### TODO
 - Allow building multiple openstack projects

ci_framework/roles/edpm_build_images/README.md

@@ -12,7 +12,7 @@ None
 ### Parameters
 * `cifmw_edpm_build_images_basedir`: Base directory. Defaults to `cifmw_basedir` which  defaults to `~/ci-framework`.
 * `cifmw_edpm_build_images_via_rpm`: Whether to install `edpm-image-builder` repo using rpm or not.
-* `cifmw_build_host_packages`: List of packges required to build the images.
+* `cifmw_build_host_packages`: List of packages required to build the images.
 * `cifmw_edpm_build_images_elements`: Elements path which contains `edpm-image-builder` and `ironic-python-agent-builder` repo.
 * `cifmw_edpm_build_images_all`: (Boolean) Build both the `edpm-hardened-uefi` and `ironic-python-agent` images when it true. Default to false.
 * `cifmw_edpm_build_images_hardened_uefi`: (Boolean) Build `edpm-hardened-uefi` image when it true. Default to false.
@@ -21,7 +21,7 @@ None
 * `cifmw_edpm_build_images_ironic_python_agent_package`: (Boolean) Packaged  `ironic-python-agent-builder` image inside a container image for distribution. Default to false.
 * `cifmw_edpm_build_images_dib_yum_repo_conf_centos`:  (List) List of yum repos to be used on centos node.
 * `cifmw_edpm_build_images_dib_yum_repo_conf_rhel`: (List) List of yum repos to be used on rhel node.
-* `cifmw_edpm_build_images_dib_yum_repo_conf`: (List) List of yum repos to be used, By default we select i.e `cifmw_edpm_build_images_dib_yum_repo_conf_centos` var or `cifmw_edpm_build_images_dib_yum_repo_conf_rhel` based on distro var.
+* `cifmw_edpm_build_images_dib_yum_repo_conf`: (List) List of yum repos to be used, By default we select i.e. `cifmw_edpm_build_images_dib_yum_repo_conf_centos` var or `cifmw_edpm_build_images_dib_yum_repo_conf_rhel` based on distro var.
 * `cifmw_edpm_build_images_tag`: (String) Tag with which we want to build container images. Default: `latest`.
 * `cifmw_edpm_build_images_dry_run`: (Boolean) Whether to perform a dry run of the image build. Default: false.
 * `cifmw_edpm_build_images_push_container_images`: (Boolean) Whether to push container images to remote registry. Default: false.

ci_framework/roles/edpm_deploy/README.md

@@ -1,5 +1,5 @@
 # edpm_deploy
-Peform External compute deploy on the pre-provisioned node from openshift cluster.
+Perform External compute deploy on the pre-provisioned node from openshift cluster.
 
 ## Privilege escalation
 None

ci_framework/roles/edpm_deploy_baremetal/README.md

@@ -4,7 +4,7 @@ and provision the compute nodes for further deployment by toggling the deploy:tr
 and waits for the necessary components to be available.
 
 ## Privilege escalation
-This role doesn't need privilege scalation.
+This role doesn't need privilege escalation.
 
 ## Parameters
 * `cifmw_edpm_deploy_baremetal_manifests_dir`: (string) The directory path where the manifests will be stored. Default: `{{ cifmw_manifests | default(cifmw_edpm_deploy_baremetal_basedir ~ '/artifacts/manifests') }}`

ci_framework/roles/edpm_prepare/README.md

@@ -2,12 +2,12 @@
 Prepares the environment to deploy OpenStack control plane and compute nodes.
 
 ## Privilege escalation
-This role doesn't need privilege scalation.
+This role doesn't need privilege escalation.
 
 ## Parameters
 * `cifmw_edpm_prepare_basedir`: (String) Base directory. Defaults to `cifmw_basedir` which defaults to `~/ci-framework-data`.
 * `cifmw_edpm_prepare_dry_run`: (Boolean) Skips resources installations and waits. Defaults to false.
-* `cifmw_edpm_prepare_manifests_dir`: String) Directory in where install_yamls output manifests will be placed. Defaults to `"{{ cifmw_edpm_prepare_basedir }}/artifacts/manifests"`
+* `cifmw_edpm_prepare_manifests_dir`: (String) Directory in where install_yamls output manifests will be placed. Defaults to `"{{ cifmw_edpm_prepare_basedir }}/artifacts/manifests"`
 * `cifmw_edpm_prepare_skip_crc_storage_creation`: (Boolean) Intentionally skips the deployment of the CRC storage related resources. Defaults to `False`.
 * `cifmw_edpm_prepare_wait_subscription_retries`: (Integer) Number of retries, with 5 seconds delays, waiting for the OpenStack subscription to come up. Defaults to `5`.
 * `cifmw_edpm_prepare_update_os_containers`: (Boolean) Updates the openstack services containers env variable. Defaults to `false`.

ci_framework/roles/hive/README.md

@@ -45,7 +45,7 @@ This role is wrapper around the Hive service providing the following support
   for the claimed OpenShift cluster.
 
 ### OpenStack platform optional parameters
-* `cifmw_hive_openstack_claim_life_time`: (String) Maximum life time of the
+* `cifmw_hive_openstack_claim_life_time`: (String) Maximum lifetime of the
   claimed OpenShift cluster. Defaults to `24h`.
 * `cifmw_hive_openstack_claim_timeout`: (String) Maximum allowed time before
   failing during the claim operation. Defaults to `59m`.

ci_framework/roles/local_env_vm/README.md

@@ -3,7 +3,7 @@ This role bootstrap a VM on your host, and makes it ready for the ci-framework
 usage directly on it.
 
 Running in a VM might be slow, so you want to get proper hardware (especially
-regarding to the I/O performances) - please note it's using nested virtualization
+in regard to the I/O performances) - please note it's using nested virtualization
 in the end (CRC + Compute VMs will be running from within the virtual machine
 this role creates).
 

ci_framework/roles/openshift_login/README.md

@@ -3,10 +3,10 @@ Manages OpenShift login operations
 
 This role performs OpenShift login based on calls to the `oc` cli tool and exposes a well defined set of
 variables that, after a successful login, can be used as credentials and API endpoints in other parts of
-the framework. If more than one login attempts are neeeded the role retries as many time as dictated by
+the framework. If more than one login attempts are needed the role retries as many times as dictated by
 `cifmw_openshift_login_retries`.
 
-Many login scenarios are allowed by passing or ommiting the following variables:
+Many login scenarios are allowed by passing or omitting the following variables:
 - `cifmw_openshift_login_kubeconfig`: The kubeconfig file path, if not given, the role will try to use user/password login
     and will create the kubeconfig in the default location `~/.kube/config`.
 - `cifmw_openshift_login_api`: The OpenShift API endpoint. If not given the role will extract it from the kubeconfig.
@@ -32,11 +32,11 @@ No privilege escalation needed.
 * `cifmw_openshift_login_force_refresh`: (Boolean) Disallow reusing already existing token. Defaults to `false`.
 * `cifmw_openshift_login_retries`: (Integer) Number of attempts to retry the login action if it fails. Defaults to `10`.
 * `cifmw_openshift_login_retries_delay`: (Integer) Delay, in seconds, between login retries. Defaults to `20`.
-* `cifmw_openshift_login_assume_cert_system_user`: (Boolean) When trying cert key login from kubeconfig, assume that the infered user is a `system:` admin. Defaults to `true`.
+* `cifmw_openshift_login_assume_cert_system_user`: (Boolean) When trying cert key login from kubeconfig, assume that the inferred user is a `system:` admin. Defaults to `true`.
 * `cifmw_openshift_login_skip_tls_verify`: (Boolean) Skip TLS verification to login. Note: This option may break admin login using certs. Defaults to `false`.
 
 ## Examples
-### 1 - Login using user/password and API convination
+### 1 - Login using user/password and API combination
 ```yaml
 - hosts: all
   tasks:
@@ -49,7 +49,7 @@ No privilege escalation needed.
         cifmw_openshift_login_password: "12345678"
 ```
 
-### 2 - Login using user/password and kubeconfig convination
+### 2 - Login using user/password and kubeconfig combination
 ```yaml
 - hosts: all
   tasks:

ci_framework/roles/operator_build/README.md

@@ -16,7 +16,7 @@ you want to build meta-operator too, so the role can properly replace api refere
 * `cifmw_operator_build_meta_name`: (String) Meta operator's name. Defaults to `openstack-operator`.
 * `cifmw_operator_build_meta_src`: (String) Directory with src code for meta operator. Defaults to `"{{ ansible_user_dir }}/src/github.com/{{ cifmw_operator_build_org }}/{{ cifmw_operator_build_meta_name }}"`
 * `cifmw_operator_build_meta_build`: (Boolean) When set to `true` updates meta-operator's go.mod when build operators and builds meta-operator in the end. Default to `true`.
-* `cifmw_operator_build_meta_image_base`: (String) Name of the service added to be added to meta-operator build. Still limited to a sindle service (and operator). Default to `""`
+* `cifmw_operator_build_meta_image_base`: (String) Name of the service added to be added to meta-operator build. Still limited to a single service (and operator). Default to `""`
 * `cifmw_operator_build_push_registry_tls_verify`: (Boolean) Variable to control whether to enable/disable TLS verification for push registry . Defaults to `true`.
 
 ## TODO

ci_framework/roles/repo_setup/README.md

@@ -25,7 +25,7 @@ Please explain the role purpose.
 
 ### Use repo-setup role with custom DLRN server
 
-When we use repo-setup role with custom DLRN server. The server might needs custom TLS certificates.
+When we use repo-setup role with custom DLRN server. The server might need custom TLS certificates.
 Make sure we set `cifmw_repo_setup_env` variable while running repo-setup role.
 ```
 cifmw_repo_setup_env:

ci_framework/roles/rhol_crc/README.md

@@ -4,7 +4,7 @@ Role to deploy get, configure and start RHOL/CRC instance.
 
 ## Privilege escalation
 
-Become - required for the tasks in `sudoers_grant.yml` and `sudoers_revoke.yml` since these ones add and remove under `/etc/sudoers.d/` folder.
+Become - required for the tasks in `sudoers_grant.yml` and `sudoers_revoke.yml` since these add and remove under `/etc/sudoers.d/` folder.
 
 ## Parameters
 
@@ -13,8 +13,8 @@ Become - required for the tasks in `sudoers_grant.yml` and `sudoers_revoke.yml`
 * `cifmw_rhol_crc_use_installyamls`: (Boolean) Tell the role to leverage install_yamls `crc` related targets. Defaults to `False`.
 * `cifmw_rhol_crc_dryrun`: (Boolean) Toggle the `ci_make` `dry_run` parameter. Defaults to `False`.
 * `cifmw_rhol_crc_config`: (Dict) This structure is merged with the `cifmw_rhol_crc_config_defaults` dictionary. We can add extra properties or override the existing one using this parameter. We can know the parameters that can be used with the output of the `crc config --help` command. Defaults to `{}`.
-* `cifmw_rhol_crc_version`: (String) RHOL/CRC binary version we wanna use. Default: `latest`.
-* `cifmw_rhol_crc_tarball_name`: (String) RHOL/CRC tarball name depending of the architecture. Defaults to `crc-linux-amd64.tar.xz`.
+* `cifmw_rhol_crc_version`: (String) RHOL/CRC binary version we want to use. Default: `latest`.
+* `cifmw_rhol_crc_tarball_name`: (String) RHOL/CRC tarball name depending on the architecture. Defaults to `crc-linux-amd64.tar.xz`.
 * `cifmw_rhol_crc_tarball_checksum_name`: (String) RHOL/CRC tarball file checksum name. Defaults to `crc-linux-amd64.tar.xz.sha256`.
 * `cifmw_rhol_crc_base_url`: (String) RHOL/CRC URL base. Defaults to `https://mirror.openshift.com/pub/openshift-v4/clients/crc/2.14.0`.
 * `cifmw_rhol_crc_binary_folder`: (String) Folder that will be used to store the RHOL/CRC binary. Defaults to `{{ cifmw_rhol_crc_basedir }}/bin`.

ci_framework/roles/run_hook/README.md

@@ -24,7 +24,7 @@ In such a case, the following data can be provided to the hook:
 
 #### Hook callback
 A hook may generate new parameters that will be fed into the main play. In order
-to do so, the hook playbook has to create a YAML file as follow:
+to do so, the hook playbook has to create a YAML file as follows:
 ```YAML
 - name: Feed generated content to main play
   ansible.builtin.copy:

ci_framework/roles/set_openstack_containers/README.md

@@ -48,7 +48,7 @@ It is used in edpm-prepare role to update all openstack service containers.
         name: set_openstack_containers
 ```
 
-### Update all the openstack servicess containers env vars with podified-ci-testing for a single operator `baremetal`
+### Update all the openstack services containers env vars with podified-ci-testing for a single operator `baremetal`
 
 It is used in edpm_deploy_baremetal role to update the UEFI image
 ```yaml

ci_framework/roles/tempest/README.md

@@ -8,7 +8,7 @@ become - Required to install required rpm packages
 
 * `cifmw_tempest_artifacts_basedir`: (String) Directory where we will have all tempest files. Default to `cifmw_basedir/artifacts/tempest` which defaults to `~/ci-framework-data/artifacts/tempest`.
 * `cifmw_tempest_default_groups`: (List) List of groups in the include list to search for tests to be executed
-* `cifmw_tempest_default_jobs`: (List) List of jobs in the esclude list to search for tests to be excluded
+* `cifmw_tempest_default_jobs`: (List) List of jobs in the exclude list to search for tests to be excluded
 * `cifmw_tempest_image`: (String) Name of the tempest image to be used. Default to `quay.io/podified-antelope-centos9/openstack-tempest`
 * `cifmw_tempest_image_tag`: (String) Tag for the `cifmw_tempest_image`. Default to `current-podified`
 * `cifmw_tempest_dry_run`: (Boolean) Whether tempest should run or not. Default to `false`

docs/source/internals/01_structure.md

@@ -6,9 +6,9 @@ We can find them here: https://github.com/openstack-k8s-operators/ci-framework/t
 
 Each role, playbook and plugin has README.md with the related documentation.
 
-Some roles uses the [install_yamls](https://github.com/openstack-k8s-operators/install_yamls) project. Althought is not part directly of the CI Framework project it's good to keep on mind. We could need to do changes there.
+Some roles used the [install_yamls](https://github.com/openstack-k8s-operators/install_yamls) project. Although it is not part directly of the CI Framework project, it's good to keep it in mind. We may need to do changes there.
 
-We will also find in the root of the project the [deploy-edpm.yml](https://github.com/openstack-k8s-operators/ci-framework/blob/main/deploy-edpm.yml) file that import all the playbooks needed to setup everything - these playbooks import all the roles that are part of the framework -, it means that it will setup a CRC environment with EDPM VMs. We have more information in [Using the framework](https://github.com/openstack-k8s-operators/ci-framework#using-the-framework).
+We will also find in the root of the project the [deploy-edpm.yml](https://github.com/openstack-k8s-operators/ci-framework/blob/main/deploy-edpm.yml) file that imports all the playbooks needed to setup everything - these playbooks import all the roles that are part of the framework -, it means that it will setup a CRC environment with EDPM VMs. We have more information in [Using the framework](https://github.com/openstack-k8s-operators/ci-framework#using-the-framework).
 
 To cleanup everything [cleanup-edpm.yml](https://github.com/openstack-k8s-operators/ci-framework/blob/main/cleanup-edpm.yml).
 

docs/source/quickstart/02_nested_virt.md

@@ -48,7 +48,7 @@ make local_env_create LOCAL_ENV_OPTS="-K"
 in the roles - please refer to the READMEs located in the used roles: libvirt_manager). Of course, if you have a NOPASSWD directive in your sudoers, you don't need
 to pass that option/parameter.
 
-ℹ️ You may want to check the local_env_vm role README in order to find all of the available parameters. You can then pass them as follow:
+ℹ️ You may want to check the local_env_vm role README in order to find all of the available parameters. You can then pass them as follows:
 ```Bash
 make local_env_create LOCAL_ENV_OPTS="-K -e param_name='param_value' -e @my-custom-file.yml"
 ```
@@ -65,7 +65,7 @@ If everything goes as expected, you should see the following message:
 ssh cifmw-vm
 ```
 
-ℹ️ This is possible because your `~/.ssh/config` has a configuration block allowing an easy access to the VM.
+ℹ️ This is possible because your `~/.ssh/config` has a configuration block allowing easy access to the VM.
 
 8. **Run the ci-framework**
 
@@ -98,5 +98,5 @@ The `make` target will call `ansible-playbook` against the dev-local-env.yml pla
 - generate an ephemeral SSH keypair in `~/ci-framework-data/artifacts` and allow it in the VM
 - fetch the latest CentOS Stream 9 image and store it in `~/ci-framework-data/images`
 - create a layered image based upon that CS9 image, and store i in `~/ci-framework-data/images`
-- bootstrap the VM, installing some softwares, configuring services and all
-- inject a block in your `~/.ssh/config` file for an easy access
+- bootstrap the VM, installing some software, configuring services and all
+- inject a block in your `~/.ssh/config` file for easy access

docs/source/quickstart/03_psi.md

@@ -33,7 +33,7 @@ openstack network list --external -c Name -f value | \
   xargs -n1 openstack network show  -c name -f value
 ```
 
-Finally, create a vm with valued you picked for the falvor/image/network/key-pair
+Finally, create a vm with valued you picked for the flavor/image/network/key-pair
 
 ```
 openstack server create --flavor ocp4-compute-large --image CentOS-Stream-9-latest \

docs/source/quickstart/04_non-virt.md

@@ -59,7 +59,7 @@ pre_infra:
     source: "{{ cifmw_installyamls_repos }}/devsetup/download_tools.yaml"
 ```
 
-⚠️ Ensure you're not overprovisioning the CRC VM - here, it's allocating
+⚠️ Ensure you're not over provisioning the CRC VM - here, it's allocating
 about 30G of RAM, 10 Cores and 120G of disk space. It's more than the minimal
 requirements.