diff --git a/doc/build/html/_modules/index.html b/doc/build/html/_modules/index.html index 4e1196b..8f4dc7f 100644 --- a/doc/build/html/_modules/index.html +++ b/doc/build/html/_modules/index.html @@ -6,7 +6,7 @@ - Overview: module code — kollacli 1.0.0.dev386 documentation + Overview: module code — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
@@ -35,7 +35,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • @@ -108,7 +108,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • diff --git a/doc/build/html/_modules/kollacli/api/async.html b/doc/build/html/_modules/kollacli/api/async.html index dd46ef8..285cb45 100644 --- a/doc/build/html/_modules/kollacli/api/async.html +++ b/doc/build/html/_modules/kollacli/api/async.html @@ -6,7 +6,7 @@ - kollacli.api.async — kollacli 1.0.0.dev386 documentation + kollacli.api.async — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -214,7 +214,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/client.html b/doc/build/html/_modules/kollacli/api/client.html index 6a0ca82..4590517 100644 --- a/doc/build/html/_modules/kollacli/api/client.html +++ b/doc/build/html/_modules/kollacli/api/client.html @@ -6,7 +6,7 @@ - kollacli.api.client — kollacli 1.0.0.dev386 documentation + kollacli.api.client — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -60,7 +60,13 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. +import kollacli.i18n as u + import logging +import os +import sys + +from logging.handlers import RotatingFileHandler from kollacli.api.async import AsyncApi from kollacli.api.deploy import DeployApi @@ -71,6 +77,9 @@ from kollacli.api.service import ServiceApi from kollacli.api.support import SupportApi +CONSOLE_MESSAGE_FORMAT = '%(message)s' +LOG_FILE_MESSAGE_FORMAT = \ + '[%(asctime)s] %(levelname)-8s %(name)s %(message)s' LOG = logging.getLogger(__name__) @@ -85,8 +94,70 @@ SupportApi, ): + def __init__(self): + self._configure_logging() +
    [docs] def base_call(self): - LOG.info('base call')
    + LOG.info('base call') + +
    [docs] def enable_console_logging(self, level, enable=True): + """enable/disable console logging for the api + + enable: True/False + level: logging.INFO, logging.DEBUG, logging.WARNING, + logging.CRITICAL... + """ + root_logger = logging.getLogger('') + console = logging.StreamHandler(sys.stderr) + if enable: + console.setLevel(level) + formatter = logging.Formatter(CONSOLE_MESSAGE_FORMAT) + console.setFormatter(formatter) + root_logger.addHandler(console) + else: + root_logger.removeHandler(console) +
    + def _configure_logging(self): + root_logger = logging.getLogger('') + root_logger.setLevel(logging.DEBUG) + + handler_found = False + handlers = root_logger.handlers + for handler in handlers: + if isinstance(handler, RotatingFileHandler): + handler_found = True + break + if not handler_found: + # logger has not been set up + try: + rotate_handler = RotatingFileHandler( + os.path.join(os.path.abspath(os.sep), + 'var', 'log', 'kolla', 'kolla.log'), + maxBytes=self._get_kolla_log_file_size(), + backupCount=4) + except IOError as e: + # most likely the caller is not part of the kolla group + raise IOError(u._('Permission denied to run the kolla client.' + '\nPlease add user to the kolla group and ' + 'then log out and back in. {error}') + .format(error=str(e))) + + formatter = logging.Formatter(LOG_FILE_MESSAGE_FORMAT) + rotate_handler.setFormatter(formatter) + rotate_handler.setLevel(logging.INFO) + root_logger.addHandler(rotate_handler) + + def _get_kolla_log_file_size(self): + envvar = 'KOLLA_LOG_FILE_SIZE' + size_str = os.environ.get(envvar, '500000') + try: + size = int(size_str) + except Exception: + LOG.error(('Environmental variable ({env_var}) is not an ' + 'integer ({log_size}).') + .format(env_var=envvar, log_size=size_str)) + size = 50000 + return size @@ -120,7 +191,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/deploy.html b/doc/build/html/_modules/kollacli/api/deploy.html index 4393855..7604751 100644 --- a/doc/build/html/_modules/kollacli/api/deploy.html +++ b/doc/build/html/_modules/kollacli/api/deploy.html @@ -6,7 +6,7 @@ - kollacli.api.deploy — kollacli 1.0.0.dev386 documentation + kollacli.api.deploy — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -119,7 +119,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/exceptions.html b/doc/build/html/_modules/kollacli/api/exceptions.html index 5dfd548..90d2bc5 100644 --- a/doc/build/html/_modules/kollacli/api/exceptions.html +++ b/doc/build/html/_modules/kollacli/api/exceptions.html @@ -6,7 +6,7 @@ - kollacli.api.exceptions — kollacli 1.0.0.dev386 documentation + kollacli.api.exceptions — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -160,7 +160,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/group.html b/doc/build/html/_modules/kollacli/api/group.html index f9c51cc..aac0958 100644 --- a/doc/build/html/_modules/kollacli/api/group.html +++ b/doc/build/html/_modules/kollacli/api/group.html @@ -6,7 +6,7 @@ - kollacli.api.group — kollacli 1.0.0.dev386 documentation + kollacli.api.group — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -274,7 +274,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/host.html b/doc/build/html/_modules/kollacli/api/host.html index c888ad6..148b1a5 100644 --- a/doc/build/html/_modules/kollacli/api/host.html +++ b/doc/build/html/_modules/kollacli/api/host.html @@ -6,7 +6,7 @@ - kollacli.api.host — kollacli 1.0.0.dev386 documentation + kollacli.api.host — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -228,7 +228,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/job.html b/doc/build/html/_modules/kollacli/api/job.html index c84701a..3a9e467 100644 --- a/doc/build/html/_modules/kollacli/api/job.html +++ b/doc/build/html/_modules/kollacli/api/job.html @@ -6,7 +6,7 @@ - kollacli.api.job — kollacli 1.0.0.dev386 documentation + kollacli.api.job — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -78,7 +78,10 @@
    [docs] def get_status(self): """Get status of job - :return: None if job still running, 0 if job succeeded, 1 if job failed + :return: None: job is still running + 0: job succeeded + 1: job failed + 2: job killed by user :rtype: int or None """ return self._ansible_job.get_status() @@ -97,7 +100,11 @@ :return: console output useful for debugging failed jobs. :rtype: string """ - return self._ansible_job.get_command_output()
    + return self._ansible_job.get_command_output() + +
    [docs] def kill(self): + """kill the job""" + self._ansible_job.kill()
    @@ -131,7 +138,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/password.html b/doc/build/html/_modules/kollacli/api/password.html index 7b92473..2669f23 100644 --- a/doc/build/html/_modules/kollacli/api/password.html +++ b/doc/build/html/_modules/kollacli/api/password.html @@ -6,7 +6,7 @@ - kollacli.api.password — kollacli 1.0.0.dev386 documentation + kollacli.api.password — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -130,7 +130,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/properties.html b/doc/build/html/_modules/kollacli/api/properties.html index 1dbdc2d..3e2333a 100644 --- a/doc/build/html/_modules/kollacli/api/properties.html +++ b/doc/build/html/_modules/kollacli/api/properties.html @@ -6,7 +6,7 @@ - kollacli.api.properties — kollacli 1.0.0.dev386 documentation + kollacli.api.properties — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -112,14 +112,12 @@ self.ovr_group = False self.ovr_host = False -
    [docs] def property_set(self, key, value, +
    [docs] def property_set(self, property_dict, property_type=GLOBAL_TYPE, change_set=None): """Set a property - :param key: property key - :type key: string - :param value: property value - :type value: string + :param property_dict: property dictionary containing key / values + :type property_dict: dictionary :param property_type: one of 'global', 'group' or 'host' :type property_type: string :param change_set: for group or host sets this is the list of groups @@ -127,10 +125,11 @@ :type change_set: list of strings """ - check_arg(key, u._('Property Key'), str) - key = safe_decode(key) - check_arg(value, u._('Property Value'), str) - value = safe_decode(value) + for key, value in property_dict.items(): + check_arg(key, u._('Property Key'), str) + check_arg(value, u._('Property Value'), str) + property_dict = safe_decode(property_dict) + self._check_type(property_type) if property_type is not GLOBAL_TYPE: check_arg(change_set, u._('Change Set'), list, none_ok=True) @@ -139,18 +138,18 @@ ansible_properties = AnsibleProperties() if property_type == GLOBAL_TYPE: - ansible_properties.set_property(key, value) + ansible_properties.set_property(property_dict) elif property_type == GROUP_TYPE: - ansible_properties.set_group_property(key, value, change_set) + ansible_properties.set_group_property(property_dict, change_set) else: - ansible_properties.set_host_property(key, value, change_set) + ansible_properties.set_host_property(property_dict, change_set)
    -
    [docs] def property_clear(self, key, property_type=GLOBAL_TYPE, +
    [docs] def property_clear(self, property_list, property_type=GLOBAL_TYPE, change_set=None): """Clear a property - :param key: property key - :type key: string + :param property_list: property list + :type property_list: list :param property_type: one of 'global', 'group' or 'host' :type property_type: string :param change_set: for group or host clears this is the list of @@ -158,8 +157,9 @@ :type change_set: list of strings """ - check_arg(key, u._('Property Key'), str) - key = safe_decode(key) + check_arg(property_list, u._('Property List'), list) + property_list = safe_decode(property_list) + self._check_type(property_type) if property_type is not GLOBAL_TYPE: check_arg(change_set, u._('Change Set'), list, none_ok=True) @@ -168,11 +168,11 @@ ansible_properties = AnsibleProperties() if property_type == GLOBAL_TYPE: - ansible_properties.clear_property(key) + ansible_properties.clear_property(property_list) elif property_type == GROUP_TYPE: - ansible_properties.clear_group_property(key, change_set) + ansible_properties.clear_group_property(property_list, change_set) else: - ansible_properties.clear_host_property(key, change_set) + ansible_properties.clear_host_property(property_list, change_set)
    [docs] def property_get(self, property_type=GLOBAL_TYPE, get_set=None): """Returns a list of Property objects @@ -245,7 +245,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/service.html b/doc/build/html/_modules/kollacli/api/service.html index 3451f6d..447dc85 100644 --- a/doc/build/html/_modules/kollacli/api/service.html +++ b/doc/build/html/_modules/kollacli/api/service.html @@ -6,7 +6,7 @@ - kollacli.api.service — kollacli 1.0.0.dev386 documentation + kollacli.api.service — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -204,7 +204,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/api/support.html b/doc/build/html/_modules/kollacli/api/support.html index f579773..1ff6c49 100644 --- a/doc/build/html/_modules/kollacli/api/support.html +++ b/doc/build/html/_modules/kollacli/api/support.html @@ -6,7 +6,7 @@ - kollacli.api.support — kollacli 1.0.0.dev386 documentation + kollacli.api.support — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -153,7 +153,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/deploy.html b/doc/build/html/_modules/kollacli/commands/deploy.html index 4956813..f63e5b4 100644 --- a/doc/build/html/_modules/kollacli/commands/deploy.html +++ b/doc/build/html/_modules/kollacli/commands/deploy.html @@ -6,7 +6,7 @@ - kollacli.commands.deploy — kollacli 1.0.0.dev386 documentation + kollacli.commands.deploy — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -193,7 +193,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/exceptions.html b/doc/build/html/_modules/kollacli/commands/exceptions.html index cafad62..3d0977f 100644 --- a/doc/build/html/_modules/kollacli/commands/exceptions.html +++ b/doc/build/html/_modules/kollacli/commands/exceptions.html @@ -6,7 +6,7 @@ - kollacli.commands.exceptions — kollacli 1.0.0.dev386 documentation + kollacli.commands.exceptions — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -104,7 +104,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/group.html b/doc/build/html/_modules/kollacli/commands/group.html index cd10be4..064f91f 100644 --- a/doc/build/html/_modules/kollacli/commands/group.html +++ b/doc/build/html/_modules/kollacli/commands/group.html @@ -6,7 +6,7 @@ - kollacli.commands.group — kollacli 1.0.0.dev386 documentation + kollacli.commands.group — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -280,7 +280,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/host.html b/doc/build/html/_modules/kollacli/commands/host.html index 854ddc6..119a37f 100644 --- a/doc/build/html/_modules/kollacli/commands/host.html +++ b/doc/build/html/_modules/kollacli/commands/host.html @@ -6,7 +6,7 @@ - kollacli.commands.host — kollacli 1.0.0.dev386 documentation + kollacli.commands.host — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -379,7 +379,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/password.html b/doc/build/html/_modules/kollacli/commands/password.html index 19afccb..0998321 100644 --- a/doc/build/html/_modules/kollacli/commands/password.html +++ b/doc/build/html/_modules/kollacli/commands/password.html @@ -6,7 +6,7 @@ - kollacli.commands.password — kollacli 1.0.0.dev386 documentation + kollacli.commands.password — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -168,7 +168,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/property.html b/doc/build/html/_modules/kollacli/commands/property.html index d873557..d4ccc35 100644 --- a/doc/build/html/_modules/kollacli/commands/property.html +++ b/doc/build/html/_modules/kollacli/commands/property.html @@ -6,7 +6,7 @@ - kollacli.commands.property — kollacli 1.0.0.dev386 documentation + kollacli.commands.property — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -103,6 +103,8 @@ try: property_name = parsed_args.propertyname.strip() property_value = parsed_args.propertyvalue.strip() + property_dict = {} + property_dict[property_name] = property_value if parsed_args.hosts: if parsed_args.groups: @@ -112,16 +114,16 @@ host_names = _get_names(parsed_args.hosts) - CLIENT.property_set(property_name, property_value, + CLIENT.property_set(property_dict, 'host', host_names) elif parsed_args.groups: group_names = _get_names(parsed_args.groups) - CLIENT.property_set(property_name, property_value, + CLIENT.property_set(property_dict, 'group', group_names) else: - CLIENT.property_set(property_name, property_value, + CLIENT.property_set(property_dict, 'global') except Exception: @@ -146,6 +148,8 @@
    [docs] def take_action(self, parsed_args): try: property_name = parsed_args.propertyname.strip() + property_list = [] + property_list.append(property_name) if parsed_args.hosts: if parsed_args.groups: @@ -155,15 +159,15 @@ host_names = _get_names(parsed_args.hosts) - CLIENT.property_clear(property_name, 'host', + CLIENT.property_clear(property_list, 'host', host_names) elif parsed_args.groups: group_names = _get_names(parsed_args.groups) - CLIENT.property_clear(property_name, 'group', + CLIENT.property_clear(property_list, 'group', group_names) else: - CLIENT.property_clear(property_name, 'global') + CLIENT.property_clear(property_list, 'global') except Exception: raise Exception(traceback.format_exc()) @@ -342,7 +346,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/service.html b/doc/build/html/_modules/kollacli/commands/service.html index 6196914..a8d4da5 100644 --- a/doc/build/html/_modules/kollacli/commands/service.html +++ b/doc/build/html/_modules/kollacli/commands/service.html @@ -6,7 +6,7 @@ - kollacli.commands.service — kollacli 1.0.0.dev386 documentation + kollacli.commands.service — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -209,7 +209,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/support.html b/doc/build/html/_modules/kollacli/commands/support.html index 4235064..098a9e7 100644 --- a/doc/build/html/_modules/kollacli/commands/support.html +++ b/doc/build/html/_modules/kollacli/commands/support.html @@ -6,7 +6,7 @@ - kollacli.commands.support — kollacli 1.0.0.dev386 documentation + kollacli.commands.support — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -119,7 +119,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/commands/upgrade.html b/doc/build/html/_modules/kollacli/commands/upgrade.html index 57e20e2..2320c2c 100644 --- a/doc/build/html/_modules/kollacli/commands/upgrade.html +++ b/doc/build/html/_modules/kollacli/commands/upgrade.html @@ -6,7 +6,7 @@ - kollacli.commands.upgrade — kollacli 1.0.0.dev386 documentation + kollacli.commands.upgrade — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -132,7 +132,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/ansible/actions.html b/doc/build/html/_modules/kollacli/common/ansible/actions.html index 1339e6f..048cebe 100644 --- a/doc/build/html/_modules/kollacli/common/ansible/actions.html +++ b/doc/build/html/_modules/kollacli/common/ansible/actions.html @@ -6,7 +6,7 @@ - kollacli.common.ansible.actions — kollacli 1.0.0.dev386 documentation + kollacli.common.ansible.actions — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -300,7 +300,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/ansible/job.html b/doc/build/html/_modules/kollacli/common/ansible/job.html index 6ae34e8..5b7d313 100644 --- a/doc/build/html/_modules/kollacli/common/ansible/job.html +++ b/doc/build/html/_modules/kollacli/common/ansible/job.html @@ -6,7 +6,7 @@ - kollacli.common.ansible.job — kollacli 1.0.0.dev386 documentation + kollacli.common.ansible.job — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -64,6 +64,7 @@ import json import logging import os +import pwd import subprocess # nosec import tempfile import time @@ -72,6 +73,12 @@ from kollacli.common.inventory import remove_temp_inventory from kollacli.common.utils import get_admin_uids +from kollacli.common.utils import get_admin_user +from kollacli.common.utils import get_ansible_lock_path +from kollacli.common.utils import get_kolla_actions_path +from kollacli.common.utils import Lock +from kollacli.common.utils import PidManager +from kollacli.common.utils import run_cmd from kollacli.common.utils import safe_decode LOG = logging.getLogger(__name__) @@ -106,9 +113,20 @@ self._process_std_err = None self._errors = [] self._cmd_output = '' + self._kill_uname = None + self._ansible_lock = Lock(get_ansible_lock_path(), 'ansible_job')
    [docs] def run(self): try: + locked = self._ansible_lock.wait_acquire() + if not locked: + raise Exception( + u._('unable to run ansible job {cmd} ' + 'as we couldn\'t get lock held by {owner}:{pid}.') + .format(cmd=self._command, + owner=self._ansible_lock.current_owner, + pid=self._ansible_lock.current_pid)) + # create and open named pipe, must be owned by kolla group os.mkfifo(self._fifo_path, 0o660) _, grp_id = get_admin_uids() @@ -122,6 +140,7 @@ stderr=subprocess.PIPE) # setup stdout to be read without blocking + LOG.debug('process pid: %s' % self._process.pid) flags = fcntl.fcntl(self._process.stdout, fcntl.F_GETFL) fcntl.fcntl(self._process.stdout, fcntl.F_SETFL, (flags | os.O_NONBLOCK)) @@ -148,6 +167,7 @@ - None: running - 0: done, success - 1: done, error + - 2: done, killed by user """ status = self._process.poll() self._read_from_callback() @@ -155,9 +175,15 @@ self._cmd_output = ''.join([self._cmd_output, out]) if status is not None: # job has completed - status = self._process.returncode - if status != 0: - status = 1 + if self._kill_uname: + status = 2 + msg = (u._('Job killed by user ({name})') + .format(name=self._kill_uname)) + self._errors = [msg] + else: + status = self._process.returncode + if status != 0: + status = 1 if not self._process_std_err: # read stderr from process std_err = self._read_stream(self._process.stderr) @@ -182,6 +208,31 @@ get final output text from command execution """ return self._cmd_output +
    +
    [docs] def kill(self): + """kill job in progress + + The process pid is owned by root, so + that is not killable. Need to kill all its children. + """ + # the kill must be run as the kolla user so the + # kolla_actions program must be used. + actions_path = get_kolla_actions_path() + kolla_user = get_admin_user() + cmd_prefix = ('/usr/bin/sudo -u %s %s job -t -p ' + % (kolla_user, actions_path)) + + # kill the children from largest to smallest pids. + child_pids = PidManager.get_child_pids(self._process.pid) + for child_pid in sorted(child_pids, reverse=True): + cmd = ''.join([cmd_prefix, child_pid]) + err_msg, output = run_cmd(cmd, print_output=False) + if err_msg: + LOG.debug('kill failed: %s %s' % (err_msg, output)) + + # record the name of user who killed the job + cur_uid = os.getuid() + self._kill_uname = pwd.getpwuid(cur_uid)[0]
    def _read_stream(self, stream): out = '' @@ -207,13 +258,18 @@ - close stdout and stderr - close and delete named pipe (fifo) """ + # try to clear the ansible lock + self._ansible_lock.release() + # delete temp inventory file remove_temp_inventory(self._temp_inv_path) # close the process's stdout and stderr streams - if self._process.stdout and not self._process.stdout.closed: + if (self._process and self._process.stdout and not + self._process.stdout.closed): self._process.stdout.close() - if self._process.stderr and not self._process.stderr.closed: + if (self._process and self._process.stderr and not + self._process.stderr.closed): self._process.stderr.close() # close and delete the named pipe (fifo) @@ -329,7 +385,7 @@ if sub_errs: err_msg = ''.join([err_msg, ' [', sub_errs, ']']) - if not err_msg: + if not err_msg or not err_msg.strip(): # sometimes the error message is in std_out # eg- "stdout": 'localhost | FAILED! => {"changed": false, # "failed": true, "msg": "...msg..."}' @@ -340,6 +396,12 @@ if not err_msg: err_msg = stdout + if not err_msg or not err_msg.strip(): + # if still no err_msg, provide entire result + try: + err_msg = json.dumps(results) + except Exception as e: + LOG.debug('unable to convert results to string' % str(e)) msg = ('Host: %s, Task: %s, Status: %s, Message: %s' % (host, taskname, status, err_msg)) return msg @@ -417,7 +479,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/ansible/playbook.html b/doc/build/html/_modules/kollacli/common/ansible/playbook.html index b0f27ee..25a4b58 100644 --- a/doc/build/html/_modules/kollacli/common/ansible/playbook.html +++ b/doc/build/html/_modules/kollacli/common/ansible/playbook.html @@ -6,7 +6,7 @@ - kollacli.common.ansible.playbook — kollacli 1.0.0.dev386 documentation + kollacli.common.ansible.playbook — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -91,11 +91,9 @@ deploy_id = None inventory = None - def __init__(self): - self.inventory = Inventory.load() -
    [docs] def run(self): try: + self.inventory = Inventory.load() inventory_path = self._make_temp_inventory() cmd = self._get_playbook_cmd(inventory_path) self._log_ansible_cmd(cmd, inventory_path) @@ -229,7 +227,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/inventory.html b/doc/build/html/_modules/kollacli/common/inventory.html index 4c56697..fe22e69 100644 --- a/doc/build/html/_modules/kollacli/common/inventory.html +++ b/doc/build/html/_modules/kollacli/common/inventory.html @@ -6,7 +6,7 @@ - kollacli.common.inventory — kollacli 1.0.0.dev386 documentation + kollacli.common.inventory — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -994,7 +994,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/passwords.html b/doc/build/html/_modules/kollacli/common/passwords.html index 0fe1d95..db1d5e3 100644 --- a/doc/build/html/_modules/kollacli/common/passwords.html +++ b/doc/build/html/_modules/kollacli/common/passwords.html @@ -6,7 +6,7 @@ - kollacli.common.passwords — kollacli 1.0.0.dev386 documentation + kollacli.common.passwords — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -68,7 +68,6 @@ from kollacli.common import utils PWDS_FILENAME = 'passwords.yml' -PWD_EDITOR_FILENAME = 'passwd_editor.py'
    [docs]def set_password(pwd_key, pwd_value): @@ -110,14 +109,12 @@
    def _get_cmd_prefix(): - editor_path = os.path.join(utils.get_kollacli_home(), - 'tools', - PWD_EDITOR_FILENAME) + actions_path = utils.get_kolla_actions_path() pwd_file_path = os.path.join(utils.get_kolla_etc(), PWDS_FILENAME) user = utils.get_admin_user() - prefix = '/usr/bin/sudo -u %s %s -p %s ' % (user, - editor_path, pwd_file_path) + prefix = ('/usr/bin/sudo -u %s %s password -p %s ' + % (user, actions_path, pwd_file_path)) return prefix @@ -152,7 +149,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/properties.html b/doc/build/html/_modules/kollacli/common/properties.html index bb73d38..77e1b0b 100644 --- a/doc/build/html/_modules/kollacli/common/properties.html +++ b/doc/build/html/_modules/kollacli/common/properties.html @@ -6,7 +6,7 @@ - kollacli.common.properties — kollacli 1.0.0.dev386 documentation + kollacli.common.properties — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -60,6 +60,7 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. +import copy import logging import os import six @@ -291,14 +292,14 @@ new_contents[key] = value return new_contents -
    [docs] def set_property(self, property_key, property_value): +
    [docs] def set_property(self, property_dict): try: - change_property(self.globals_path, property_key, - property_value, clear=False) + change_property(self.globals_path, property_dict, + clear=False) except Exception as e: raise e
    -
    [docs] def set_host_property(self, property_key, property_value, hosts): +
    [docs] def set_host_property(self, property_dict, hosts): # if hosts is None set the property on all hosts inventory = Inventory.load() host_list = [] @@ -313,12 +314,12 @@ try: for host in host_list: file_path = os.path.join(get_host_vars_dir(), host.name) - change_property(file_path, property_key, - property_value, clear=False) + change_property(file_path, property_dict, + clear=False) except Exception as e: raise e
    -
    [docs] def set_group_property(self, property_key, property_value, groups): +
    [docs] def set_group_property(self, property_dict, groups): # if groups is None set the property on all hosts inventory = Inventory.load() group_list = [] @@ -332,20 +333,22 @@ group_list.append(group) try: for group in group_list: + tmp_dict = copy.copy(property_dict) file_path = os.path.join(get_group_vars_dir(), group.name) - change_property(file_path, property_key, - property_value, clear=False) + change_property(file_path, tmp_dict, + clear=False) except Exception as e: raise e
    -
    [docs] def clear_property(self, property_key): +
    [docs] def clear_property(self, property_list): try: - change_property(self.globals_path, property_key, - None, clear=True) + change_property(self.globals_path, + self._list_to_dict(property_list), + clear=True) except Exception as e: raise e
    -
    [docs] def clear_host_property(self, property_key, hosts): +
    [docs] def clear_host_property(self, property_list, hosts): # if hosts is None set the property on all hosts inventory = Inventory.load() host_list = [] @@ -360,12 +363,12 @@ try: for host in host_list: file_path = os.path.join(get_host_vars_dir(), host.name) - change_property(file_path, property_key, - None, clear=True) + change_property(file_path, self._list_to_dict(property_list), + clear=True) except Exception as e: raise e
    -
    [docs] def clear_group_property(self, property_key, groups): +
    [docs] def clear_group_property(self, property_list, groups): # if hosts is None set the property on all hosts inventory = Inventory.load() group_list = [] @@ -380,12 +383,18 @@ try: for group in group_list: file_path = os.path.join(get_group_vars_dir(), group.name) - change_property(file_path, property_key, - None, clear=True) + change_property(file_path, self._list_to_dict(property_list), + clear=True) except Exception as e: raise e +
    + def _list_to_dict(self, property_list): + property_dict = {} + for key in property_list: + property_dict[key] = '' + return property_dict -
    +
    [docs]class AnsibleProperty(object): def __init__(self, name, value, file_name, overrides=False, @@ -438,7 +447,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/sshutils.html b/doc/build/html/_modules/kollacli/common/sshutils.html index c07b5e7..97b174d 100644 --- a/doc/build/html/_modules/kollacli/common/sshutils.html +++ b/doc/build/html/_modules/kollacli/common/sshutils.html @@ -6,7 +6,7 @@ - kollacli.common.sshutils — kollacli 1.0.0.dev386 documentation + kollacli.common.sshutils — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -176,7 +176,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/support.html b/doc/build/html/_modules/kollacli/common/support.html index 64d221b..b4f8f9a 100644 --- a/doc/build/html/_modules/kollacli/common/support.html +++ b/doc/build/html/_modules/kollacli/common/support.html @@ -6,7 +6,7 @@ - kollacli.common.support — kollacli 1.0.0.dev386 documentation + kollacli.common.support — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -315,7 +315,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/common/utils.html b/doc/build/html/_modules/kollacli/common/utils.html index a0eab90..75bef6f 100644 --- a/doc/build/html/_modules/kollacli/common/utils.html +++ b/doc/build/html/_modules/kollacli/common/utils.html @@ -6,7 +6,7 @@ - kollacli.common.utils — kollacli 1.0.0.dev386 documentation + kollacli.common.utils — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -60,6 +60,8 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. +import copy +import fcntl import grp import logging import os @@ -104,6 +106,14 @@
    [docs]def get_kolla_log_dir(): return '/var/log/kolla/' +
    +
    [docs]def get_ansible_lock_path(): + return os.path.join(get_kollacli_etc(), 'ansible/ansible.lock') + +
    +
    [docs]def get_kolla_actions_path(): + return os.path.join(get_kollacli_home(), 'tools', 'kolla_actions.py') +
    [docs]def get_admin_uids(): """get uid and gid of admin user""" @@ -216,12 +226,11 @@ return err, output
    -
    [docs]def change_property(file_path, property_key, property_value, clear=False): +
    [docs]def change_property(file_path, property_dict, clear=False): """change property with a file file_path: path to property file - property_key: property name - property value: property value + property_dict: dictionary of property names and values clear: flag to remove property If clear, and property exists, remove it from the property file. @@ -230,6 +239,7 @@ If not clear, and key is found, edit property in place. """ try: + cloned_dict = copy.copy(property_dict) group_info = grp.getgrnam('kolla') if not os.path.exists(file_path): with open(file_path, 'a'): @@ -239,8 +249,6 @@ new_contents = [] read_data = sync_read_file(file_path) lines = read_data.split('\n') - new_line = '%s: "%s"' % (property_key, property_value) - property_key_found = False last_line_empty = False for line in lines: line = line.rstrip() @@ -257,17 +265,21 @@ if len(split_line) > 1: split_key = split_line[0] split_key.rstrip() - if split_key == property_key: - property_key_found = True + if split_key in cloned_dict: if clear: # clear existing property continue # edit existing property - line = new_line + line = '%s: "%s"' % (split_key, cloned_dict[split_key]) + # clear out the key after we are done, all existing keys + # will be appended at the end (or for clear, ignored) + del cloned_dict[split_key] new_contents.append(line) - if not property_key_found and not clear: - # add new property to file - new_contents.append(new_line) + if not clear: + # add new properties to file + for key, value in cloned_dict.items(): + line = '%s: "%s"' % (key, value) + new_contents.append(line) write_data = '\n'.join(new_contents) sync_write_file(file_path, write_data) @@ -283,14 +295,13 @@ """ lock = None try: - lock = Lock(path + '.lock', 'sync_read') - locked = lock.wait_acquire(10) + lock = Lock(path, 'sync_read') + locked = lock.wait_acquire() if not locked: raise Exception( u._('unable to read file {path} ' - 'as it was locked by {owner}:{pid}.') - .format(path=path, owner=lock.current_owner, - pid=lock.current_pid)) + 'as it was locked.') + .format(path=path)) with open(path, mode) as data_file: data = data_file.read() except Exception as e: @@ -298,34 +309,44 @@ finally: if lock: lock.release() - return data + return safe_decode(data)
    [docs]def sync_write_file(path, data, mode='w'): """synchronously write file""" + ansible_lock = None lock = None try: - lock = Lock(path + '.lock', 'sync_write') - locked = lock.wait_acquire(10) + ansible_lock = Lock(get_ansible_lock_path(), 'sync_write') + locked = ansible_lock.wait_acquire() + if not locked: + raise Exception( + u._('unable to get ansible lock while writing to {path} ' + 'as it was locked.') + .format(path=path)) + + lock = Lock(path, 'sync_write') + locked = lock.wait_acquire() if not locked: raise Exception( u._('unable to write file {path} ' - 'as it was locked by {owner}:{pid}.') - .format(path=path, owner=lock.current_owner, - pid=lock.current_pid)) + 'as it was locked.') + .format(path=path)) with open(path, mode) as data_file: data_file.write(data) except Exception as e: raise e finally: + if ansible_lock: + ansible_lock.release() if lock: lock.release()
    [docs]def safe_decode(obj_to_decode): - """Convert bytes or string to unicode string + """Convert bytes or strings to unicode string - Convert either a string or list of strings to + Converts strings, lists, or dictionaries to unicode. """ if obj_to_decode is None: @@ -335,12 +356,15 @@ if isinstance(obj_to_decode, list): new_obj = [] for text in obj_to_decode: - try: - text = text.decode('utf-8') - except AttributeError: # nosec - # py3 will raise if text is already a string - pass + text = safe_decode(text) new_obj.append(text) + elif isinstance(obj_to_decode, dict): + new_obj = {} + for key, value in obj_to_decode.items(): + key = safe_decode(key) + value = safe_decode(value) + new_obj[key] = value + else: try: new_obj = obj_to_decode.decode('utf-8') @@ -381,29 +405,52 @@
    [docs]class Lock(object): + """Object which represents an exclusive resource lock - def __init__(self, lockpath, owner='unknown owner'): + flock usage is the default behavior but a separate pidfile mechanism + is also available. flock doesn't have the same orphaned lock issue + that pidfile usage does. both need to be tests on NFS. if flock + works then it seems better / less complicated for our needs. + """ + + def __init__(self, lockpath, owner='unknown owner', use_flock=True): self.lockpath = lockpath self.pid = str(os.getpid()) + self.fd = None self.owner = owner self.current_pid = -1 self.current_owner = '' + self.use_flock = use_flock
    [docs] def acquire(self): - if not self.is_owned_by_me(): try: - fd = os.open(self.lockpath, os.O_CREAT | os.O_EXCL | os.O_RDWR) - with os.fdopen(fd, 'a') as f: - f.write(self.pid + '\n' + self.owner) - return self.is_owned_by_me() + if self.use_flock: + return self._acquire_flock() + else: + return self._acquire_pidfile() except Exception as e: + if not os.path.exists(self.lockpath): + raise Exception('Lock file (%s) is missing' + % self.lockpath) + # it is ok to fail to acquire, we just return that we failed - LOG.debug('Exception in is_owned_by_me lock check ' + LOG.debug('Exception in acquire lock. ' 'path: %s pid: %s owner: %s error: %s' % (self.lockpath, self.pid, self.owner, str(e))) - return False
    -
    [docs] def wait_acquire(self, wait_duration, interval=0.1): + def _acquire_pidfile(self): + if not self.is_owned_by_me(): + fd = os.open(self.lockpath, os.O_CREAT | os.O_EXCL | os.O_RDWR) + with os.fdopen(fd, 'a') as f: + f.write(self.pid + '\n' + self.owner) + return self.is_owned_by_me() + + def _acquire_flock(self): + self.fd = os.open(self.lockpath, os.O_RDWR) + fcntl.flock(self.fd, fcntl.LOCK_EX | fcntl.LOCK_NB) + return True + +
    [docs] def wait_acquire(self, wait_duration=3, interval=0.1): wait_time = 0 while (wait_time < wait_duration): if not self.acquire(): @@ -416,7 +463,14 @@
    [docs] def is_owned_by_me(self): """Returns True if we own the lock or False otherwise""" try: - fd = os.open(self.lockpath, os.O_RDWR) + if self.use_flock: + raise Exception(u._('Invalid use of is_owned_by_me while' + 'using flock')) + + if not os.path.exists(self.lockpath): + # lock doesn't exist, just return + return False + fd = os.open(self.lockpath, os.O_RDONLY) with os.fdopen(fd, 'r') as f: contents = f.read(2048).strip().split('\n') if len(contents) > 0: @@ -430,25 +484,61 @@ return False except Exception as e: # it is ok to fail to acquire, we just return that we failed - LOG.debug('Exception in is_owned_by_me lock check ' + LOG.debug('Exception in is_owned_by_me lock check. ' 'path: %s pid: %s owner: %s error: %s' % (self.lockpath, self.pid, self.owner, str(e))) return False
    [docs] def release(self): + try: + if self.use_flock: + self._release_flock() + else: + self._release_pidfile() + except Exception: + # this really shouldn't happen unless for some reason + # two areas in the same process try to release the lock + # at the same time and if that happens you want to see + # an error about it + LOG.error('Error releasing lock', exc_info=True) + return False +
    + def _release_pidfile(self): if self.is_owned_by_me(): - try: - os.remove(self.lockpath) - return True - except Exception: - # this really shouldn't happen unless for some reason - # two areas in the same process try to release the lock - # at the same time and if that happens you want to see - # an error about it - LOG.error('Error releasing lock', exc_info=True) - return False - else: - return False
    + os.remove(self.lockpath) + return True + + def _release_flock(self): + fcntl.flock(self.fd, fcntl.LOCK_UN) + os.close(self.fd) + return True + +
    +
    [docs]class PidManager(object): + @staticmethod +
    [docs] def get_child_pids(pid, child_pids=[]): + """get child pids of parent pid""" + # This ps command will return child pids of parent pid, separated by + # newlines. + err_msg, output = run_cmd('ps --ppid %s -o pid=""' % pid, + print_output=False) + + # err_msg is expected when pid has no children + if not err_msg: + output = output.strip() + + if '\n' in output: + ps_pids = output.split('\n') + else: + ps_pids = [output] + + if ps_pids: + child_pids.extend(ps_pids) + + # recurse through children to get all child pids + for ps_pid in ps_pids: + PidManager.get_child_pids(ps_pid, child_pids) + return child_pids
    @@ -482,7 +572,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/_modules/kollacli/shell.html b/doc/build/html/_modules/kollacli/shell.html index 3c744fd..5f9d66d 100644 --- a/doc/build/html/_modules/kollacli/shell.html +++ b/doc/build/html/_modules/kollacli/shell.html @@ -6,7 +6,7 @@ - kollacli.shell — kollacli 1.0.0.dev386 documentation + kollacli.shell — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • @@ -70,10 +70,9 @@ import kollacli.i18n as u +from kollacli.api.client import ClientApi from kollacli.commands.exceptions import CommandError from kollacli.common.inventory import INVENTORY_PATH -from kollacli.common.utils import get_kolla_log_dir -from kollacli.common.utils import get_kolla_log_file_size from kollacli.common.utils import get_kollacli_etc LOG = logging.getLogger(__name__) @@ -96,43 +95,16 @@ 'recreate the file.').format(inventory=inventory_path) raise CommandError(err_string) - # check that current user can access the inventory file - inventory_file = None - try: - inventory_file = open(inventory_path, 'r+') - except Exception: - raise CommandError( - u._('Permission denied to run the kollacli.\n' - 'Please add user to the kolla group and ' - 'then log out and back in.')) - finally: - if inventory_file and inventory_file.close is False: - inventory_file.close() + # set up logging and test that user running shell is part + # of kolla group + ClientApi() # paramiko log is very chatty, tune it down logging.getLogger('paramiko').setLevel(logging.WARNING) - # set up logging - self.rotating_log_dir = get_kolla_log_dir() - self.max_bytes = get_kolla_log_file_size() - self.backup_count = 4 - self.dump_stack_trace = False - self.add_rotational_log() - -
    [docs] def add_rotational_log(self): - root_logger = logging.getLogger('') - rotate_handler = logging.handlers.RotatingFileHandler( - os.path.join(self.rotating_log_dir, 'kolla.log'), - maxBytes=self.max_bytes, - backupCount=self.backup_count) - formatter = logging.Formatter(self.LOG_FILE_MESSAGE_FORMAT) - rotate_handler.setFormatter(formatter) - rotate_handler.setLevel(logging.INFO) - root_logger.addHandler(rotate_handler) - -
    +
    [docs]def main(argv=sys.argv[1:]): shell = KollaCli() return shell.run(argv) @@ -172,7 +144,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
  • Module code »
    • diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html index db01270..f45734d 100644 --- a/doc/build/html/genindex.html +++ b/doc/build/html/genindex.html @@ -7,7 +7,7 @@ - Index — kollacli 1.0.0.dev386 documentation + Index — kollacli 1.0.0.dev396 documentation @@ -15,7 +15,7 @@ - +
    @@ -36,7 +36,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • @@ -113,10 +113,6 @@ -
    add_rotational_log() (kollacli.shell.KollaCli method) -
    - -
    add_service() (kollacli.api.group.GroupApi.Group method)
    @@ -313,6 +309,12 @@ + + -
    +
    enable_console_logging() (kollacli.api.client.ClientApi method) +
    + +
    +
    extra_vars (kollacli.common.ansible.playbook.AnsiblePlaybook attribute)
    @@ -375,6 +377,14 @@ +
    get_ansible_lock_path() (in module kollacli.common.utils) +
    + + +
    get_child_pids() (kollacli.common.utils.PidManager static method) +
    + +
    get_children() (kollacli.api.service.ServiceApi.Service method)
    @@ -481,6 +491,10 @@
    +
    get_kolla_actions_path() (in module kollacli.common.utils) +
    + +
    get_kolla_etc() (in module kollacli.common.utils)
    @@ -504,6 +518,8 @@
    get_kollacli_home() (in module kollacli.common.utils)
    +
    get_log() (kollacli.common.support.HostLogs method)
    @@ -512,8 +528,6 @@
    get_logs() (in module kollacli.common.support)
    -
    get_name() (kollacli.api.group.GroupApi.Group method)
    @@ -901,6 +915,16 @@ + - - + @@ -646,6 +658,12 @@ The uname entry is optional.

    +
    kill() (kollacli.api.job.Job method) +
    + +
    + +
    (kollacli.common.ansible.job.AnsibleJob method) +
    + +
    +
    KollaCli (class in kollacli.shell)
    @@ -972,12 +996,12 @@
    kollacli.commands.group (module)
    +
    kollacli.commands.host (module)
    -
    kollacli.commands.password (module)
    @@ -1141,6 +1165,10 @@ +
    PidManager (class in kollacli.common.utils) +
    + +
    playbook_path (kollacli.common.ansible.playbook.AnsiblePlaybook attribute)
    @@ -1669,7 +1697,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • diff --git a/doc/build/html/index.html b/doc/build/html/index.html index 3a62d88..e41626e 100644 --- a/doc/build/html/index.html +++ b/doc/build/html/index.html @@ -6,7 +6,7 @@ - Welcome to kollacli’s documentation! — kollacli 1.0.0.dev386 documentation + Welcome to kollacli’s documentation! — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
    @@ -35,7 +35,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • @@ -104,7 +104,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • diff --git a/doc/build/html/kollacli.api.html b/doc/build/html/kollacli.api.html index cb7f0f9..e1fa765 100644 --- a/doc/build/html/kollacli.api.html +++ b/doc/build/html/kollacli.api.html @@ -6,7 +6,7 @@ - kollacli.api package — kollacli 1.0.0.dev386 documentation + kollacli.api package — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
    @@ -35,7 +35,7 @@
  • modules |
    • -
  • kollacli 1.0.0.dev386 documentation »
    • +
  • kollacli 1.0.0.dev396 documentation »
    • @@ -160,6 +160,15 @@ already been deployed to. base_call()[source]
    +
    +
    +enable_console_logging(level, enable=True)[source]
    +

    enable/disable console logging for the api

    +

    enable: True/False +level: logging.INFO, logging.DEBUG, logging.WARNING, +logging.CRITICAL...

    +
    + @@ -638,7 +647,10 @@ The uname entry is optional.
    Returns:None if job still running, 0 if job succeeded, 1 if job failed
    Returns:None: job is still running +0: job succeeded +1: job failed +2: job killed by user
    Return type:int or None
    +
    +
    +kill()[source]
    +

    kill the job

    +
    +
    wait()[source]
    @@ -753,14 +771,14 @@ The uname entry is optional.

    -PropertyApi.property_clear(key, property_type='global', change_set=None)[source]
    +PropertyApi.property_clear(property_list, property_type='global', change_set=None)[source]

    Clear a property

    Parameters:
      -
    • key (string) – property key
      • +
    • property_list (list) – property list
    • property_type (string) – one of ‘global’, ‘group’ or ‘host’
    • change_set (list of strings) – for group or host clears this is the list of groups or hosts to clear the property for
      • @@ -798,15 +816,14 @@ getting group or host related property lists
      -PropertyApi.property_set(key, value, property_type='global', change_set=None)[source]
      +PropertyApi.property_set(property_dict, property_type='global', change_set=None)[source]

      Set a property

      Parameters:
        -
      • key (string) – property key
        • -
      • value (string) – property value
        • +
      • property_dict (dictionary) – property dictionary containing key / values
      • property_type (string) – one of ‘global’, ‘group’ or ‘host’
      • change_set (list of strings) – for group or host sets this is the list of groups or hosts to set the property for
        • @@ -1081,7 +1098,7 @@ names for each log will be servicename_id.log.

      • modules |
        • -
      • kollacli 1.0.0.dev386 documentation »
        • +
      • kollacli 1.0.0.dev396 documentation »
      diff --git a/doc/build/html/kollacli.commands.html b/doc/build/html/kollacli.commands.html index 452dafe..a726216 100644 --- a/doc/build/html/kollacli.commands.html +++ b/doc/build/html/kollacli.commands.html @@ -6,7 +6,7 @@ - kollacli.commands package — kollacli 1.0.0.dev386 documentation + kollacli.commands package — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
      @@ -35,7 +35,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -601,7 +601,7 @@ debugging problems.

    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/kollacli.common.ansible.html b/doc/build/html/kollacli.common.ansible.html index 7194a0e..0d48954 100644 --- a/doc/build/html/kollacli.common.ansible.html +++ b/doc/build/html/kollacli.common.ansible.html @@ -6,7 +6,7 @@ - kollacli.common.ansible package — kollacli 1.0.0.dev386 documentation + kollacli.common.ansible package — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
      @@ -35,7 +35,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -104,7 +104,16 @@ which can either be ‘stop’ or ‘kill’.

      status: - None: running - 0: done, success -- 1: done, error

      +- 1: done, error +- 2: done, killed by user

      + + +
      +
      +kill()[source]
      +

      kill job in progress

      +

      The process pid is owned by root, so +that is not killable. Need to kill all its children.

      @@ -250,7 +259,7 @@ which can either be ‘stop’ or ‘kill’.

    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/kollacli.common.html b/doc/build/html/kollacli.common.html index 32158d9..ee5b44c 100644 --- a/doc/build/html/kollacli.common.html +++ b/doc/build/html/kollacli.common.html @@ -6,7 +6,7 @@ - kollacli.common package — kollacli 1.0.0.dev386 documentation + kollacli.common package — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
      @@ -35,7 +35,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -568,17 +568,17 @@ If it doesn’t exist, a new password will be added.

      Bases: object

      -clear_group_property(property_key, groups)[source]
      +clear_group_property(property_list, groups)[source]
      -clear_host_property(property_key, hosts)[source]
      +clear_host_property(property_list, hosts)[source]
      -clear_property(property_key)[source]
      +clear_property(property_list)[source]
      @@ -618,17 +618,17 @@ If it doesn’t exist, a new password will be added.

      -set_group_property(property_key, property_value, groups)[source]
      +set_group_property(property_dict, groups)[source]
      -set_host_property(property_key, property_value, hosts)[source]
      +set_host_property(property_dict, hosts)[source]
      -set_property(property_key, property_value)[source]
      +set_property(property_dict)[source]
      @@ -721,8 +721,13 @@ debugging problems.

      kollacli.common.utils module

      -class kollacli.common.utils.Lock(lockpath, owner='unknown owner')[source]
      +class kollacli.common.utils.Lock(lockpath, owner='unknown owner', use_flock=True)[source]

      Bases: object

      +

      Object which represents an exclusive resource lock

      +

      flock usage is the default behavior but a separate pidfile mechanism +is also available. flock doesn’t have the same orphaned lock issue +that pidfile usage does. both need to be tests on NFS. if flock +works then it seems better / less complicated for our needs.

      acquire()[source]
      @@ -741,18 +746,29 @@ debugging problems.

      -wait_acquire(wait_duration, interval=0.1)[source]
      +wait_acquire(wait_duration=3, interval=0.1)[source]
      +
      +
      +class kollacli.common.utils.PidManager[source]
      +

      Bases: object

      +
      +
      +static get_child_pids(pid, child_pids=[])[source]
      +

      get child pids of parent pid

      +
      + +
      +
      -kollacli.common.utils.change_property(file_path, property_key, property_value, clear=False)[source]
      +kollacli.common.utils.change_property(file_path, property_dict, clear=False)[source]

      change property with a file

      file_path: path to property file -property_key: property name -property value: property value +property_dict: dictionary of property names and values clear: flag to remove property

      If clear, and property exists, remove it from the property file. If clear, and property doesn’t exists, nothing is done. @@ -793,6 +809,11 @@ python is py3, prefix the ansible command with a py2 interpreter.

      +
      +
      +kollacli.common.utils.get_ansible_lock_path()[source]
      +
      +
      kollacli.common.utils.get_group_vars_dir()[source]
      @@ -803,6 +824,11 @@ interpreter.

      kollacli.common.utils.get_host_vars_dir()[source]
      +
      +
      +kollacli.common.utils.get_kolla_actions_path()[source]
      +
      +
      kollacli.common.utils.get_kolla_etc()[source]
      @@ -865,8 +891,8 @@ interpreter.

      kollacli.common.utils.safe_decode(obj_to_decode)[source]
      -

      Convert bytes or string to unicode string

      -

      Convert either a string or list of strings to +

      Convert bytes or strings to unicode string

      +

      Converts strings, lists, or dictionaries to unicode.

      @@ -942,7 +968,7 @@ unicode.

    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/kollacli.html b/doc/build/html/kollacli.html index c314b44..812653a 100644 --- a/doc/build/html/kollacli.html +++ b/doc/build/html/kollacli.html @@ -6,7 +6,7 @@ - kollacli package — kollacli 1.0.0.dev386 documentation + kollacli package — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
      @@ -35,7 +35,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -118,11 +118,6 @@
      class kollacli.shell.KollaCli[source]

      Bases: cliff.app.App

      -
      -
      -add_rotational_log()[source]
      -
      -
      @@ -185,7 +180,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/modules.html b/doc/build/html/modules.html index c7c2c33..9fe319c 100644 --- a/doc/build/html/modules.html +++ b/doc/build/html/modules.html @@ -6,7 +6,7 @@ - kollacli — kollacli 1.0.0.dev386 documentation + kollacli — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - +
      @@ -35,7 +35,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -141,7 +141,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv index d782d55..adf30ea 100644 Binary files a/doc/build/html/objects.inv and b/doc/build/html/objects.inv differ diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html index dace9a9..8089a64 100644 --- a/doc/build/html/py-modindex.html +++ b/doc/build/html/py-modindex.html @@ -6,7 +6,7 @@ - Python Module Index — kollacli 1.0.0.dev386 documentation + Python Module Index — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -38,7 +38,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -273,7 +273,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/search.html b/doc/build/html/search.html index e80f2b1..98cefdc 100644 --- a/doc/build/html/search.html +++ b/doc/build/html/search.html @@ -6,7 +6,7 @@ - Search — kollacli 1.0.0.dev386 documentation + Search — kollacli 1.0.0.dev396 documentation @@ -14,7 +14,7 @@ - + @@ -43,7 +43,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • @@ -94,7 +94,7 @@
    • modules |
      • -
    • kollacli 1.0.0.dev386 documentation »
      • +
    • kollacli 1.0.0.dev396 documentation »
      • diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js index 147fb72..33fc8e0 100644 --- a/doc/build/html/searchindex.js +++ b/doc/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{all:[5,1,4],get_error_messag:[1,6],err_msg:4,groupadd:5,global:[1,4],host_list:4,remove_temp_inventori:4,prefix:4,dirnam:4,host_check_ssh:[],get_kolla_etc:4,children:4,prog_nam:5,create_json_gen_fil:4,logdata:4,service_get_al:1,host_add:1,sourc:[4,5,1,6,3],string:[1,4],fals:[1,6,4],invalidconfigur:1,set_remot:4,property_kei:4,util:[],sshutil:[],parentnam:1,level:1,cmd:[6,4],list:[5,1,4],check_arg:4,user_nam:[1,4],expected_typ:4,pwd_kei:4,asyncapi:1,base_cal:1,clear_var:4,append:4,index:0,sub:5,get_ansible_command:4,property_typ:1,current:4,delet:4,version:[1,4],directori:[1,4],"new":[1,4],ovr_host:1,file_path:4,serviceapi:1,get_admin_uid:4,gener:4,get_kolla_log_file_s:4,add_rotational_log:3,property_get:1,path:[1,4],valu:[1,6,4],wait:[1,6],precheck:6,search:0,ansibleplaybook:6,get_host_list:4,groupaddhost:5,action:[],chang:4,is_string_tru:4,via:1,modul:[],change_properti:4,api:[],ansible_job:1,"byte":4,select:1,from:[5,1,6,4],would:1,async_host_destroi:1,upgrad:[],destroy_host:6,remove_group_from_servic:4,usr:[5,1,4],msg:[1,4],type:1,more:[1,4],get_nam:1,relat:[5,1],flag:[5,4],get_hostnam:4,"0x3bf4710":[],none:[5,1,6,4],setup:[5,1,4],wait_dur:4,uniqu:4,histori:4,can:6,fetch:1,overrid:[1,4],hostvar:4,hostadd:5,tar:[5,1,4],process:6,lock:4,share:[5,1,4],get_parent_servicenam:4,hostssshcheckerror:1,serial:6,delete_sub_servic:4,propertyset:5,multipl:[1,4],ssh_check_host:4,net_addr:4,write:4,how:1,override_flag:1,clear_host_properti:4,grouplistservic:5,password_get_nam:1,get_groupnam:4,overridden:1,run_ansible_command:4,container_id:4,host_ssh_check:1,obj_nam:1,data:[5,1,4],lockpath:4,hostcheck:5,caus:4,inform:5,allow:4,help:[5,1,4],set_var:4,set_host_properti:4,still:1,paramet:1,group:[],uuid:4,run_cmd:4,async_host_precheck:1,main:3,"return":[1,6,4],thei:1,python:4,initi:4,extra_var:6,setdeploi:5,bar:4,get_par:1,ansible_properti:1,yml_path:[],host_get:1,"_meta":4,edit:4,load_group:[],unpickl:4,empty_ok:4,get_group_host:4,mode:[5,1,4],each:1,debug:[5,1,4],get_password_nam:4,unicod:4,complet:[1,6],get_group_vars_dir:4,groupaddservic:5,obj_typ:1,get_host_group:4,host_specific_var:4,hosts_info:[1,4],destroy_typ:[1,6],parsed_arg:5,connect:1,set_deploy_mod:4,the_str:4,out:4,class_vers:4,content:[],file_nam:[1,4],grouplisthost:5,argv:3,get_var:4,base:[4,5,1,6,3],dictionari:1,releas:4,groupremov:5,print_output:[6,4],propertyclear:5,get_sub_servic:4,synchron:4,get_property_list_length:4,filter:4,place:[1,4],hosterror:1,async_upgrad:1,setup_host:4,ansibleproperti:4,missingargu:1,invalidargu:1,propertylist:5,number:1,validate_servicenam:4,get_properti:4,"0x3a50b50":[],alreadi:1,done:[1,6,4],get_all_override_flag:4,owner:4,miss:1,get_kollacli_hom:4,parent_svc_nam:4,given:[5,1,4],lister:5,ansible_ssh_us:4,"0x2edba90":[],unknown:4,system:4,messag:[5,1,6,4],name:[5,1,4],async_deploi:1,lognam:4,too:1,"final":6,consol:1,option:[1,4],property_clear:1,add_host:[1,4],specifi:[5,1,6],get_kollacli_etc:4,sync_read_fil:4,filter_servic:4,target:[1,4],provid:5,remov:[5,1,4],"0x2758710":[],str:1,remove_servic:1,pre:1,get_yml_data:[],"0x281e1d0":[],py2:4,subservic:4,load_glob:[],ani:1,passwordset:5,fail:[1,4],argnam:1,have:1,ssh_setup_host:4,"0x430e490":[],engin:1,set_group_properti:4,destroi:[5,1,6],notininventori:1,example_vari:4,exampl:1,which:[1,6],command:[],noth:4,deploy:[5,1,4],usernam:4,object:[1,6,4],most:[5,1,4],deploy_set_mod:1,host_get_al:1,deploi:[],playbook_path:6,hostlog:4,"class":[4,5,1,6,3],orig_valu:[1,4],message_str:1,set_parent_servicenam:4,clear:[5,1,4],passwordlist:5,clear_properti:4,determin:6,get_command_output:6,text:6,verbos:1,playbook:[],dirpath:[1,4],clientexcept:1,access:1,onli:[5,4],acquir:4,async:[],group_get:1,configur:[5,1,4],dict:4,local:[5,1],is_owned_by_m:4,get:[1,6,4],get_host:[1,4],overrideflag:4,stop:[5,1,6],get_log:4,cannot:4,none_ok:4,ssh:[1,4],add_group_to_servic:4,deploy_id:6,serviceaddgroup:5,get_parent_service_nam:[],servicelistgroup:5,remove_host:[1,4],remot:[5,1],common:[],contain:[5,1,6,4],where:[1,4],set:[5,1,6,4],dump:[5,1,4],see:6,arg:[5,1],ovr_glob:1,add_groupnam:4,statu:[1,6],parent:[1,4],correctli:1,get_group:[1,4],property_set:1,convert_to_unicod:4,written:1,"0x2521f50":[],groupnam:[1,6,4],remove_json_gen_fil:4,get_set:1,get_host_vars_dir:4,remove_all_host:4,kei:[1,4],job:[],succeed:[1,4],otherwis:4,"0x396d710":[],host_remov:1,cli:5,deployapi:1,inventory_path:6,rtype:1,admin:4,change_set:1,add_servic:1,etc:[5,1,4],serial_flag:[1,6],marietta:4,include_data:[1,6],mean:[5,1],load:4,get_kolla_hom:4,param:[1,4],remote_mod:1,service_get:1,been:1,"int":1,json:4,group_get_al:1,interpret:4,interest:4,support_get_log:1,py3:4,convert:4,argument:1,hostremov:5,child:1,those:4,prop_typ:[1,4],look:1,pwd_valu:4,clear_password:4,clear_group_properti:4,servic:[],properti:[],get_admin_us:4,error:[5,1,6,4],build_sphinx:3,clientapi:1,glanc:1,readi:1,passwordapi:1,add_sub_servicenam:4,"0x3a98b50":[],get_console_output:1,property_valu:4,ascii:4,develop:[5,1,4],inventori:[],"0x38f0a90":[],get_kolla_log_dir:4,format:4,get_ansible_json:4,member:1,murano:1,get_sub_servicenam:4,fixup:4,ansibl:[],higher:1,groupapi:1,verbose_level:[1,6],hostnam:[5,1,6,4],user:4,filter_jinja2:4,remove_groupnam:4,typic:4,property_nam:4,johndo:4,get_service_group:[],remove_group:4,entri:[1,4],flush_cach:6,inherit:5,pickl:4,"0x4587f50":[],client:[],add_group:4,thi:[5,1,4],docker:[5,1],execut:[1,6],load_host:[],when:1,get_group_servic:4,ansible_command:4,validate_groupnam:4,kill:[1,6],servicename_id:1,openstack:[5,1],cmd_name:5,yet:4,propertyapi:1,get_children:1,add:[5,1,4],failedoper:1,take_act:5,els:[],save:4,app:[5,3],groupremoveservic:5,ansible_ssh_private_key_fil:4,get_statu:[1,6],read:[1,4],get_service_sub_servic:4,inventory_filt:4,include_password:6,sync_write_fil:4,load_container_info:4,create_servic:4,password:[],set_password:4,python3:4,python2:4,specif:4,success:[1,6,4],create_sub_servic:4,hostgroup:4,get_pars:5,"boolean":[1,4],either:[5,1,6,4],output:[1,6,4],page:0,serviceremovegroup:5,interv:4,some:1,get_group_list:4,integ:1,"0x4595590":[],group_remov:1,tmp:4,definit:[5,1],safe_decod:4,sub_servic:4,foo:4,run:[1,6,4],obj_to_decod:4,password_set:1,host:[],found:4,childnam:1,about:5,get_setup_us:4,ovr_group:1,commanderror:5,app_arg:5,associ:[5,1],own:4,support_dump:1,hostapi:1,validate_hostnam:4,empti:[1,4],host_setup_host:[],write_log:4,get_al:4,log:[1,4],support:[],ssh_connect:4,mykei:4,avail:1,wait_acquir:4,gid:4,interfac:3,"var":4,write_logfil:4,kolla_uuid:4,kolla:[4,5,1,3],unam:[1,4],host_get_group:[],form:[1,4],passwordclear:5,sub_servicenam:4,get_childnam:[],group_list:4,line:3,"true":[1,6,4],delete_servic:4,supportapi:1,extend:4,temp:4,password_clear:1,"default":4,record:[],hostlist:5,"static":4,problem:[5,1,4],servicelist:5,uid:4,creat:4,get_parentnam:[],openstack_releas:1,doesn:4,repres:[1,4],"char":4,hostname1:4,exist:4,get_servic:[1,4],file:[5,1,4],doe:1,hostsetup:5,check:[5,1,6,4],hostdestroi:5,nova:1,remote_flag:4,invalid:1,setup_us:4,other:1,bool:1,servicenam:[1,6,4],"5point":4,host_setup:1,groupremovehost:5,param_nam:4,cliff:[5,3],ssh_get_public_kei:4,get_all_uniqu:4,set_properti:4,ansiblejob:6,time:1,group_add:1},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:attribute","5":"py:function","6":"py:staticmethod"},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"],"6":["py","staticmethod","Python static method"]},filenames:["index","kollacli.api","modules","kollacli","kollacli.common","kollacli.commands","kollacli.common.ansible"],titles:["Welcome to kollacli’s documentation!","kollacli.api package","kollacli","kollacli package","kollacli.common package","kollacli.commands package","kollacli.common.ansible package"],objects:{"":{kollacli:[3,0,0,"-"]},"kollacli.api.service":{ServiceApi:[1,1,1,""]},"kollacli.api.properties":{PropertyApi:[1,1,1,""]},"kollacli.common.ansible.actions":{precheck:[6,5,1,""],upgrade:[6,5,1,""],deploy:[6,5,1,""],destroy_hosts:[6,5,1,""]},"kollacli.common.inventory":{remove_temp_inventory:[4,5,1,""],Service:[4,1,1,""],SubService:[4,1,1,""],HostGroup:[4,1,1,""],Host:[4,1,1,""],Inventory:[4,1,1,""]},"kollacli.commands.property.PropertyList":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.common.inventory.SubService":{class_version:[4,4,1,""],upgrade:[4,2,1,""],set_parent_servicename:[4,2,1,""],get_parent_servicename:[4,2,1,""],add_groupname:[4,2,1,""],get_vars:[4,2,1,""],remove_groupname:[4,2,1,""],get_groupnames:[4,2,1,""]},"kollacli.common.inventory.Host":{class_version:[4,4,1,""],get_vars:[4,2,1,""],upgrade:[4,2,1,""],set_var:[4,2,1,""]},"kollacli.commands.host.HostDestroy":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.property.PropertySet":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.group.GroupListhosts":{take_action:[5,2,1,""]},"kollacli.commands.deploy.Setdeploy":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.host.HostList":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.common.sshutils":{ssh_connect:[4,5,1,""],ssh_get_public_key:[4,5,1,""],ssh_setup_host:[4,5,1,""]},"kollacli.commands.property.PropertyClear":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.shell.KollaCli":{add_rotational_log:[3,2,1,""]},"kollacli.api.async.AsyncApi":{async_host_destroy:[1,2,1,""],async_deploy:[1,2,1,""],async_upgrade:[1,2,1,""],async_host_precheck:[1,2,1,""]},"kollacli.api.host.HostApi.Host":{get_groups:[1,2,1,""],get_name:[1,2,1,""]},"kollacli.commands.service.ServiceRemoveGroup":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.api.service.ServiceApi":{service_get:[1,2,1,""],service_get_all:[1,2,1,""],Service:[1,1,1,""]},"kollacli.common":{passwords:[4,0,0,"-"],support:[4,0,0,"-"],sshutils:[4,0,0,"-"],ansible:[6,0,0,"-"],inventory:[4,0,0,"-"],properties:[4,0,0,"-"],utils:[4,0,0,"-"]},"kollacli.api.group.GroupApi":{group_remove:[1,2,1,""],group_get_all:[1,2,1,""],Group:[1,1,1,""],group_add:[1,2,1,""],group_get:[1,2,1,""]},"kollacli.api.group.GroupApi.Group":{add_service:[1,2,1,""],add_host:[1,2,1,""],get_name:[1,2,1,""],remove_service:[1,2,1,""],remove_host:[1,2,1,""],get_services:[1,2,1,""],get_hosts:[1,2,1,""]},"kollacli.api.job":{Job:[1,1,1,""]},"kollacli.commands.group.GroupAdd":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands":{upgrade:[5,0,0,"-"],group:[5,0,0,"-"],service:[5,0,0,"-"],deploy:[5,0,0,"-"],support:[5,0,0,"-"],property:[5,0,0,"-"],host:[5,0,0,"-"],exceptions:[5,0,0,"-"],password:[5,0,0,"-"]},"kollacli.common.ansible.playbook":{AnsiblePlaybook:[6,1,1,""]},"kollacli.commands.password":{PasswordList:[5,1,1,""],PasswordSet:[5,1,1,""],PasswordClear:[5,1,1,""]},"kollacli.commands.group.GroupRemove":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.common.inventory.HostGroup":{set_remote:[4,2,1,""],add_host:[4,2,1,""],remove_host:[4,2,1,""],class_version:[4,4,1,""],upgrade:[4,2,1,""],set_var:[4,2,1,""],get_hostnames:[4,2,1,""],clear_var:[4,2,1,""],get_vars:[4,2,1,""]},"kollacli.commands.host.HostSetup":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.api.password":{PasswordApi:[1,1,1,""]},"kollacli.common.inventory.Inventory":{load:[4,6,1,""],remove_group_from_service:[4,2,1,""],validate_groupnames:[4,2,1,""],get_service_sub_services:[4,2,1,""],delete_sub_service:[4,2,1,""],set_deploy_mode:[4,2,1,""],create_service:[4,2,1,""],get_services:[4,2,1,""],get_groups:[4,2,1,""],get_host_groups:[4,2,1,""],upgrade:[4,2,1,""],setup_hosts:[4,2,1,""],get_group:[4,2,1,""],ssh_check_host:[4,2,1,""],get_ansible_json:[4,2,1,""],add_group_to_service:[4,2,1,""],class_version:[4,4,1,""],get_sub_services:[4,2,1,""],save:[4,6,1,""],delete_service:[4,2,1,""],get_group_services:[4,2,1,""],get_groupnames:[4,2,1,""],run_ansible_command:[4,2,1,""],remove_all_hosts:[4,2,1,""],get_host:[4,2,1,""],add_host:[4,2,1,""],get_group_hosts:[4,2,1,""],get_hostnames:[4,2,1,""],validate_hostnames:[4,2,1,""],create_json_gen_file:[4,2,1,""],create_sub_service:[4,2,1,""],ssh_check_hosts:[4,2,1,""],validate_servicenames:[4,2,1,""],remove_group:[4,2,1,""],get_sub_service:[4,2,1,""],remove_host:[4,2,1,""],get_service:[4,2,1,""],add_group:[4,2,1,""],get_hosts:[4,2,1,""],setup_host:[4,2,1,""],remove_json_gen_file:[4,2,1,""]},kollacli:{i18n:[3,0,0,"-"],shell:[3,0,0,"-"],commands:[5,0,0,"-"],api:[1,0,0,"-"],common:[4,0,0,"-"]},"kollacli.api.group":{GroupApi:[1,1,1,""]},"kollacli.commands.deploy":{Setdeploy:[5,1,1,""],Deploy:[5,1,1,""]},"kollacli.commands.service.ServiceAddGroup":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.host.HostRemove":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.group":{GroupAddservice:[5,1,1,""],GroupRemoveservice:[5,1,1,""],GroupListhosts:[5,1,1,""],GroupRemovehost:[5,1,1,""],GroupAdd:[5,1,1,""],GroupAddhost:[5,1,1,""],GroupListservices:[5,1,1,""],GroupRemove:[5,1,1,""]},"kollacli.api":{group:[1,0,0,"-"],service:[1,0,0,"-"],deploy:[1,0,0,"-"],support:[1,0,0,"-"],host:[1,0,0,"-"],job:[1,0,0,"-"],client:[1,0,0,"-"],exceptions:[1,0,0,"-"],async:[1,0,0,"-"],password:[1,0,0,"-"],properties:[1,0,0,"-"]},"kollacli.api.exceptions":{InvalidArgument:[1,3,1,""],MissingArgument:[1,3,1,""],HostError:[1,3,1,""],ClientException:[1,3,1,""],HostsSshCheckError:[1,3,1,""],NotInInventory:[1,3,1,""],FailedOperation:[1,3,1,""],InvalidConfiguration:[1,3,1,""]},"kollacli.commands.service":{ServiceRemoveGroup:[5,1,1,""],ServiceListGroups:[5,1,1,""],ServiceList:[5,1,1,""],ServiceAddGroup:[5,1,1,""]},"kollacli.commands.group.GroupAddservice":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.api.support.SupportApi":{support_get_logs:[1,2,1,""],support_dump:[1,2,1,""]},"kollacli.commands.service.ServiceList":{take_action:[5,2,1,""]},"kollacli.common.utils.Lock":{release:[4,2,1,""],is_owned_by_me:[4,2,1,""],wait_acquire:[4,2,1,""],acquire:[4,2,1,""]},"kollacli.commands.upgrade.Upgrade":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.common.support":{HostLogs:[4,1,1,""],dump:[4,5,1,""],get_logs:[4,5,1,""]},"kollacli.commands.group.GroupAddhost":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.api.service.ServiceApi.Service":{get_parent:[1,2,1,""],get_children:[1,2,1,""],get_name:[1,2,1,""],get_groups:[1,2,1,""]},"kollacli.api.support":{SupportApi:[1,1,1,""]},"kollacli.api.client":{ClientApi:[1,1,1,""]},"kollacli.common.inventory.Service":{upgrade:[4,2,1,""],add_sub_servicename:[4,2,1,""],class_version:[4,4,1,""],add_groupname:[4,2,1,""],get_sub_servicenames:[4,2,1,""],get_vars:[4,2,1,""],remove_groupname:[4,2,1,""],get_groupnames:[4,2,1,""]},"kollacli.commands.password.PasswordSet":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.upgrade":{Upgrade:[5,1,1,""]},"kollacli.common.support.HostLogs":{get_log:[4,2,1,""],load_container_info:[4,2,1,""],write_logs:[4,2,1,""],filter_services:[4,2,1,""],write_logfile:[4,2,1,""]},"kollacli.api.async":{AsyncApi:[1,1,1,""]},"kollacli.api.job.Job":{get_console_output:[1,2,1,""],get_status:[1,2,1,""],get_error_message:[1,2,1,""],wait:[1,2,1,""]},"kollacli.api.host.HostApi":{host_setup:[1,2,1,""],host_get:[1,2,1,""],Host:[1,1,1,""],host_remove:[1,2,1,""],host_ssh_check:[1,2,1,""],host_get_all:[1,2,1,""],host_add:[1,2,1,""]},"kollacli.commands.password.PasswordList":{take_action:[5,2,1,""]},"kollacli.common.ansible.playbook.AnsiblePlaybook":{verbose_level:[6,4,1,""],extra_vars:[6,4,1,""],include_passwords:[6,4,1,""],services:[6,4,1,""],hosts:[6,4,1,""],flush_cache:[6,4,1,""],groups:[6,4,1,""],playbook_path:[6,4,1,""],run:[6,2,1,""],deploy_id:[6,4,1,""],print_output:[6,4,1,""],serial:[6,4,1,""],inventory:[6,4,1,""]},"kollacli.api.password.PasswordApi":{password_get_names:[1,2,1,""],password_set:[1,2,1,""],password_clear:[1,2,1,""]},"kollacli.common.ansible.job.AnsibleJob":{get_command_output:[6,2,1,""],get_status:[6,2,1,""],run:[6,2,1,""],get_error_message:[6,2,1,""],wait:[6,2,1,""]},"kollacli.commands.exceptions":{CommandError:[5,3,1,""]},"kollacli.commands.password.PasswordClear":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.common.ansible":{job:[6,0,0,"-"],playbook:[6,0,0,"-"],actions:[6,0,0,"-"]},"kollacli.api.host":{HostApi:[1,1,1,""]},"kollacli.common.passwords":{get_password_names:[4,5,1,""],set_password:[4,5,1,""],clear_password:[4,5,1,""]},"kollacli.commands.group.GroupListservices":{take_action:[5,2,1,""]},"kollacli.common.properties":{AnsibleProperty:[4,1,1,""],AnsibleProperties:[4,1,1,""],OverrideFlags:[4,1,1,""]},"kollacli.common.ansible.job":{AnsibleJob:[6,1,1,""]},"kollacli.commands.property":{PropertyList:[5,1,1,""],PropertySet:[5,1,1,""],PropertyClear:[5,1,1,""]},"kollacli.commands.group.GroupRemoveservice":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.support.Dump":{take_action:[5,2,1,""]},"kollacli.commands.group.GroupRemovehost":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.host.HostAdd":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.deploy.Deploy":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.host.HostCheck":{get_parser:[5,2,1,""],take_action:[5,2,1,""]},"kollacli.commands.host":{HostAdd:[5,1,1,""],HostCheck:[5,1,1,""],HostList:[5,1,1,""],HostRemove:[5,1,1,""],HostDestroy:[5,1,1,""],HostSetup:[5,1,1,""]},"kollacli.api.deploy.DeployApi":{deploy_set_mode:[1,2,1,""]},"kollacli.api.properties.PropertyApi":{property_set:[1,2,1,""],Property:[1,1,1,""],property_get:[1,2,1,""],property_clear:[1,2,1,""]},"kollacli.commands.service.ServiceListGroups":{take_action:[5,2,1,""]},"kollacli.api.deploy":{DeployApi:[1,1,1,""]},"kollacli.api.client.ClientApi":{base_call:[1,2,1,""]},"kollacli.shell":{main:[3,5,1,""],KollaCli:[3,1,1,""]},"kollacli.commands.support":{Dump:[5,1,1,""]},"kollacli.common.properties.AnsibleProperties":{get_property:[4,2,1,""],get_all_unique:[4,2,1,""],get_all_override_flags:[4,2,1,""],get_all:[4,2,1,""],filter_jinja2:[4,2,1,""],get_host_list:[4,2,1,""],set_host_property:[4,2,1,""],get_group_list:[4,2,1,""],clear_host_property:[4,2,1,""],set_group_property:[4,2,1,""],clear_group_property:[4,2,1,""],set_property:[4,2,1,""],clear_property:[4,2,1,""]},"kollacli.common.utils":{is_string_true:[4,5,1,""],get_kollacli_home:[4,5,1,""],sync_read_file:[4,5,1,""],get_kolla_etc:[4,5,1,""],sync_write_file:[4,5,1,""],get_kolla_log_dir:[4,5,1,""],run_cmd:[4,5,1,""],get_kolla_home:[4,5,1,""],get_host_vars_dir:[4,5,1,""],change_property:[4,5,1,""],convert_to_unicode:[4,5,1,""],get_kollacli_etc:[4,5,1,""],get_admin_uids:[4,5,1,""],get_admin_user:[4,5,1,""],safe_decode:[4,5,1,""],Lock:[4,1,1,""],get_setup_user:[4,5,1,""],get_property_list_length:[4,5,1,""],get_ansible_command:[4,5,1,""],check_arg:[4,5,1,""],get_kolla_log_file_size:[4,5,1,""],get_group_vars_dir:[4,5,1,""]}},titleterms:{modul:[4,5,1,6,3],submodul:[4,5,1,6,3],indic:0,upgrad:5,packag:[4,5,1,6,3],api:1,playbook:6,tabl:0,group:[5,1],welcom:0,support:[5,1,4],except:[5,1],content:[4,5,1,6,3],document:0,ansibl:6,shell:3,util:4,job:[1,6],deploi:[5,1],i18n:3,password:[5,1,4],inventori:4,subpackag:[4,3],sshutil:4,servic:[5,1],properti:[5,1,4],host:[5,1],kollacli:[0,1,2,3,4,5,6],client:1,command:5,common:[6,4],action:6,async:1}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{all:[5,1,6,4],get_error_messag:[1,6],definit:[5,1],groupadd:5,global:[1,4],host_list:4,remove_temp_inventori:4,prefix:4,dirnam:4,pwd_kei:4,get_kolla_etc:4,children:[6,4],prog_nam:5,create_json_gen_fil:4,logdata:4,service_get_al:1,host_add:1,sourc:[4,5,1,6,3],string:[1,4],fals:[1,6,4],invalidconfigur:1,set_remot:4,property_kei:[],util:[],mechan:4,look:1,mykei:4,parentnam:1,level:1,cmd:[6,4],list:[5,1,4],check_arg:4,user_nam:[1,4],expected_typ:4,host_check_ssh:[],asyncapi:1,base_cal:1,clear_var:4,append:4,index:0,sub:5,get_ansible_command:4,property_typ:1,current:4,delet:4,version:[1,4],"new":[1,4],ovr_host:1,file_path:4,property_dict:[1,4],serviceapi:1,get_admin_uid:4,gener:4,get_kolla_log_file_s:4,add_rotational_log:[],property_get:1,path:[1,4],valu:[1,6,4],wait:[1,6],precheck:6,search:0,ansibleplaybook:6,get_host_list:4,groupaddhost:5,action:[],chang:4,is_string_tru:4,via:1,modul:[],api:[],ansible_job:1,groupremov:5,select:1,kei:[1,4],from:[5,1,6,4],would:1,async_host_destroi:1,upgrad:[],destroy_host:6,remove_group_from_servic:4,usr:[5,1,4],msg:[1,4],type:1,more:[1,4],get_nam:1,relat:[5,1],about:5,warn:1,flag:[5,4],get_hostnam:4,"0x3bf4710":[],none:[5,1,6,4],setup:[5,1,4],work:4,uniqu:4,histori:4,can:6,root:6,fetch:1,overrid:[1,4],hostvar:4,hostadd:5,tar:[5,1,4],process:6,lock:4,share:[5,1,4],critic:1,get_parent_servicenam:4,hostssshcheckerror:1,serial:6,delete_sub_servic:4,multipl:[1,4],ssh_check_host:4,net_addr:4,write:4,how:1,override_flag:1,clear_host_properti:4,grouplistservic:5,password_get_nam:1,get_groupnam:4,resourc:4,overridden:1,run_ansible_command:4,container_id:4,host_ssh_check:1,obj_nam:1,data:[5,1,4],lockpath:4,hostcheck:5,issu:4,inform:5,allow:4,exclus:4,help:[5,1,4],set_var:4,set_host_properti:4,still:1,paramet:1,group:[],uuid:4,run_cmd:4,async_host_precheck:1,better:4,main:3,"return":[1,6,4],thei:1,python:4,enable_console_log:1,initi:4,extra_var:6,setdeploi:5,get_parent_service_nam:[],get_par:1,ansible_properti:1,yml_path:[],host_get:1,"_meta":4,edit:4,load_group:[],unpickl:4,empty_ok:4,separ:4,parsed_arg:5,get_group_host:4,mode:[5,1,4],each:1,debug:[5,1,4],get_password_nam:4,unicod:4,higher:1,get_group_vars_dir:4,groupaddservic:5,obj_typ:1,get_host_group:4,host_specific_var:4,hosts_info:[1,4],groupapi:1,"static":4,connect:1,our:4,flock:4,set_deploy_mod:4,the_str:4,out:4,property_list:[1,4],class_vers:4,content:[],file_nam:[1,4],found:4,grouplisthost:5,argv:3,get_var:4,base:[4,5,1,6,3],dictionari:[1,4],releas:4,"byte":4,print_output:[6,4],extend:4,propertyclear:5,get_sub_servic:4,synchron:4,get_property_list_length:4,filter:4,place:[1,4],hosterror:1,async_upgrad:1,setup_host:4,ansibleproperti:4,missingargu:1,invalidargu:1,get_ansible_lock_path:4,propertylist:5,number:1,validate_servicenam:4,get_properti:4,"0x3a50b50":[],alreadi:1,done:[1,6,4],get_all_override_flag:4,get_ansible_json:4,owner:4,python2:4,miss:1,get_kollacli_hom:4,parent_svc_nam:4,given:[5,1,4],lister:5,ansible_ssh_us:4,"0x2edba90":[],unknown:4,system:4,messag:[5,1,6,4],async_deploi:1,lognam:4,too:1,"final":6,consol:1,option:[1,4],property_clear:1,add_host:[1,4],specifi:[5,1,6],get_kollacli_etc:4,sync_read_fil:4,filter_servic:4,target:[1,4],provid:5,remov:[5,1,4],"0x2758710":[],str:1,remove_servic:1,pre:1,get_yml_data:[],"0x281e1d0":[],py2:4,subservic:4,load_glob:[],ani:1,passwordset:5,fail:[1,4],inherit:5,have:[1,4],need:[6,4],seem:4,ssh_setup_host:4,"0x430e490":[],caus:4,get_setup_us:4,engin:1,set_group_properti:4,output:[1,6,4],destroi:[5,1,6],notininventori:1,example_vari:4,also:4,client:[],which:[1,6,4],add_group:4,noth:4,deploy:[5,1,4],usernam:4,object:[1,6,4],most:[5,1,4],deploy_set_mod:1,host_get_al:1,deploi:[],playbook_path:6,hostlog:4,"class":[4,5,1,6,3],write_logfil:4,correctli:1,set_parent_servicenam:4,clear:[5,1,4],passwordlist:5,clear_properti:4,pidfil:4,determin:6,get_command_output:6,text:6,verbos:1,playbook:[],dirpath:[1,4],line:3,clientexcept:1,access:1,onli:[5,4],acquir:4,group_get:1,configur:[5,1,4],dict:4,local:[5,1],is_owned_by_m:4,get:[1,6,4],get_host:[1,4],overrideflag:4,stop:[5,1,6],get_log:4,cannot:4,none_ok:4,ssh:[1,4],add_group_to_servic:4,deploy_id:6,serviceaddgroup:5,bar:4,enabl:1,servicelistgroup:5,remove_host:[1,4],remot:[5,1],common:[],contain:[5,1,6,4],where:[1,4],set:[5,1,6,4],dump:[5,1,4],orphan:4,see:6,arg:[5,1],ovr_glob:1,add_groupnam:4,statu:[1,6],orig_valu:[1,4],message_str:1,get_group:[1,4],property_set:1,convert_to_unicod:4,written:1,"0x2521f50":[],groupnam:[1,6,4],progress:6,remove_json_gen_fil:4,get_set:1,get_host_vars_dir:4,remove_all_host:4,parent:[1,4],job:[],succeed:[1,4],"0x396d710":[],host_remov:1,cli:5,both:4,deployapi:1,rtype:1,admin:4,change_set:1,add_servic:1,etc:[5,1,4],serial_flag:[1,6],marietta:4,include_data:[1,6],load:4,get_kolla_hom:4,get_children:1,remote_mod:1,service_get:1,been:1,"int":1,json:4,group_get_al:1,interpret:4,interest:4,support_get_log:1,py3:4,convert:4,argument:1,hostremov:5,child:[1,4],those:4,prop_typ:[1,4],sshutil:[],pwd_valu:4,clear_password:4,clear_group_properti:4,servic:[],properti:[],get_admin_us:4,behavior:4,error:[5,1,6,4],build_sphinx:3,clientapi:1,file:[5,1,4],readi:1,passwordapi:1,add_sub_servicenam:4,"0x3a98b50":[],get_console_output:1,property_valu:[],ascii:4,develop:[5,1,4],inventori:[],"0x38f0a90":[],get_kolla_log_dir:4,get_statu:[1,6],same:4,member:1,murano:1,get_sub_servicenam:4,hostdestroi:5,ansibl:[],complet:[1,6],destroy_typ:[1,6],verbose_level:[1,6],hostnam:[5,1,6,4],user:[1,6,4],filter_jinja2:4,remove_groupnam:4,get_child_pid:4,typic:4,property_nam:4,johndo:4,get_service_group:[],remove_group:4,entri:[1,4],flush_cach:6,argnam:1,pickl:4,"0x4587f50":[],exampl:1,command:[],thi:[5,1,4],docker:[5,1],execut:[1,6],less:4,load_host:[],remote_flag:4,get_group_servic:4,ansible_command:4,killabl:6,validate_groupnam:4,kill:[1,6],invalid:1,openstack:[5,1],cmd_name:5,yet:4,propertyapi:1,param:[1,4],add:[5,1,4],failedoper:1,take_act:5,els:[],save:4,app:[5,3],servicenam:[1,6,4],groupremoveservic:5,ansible_ssh_private_key_fil:4,format:4,read:[1,4],get_service_sub_servic:4,inventory_filt:4,include_password:6,sync_write_fil:4,load_container_info:4,create_servic:4,password:[],set_password:4,python3:4,name:[5,1,4],success:[1,6,4],specif:4,create_sub_servic:4,hostgroup:4,get_pars:5,"boolean":[1,4],either:[5,1,6],async:[],page:0,serviceremovegroup:5,interv:4,some:1,get_group_list:4,integ:1,"0x4595590":[],group_remov:1,tmp:4,err_msg:4,safe_decod:4,sub_servic:4,foo:4,complic:4,run:[1,6,4],obj_to_decod:4,password_set:1,usag:4,host:[],change_properti:4,childnam:1,use_flock:4,wait_dur:4,ovr_group:1,commanderror:5,mean:[5,1],disabl:1,get_parentnam:[],associ:[5,1],own:[6,4],support_dump:1,hostapi:1,validate_hostnam:4,empti:[1,4],host_setup_host:[],write_log:4,get_al:4,log:[1,4],support:[],ssh_connect:4,propertyset:5,avail:[1,4],wait_acquir:4,gid:4,interfac:3,"var":4,kolla_uuid:4,kolla:[4,5,1,3],unam:[1,4],host_get_group:[],form:[1,4],passwordclear:5,sub_servicenam:4,get_childnam:[],group_list:4,inventory_path:6,"true":[1,6,4],delete_servic:4,supportapi:1,info:1,temp:4,password_clear:1,"default":4,record:[],hostlist:5,get_all_uniqu:4,otherwis:4,problem:[5,1,4],servicelist:5,uid:4,creat:4,app_arg:5,pid:[6,4],openstack_releas:1,doesn:4,repres:[1,4],"char":4,hostname1:4,exist:4,get_servic:[1,4],glanc:1,doe:[1,4],hostsetup:5,check:[5,1,6,4],fixup:4,nova:1,when:1,get_kolla_actions_path:4,servicename_id:1,setup_us:4,other:1,bool:1,child_pid:4,test:4,"5point":4,host_setup:1,groupremovehost:5,param_nam:4,cliff:[5,3],ssh_get_public_kei:4,directori:[1,4],set_properti:4,ansiblejob:6,time:1,group_add:1,pidmanag:4},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:exception","4":"py:attribute","5":"py:function","6":"py:staticmethod"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","exception","Python exception"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"],"6":["py","staticmethod","Python static method"]},filenames:["index","kollacli.api","modules","kollacli","kollacli.common","kollacli.commands","kollacli.common.ansible"],titles:["Welcome to kollacli’s documentation!","kollacli.api package","kollacli","kollacli package","kollacli.common package","kollacli.commands package","kollacli.common.ansible package"],objects:{"":{kollacli:[3,0,0,"-"]},"kollacli.api.service":{ServiceApi:[1,2,1,""]},"kollacli.api.properties":{PropertyApi:[1,2,1,""]},"kollacli.common.ansible.actions":{precheck:[6,5,1,""],upgrade:[6,5,1,""],deploy:[6,5,1,""],destroy_hosts:[6,5,1,""]},"kollacli.common.inventory":{remove_temp_inventory:[4,5,1,""],Service:[4,2,1,""],SubService:[4,2,1,""],HostGroup:[4,2,1,""],Host:[4,2,1,""],Inventory:[4,2,1,""]},"kollacli.commands.property.PropertyList":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.common.inventory.SubService":{class_version:[4,4,1,""],upgrade:[4,1,1,""],set_parent_servicename:[4,1,1,""],get_parent_servicename:[4,1,1,""],add_groupname:[4,1,1,""],get_vars:[4,1,1,""],remove_groupname:[4,1,1,""],get_groupnames:[4,1,1,""]},"kollacli.common.inventory.Host":{class_version:[4,4,1,""],get_vars:[4,1,1,""],upgrade:[4,1,1,""],set_var:[4,1,1,""]},"kollacli.commands.host.HostDestroy":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.property.PropertySet":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.group.GroupListhosts":{take_action:[5,1,1,""]},"kollacli.commands.deploy.Setdeploy":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.host.HostList":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.common.sshutils":{ssh_connect:[4,5,1,""],ssh_get_public_key:[4,5,1,""],ssh_setup_host:[4,5,1,""]},"kollacli.commands.property.PropertyClear":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.api.async.AsyncApi":{async_host_destroy:[1,1,1,""],async_deploy:[1,1,1,""],async_upgrade:[1,1,1,""],async_host_precheck:[1,1,1,""]},"kollacli.api.host.HostApi.Host":{get_groups:[1,1,1,""],get_name:[1,1,1,""]},"kollacli.commands.service.ServiceRemoveGroup":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.api.service.ServiceApi":{service_get:[1,1,1,""],service_get_all:[1,1,1,""],Service:[1,2,1,""]},"kollacli.common":{passwords:[4,0,0,"-"],support:[4,0,0,"-"],properties:[4,0,0,"-"],ansible:[6,0,0,"-"],inventory:[4,0,0,"-"],sshutils:[4,0,0,"-"],utils:[4,0,0,"-"]},"kollacli.api.group.GroupApi":{group_remove:[1,1,1,""],group_get_all:[1,1,1,""],Group:[1,2,1,""],group_add:[1,1,1,""],group_get:[1,1,1,""]},"kollacli.api.group.GroupApi.Group":{add_service:[1,1,1,""],add_host:[1,1,1,""],get_name:[1,1,1,""],remove_service:[1,1,1,""],remove_host:[1,1,1,""],get_services:[1,1,1,""],get_hosts:[1,1,1,""]},"kollacli.api.job":{Job:[1,2,1,""]},"kollacli.commands.group.GroupAdd":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands":{upgrade:[5,0,0,"-"],group:[5,0,0,"-"],service:[5,0,0,"-"],deploy:[5,0,0,"-"],support:[5,0,0,"-"],property:[5,0,0,"-"],host:[5,0,0,"-"],exceptions:[5,0,0,"-"],password:[5,0,0,"-"]},"kollacli.common.ansible.playbook":{AnsiblePlaybook:[6,2,1,""]},"kollacli.commands.password":{PasswordList:[5,2,1,""],PasswordSet:[5,2,1,""],PasswordClear:[5,2,1,""]},"kollacli.commands.group.GroupRemove":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.common.inventory.HostGroup":{set_remote:[4,1,1,""],add_host:[4,1,1,""],remove_host:[4,1,1,""],class_version:[4,4,1,""],upgrade:[4,1,1,""],set_var:[4,1,1,""],get_hostnames:[4,1,1,""],clear_var:[4,1,1,""],get_vars:[4,1,1,""]},"kollacli.commands.host.HostSetup":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.api.password":{PasswordApi:[1,2,1,""]},"kollacli.common.inventory.Inventory":{load:[4,6,1,""],remove_group_from_service:[4,1,1,""],validate_groupnames:[4,1,1,""],get_service_sub_services:[4,1,1,""],delete_sub_service:[4,1,1,""],set_deploy_mode:[4,1,1,""],create_service:[4,1,1,""],get_services:[4,1,1,""],get_groups:[4,1,1,""],get_host_groups:[4,1,1,""],upgrade:[4,1,1,""],setup_hosts:[4,1,1,""],get_group:[4,1,1,""],ssh_check_host:[4,1,1,""],get_ansible_json:[4,1,1,""],add_group_to_service:[4,1,1,""],class_version:[4,4,1,""],get_sub_services:[4,1,1,""],save:[4,6,1,""],delete_service:[4,1,1,""],get_group_services:[4,1,1,""],get_groupnames:[4,1,1,""],run_ansible_command:[4,1,1,""],remove_all_hosts:[4,1,1,""],get_host:[4,1,1,""],add_host:[4,1,1,""],get_group_hosts:[4,1,1,""],get_hostnames:[4,1,1,""],validate_hostnames:[4,1,1,""],create_json_gen_file:[4,1,1,""],create_sub_service:[4,1,1,""],ssh_check_hosts:[4,1,1,""],validate_servicenames:[4,1,1,""],remove_group:[4,1,1,""],get_sub_service:[4,1,1,""],remove_host:[4,1,1,""],get_service:[4,1,1,""],add_group:[4,1,1,""],get_hosts:[4,1,1,""],setup_host:[4,1,1,""],remove_json_gen_file:[4,1,1,""]},kollacli:{i18n:[3,0,0,"-"],shell:[3,0,0,"-"],commands:[5,0,0,"-"],api:[1,0,0,"-"],common:[4,0,0,"-"]},"kollacli.api.group":{GroupApi:[1,2,1,""]},"kollacli.commands.deploy":{Setdeploy:[5,2,1,""],Deploy:[5,2,1,""]},"kollacli.commands.service.ServiceAddGroup":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.host.HostRemove":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.group":{GroupAddservice:[5,2,1,""],GroupRemoveservice:[5,2,1,""],GroupListhosts:[5,2,1,""],GroupListservices:[5,2,1,""],GroupAdd:[5,2,1,""],GroupAddhost:[5,2,1,""],GroupRemovehost:[5,2,1,""],GroupRemove:[5,2,1,""]},"kollacli.api":{group:[1,0,0,"-"],service:[1,0,0,"-"],deploy:[1,0,0,"-"],support:[1,0,0,"-"],host:[1,0,0,"-"],job:[1,0,0,"-"],client:[1,0,0,"-"],exceptions:[1,0,0,"-"],async:[1,0,0,"-"],password:[1,0,0,"-"],properties:[1,0,0,"-"]},"kollacli.common.utils.PidManager":{get_child_pids:[4,6,1,""]},"kollacli.api.exceptions":{InvalidArgument:[1,3,1,""],MissingArgument:[1,3,1,""],HostError:[1,3,1,""],ClientException:[1,3,1,""],HostsSshCheckError:[1,3,1,""],NotInInventory:[1,3,1,""],FailedOperation:[1,3,1,""],InvalidConfiguration:[1,3,1,""]},"kollacli.commands.service":{ServiceRemoveGroup:[5,2,1,""],ServiceListGroups:[5,2,1,""],ServiceList:[5,2,1,""],ServiceAddGroup:[5,2,1,""]},"kollacli.commands.group.GroupAddservice":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.api.support.SupportApi":{support_get_logs:[1,1,1,""],support_dump:[1,1,1,""]},"kollacli.commands.service.ServiceList":{take_action:[5,1,1,""]},"kollacli.common.utils.Lock":{release:[4,1,1,""],is_owned_by_me:[4,1,1,""],wait_acquire:[4,1,1,""],acquire:[4,1,1,""]},"kollacli.commands.upgrade.Upgrade":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.common.support":{HostLogs:[4,2,1,""],dump:[4,5,1,""],get_logs:[4,5,1,""]},"kollacli.commands.group.GroupAddhost":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.api.service.ServiceApi.Service":{get_parent:[1,1,1,""],get_children:[1,1,1,""],get_name:[1,1,1,""],get_groups:[1,1,1,""]},"kollacli.api.support":{SupportApi:[1,2,1,""]},"kollacli.api.client":{ClientApi:[1,2,1,""]},"kollacli.common.inventory.Service":{upgrade:[4,1,1,""],add_sub_servicename:[4,1,1,""],class_version:[4,4,1,""],add_groupname:[4,1,1,""],get_sub_servicenames:[4,1,1,""],get_vars:[4,1,1,""],remove_groupname:[4,1,1,""],get_groupnames:[4,1,1,""]},"kollacli.commands.password.PasswordSet":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.upgrade":{Upgrade:[5,2,1,""]},"kollacli.common.support.HostLogs":{get_log:[4,1,1,""],load_container_info:[4,1,1,""],write_logs:[4,1,1,""],filter_services:[4,1,1,""],write_logfile:[4,1,1,""]},"kollacli.api.async":{AsyncApi:[1,2,1,""]},"kollacli.api.job.Job":{get_console_output:[1,1,1,""],get_status:[1,1,1,""],kill:[1,1,1,""],get_error_message:[1,1,1,""],wait:[1,1,1,""]},"kollacli.api.host.HostApi":{host_setup:[1,1,1,""],host_get:[1,1,1,""],Host:[1,2,1,""],host_remove:[1,1,1,""],host_ssh_check:[1,1,1,""],host_get_all:[1,1,1,""],host_add:[1,1,1,""]},"kollacli.commands.password.PasswordList":{take_action:[5,1,1,""]},"kollacli.common.ansible.playbook.AnsiblePlaybook":{verbose_level:[6,4,1,""],extra_vars:[6,4,1,""],flush_cache:[6,4,1,""],services:[6,4,1,""],hosts:[6,4,1,""],include_passwords:[6,4,1,""],groups:[6,4,1,""],playbook_path:[6,4,1,""],run:[6,1,1,""],deploy_id:[6,4,1,""],print_output:[6,4,1,""],serial:[6,4,1,""],inventory:[6,4,1,""]},"kollacli.api.password.PasswordApi":{password_get_names:[1,1,1,""],password_set:[1,1,1,""],password_clear:[1,1,1,""]},"kollacli.common.ansible.job.AnsibleJob":{get_command_output:[6,1,1,""],run:[6,1,1,""],get_error_message:[6,1,1,""],get_status:[6,1,1,""],kill:[6,1,1,""],wait:[6,1,1,""]},"kollacli.commands.exceptions":{CommandError:[5,3,1,""]},"kollacli.commands.password.PasswordClear":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.common.ansible":{job:[6,0,0,"-"],playbook:[6,0,0,"-"],actions:[6,0,0,"-"]},"kollacli.api.host":{HostApi:[1,2,1,""]},"kollacli.common.passwords":{get_password_names:[4,5,1,""],set_password:[4,5,1,""],clear_password:[4,5,1,""]},"kollacli.commands.group.GroupListservices":{take_action:[5,1,1,""]},"kollacli.common.properties":{AnsibleProperty:[4,2,1,""],AnsibleProperties:[4,2,1,""],OverrideFlags:[4,2,1,""]},"kollacli.common.ansible.job":{AnsibleJob:[6,2,1,""]},"kollacli.commands.property":{PropertyList:[5,2,1,""],PropertySet:[5,2,1,""],PropertyClear:[5,2,1,""]},"kollacli.commands.group.GroupRemoveservice":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.support.Dump":{take_action:[5,1,1,""]},"kollacli.commands.group.GroupRemovehost":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.host.HostAdd":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.deploy.Deploy":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.host.HostCheck":{get_parser:[5,1,1,""],take_action:[5,1,1,""]},"kollacli.commands.host":{HostAdd:[5,2,1,""],HostCheck:[5,2,1,""],HostList:[5,2,1,""],HostRemove:[5,2,1,""],HostDestroy:[5,2,1,""],HostSetup:[5,2,1,""]},"kollacli.api.deploy.DeployApi":{deploy_set_mode:[1,1,1,""]},"kollacli.api.properties.PropertyApi":{property_set:[1,1,1,""],Property:[1,2,1,""],property_get:[1,1,1,""],property_clear:[1,1,1,""]},"kollacli.commands.service.ServiceListGroups":{take_action:[5,1,1,""]},"kollacli.api.deploy":{DeployApi:[1,2,1,""]},"kollacli.api.client.ClientApi":{enable_console_logging:[1,1,1,""],base_call:[1,1,1,""]},"kollacli.shell":{main:[3,5,1,""],KollaCli:[3,2,1,""]},"kollacli.commands.support":{Dump:[5,2,1,""]},"kollacli.common.properties.AnsibleProperties":{get_property:[4,1,1,""],get_all_unique:[4,1,1,""],get_all_override_flags:[4,1,1,""],get_all:[4,1,1,""],get_host_list:[4,1,1,""],set_host_property:[4,1,1,""],get_group_list:[4,1,1,""],clear_host_property:[4,1,1,""],filter_jinja2:[4,1,1,""],set_group_property:[4,1,1,""],clear_group_property:[4,1,1,""],set_property:[4,1,1,""],clear_property:[4,1,1,""]},"kollacli.common.utils":{get_ansible_lock_path:[4,5,1,""],is_string_true:[4,5,1,""],get_kollacli_home:[4,5,1,""],sync_read_file:[4,5,1,""],get_kolla_etc:[4,5,1,""],sync_write_file:[4,5,1,""],get_ansible_command:[4,5,1,""],run_cmd:[4,5,1,""],get_kolla_home:[4,5,1,""],get_host_vars_dir:[4,5,1,""],change_property:[4,5,1,""],convert_to_unicode:[4,5,1,""],get_kollacli_etc:[4,5,1,""],get_admin_uids:[4,5,1,""],PidManager:[4,2,1,""],get_admin_user:[4,5,1,""],safe_decode:[4,5,1,""],Lock:[4,2,1,""],get_setup_user:[4,5,1,""],get_property_list_length:[4,5,1,""],get_kolla_log_dir:[4,5,1,""],get_kolla_actions_path:[4,5,1,""],check_arg:[4,5,1,""],get_kolla_log_file_size:[4,5,1,""],get_group_vars_dir:[4,5,1,""]}},titleterms:{modul:[4,5,1,6,3],submodul:[4,5,1,6,3],indic:0,upgrad:5,packag:[4,5,1,6,3],api:1,playbook:6,tabl:0,group:[5,1],welcom:0,support:[5,1,4],except:[5,1],content:[4,5,1,6,3],document:0,ansibl:6,shell:3,util:4,job:[1,6],deploi:[5,1],i18n:3,password:[5,1,4],inventori:4,subpackag:[4,3],sshutil:4,servic:[5,1],properti:[5,1,4],host:[5,1],kollacli:[0,1,2,3,4,5,6],client:1,command:5,common:[6,4],action:6,async:1}}) \ No newline at end of file