Move inventory management code to enable imports
In order to import code from inventory-manage.py, such as for testing purposes, the file must either be renamed or some very brittle hacks are necessary to fake an import. This is due to the '-' character in the file name. To accomodate both the goal of importable code and maintained compatibility, the contents of inventory-manage.py have been moved to manage_inventory.py, and inventory-manage.py simply imports that code and runs it. No new functionality is added. Change-Id: I60e73bed699b159f47e6c5b46d0787cf15fe1a4f
This commit is contained in:
Nolan Brubaker
parent
5e65a9e2f1
commit
c8791e0d09
@ -18,311 +18,12 @@
|
||||
# (c) 2015, Major Hayden <major@mhtx.net>
|
||||
#
|
||||
"""Returns data about containers and groups in tabular formats."""
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
import prettytable
|
||||
|
||||
# NOTE(nrb/palendae): The contents of this file were moved
|
||||
# to manage_inventory.py in order to facilitate importing of the python code
|
||||
|
||||
def file_find(filename, user_file=None, pass_exception=False):
|
||||
"""Return the path to a file.
|
||||
|
||||
If no file is found the system will exit.
|
||||
The file lookup will be done in the following directories:
|
||||
/etc/openstack_deploy/
|
||||
$(pwd)/openstack_deploy/
|
||||
|
||||
:param filename: ``str`` Name of the file to find
|
||||
:param user_file: ``str`` Additional location to look in FIRST for a file
|
||||
"""
|
||||
file_check = [
|
||||
os.path.join(
|
||||
'/etc', 'openstack_deploy', filename
|
||||
),
|
||||
os.path.join(
|
||||
os.getcwd(), filename
|
||||
)
|
||||
]
|
||||
|
||||
if user_file is not None:
|
||||
file_check.insert(0, os.path.expanduser(user_file))
|
||||
|
||||
for filename in file_check:
|
||||
if os.path.isfile(filename):
|
||||
return filename
|
||||
else:
|
||||
if pass_exception is False:
|
||||
raise SystemExit('No file found at: %s' % file_check)
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def recursive_list_removal(inventory, purge_list):
|
||||
"""Remove items from a list.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
purge_list -- list of items to remove
|
||||
"""
|
||||
for item in purge_list:
|
||||
for _item in inventory:
|
||||
if item == _item:
|
||||
inventory.pop(inventory.index(item))
|
||||
|
||||
|
||||
def recursive_dict_removal(inventory, purge_list):
|
||||
"""Remove items from a dictionary.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
purge_list -- list of items to remove
|
||||
"""
|
||||
for key, value in inventory.iteritems():
|
||||
if isinstance(value, dict):
|
||||
for _key, _value in value.iteritems():
|
||||
if isinstance(_value, dict):
|
||||
for item in purge_list:
|
||||
if item in _value:
|
||||
del(_value[item])
|
||||
elif isinstance(_value, list):
|
||||
recursive_list_removal(_value, purge_list)
|
||||
elif isinstance(value, list):
|
||||
recursive_list_removal(value, purge_list)
|
||||
|
||||
|
||||
def args():
|
||||
"""Setup argument Parsing."""
|
||||
parser = argparse.ArgumentParser(
|
||||
usage='%(prog)s',
|
||||
description='OpenStack Inventory Generator',
|
||||
epilog='Inventory Generator Licensed "Apache 2.0"')
|
||||
|
||||
parser.add_argument(
|
||||
'-f',
|
||||
'--file',
|
||||
help='Inventory file.',
|
||||
required=False,
|
||||
default='openstack_inventory.json'
|
||||
)
|
||||
parser.add_argument(
|
||||
'-s',
|
||||
'--sort',
|
||||
help='Sort items based on given key i.e. physical_host',
|
||||
required=False,
|
||||
default='component'
|
||||
)
|
||||
|
||||
exclusive_action = parser.add_mutually_exclusive_group(required=True)
|
||||
exclusive_action.add_argument(
|
||||
'-r',
|
||||
'--remove-item',
|
||||
help='host name to remove from inventory, this can be used multiple'
|
||||
' times.',
|
||||
action='append',
|
||||
default=[]
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-l',
|
||||
'--list-host',
|
||||
help='',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-g',
|
||||
'--list-groups',
|
||||
help='List groups and containers in each group',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-G',
|
||||
'--list-containers',
|
||||
help='List containers and their groups',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
|
||||
return vars(parser.parse_args())
|
||||
|
||||
|
||||
def get_all_groups(inventory):
|
||||
"""Retrieve all ansible groups.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
|
||||
Will return a dictionary of containers as keys and corresponding groups
|
||||
as values.
|
||||
"""
|
||||
containers = {}
|
||||
for container_name in inventory['_meta']['hostvars'].keys():
|
||||
|
||||
# Skip the default group names since they're not helpful (like aio1).
|
||||
if '_' not in container_name:
|
||||
continue
|
||||
|
||||
groups = get_groups_for_container(inventory, container_name)
|
||||
containers[container_name] = groups
|
||||
|
||||
return containers
|
||||
|
||||
|
||||
def get_groups_for_container(inventory, container_name):
|
||||
"""Return groups for a particular container.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
container_name -- name of a container to lookup
|
||||
|
||||
Will return a list of groups that the container belongs to.
|
||||
"""
|
||||
# Beware, this dictionary comprehension requires Python 2.7, but we should
|
||||
# have this on openstack-ansible hosts already.
|
||||
groups = {k for (k, v) in inventory.items() if
|
||||
('hosts' in v and
|
||||
container_name in v['hosts'])}
|
||||
return groups
|
||||
|
||||
|
||||
def get_containers_for_group(inventory, group):
|
||||
"""Return containers that belong to a particular group.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
group -- group to use to lookup containers
|
||||
|
||||
Will return a list of containers that belong to a group, or None if no
|
||||
containers match the group provided.
|
||||
"""
|
||||
if 'hosts' in inventory[group]:
|
||||
containers = inventory[group]['hosts']
|
||||
else:
|
||||
containers = None
|
||||
return containers
|
||||
|
||||
|
||||
def print_groups_per_container(inventory):
|
||||
"""Return a table of containers and the groups they belong to.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
containers = get_all_groups(inventory)
|
||||
required_list = [
|
||||
'container_name',
|
||||
'groups'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
|
||||
for container_name, groups in containers.iteritems():
|
||||
row = [container_name, ', '.join(sorted(groups))]
|
||||
table.add_row(row)
|
||||
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
|
||||
return table
|
||||
|
||||
|
||||
def print_containers_per_group(inventory):
|
||||
"""Return a table of groups and the containers in each group.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
required_list = [
|
||||
'groups',
|
||||
'container_name'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
|
||||
for group_name in inventory.keys():
|
||||
containers = get_containers_for_group(inventory, group_name)
|
||||
|
||||
# Don't show a group if it has no containers
|
||||
if containers is None or len(containers) < 1:
|
||||
continue
|
||||
|
||||
# Don't show default group
|
||||
if len(containers) == 1 and '_' not in containers[0]:
|
||||
continue
|
||||
|
||||
# Join with newlines here to avoid having a horrific table with tons
|
||||
# of line wrapping.
|
||||
row = [group_name, '\n'.join(containers)]
|
||||
table.add_row(row)
|
||||
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
|
||||
return table
|
||||
|
||||
|
||||
def print_inventory(inventory, sort_key):
|
||||
"""Return a table of containers with detail about each.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
_meta_data = inventory['_meta']['hostvars']
|
||||
required_list = [
|
||||
'container_name',
|
||||
'is_metal',
|
||||
'component',
|
||||
'physical_host',
|
||||
'tunnel_address',
|
||||
'ansible_ssh_host',
|
||||
'container_types'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
for key, values in _meta_data.iteritems():
|
||||
for rl in required_list:
|
||||
if rl not in values:
|
||||
values[rl] = None
|
||||
else:
|
||||
row = []
|
||||
for _rl in required_list:
|
||||
if _rl == 'container_name':
|
||||
if values.get(_rl) is None:
|
||||
values[_rl] = key
|
||||
|
||||
row.append(values.get(_rl))
|
||||
else:
|
||||
table.add_row(row)
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
table.sortby = sort_key
|
||||
return table
|
||||
|
||||
|
||||
def main():
|
||||
"""Run the main application."""
|
||||
# Parse user args
|
||||
user_args = args()
|
||||
|
||||
# Get the contents of the system environment json
|
||||
environment_file = file_find(filename=user_args['file'])
|
||||
with open(environment_file, 'rb') as f_handle:
|
||||
inventory = json.loads(f_handle.read())
|
||||
|
||||
# Make a table with hosts in the left column and details about each in the
|
||||
# columns to the right
|
||||
if user_args['list_host'] is True:
|
||||
print(print_inventory(inventory, user_args['sort']))
|
||||
|
||||
# Groups in first column, containers in each group on the right
|
||||
elif user_args['list_groups'] is True:
|
||||
print(print_groups_per_container(inventory))
|
||||
|
||||
# Containers in the first column, groups for each container on the right
|
||||
elif user_args['list_containers'] is True:
|
||||
print(print_containers_per_group(inventory))
|
||||
else:
|
||||
recursive_dict_removal(inventory, user_args['remove_item'])
|
||||
with open(environment_file, 'wb') as f_handle:
|
||||
f_handle.write(json.dumps(inventory, indent=2))
|
||||
print('Success. . .')
|
||||
# This file remains for backwards compatibility
|
||||
import manage_inventory
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
manage_inventory.main()
|
||||
|
||||
328
scripts/manage_inventory.py
Normal file
328
scripts/manage_inventory.py
Normal file
@ -0,0 +1,328 @@
|
||||
#!/usr/bin/env python
|
||||
#
|
||||
# Copyright 2014, Rackspace US, Inc.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
# (c) 2014, Kevin Carter <kevin.carter@rackspace.com>
|
||||
# (c) 2015, Major Hayden <major@mhtx.net>
|
||||
#
|
||||
"""Returns data about containers and groups in tabular formats."""
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
import prettytable
|
||||
|
||||
|
||||
def file_find(filename, user_file=None, pass_exception=False):
|
||||
"""Return the path to a file.
|
||||
|
||||
If no file is found the system will exit.
|
||||
The file lookup will be done in the following directories:
|
||||
/etc/openstack_deploy/
|
||||
$(pwd)/openstack_deploy/
|
||||
|
||||
:param filename: ``str`` Name of the file to find
|
||||
:param user_file: ``str`` Additional location to look in FIRST for a file
|
||||
"""
|
||||
file_check = [
|
||||
os.path.join(
|
||||
'/etc', 'openstack_deploy', filename
|
||||
),
|
||||
os.path.join(
|
||||
os.getcwd(), filename
|
||||
)
|
||||
]
|
||||
|
||||
if user_file is not None:
|
||||
file_check.insert(0, os.path.expanduser(user_file))
|
||||
|
||||
for filename in file_check:
|
||||
if os.path.isfile(filename):
|
||||
return filename
|
||||
else:
|
||||
if pass_exception is False:
|
||||
raise SystemExit('No file found at: %s' % file_check)
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def recursive_list_removal(inventory, purge_list):
|
||||
"""Remove items from a list.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
purge_list -- list of items to remove
|
||||
"""
|
||||
for item in purge_list:
|
||||
for _item in inventory:
|
||||
if item == _item:
|
||||
inventory.pop(inventory.index(item))
|
||||
|
||||
|
||||
def recursive_dict_removal(inventory, purge_list):
|
||||
"""Remove items from a dictionary.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
purge_list -- list of items to remove
|
||||
"""
|
||||
for key, value in inventory.iteritems():
|
||||
if isinstance(value, dict):
|
||||
for _key, _value in value.iteritems():
|
||||
if isinstance(_value, dict):
|
||||
for item in purge_list:
|
||||
if item in _value:
|
||||
del(_value[item])
|
||||
elif isinstance(_value, list):
|
||||
recursive_list_removal(_value, purge_list)
|
||||
elif isinstance(value, list):
|
||||
recursive_list_removal(value, purge_list)
|
||||
|
||||
|
||||
def args():
|
||||
"""Setup argument Parsing."""
|
||||
parser = argparse.ArgumentParser(
|
||||
usage='%(prog)s',
|
||||
description='OpenStack Inventory Generator',
|
||||
epilog='Inventory Generator Licensed "Apache 2.0"')
|
||||
|
||||
parser.add_argument(
|
||||
'-f',
|
||||
'--file',
|
||||
help='Inventory file.',
|
||||
required=False,
|
||||
default='openstack_inventory.json'
|
||||
)
|
||||
parser.add_argument(
|
||||
'-s',
|
||||
'--sort',
|
||||
help='Sort items based on given key i.e. physical_host',
|
||||
required=False,
|
||||
default='component'
|
||||
)
|
||||
|
||||
exclusive_action = parser.add_mutually_exclusive_group(required=True)
|
||||
exclusive_action.add_argument(
|
||||
'-r',
|
||||
'--remove-item',
|
||||
help='host name to remove from inventory, this can be used multiple'
|
||||
' times.',
|
||||
action='append',
|
||||
default=[]
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-l',
|
||||
'--list-host',
|
||||
help='',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-g',
|
||||
'--list-groups',
|
||||
help='List groups and containers in each group',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
exclusive_action.add_argument(
|
||||
'-G',
|
||||
'--list-containers',
|
||||
help='List containers and their groups',
|
||||
action='store_true',
|
||||
default=False
|
||||
)
|
||||
|
||||
return vars(parser.parse_args())
|
||||
|
||||
|
||||
def get_all_groups(inventory):
|
||||
"""Retrieve all ansible groups.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
|
||||
Will return a dictionary of containers as keys and corresponding groups
|
||||
as values.
|
||||
"""
|
||||
containers = {}
|
||||
for container_name in inventory['_meta']['hostvars'].keys():
|
||||
|
||||
# Skip the default group names since they're not helpful (like aio1).
|
||||
if '_' not in container_name:
|
||||
continue
|
||||
|
||||
groups = get_groups_for_container(inventory, container_name)
|
||||
containers[container_name] = groups
|
||||
|
||||
return containers
|
||||
|
||||
|
||||
def get_groups_for_container(inventory, container_name):
|
||||
"""Return groups for a particular container.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
container_name -- name of a container to lookup
|
||||
|
||||
Will return a list of groups that the container belongs to.
|
||||
"""
|
||||
# Beware, this dictionary comprehension requires Python 2.7, but we should
|
||||
# have this on openstack-ansible hosts already.
|
||||
groups = {k for (k, v) in inventory.items() if
|
||||
('hosts' in v and
|
||||
container_name in v['hosts'])}
|
||||
return groups
|
||||
|
||||
|
||||
def get_containers_for_group(inventory, group):
|
||||
"""Return containers that belong to a particular group.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
group -- group to use to lookup containers
|
||||
|
||||
Will return a list of containers that belong to a group, or None if no
|
||||
containers match the group provided.
|
||||
"""
|
||||
if 'hosts' in inventory[group]:
|
||||
containers = inventory[group]['hosts']
|
||||
else:
|
||||
containers = None
|
||||
return containers
|
||||
|
||||
|
||||
def print_groups_per_container(inventory):
|
||||
"""Return a table of containers and the groups they belong to.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
containers = get_all_groups(inventory)
|
||||
required_list = [
|
||||
'container_name',
|
||||
'groups'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
|
||||
for container_name, groups in containers.iteritems():
|
||||
row = [container_name, ', '.join(sorted(groups))]
|
||||
table.add_row(row)
|
||||
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
|
||||
return table
|
||||
|
||||
|
||||
def print_containers_per_group(inventory):
|
||||
"""Return a table of groups and the containers in each group.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
required_list = [
|
||||
'groups',
|
||||
'container_name'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
|
||||
for group_name in inventory.keys():
|
||||
containers = get_containers_for_group(inventory, group_name)
|
||||
|
||||
# Don't show a group if it has no containers
|
||||
if containers is None or len(containers) < 1:
|
||||
continue
|
||||
|
||||
# Don't show default group
|
||||
if len(containers) == 1 and '_' not in containers[0]:
|
||||
continue
|
||||
|
||||
# Join with newlines here to avoid having a horrific table with tons
|
||||
# of line wrapping.
|
||||
row = [group_name, '\n'.join(containers)]
|
||||
table.add_row(row)
|
||||
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
|
||||
return table
|
||||
|
||||
|
||||
def print_inventory(inventory, sort_key):
|
||||
"""Return a table of containers with detail about each.
|
||||
|
||||
Keyword arguments:
|
||||
inventory -- inventory dictionary
|
||||
"""
|
||||
_meta_data = inventory['_meta']['hostvars']
|
||||
required_list = [
|
||||
'container_name',
|
||||
'is_metal',
|
||||
'component',
|
||||
'physical_host',
|
||||
'tunnel_address',
|
||||
'ansible_ssh_host',
|
||||
'container_types'
|
||||
]
|
||||
table = prettytable.PrettyTable(required_list)
|
||||
for key, values in _meta_data.iteritems():
|
||||
for rl in required_list:
|
||||
if rl not in values:
|
||||
values[rl] = None
|
||||
else:
|
||||
row = []
|
||||
for _rl in required_list:
|
||||
if _rl == 'container_name':
|
||||
if values.get(_rl) is None:
|
||||
values[_rl] = key
|
||||
|
||||
row.append(values.get(_rl))
|
||||
else:
|
||||
table.add_row(row)
|
||||
for tbl in table.align.keys():
|
||||
table.align[tbl] = 'l'
|
||||
table.sortby = sort_key
|
||||
return table
|
||||
|
||||
|
||||
def main():
|
||||
"""Run the main application."""
|
||||
# Parse user args
|
||||
user_args = args()
|
||||
|
||||
# Get the contents of the system environment json
|
||||
environment_file = file_find(filename=user_args['file'])
|
||||
with open(environment_file, 'rb') as f_handle:
|
||||
inventory = json.loads(f_handle.read())
|
||||
|
||||
# Make a table with hosts in the left column and details about each in the
|
||||
# columns to the right
|
||||
if user_args['list_host'] is True:
|
||||
print(print_inventory(inventory, user_args['sort']))
|
||||
|
||||
# Groups in first column, containers in each group on the right
|
||||
elif user_args['list_groups'] is True:
|
||||
print(print_groups_per_container(inventory))
|
||||
|
||||
# Containers in the first column, groups for each container on the right
|
||||
elif user_args['list_containers'] is True:
|
||||
print(print_containers_per_group(inventory))
|
||||
else:
|
||||
recursive_dict_removal(inventory, user_args['remove_item'])
|
||||
with open(environment_file, 'wb') as f_handle:
|
||||
f_handle.write(json.dumps(inventory, indent=2))
|
||||
print('Success. . .')
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
x
Reference in New Issue
Block a user