diff --git a/nova/core/roles/configure_package_mirrors/README.md b/nova/core/roles/configure_package_mirrors/README.md index b81d9d86..56f86a69 100644 --- a/nova/core/roles/configure_package_mirrors/README.md +++ b/nova/core/roles/configure_package_mirrors/README.md @@ -59,7 +59,7 @@ none ansible.builtin.include_role: name: nova.core.configure_package_mirrors vars: - package_mirror_ubuntu_uri: + package_mirror_ubuntu_uri: general: "https://nexus.example.com/repository/{{ ansible_facts.lsb.codename }}/" updates: "https://nexus.example.com/repository/{{ ansible_facts.lsb.codename }}-updates/" security: "https://nexus.example.com/repository/{{ ansible_facts.lsb.codename }}-security/" diff --git a/nova/core/roles/customization/README.md b/nova/core/roles/customization/README.md index 4fbb39b2..fa63b074 100644 --- a/nova/core/roles/customization/README.md +++ b/nova/core/roles/customization/README.md @@ -1,6 +1,6 @@ # customization -This is a universal role that can be included in [start.yml](https://github.com/ClarifiedSecurity/catapult/blob/main/defaults/start.yml). It is used to look for existance of a role in the `customization_role_path` and include it if it exists. +This is a universal role that can be included in [start.yml](https://github.com/ClarifiedSecurity/catapult/blob/main/defaults/start.yml). It is used to look for existence of a role in the `customization_role_path` and include it if it exists. ## Requirements diff --git a/nova/core/roles/customization_pre_role/README.md b/nova/core/roles/customization_pre_role/README.md index 10ec5cbf..c299ee35 100644 --- a/nova/core/roles/customization_pre_role/README.md +++ b/nova/core/roles/customization_pre_role/README.md @@ -1,6 +1,6 @@ # customization_pre_role -This role gets loaded in start.yml before any connection is made to the Ansible inventory host. It can be used include roles that interact with different services or APIs directly from the Catapult container. It'll first check if a role name matching `pre_role` variable exists in `{{ inventory_dir }}/roles` and includes it. If no role exits it'll try to include the role based on the FQCN defined in `pre_role` variable. After the include role is complete the play stops. +This role gets loaded in `start.yml` before any connection is made to the Ansible inventory host. It can be used include roles that interact with different services or APIs directly from the Catapult container. It'll first check if a role name matching `pre_role` variable exists in `{{ inventory_dir }}/roles` and includes it. If no role exits it'll try to include the role based on the FQCN defined in `pre_role` variable. After the include role is complete the play stops. ## Requirements diff --git a/nova/core/roles/customization_pre_vm_role/README.md b/nova/core/roles/customization_pre_vm_role/README.md index 005565e9..cb3c5683 100644 --- a/nova/core/roles/customization_pre_vm_role/README.md +++ b/nova/core/roles/customization_pre_vm_role/README.md @@ -11,7 +11,7 @@ Any pre-requisites that may not be covered by Ansible itself or the role should ## Role Variables COMING SOON -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +A description of the settable variables for this role should go here, including any variables that are in `defaults/main.yml`, `vars/main.yml`, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. ## Dependencies diff --git a/nova/core/roles/deploy_vars/README.md b/nova/core/roles/deploy_vars/README.md index 005565e9..cb3c5683 100644 --- a/nova/core/roles/deploy_vars/README.md +++ b/nova/core/roles/deploy_vars/README.md @@ -11,7 +11,7 @@ Any pre-requisites that may not be covered by Ansible itself or the role should ## Role Variables COMING SOON -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +A description of the settable variables for this role should go here, including any variables that are in `defaults/main.yml`, `vars/main.yml`, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. ## Dependencies diff --git a/nova/core/roles/outline/README.md b/nova/core/roles/outline/README.md index f7878200..ddc80c4c 100644 --- a/nova/core/roles/outline/README.md +++ b/nova/core/roles/outline/README.md @@ -71,7 +71,7 @@ Bucket access policy example - take care that you define the correct bucket name ## Public folders in the private bucket -Outline wants to store and show user profile picures under **bucketname/public/** and some other avatars under **bucketname/avatars/**. +Outline wants to store and show user profile pictures under **bucketname/public/** and some other avatars under **bucketname/avatars/**. Since we have locked down our bucket to be private, we have to add anonymous access rules under the bucket configuration (readonly access) ```shell @@ -102,4 +102,4 @@ Example - In order for the exporting/importing functions to be successful, please make sure that you have connectivity between the outline application container and the s3 service (that can also be a container, running on the same host). - If importing or exporting fails, make sure that there are no DNS issues (that the outline container can resolve the s3 service), no certificate trust issues etc. - Exporting the wiki **does not include users, groups or any permission schemes**, only articles and attachments are included. Makes sense to always make backups at the OS level as well. -- Exporting the wiki includes only those collections that you have the premissions to read, even if you are admin. +- Exporting the wiki includes only those collections that you have the permissions to read, even if you are admin. diff --git a/nova/core/roles/secrets_to_vault/README.md b/nova/core/roles/secrets_to_vault/README.md index e6cc2408..f5fc45ea 100644 --- a/nova/core/roles/secrets_to_vault/README.md +++ b/nova/core/roles/secrets_to_vault/README.md @@ -4,7 +4,7 @@ This is a role for saving secrets to [Hashicorp Vault](https://www.hashicorp.com - User accounts passwords - Will generate (if needed) and save the password for items in `user_accounts`, `domain_user_accounts` & `admin_accounts` lists to Vault. - Pregenerated secrets - Secrets are generated by the role and passed in as list for the role and the roles saves them to Vault if they do not already exist. -- Autogenerated secrets - Secrets cannot be generated by the user but are generated automatically by some application and only shown once (API keys, tokens etc). In that case this role will save the secret to Vault overwriting any existing secret with the same name. +- Auto-generated secrets - Secrets cannot be generated by the user but are generated automatically by some application and only shown once (API keys, tokens etc). In that case this role will save the secret to Vault overwriting any existing secret with the same name. Refer to [nova.core.accounts](https://github.com/novateams/nova.core/tree/main/nova/core/roles/accounts) role for more information about the `user_accounts`, `domain_user_accounts` & `admin_accounts` lists. diff --git a/nova/core/roles/snapshots/README.md b/nova/core/roles/snapshots/README.md index a636ec20..e525b471 100644 --- a/nova/core/roles/snapshots/README.md +++ b/nova/core/roles/snapshots/README.md @@ -34,7 +34,7 @@ One of the following variables must be set: Modifiers: - `live_snap` (true|false) - Affects `snap`, `clean-snap`, `re-snap` -- `snapshot_name` (string) - Used to interact with the snapshos +- `snapshot_name` (string) - Used to interact with the snapshots - `new_snapshot_name` (string) - Only used when `rename` - `start_vm_after_snapshot` (true|false) - `start_vm_after_revert` (true|false) diff --git a/nova/core/roles/template_os_configuration/README.md b/nova/core/roles/template_os_configuration/README.md index dbc6e17a..f99b817a 100644 --- a/nova/core/roles/template_os_configuration/README.md +++ b/nova/core/roles/template_os_configuration/README.md @@ -1,6 +1,6 @@ # template_os_configuration -This is a role to pre-configure a VM template. It is reccomeneded that you have your VM templates in separate project or separately in your project's inventory so you use this role to configure them for use with the rest of the roles in this collection. +This is a role to pre-configure a VM template. It is recommended that you have your VM templates in separate project or separately in your project's inventory so you use this role to configure them for use with the rest of the roles in this collection. ## Requirements @@ -10,7 +10,7 @@ none Refer to the [defaults/main.yml](https://github.com/novateams/nova.core/blob/main/nova/core/roles/template_os_configuration/defaults/main.yml) file for a list and description of the variables used in this role. -Currently some of the when conditions expect you to have specificly named group vars defined for certain settings to applied. +Currently some of the when conditions expect you to have specifically named group vars defined for certain settings to applied. Examples: diff --git a/nova/core/roles/vcenter_vmtools_policy/README.md b/nova/core/roles/vcenter_vmtools_policy/README.md index 005565e9..77b74ab3 100644 --- a/nova/core/roles/vcenter_vmtools_policy/README.md +++ b/nova/core/roles/vcenter_vmtools_policy/README.md @@ -11,7 +11,7 @@ Any pre-requisites that may not be covered by Ansible itself or the role should ## Role Variables COMING SOON -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +A description of the settable variables for this role should go here, including any variables that are in `defaults/main.yml`,` vars/main.yml`, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. ## Dependencies diff --git a/nova/core/roles/win_sysprep/README.md b/nova/core/roles/win_sysprep/README.md index a0ae4fe9..fee1dfb4 100644 --- a/nova/core/roles/win_sysprep/README.md +++ b/nova/core/roles/win_sysprep/README.md @@ -1,6 +1,6 @@ # win_sysprep -This is a role for running sysprep on a Windows host running on vSphere. This is automatically included in the `nova.core.template_os_configuration` role, but can be run independently if desired. +This is a role for running `sysprep` on a Windows host running on vSphere. This is automatically included in the `nova.core.template_os_configuration` role, but can be run independently if desired. ## Requirements @@ -8,7 +8,7 @@ none ## Role Variables -`post_sysprep_administrator_password` - The password for the Administrator account after sysprep is run. Defaults to current `ansible_user`. +`post_sysprep_administrator_password` - The password for the Administrator account after `sysprep` is run. Defaults to current `ansible_user`. ## Dependencies