Skip to content

vmware region relation #505

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.

Sign up for GitHub

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

Open
tsia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

vmware region relation #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions module/sources/vmware/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,14 @@ def __init__(self):
description="""Same as cluster site but on host level.
If unset it will fall back to cluster_site_relation""",
config_example="nyc02.* = New York, ffm01.* = Frankfurt"),
ConfigOption("cluster_region_relation",
str,
description="""Same as cluster site but for regions."""),
ConfigOption("host_region_relation",
str,
description="""Same as cluster region but on host level.
If unset it will fall back to cluster_region_relation""",
config_example="nyc02.* = New York, ffm01.* = Frankfurt"),
ConfigOption("cluster_tenant_relation",
str,
description="""\
Expand Down
81 changes: 52 additions & 29 deletions module/sources/vmware/connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,50 +446,57 @@ def passes_filter(name, include_filter, exclude_filter):
return True

def get_site_name(self, object_type, object_name, cluster_name=""):
return self.get_object_relation_name(object_type, object_name, 'site', cluster_name)

def get_region_name(self, object_type, object_name, cluster_name=""):
return self.get_object_relation_name(object_type, object_name, 'region', cluster_name)

def get_object_relation_name(self, object_type, object_name, relation, cluster_name=""):
"""
Return a site name for a NBCluster or NBDevice depending on config options
host_site_relation and cluster_site_relation
Return a relation object name for a NBCluster or NBDevice depending on config options
host_{relation}_relation and cluster_{relation}_relation

Parameters
----------
object_type: (NBCluster, NBDevice)
object type to check site relation for
object_name: str
object name to check site relation for
relation: str
name of the relation (site, region)
cluster_name: str
cluster name of NBDevice to check for site name

Returns
-------
str: site name if a relation was found
"""

if object_type not in [NBCluster, NBDevice]:
raise ValueError(f"Object must be a '{NBCluster.name}' or '{NBDevice.name}'.")

log.debug2(f"Trying to find site name for {object_type.name} '{object_name}'")
log.debug2(f"Trying to find {relation} name for {object_type.name} '{object_name}'")

# check if site was provided in config
relation_name = "host_site_relation" if object_type == NBDevice else "cluster_site_relation"
# check if relation was provided in config
relation_name = f"host_{relation}_relation" if object_type == NBDevice else f"cluster_{relation}_relation"

site_name = self.get_object_relation(object_name, relation_name)
result = self.get_object_relation(object_name, relation_name)

if object_type == NBDevice and site_name is None:
site_name = self.get_site_name(NBCluster, cluster_name)
if site_name is not None:
log.debug2(f"Found a matching cluster site for {object_name}, using site '{site_name}'")
if object_type == NBDevice and result is None:
result = self.get_object_relation_name(NBCluster, cluster_name, relation)
if result is not None:
log.debug2(f"Found a matching cluster {relation} for {object_name}, using {relation} '{result}'")

# set default site name
if site_name is None:
site_name = self.site_name
log.debug(f"No site relation for '{object_name}' found, using default site '{site_name}'")
if result is None and relation == 'site':
result = self.site_name
log.debug(f"No {relation} relation for '{object_name}' found, using default {relation} '{result}'")

# set the site for cluster to None if None-keyword ("<NONE>") is set via cluster_site_relation
if object_type == NBCluster and site_name == "<NONE>":
site_name = None
log.debug2(f"Site relation for '{object_name}' set to None")
# set the relation for cluster to None if None-keyword ("<NONE>") is set via cluster_site_relation
if object_type == NBCluster and result == "<NONE>":
result = None
log.debug2(f"{relation} relation for '{object_name}' set to None")

return site_name
return result

def get_object_based_on_macs(self, object_type, mac_list=None):
"""
Expand Down Expand Up @@ -1380,19 +1387,27 @@ def add_cluster(self, obj):
return

site_name = self.get_site_name(NBCluster, full_cluster_name)
region_name = self.get_region_name(NBCluster, full_cluster_name)

data = {
"name": name,
"type": {"name": "VMware ESXi"},
"group": group
}

if version.parse(self.inventory.netbox_api_version) >= version.parse("4.2.0"):
if site_name is not None:
if site_name:
if version.parse(self.inventory.netbox_api_version) >= version.parse("4.2.0"):
data["scope_id"] = {"name": site_name}
data["scope_type"] = "dcim.site"
else:
data["site"] = {"name": site_name}
else:
data["site"] = {"name": site_name}
elif region_name:
if version.parse(self.inventory.netbox_api_version) >= version.parse("4.2.0"):
data["scope_id"] = {"name": region_name}
data["scope_type"] = "dcim.region"
else:
data["region"] = {"name": region_name}
log.info(f"full_cluster_name: {full_cluster_name}, site_name: {site_name}, region_name: {region_name}")

tenant_name = self.get_object_relation(full_cluster_name, "cluster_tenant_relation")
if tenant_name is not None:
Expand All @@ -1411,24 +1426,32 @@ def add_cluster(self, obj):
if grab(cluster_candidate, "data.name") != name:
continue

# try to find a cluster with matching site and group
if cluster_candidate.get_site_name() == site_name and \
grab(cluster_candidate, "data.group") is not None and \
grab(cluster_candidate, "data.group.data.name") == group_name:
cluster_object = cluster_candidate
log.debug2("Found an existing cluster where 'name', 'site' and 'group' are matching")
break

# try to find a cluster with matching site
if cluster_candidate.get_site_name() == site_name:
if not cluster_object and cluster_candidate.get_site_name() == site_name:
cluster_object = cluster_candidate
log.debug2("Found an existing cluster where 'name' and 'site' are matching")
break
continue

if grab(cluster_candidate, "data.group") is not None and \
if not cluster_object and grab(cluster_candidate, "data.group") is not None and \
grab(cluster_candidate, "data.group.data.name") == group_name:
cluster_object = cluster_candidate
log.debug2("Found an existing cluster where 'name' and 'cluster group' are matching")
break
continue

if grab(cluster_candidate, "data.tenant") is not None and \
if not cluster_object and grab(cluster_candidate, "data.tenant") is not None and \
tenant_name is not None and \
grab(cluster_candidate, "data.tenant.data.name") == tenant_name:
cluster_object = cluster_candidate
log.debug2("Found an existing cluster where 'name' and 'tenant' are matching")
break
continue

# if only the name matches and there are multiple cluster with the same name we choose the first
# cluster returned from netbox. This needs to be done to not ignore possible matches in one of
Expand Down