Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct multiple spelling errors to improve readability #506

Open
wants to merge 11 commits into
base: release/1.9.3
Choose a base branch
from
Prev Previous commit
Next Next commit
Adding more spelling fixes
  • Loading branch information
george-ghawali committed Sep 26, 2024
commit 55a03736b63a5aeff58fcd5e9eea84104e38e654
10 changes: 5 additions & 5 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -173,7 +173,7 @@ Bugfixes
New Modules
-----------

- ntnx_acps - acp module which suports acp Create, update and delete operations
- ntnx_acps - acp module which supports acp Create, update and delete operations
- ntnx_acps_info - acp info module
- ntnx_address_groups - module which supports address groups CRUD operations
- ntnx_address_groups_info - address groups info module
@@ -186,7 +186,7 @@ New Modules
- ntnx_projects_info - projects info module
- ntnx_roles - module which supports role CRUD operations
- ntnx_roles_info - role info module
- ntnx_service_groups - service_groups module which suports service_groups CRUD operations
- ntnx_service_groups - service_groups module which supports service_groups CRUD operations
- ntnx_service_groups_info - service_group info module
- ntnx_user_groups - user_groups module which supports pc user_groups management create delete operations
- ntnx_user_groups_info - User Groups info module
@@ -203,7 +203,7 @@ New Modules
- ntnx_image_placement_policy - image placement policy module which supports Create, update and delete operations
- ntnx_images - images module which supports pc images management CRUD operations
- ntnx_images_info - images info module
- ntnx_security_rules - security_rule module which suports security_rule CRUD operations
- ntnx_security_rules - security_rule module which supports security_rule CRUD operations
- ntnx_security_rules_info - security_rule info module
- ntnx_static_routes - vpc static routes
- ntnx_static_routes_info - vpc static routes info module
@@ -243,8 +243,8 @@ New Modules
- ntnx_foundation_central - Nutanix module to imaged Nodes and optionally create cluster
- ntnx_foundation_central_api_keys - Nutanix module which creates api key for foundation central
- ntnx_foundation_central_api_keys_info - Nutanix module which returns the api key
- ntnx_foundation_central_imaged_clusters_info - Nutanix module which returns the imaged clusters within the Foudation Central
- ntnx_foundation_central_imaged_nodes_info - Nutanix module which returns the imaged nodes within the Foudation Central
- ntnx_foundation_central_imaged_clusters_info - Nutanix module which returns the imaged clusters within the Foundation Central
- ntnx_foundation_central_imaged_nodes_info - Nutanix module which returns the imaged nodes within the Foundation Central
- ntnx_foundation_discover_nodes_info - Nutanix module which returns nodes discovered by Foundation
- ntnx_foundation_hypervisor_images_info - Nutanix module which returns the hypervisor images uploaded to Foundation
- ntnx_foundation_image_upload - Nutanix module which uploads hypervisor or AOS image to foundation vm.
10 changes: 5 additions & 5 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
@@ -101,12 +101,12 @@ releases:
name: ntnx_foundation_central_api_keys_info
namespace: ""
- description:
Nutanix module which returns the imaged clusters within the Foudation
Nutanix module which returns the imaged clusters within the Foundation
Central
name: ntnx_foundation_central_imaged_clusters_info
namespace: ""
- description:
Nutanix module which returns the imaged nodes within the Foudation
Nutanix module which returns the imaged nodes within the Foundation
Central
name: ntnx_foundation_central_imaged_nodes_info
namespace: ""
@@ -154,7 +154,7 @@ releases:
- description: images info module
name: ntnx_images_info
namespace: ""
- description: security_rule module which suports security_rule CRUD operations
- description: security_rule module which supports security_rule CRUD operations
name: ntnx_security_rules
namespace: ""
- description: security_rule info module
@@ -172,7 +172,7 @@ releases:
bugfixes:
- Fix examples of info modules [\#226](https://github.com/nutanix/nutanix.ansible/issues/226)
modules:
- description: acp module which suports acp Create, update and delete operations
- description: acp module which supports acp Create, update and delete operations
name: ntnx_acps
namespace: ""
- description: acp info module
@@ -211,7 +211,7 @@ releases:
- description: role info module
name: ntnx_roles_info
namespace: ""
- description: service_groups module which suports service_groups CRUD operations
- description: service_groups module which supports service_groups CRUD operations
name: ntnx_service_groups
namespace: ""
- description: service_group info module
2 changes: 1 addition & 1 deletion plugins/doc_fragments/ntnx_vms_base.py
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ class ModuleDocFragment(object):
- absent
subnet:
description:
- Name or UUID of the subnet to which the VM should be connnected
- Name or UUID of the subnet to which the VM should be connected
type: dict
suboptions:
name:
6 changes: 3 additions & 3 deletions plugins/module_utils/entity.py
Original file line number Diff line number Diff line change
@@ -344,7 +344,7 @@ def _build_url_with_query(self, url, query):
def _fetch_url(
self, url, method, data=None, raise_error=True, no_response=False, timeout=30
):
# only jsonify if content-type supports, added to avoid incase of form-url-encodeded type data
# only jsonify if content-type supports, added to avoid incase of form-url-encoded type data
if self.headers["Content-Type"] == "application/json" and data is not None:
data = self.module.jsonify(data)

@@ -362,7 +362,7 @@ def _fetch_url(

body = None

# buffer size with ref. to max read size of http.client.HTTPResponse.read() defination
# buffer size with ref. to max read size of http.client.HTTPResponse.read() definition
buffer_size = 65536

# From ansible-core>=2.13, incase of http error, urllib.HTTPError object is returned in resp
@@ -500,7 +500,7 @@ def _filter_entities(entities, custom_filters):
return filtered_entities


# Read files in chunks and yeild it
# Read files in chunks and yield it
class CreateChunks(object):
def __init__(self, filename, chunk_size=1 << 13):
self.filename = filename
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ def get_engine_type(module):
if type in module.params:
return type, None

return None, "Input doesn't conatains config for allowed engine types of databases"
return None, "Input doesn't contains config for allowed engine types of databases"


def create_db_engine(module, engine_type=None, db_architecture=None):
4 changes: 2 additions & 2 deletions plugins/module_utils/ndb/database_engines/postgres.py
Original file line number Diff line number Diff line change
@@ -115,7 +115,7 @@ def build_spec_db_instance_provision_action_arguments(self, payload, config):
spec = {"name": key, "value": config.get(key, value)}
action_arguments.append(spec)

# handle scenariors where display names are diff
# handle scenarios where display names are diff
action_arguments.append(
{"name": "database_names", "value": config.get("db_name")}
)
@@ -212,7 +212,7 @@ def build_spec_db_instance_provision_action_arguments(self, payload, config):
spec = {"name": key, "value": config.get(key, default)}
action_arguments.append(spec)

# handle scenariors where display names are different
# handle scenarios where display names are different
action_arguments.append(
{"name": "database_names", "value": config.get("db_name")}
)
2 changes: 1 addition & 1 deletion plugins/module_utils/ndb/database_instances.py
Original file line number Diff line number Diff line change
@@ -281,7 +281,7 @@ def get_engine_type(self):

return (
None,
"Input doesn't conatains config for allowed engine types of databases",
"Input doesn't contains config for allowed engine types of databases",
)

def get_db_engine_spec(self, payload, params=None, **kwargs):
4 changes: 2 additions & 2 deletions plugins/module_utils/ndb/db_server_vm.py
Original file line number Diff line number Diff line change
@@ -451,7 +451,7 @@ def get_spec_registered_vm_for_db_instance_registration(
if not vm_info.get("ipAddresses", []):
return None, "No IP address found for given db server vm"

# picking first IP of db server vm for registraion
# picking first IP of db server vm for registration
payload["vmIp"] = vm_info["ipAddresses"][0]

elif params.get("ip"):
@@ -572,7 +572,7 @@ def build_spec_software_profile(self, payload, profile):
return payload, None

def build_spec_network_profile(self, payload, profile):
# set network prfile
# set network profile
network_profile = NetworkProfile(self.module)
uuid, err = network_profile.get_profile_uuid(profile)
if err:
10 changes: 5 additions & 5 deletions plugins/module_utils/ndb/profiles/profile_types.py
Original file line number Diff line number Diff line change
@@ -233,7 +233,7 @@ def _build_spec_multi_networks(self, payload, vlans):
cluster_name = clusters_uuid_name_map[cluster_uuid]

if not cluster_name:
return None, "Pleae provide uuid or name for getting cluster info"
return None, "Please provide uuid or name for getting cluster info"

properties_map["CLUSTER_NAME_" + str(i)] = cluster_name
properties_map["CLUSTER_ID_" + str(i)] = clusters_name_uuid_map[
@@ -252,7 +252,7 @@ def get_create_profile_spec(self, old_spec=None, params=None, **kwargs):
self.build_spec_methods.update(
{
"software": self._build_spec_profile,
"clusters": self._build_spec_clusters_availibilty,
"clusters": self._build_spec_clusters_availability,
}
)
payload, err = super().get_create_profile_spec(
@@ -269,7 +269,7 @@ def get_create_profile_spec(self, old_spec=None, params=None, **kwargs):
def get_update_profile_spec(self, old_spec=None, params=None, **kwargs):

self.build_spec_methods.update(
{"clusters": self._build_spec_clusters_availibilty}
{"clusters": self._build_spec_clusters_availability}
)
payload, err = super().get_update_profile_spec(old_spec, params, **kwargs)
if err:
@@ -374,7 +374,7 @@ def _build_spec_version_create_properties(
payload["properties"] = properties
return payload, None

def _build_spec_clusters_availibilty(self, payload, clusters):
def _build_spec_clusters_availability(self, payload, clusters):
_clusters = Cluster(self.module)
spec = []
clusters_name_uuid_map = _clusters.get_all_clusters_name_uuid_map()
@@ -485,7 +485,7 @@ def get_profile_type(module):
if type in module.params:
return type, None

return None, "Input doesn't conatains config for allowed profile types of databases"
return None, "Input doesn't contains config for allowed profile types of databases"


def get_profile_type_obj(module, profile_type=None): # -> tuple[Profile, str]:
2 changes: 1 addition & 1 deletion plugins/module_utils/prism/acps.py
Original file line number Diff line number Diff line change
@@ -135,7 +135,7 @@ def build_role_permissions_based_context(self, role_uuid):
if permission.get("name"):
role_permissions_names.append(permission["name"])

# Get predefined premissions to entity access expressions from constants
# Get predefined permissions to entity access expressions from constants
expressions_dict = CONSTANTS.EntityFilterExpressionList.PERMISSION_TO_ACCESS_MAP
permission_names = expressions_dict.keys()

4 changes: 2 additions & 2 deletions plugins/module_utils/prism/idempotence_identifiers.py
Original file line number Diff line number Diff line change
@@ -9,10 +9,10 @@
from .prism import Prism


class IdempotenceIdenitifiers(Prism):
class IdempotenceIdentifiers(Prism):
def __init__(self, module):
resource_type = "/idempotence_identifiers"
super(IdempotenceIdenitifiers, self).__init__(
super(IdempotenceIdentifiers, self).__init__(
module, resource_type=resource_type
)

22 changes: 10 additions & 12 deletions plugins/module_utils/prism/projects_internal.py
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@
from .accounts import Account, get_account_uuid
from .acps import ACP
from .clusters import Cluster
from .idempotence_identifiers import IdempotenceIdenitifiers
from .idempotence_identifiers import IdempotenceIdentifiers
from .prism import Prism
from .roles import get_role_uuid
from .subnets import Subnet, get_subnet_uuid
@@ -133,9 +133,9 @@ def _build_spec_default_subnet(self, payload, subnet_ref):
if err:
return None, err

payload["spec"]["project_detail"]["resources"][
"default_subnet_reference"
] = Subnet.build_subnet_reference_spec(uuid)
payload["spec"]["project_detail"]["resources"]["default_subnet_reference"] = (
Subnet.build_subnet_reference_spec(uuid)
)
return payload, None

def _build_spec_subnets(self, payload, subnet_ref_list):
@@ -193,7 +193,7 @@ def _build_spec_user_and_user_groups_list(self, payload, role_mappings):
):
new_uuids_required += 1

ii = IdempotenceIdenitifiers(self.module)
ii = IdempotenceIdentifiers(self.module)

# get uuids for user groups
new_uuid_list = ii.get_idempotent_uuids(new_uuids_required)
@@ -393,13 +393,11 @@ def _build_spec_role_mappings(self, payload, role_mappings):
acp["acp"]["resources"]["user_reference_list"] = role_user_groups_map[
acp["acp"]["resources"]["role_reference"]["uuid"]
]["users"]
acp["acp"]["resources"][
"user_group_reference_list"
] = role_user_groups_map[
acp["acp"]["resources"]["role_reference"]["uuid"]
][
"user_groups"
]
acp["acp"]["resources"]["user_group_reference_list"] = (
role_user_groups_map[
acp["acp"]["resources"]["role_reference"]["uuid"]
]["user_groups"]
)

# pop the role uuid entry once used for acp update
role_user_groups_map.pop(
2 changes: 1 addition & 1 deletion plugins/module_utils/prism/protection_rules.py
Original file line number Diff line number Diff line change
@@ -110,7 +110,7 @@ def _build_spec_schedules(self, payload, schedules):
):
return (
None,
"rpo, rpo_unit, snapshot_type and atleast one policy are required fields for aysynchronous snapshot schedule",
"rpo, rpo_unit, snapshot_type and atleast one policy are required fields for asynchronous snapshot schedule",
)

spec["recovery_point_objective_secs"], err = convert_to_secs(
2 changes: 1 addition & 1 deletion plugins/modules/ntnx_acps.py
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@
DOCUMENTATION = r"""
---
module: ntnx_acps
short_description: acp module which suports acp Create, update and delete operations
short_description: acp module which supports acp Create, update and delete operations
version_added: 1.4.0
description: 'Create, Update, Delete acp'
options:
4 changes: 2 additions & 2 deletions plugins/modules/ntnx_categories.py
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@
options:
remove_values:
description:
- it indicates to remove all values of the specfied category
- it indicates to remove all values of the specified category
- This attribute can be only used with C(state) is absent
- This attribute is mutually exclusive with C(values) when state is absent
type: bool
@@ -202,7 +202,7 @@ def create_categories(module, result):
if value not in category_key_values:
category_values_specs.append(_category_value.get_value_spec(value))

# indempotency check
# idempotency check
if not category_values_specs and (
category_key_exists and (category_key == category_key_spec)
):
2 changes: 1 addition & 1 deletion plugins/modules/ntnx_clusters_info.py
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@
- Alaa Bishtawi (@alaa-bish)
"""
EXAMPLES = r"""
- name: List clusterss
- name: List clusters
ntnx_clusters_info:
nutanix_host: "{{ ip }}"
nutanix_username: "{{ username }}"
4 changes: 2 additions & 2 deletions plugins/modules/ntnx_floating_ips.py
Original file line number Diff line number Diff line change
@@ -82,7 +82,7 @@
nutanix_username: "{{ username }}"
nutanix_password: "{{ password }}"
external_subnet:
uuid: "{{external_subnet.subnet_uuiid}}"
uuid: "{{external_subnet.subnet_uuid}}"

- name: create Floating IP with vpc Name with external subnet uuid
ntnx_floating_ips:
@@ -92,7 +92,7 @@
nutanix_username: "{{ username }}"
nutanix_password: "{{ password }}"
external_subnet:
uuid: "{{external_subnet.subnet_uuiid}}"
uuid: "{{external_subnet.subnet_uuid}}"
vpc:
name: "{{vpc.vpc_name}}"
private_ip: "{{private_ip}}"
4 changes: 2 additions & 2 deletions plugins/modules/ntnx_floating_ips_info.py
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@
DOCUMENTATION = r"""
---
module: ntnx_floating_ips_info
short_description: Floting ips info module
short_description: Floating ips info module
version_added: 1.0.0
description: 'Get floating_ip info'
options:
@@ -21,7 +21,7 @@
default: floating_ip
fip_uuid:
description:
- Floting ip UUID
- Floating ip UUID
type: str
extends_documentation_fragment:
- nutanix.ncp.ntnx_credentials
4 changes: 2 additions & 2 deletions plugins/modules/ntnx_foundation.py
Original file line number Diff line number Diff line change
@@ -295,7 +295,7 @@
required: false
other_config:
description:
- Auxillary lacp configurations. Applicable only for AHV
- Auxiliary lacp configurations. Applicable only for AHV
type: list
elements: str
required: false
@@ -549,7 +549,7 @@
required: false
other_config:
description:
- Auxillary lacp configurations. Applicable only for AHV
- Auxiliary lacp configurations. Applicable only for AHV
type: list
elements: str
required: false
2 changes: 1 addition & 1 deletion plugins/modules/ntnx_foundation_central.py
Original file line number Diff line number Diff line change
@@ -363,7 +363,7 @@
"""

RETURN = r"""
respone:
response:
description: Sample response when only Imaging is done.
returned: always
type: dict
Loading
Loading