diff --git a/app/cli/cliapp.py b/app/cli/cliapp.py index 50eb1142..c6867ebb 100644 --- a/app/cli/cliapp.py +++ b/app/cli/cliapp.py @@ -13,6 +13,10 @@ os.environ['CLAP_PATH'] = path_extend('~', '.clap') +class ArgumentError(Exception): + pass + + class Defaults(metaclass=Singleton): def __init__(self): self.verbosity: int = 0 diff --git a/app/cli/modules/cluster.py b/app/cli/modules/cluster.py index 0896f577..7a59314a 100644 --- a/app/cli/modules/cluster.py +++ b/app/cli/modules/cluster.py @@ -1,21 +1,16 @@ -import json import os import glob import yaml import click from collections import defaultdict from dataclasses import asdict -from typing import List from clap.cluster_manager import ClusterManager, ClusterConfigDatabase, ClusterRepositoryController -from clap.configs import ConfigurationDatabase from clap.executor import ShellInvoker, SSHCommandExecutor, AnsiblePlaybookExecutor -from clap.node_manager import NodeManager, NodeRepositoryController from clap.repository import RepositoryFactory from clap.utils import path_extend, float_time_to_string, get_logger, \ - Singleton, defaultdict_to_dict -from providers.provider_ansible_aws import AnsibleAWSProvider -from app.cli.cliapp import clap_command, Defaults + Singleton, defaultdict_to_dict, str_at_middle +from app.cli.cliapp import clap_command, Defaults, ArgumentError from app.cli.modules.node import NodeDefaults, get_node_manager, get_config_db from app.cli.modules.role import RoleDefaults, get_role_manager @@ -67,21 +62,23 @@ def get_cluster_manager() -> ClusterManager: default=cluster_defaults.node_defaults.node_repository_path, help='Node database where nodes will be written') @click.option('-c', '--cluster-repository', show_default=True, - default=cluster_defaults.cluster_config_path, + default=cluster_defaults.cluster_repository_path, help='Cluster database where cluster will be written') -def cluster(roles_root, node_repository, cluster_repository): +@click.option('-d', '--config-dir', show_default=True, + default=cluster_defaults.cluster_config_path, + help='Directory to search for cluster template files') +def cluster(roles_root, node_repository, cluster_repository, config_dir): cluster_defaults.role_defaults.role_dir = roles_root cluster_defaults.node_defaults.node_repository_path = node_repository - cluster_defaults.cluster_config_path = cluster_repository + cluster_defaults.cluster_repository_path = cluster_repository + cluster_defaults.cluster_config_path = config_dir @cluster.command('start') @click.argument('cluster_template', nargs=1, required=True) -@click.option('-s', '--setup', help='Also perform setup', is_flag=True, - default=True, show_default=True) -@click.option('-e', '--extra', multiple=True, - help='Extra arguments to start operation. Format =') -def cluster_start(cluster_template, setup, extra): +@click.option('-n', '--no-setup', help='Do not perform setup', is_flag=True, + default=False, show_default=True) +def cluster_start(cluster_template, no_setup): """ Start cluster based on a cluster template. The CLUSTER TEMPLATE is the ID of the cluster configuration at cluster @@ -90,19 +87,11 @@ def cluster_start(cluster_template, setup, extra): cluster_manager = get_cluster_manager() cluster_db = get_cluster_config_db() - extra_args = dict() - for e in extra: - if '=' not in e: - raise ValueError(f"Invalid value for extra argument: {e}. " - f"Did you forgot '=' character?") - extra_name, extra_value = e.split('=')[0], '='.join(e.split('=')[1:]) - extra_args[extra_name] = extra_value - cluster_config = cluster_db.clusters.get(cluster_template, None) if cluster_config is None: raise ValueError(f"Invalid cluster templated: {cluster_template}") - print(f"Starting cluster: {cluster_template} (perform setup: {setup})") + print(f"Starting cluster: {cluster_template} (perform setup: {not no_setup})") cluster_id = cluster_manager.start_cluster(cluster_config) print(f"Cluster {cluster_id} successfully created") @@ -112,7 +101,7 @@ def cluster_start(cluster_template, setup, extra): print(f"* {len(list_nodes)} nodes of type {node_type}: " f"{','.join(sorted(list_nodes))}") - if not setup: + if no_setup: return 0 print(f"Performing setup operation in cluster {cluster_id}") @@ -138,7 +127,7 @@ def cluster_start(cluster_template, setup, extra): def cluster_list(cluster_id, detailed, indent, quiet): """List clusters in the cluster repository. - The CLUSTER_ID argument is an optional list of cluster ids, to fiilter cluster by their ids. + The CLUSTER_ID argument is an optional list of cluster ids, to filter cluster by their ids. """ if quiet and detailed: raise ValueError(f"Options `detailed` and `quiet` are mutually exclusive") @@ -165,7 +154,7 @@ def cluster_list(cluster_id, detailed, indent, quiet): print(f"{'-'*20} Cluster: `{c.cluster_id}` (`{c.cluster_name}`) {'-'*20}") print(yaml.dump(asdict(c), sort_keys=True, indent=indent)) - print(f" Has {num_nodes} node types:") + print(f" Has {num_nodes} nodes:") for node_type, node_list in nodes.items(): print(f" - {len(node_list)} {node_type} nodes: " f"{', '.join(sorted(node_list))}") @@ -180,6 +169,31 @@ def cluster_list(cluster_id, detailed, indent, quiet): return 0 +@cluster.command('nodes') +@click.argument('cluster_id', nargs=1, required=True) +@click.option('-q', '--quiet', default=False, is_flag=True, show_default=True, + help="Show only node ids") +def cluster_list(cluster_id, quiet): + """List cluster's nodes. + + The CLUSTER_ID is the cluster id. + """ + cluster_manager = get_cluster_manager() + cluster_manager.get_cluster_by_id(cluster_id) + + if quiet: + nodes = cluster_manager.get_all_cluster_nodes(cluster_id) + for n in nodes: + print(n) + return 0 + + nodes = cluster_manager.get_cluster_nodes_types(cluster_id) + for node_type, node_list in nodes.items(): + print(f"{len(node_list)} {node_type}: {', '.join(sorted(node_list))}") + + return 0 + + @cluster.command('list-templates') @click.argument('template', nargs=-1, type=str, required=False) @click.option('-d', '--detailed', is_flag=True, default=False, show_default=True, @@ -240,6 +254,34 @@ def cluster_setup(cluster_id, at): f"operation again") return 1 print(f"Cluster `{cluster_id}` finished setup!") + return 0 + +@cluster.command('update') +@click.argument('cluster_id', nargs=1, required=True, type=str) +@click.option('-c', '--config', default=None, type=str, show_default=False, + help='New cluster config name') +def cluster_update(cluster_id, config): + """Perform cluster setup operation at a cluster. + + The CLUSTER_ID argument is the id of the cluster to perform the setup + """ + cluster_manager = get_cluster_manager() + cluster_config_db = get_cluster_config_db() + cluster = cluster_manager.get_cluster_by_id(cluster_id) + if config is not None: + new_config = cluster_config_db.clusters.get(config, None) + if not new_config: + raise ArgumentError(f"Invalid cluster configuration: {config}") + else: + new_config = cluster_config_db.clusters.get( + cluster.cluster_config.cluster_config_id, None) + if not new_config: + raise ArgumentError(f"Invalid cluster configuration: " + f"{cluster.cluster_config.cluster_config_id}") + cluster.cluster_config = new_config + cluster_manager.upsert_cluster(cluster) + print(f"Configuration of cluster {cluster_id} has been updated") + return 0 @cluster.command('stop') @@ -318,44 +360,33 @@ def cluster_alive(cluster_id): @click.argument('cluster_id', nargs=1, required=True, type=str) @click.option('-n', '--node', multiple=True, required=True, type=str, help='Type of node to start. Format: :') -@click.option('-s', '--setup', is_flag=True, default=True, show_default=True, - help='Also perform setup',) -def cluster_grow(cluster_id, node, setup): +@click.option('-n', '--no-setup', is_flag=True, default=False, show_default=True, + help='Do not perform setup') +def cluster_grow(cluster_id, node, no_setup): """Start more nodes at a cluster by cluster node type. The CLUSTER_ID argument is the id of the cluster to add more nodes. """ cluster_manager = get_cluster_manager() nodes_to_start = list() - cluster = cluster_manager.get_cluster_by_id(cluster_id) for n in node: node_name, qtde = n.split(':')[0], int(n.split(':')[1]) if ':' in n else 1 nodes_to_start.append((node_name, qtde)) - all_nodes = dict() + all_nodes = defaultdict(list) for node_type, qtde in nodes_to_start: - t = cluster.cluster_config.nodes[node_type].type - instance_info = cluster_manager.config_db.instance_descriptors[t] - nodes = cluster_manager.start_cluster_node( - cluster_id, node_type, instance_info, qtde) - all_nodes[node_type] = all_nodes - if len(nodes) != qtde: - logger.error(f"Could not start {qtde} {node_type} nodes. " - f"Only {len(nodes)} were started") - continue - - for node_type, list_nodes in all_nodes.items(): - print(f"* {len(list_nodes)} nodes of type {node_type}: " - f"{','.join(sorted(list_nodes))}") + nodes = cluster_manager.grow(cluster_id, node_type, qtde, min_count=qtde) + print(f"Started {len(nodes)} of type {node_type}: {', '.join(sorted(nodes))}") + all_nodes[node_type] += nodes + all_nodes = defaultdict_to_dict(all_nodes) - if not setup: + if no_setup: return 0 - # TODO check a bug here... print(f"Performing setup operation in cluster {cluster_id}") try: - cluster_manager.setup_cluster(cluster_id, nodes_types=all_nodes) + cluster_manager.setup_cluster(cluster_id, nodes_being_added=all_nodes) except Exception as e: logger.error(e) print(f"Cluster not properly setup... You may wish perform the setup " @@ -363,196 +394,140 @@ def cluster_grow(cluster_id, node, setup): return 1 print(f"Cluster `{cluster_id}` finished setup!") return 0 -# -# -# @cluster.command('shrink') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-n', '--node', help='Type of node to terminate. Format: :', multiple=True, required=True, type=str) -# @click.option('-s', '--stop', help='Also stop the nodes', is_flag=True, default=True, show_default=True) -# @click.option('-r', '--remove', help='Remove cluster if no nodes in cluster', is_flag=True, default=True, show_default=True) -# def cluster_shrink(cluster_id, node, stop, remove): -# """Stop more nodes from a cluster by cluster node type. -# -# The CLUSTER_ID argument is the id of the cluster to stop nodes. -# """ -# cluster_module = ClusterModule.get_module() -# node_types = dict() -# try: -# for n in node: -# node_name, qtde = n.split(':')[0], int(n.split(':')[1]) -# node_types[node_name] = qtde -# except Exception as e: -# logger.error(f"Invalid node format string") -# raise e -# print(f"Removing nodes of types `{node_types}` from cluster `{cluster_id}`") -# nodes = cluster_module.remove_nodes_from_cluster_by_type(cluster_id, node_types, stop_nodes=stop, remove_cluster=remove) -# print(f"Removed nodes {', '.join(sorted(nodes))}") -# return 0 -# -# -# @cluster.command('add-nodes') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-n', '--node', help='Type of node to start. Format: :', multiple=True, required=True, type=str) -# @click.option('-s', '--setup', help='Also perform setup', is_flag=True, default=True, show_default=True) -# def cluster_add_nodes(cluster_id, node, setup): -# """Add existing nodes to a cluster by their ids. -# -# The CLUSTER_ID argument is the id of the cluster to add more nodes. -# """ -# cluster_module = ClusterModule.get_module() -# node_types = defaultdict(list) -# -# for n in node: -# node_id, node_type = n.split(':')[0], n.split(':')[1] -# node_types[node_type].append(node_id) -# -# node_types = dict(node_types) -# nodes = cluster_module.add_existing_node_to_cluster(cluster_id, node_types) -# -# for node_type, list_nodes in nodes.items(): -# print(f'Added {len(list_nodes)} nodes of type `{node_type}` to cluster `{cluster_id}`:') -# for n in list_nodes: -# print(' ' * 4, n) -# -# if not setup: -# return 0 -# -# print(f"Performing setup operation in cluster `{cluster_id}`...") -# try: -# cluster_module.cluster_setup(cluster_id, nodes_type=nodes) -# except Exception as e: -# logger.error(e) -# print(f"Cluster not properly setup... You may wish perform the setup operation again") -# raise e -# print(f"Cluster `{cluster_id}` finished setup!") -# return 0 -# -# -# @cluster.command('remove-nodes') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-n', '--node', help='Id of the nodes to remove from the cluster', multiple=True, required=True, type=str) -# @click.option('-s', '--stop', help='Also stop the nodes', is_flag=True, default=True, show_default=True) -# @click.option('-r', '--remove', help='Remove cluster if no nodes in cluster', is_flag=True, default=True, show_default=True) -# def cluster_remove_nodes(cluster_id, node, stop, remove): -# """Remove nodes from a cluster based on the node id. -# -# The CLUSTER_ID argument is the id of the cluster to remove nodes. -# """ -# cluster_module = ClusterModule.get_module() -# print(f"Removing nodes `{', '.join(sorted(node))}` from cluster `{cluster_id}`") -# nodes = cluster_module.remove_nodes_from_cluster_by_id( -# cluster_id, node_ids=list(node), stop_nodes=stop, remove_cluster=remove) -# print(f"Removed nodes {', '.join(sorted(nodes))}") -# return 0 -# -# -# -# -# -# -# @cluster.command('update') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-e', '--extra', help='Extra arguments to cluster configuration. Format =', multiple=True) -# def cluster_update(cluster_id, extra): -# """Update a cluster config with the same as in the configuration files. -# -# The CLUSTER_ID argument is the id of the cluster to update its configuration. -# """ -# cluster_module = ClusterModule.get_module() -# extra_args = dict() -# for e in extra: -# if '=' not in e: -# raise ValueError(f"Invalid value for extra argument: `{e}`. " -# f"Did you forgot '=' character?") -# extra_name, extra_value = e.split('=')[0], '='.join(e.split('=')[1:]) -# extra_args[extra_name] = extra_value -# -# cluster_module.update_cluster_config(cluster_id, extra_args=extra_args) -# return 0 -# -# -# def cluster_group_add(): -# pass -# -# -# def cluster_group_action(): -# pass -# -# -# def cluster_group_remove(): -# pass -# -# -# @cluster.command('connect') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# def cluster_connect(cluster_id): -# """Obtain an interactive SSH shell to a cluster node. -# -# The CLUSTER_ID argument is the id of the cluster to obtain an interactive shell. -# """ -# cluster_module = ClusterModule.get_module() -# cluster_module.connect(cluster_id) -# return 0 -# -# -# @cluster.command('execute') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-cmd', '--command', help='Command string to execute', required=True, type=str) -# def cluster_execute(cluster_id, command): -# """Execute an shell command in all cluster nodes. -# -# The CLUSTER_ID argument is the id of the cluster to execute the shell command. -# """ -# cluster_module = ClusterModule.get_module() -# executions = cluster_module.execute_command(cluster_id, command) -# for node_id in sorted(list(executions.keys())): -# result = executions[node_id] -# if not result: -# print(f"Error executing command in node `{node_id}`") -# continue -# print(f"{'-' * 20} STDOUT: `{node_id}` {'-' * 20}") -# print(''.join(result.stdout_lines)) -# print(f"\n{'-' * 20} STDERR: `{node_id}` {'-' * 20}") -# print(''.join(result.stderr_lines)) -# print(f"\n{'-' * 70}") -# -# return 0 -# -# -# @cluster.command('playbook') -# @click.argument('cluster_id', nargs=1, required=True, type=str) -# @click.option('-p', '--playbook', help='Path to the Ansible Playbook file', required=True, type=str) -# @click.option('-e', '--extra', help='Extra arguments to cluster configuration. Format =', multiple=True) -# def cluster_playbook(cluster_id, playbook, extra): -# """Execute an Ansible Playbook in all cluster nodes. -# -# The CLUSTER_ID argument is the id of the cluster to execute the Ansible Playbook. -# """ -# cluster_module = ClusterModule.get_module() -# extra_args = dict() -# for e in extra: -# if '=' not in e: -# raise ValueError(f"Invalid value for extra argument: `{e}`. " -# f"Did you forgot '=' character?") -# extra_name, extra_value = e.split('=')[0], '='.join(e.split('=')[1:]) -# extra_args[extra_name] = extra_value -# -# playbook = path_extend(playbook) -# if not os.path.isfile(playbook): -# raise ValueError(f"Invalid playbook at `{playbook}`") -# -# results = cluster_module.execute_playbook(cluster_id, playbook, extra_args) -# if results.ok: -# print(f"Playbook `{playbook}` was successfully executed in cluster `{cluster_id}`") -# return 0 -# else: -# print(f"Playbook {playbook} was not executed correctly...") -# return 1 -# -# -# def cluster_copy(): -# pass -# -# -# def cluster_fetch(): -# pass + + +@cluster.command('connect') +@click.argument('cluster_id', nargs=1, required=True, type=str) +def cluster_connect(cluster_id): + """Obtain an interactive SSH shell to a cluster node. + + The CLUSTER_ID argument is the id of the cluster to obtain an interactive shell. + """ + cluster_manager = get_cluster_manager() + node_manager = get_node_manager() + cluster = cluster_manager.get_cluster_by_id(cluster_id) + nodes = cluster_manager.get_cluster_nodes_types(cluster_id) + if cluster.cluster_config.options.ssh_to is not None: + if cluster.cluster_config.options.ssh_to not in nodes: + raise ValueError( + f"No nodes of type {cluster.cluster_config.options.ssh_to} to " + f"connect") + nodes = node_manager.get_nodes_by_id( + nodes[cluster.cluster_config.options.ssh_to]) + print(f"Connecting to node: {nodes[0].node_id} " + f"({cluster.cluster_config.options.ssh_to})") + e = ShellInvoker(nodes[0], cluster_defaults.base_defaults.private_path) + e.run() + else: + nodes = cluster_manager.get_all_cluster_nodes(cluster_id) + if not nodes: + raise ValueError("No nodes in the cluster") + nodes = node_manager.get_nodes_by_id(nodes) + e = ShellInvoker(nodes[0], cluster_defaults.base_defaults.private_path) + e.run() + return 0 + + +@cluster.command('execute') +@click.argument('cluster_id', nargs=1, required=True, type=str) +@click.option('-cmd', '--command', required=True, type=str, + help='Command string to execute') +def cluster_execute(cluster_id, command): + """Execute an shell command in all cluster nodes. + + The CLUSTER_ID argument is the id of the cluster to execute the shell command. + """ + cluster_manager = get_cluster_manager() + node_manager = get_node_manager() + nodes = cluster_manager.get_all_cluster_nodes(cluster_id) + nodes = node_manager.get_nodes_by_id(nodes) + + if not nodes: + print("No nodes in the cluster") + return 0 + + e = SSHCommandExecutor( + command, nodes, cluster_defaults.base_defaults.private_path) + results = e.run() + + for node_id in sorted(list(results.keys())): + result = results[node_id] + if not result['ok']: + print(f"{node_id[:8]}: Error executing command in node. {result['error']}") + continue + print(str_at_middle(node_id, 80, '-')) + print(f'return code {node_id[:8]}: {result["return_code"]}') + print(f'stdout {node_id[:8]}: '.join(result['stdout_lines'])) + print(f'stderr {node_id[:8]}: '.join(result['stderr_lines'])) + + return 0 + + +@cluster.command('playbook') +@click.argument('cluster_id', nargs=1, required=True, type=str) +@click.option('-p', '--playbook', required=True, type=str, + help='Path to the Ansible Playbook file') +@click.option('-e', '--extra', multiple=True, + help='Extra arguments to cluster configuration. Format =') +@click.option('-nv', '--node-vars', default=None, type=str, multiple=True, + help='Host variables to be passed. Format: :=', + show_default=False) +def cluster_playbook(cluster_id, playbook, extra, node_vars): + """Execute an Ansible Playbook in all cluster nodes. + + The CLUSTER_ID argument is the id of the cluster to execute the Ansible Playbook. + """ + cluster_manager = get_cluster_manager() + node_manager = get_node_manager() + nodes = cluster_manager.get_all_cluster_nodes(cluster_id) + nodes = node_manager.get_nodes_by_id(nodes) + + if not nodes: + print("No nodes in the cluster") + return 0 + + extra_args = dict() + for e in extra: + if '=' not in e: + raise ValueError(f"Invalid value for extra argument: `{e}`. " + f"Did you forgot '=' character?") + extra_name, extra_value = e.split('=')[0], '='.join(e.split('=')[1:]) + extra_args[extra_name] = extra_value + + playbook = path_extend(playbook) + if not os.path.isfile(playbook): + raise ValueError(f"Invalid playbook file `{playbook}`") + + node_variables = defaultdict(dict) + for nvar in node_vars: + if ':' not in nvar: + raise ValueError(f"Invalid value for node argument: `{nvar}`. " + f"Did you forgot ':' character?") + node_id, node_extra_args = nvar.split(':')[0], ':'.join(nvar.split(':')[1:]) + for narg in node_extra_args.split(','): + if '=' not in narg: + raise ValueError(f"Invalid value for extra argument: '{narg}'. " + f"Did you forgot '=' character?") + extra_name, extra_value = narg.split('=')[0], '='.join(narg.split('=')[1:]) + node_variables[node_id].update({extra_name: extra_value}) + + node_variables = defaultdict_to_dict(node_variables) + inventory = AnsiblePlaybookExecutor.create_inventory( + nodes, cluster_defaults.base_defaults.private_path, {}, node_variables) + executor = AnsiblePlaybookExecutor( + playbook, cluster_defaults.base_defaults.private_path, inventory, extra_args) + result = executor.run() + + if not result.ok: + logger.error(f"Playbook {playbook} did not executed successfully...") + return 1 + + print(str_at_middle("Execution Summary", 80)) + for node_id in sorted(list(result.hosts.keys())): + r = result.hosts[node_id] + print(f"{node_id}: {'ok' if r else 'not ok'}") + + print(f"Playbook at `{playbook}` were executed in {len(result.hosts)} nodes") + return 0 + + diff --git a/app/cli/modules/node.py b/app/cli/modules/node.py index 822dafaa..12c8639e 100644 --- a/app/cli/modules/node.py +++ b/app/cli/modules/node.py @@ -10,7 +10,7 @@ from clap.node_manager import NodeManager, NodeRepositoryController from clap.repository import RepositoryFactory from clap.utils import path_extend, float_time_to_string, get_logger, \ - Singleton, defaultdict_to_dict + Singleton, defaultdict_to_dict, str_at_middle from providers.provider_ansible_aws import AnsibleAWSProvider from app.cli.cliapp import clap_command, Defaults @@ -85,19 +85,18 @@ def node(repository): @node.command('start') @click.argument('instance', nargs=-1, type=str) -@click.option('-st', '--start-timeout', default=600, help='Timeout to start nodes', - show_default=True) -@click.option('-cr', '--connection-tries', default=15, - help='Number of the maximum number of SSH connection tries for ' - 'check if node is alive. If zero, nodes is not checked', - show_default=True) -@click.option('-rt', '--retry-delay', default=30, - help='Delay time to try another SSH connection', - show_default=True) -@click.option('-t', '--terminate_not_alive', default=False, +@click.option('-st', '--start-timeout', default=600, show_default=True, + help='Timeout to start nodes') +@click.option('-cr', '--connection-tries', default=15, show_default=True, + help="Number of SSH connection tries to check if node is alive. " + "If the value is set to zero, only the node's information is " + "updated and no login attempts(via SSH) is performed.") +@click.option('-rt', '--retry-delay', default=30, show_default=True, + help='Time between an unsuccessful connection and another') +@click.option('-t', '--terminate_not_alive', default=False, show_default=True, + is_flag=True, help='Terminate nodes if no SSH connection were possible. ' - 'Connection-tries parameter must be higher than 0', - show_default=True, is_flag=True) + 'Connection-tries parameter must be higher than 0') def node_start(instance, start_timeout, connection_tries, retry_delay, terminate_not_alive): """ Control and manage nodes. @@ -168,9 +167,8 @@ def node_start(instance, start_timeout, connection_tries, retry_delay, @click.argument('node_id', nargs=-1) @click.option('-t', '--tags', default=None, type=str, multiple=True, help='Filter nodes by tags. There are two formats: or =') -@click.option('-d', '--detailed', - help='Show detailed node information', - default=0, show_default=True, count=True) +@click.option('-d', '--detailed', default=0, show_default=True, count=True, + help='Show detailed node information') @click.option('-i', '--indent', default=4, show_default=True, nargs=1, type=int, help="Indentation level") @click.option('-q', '--quiet', default=False, is_flag=True, show_default=True, @@ -215,13 +213,13 @@ def node_list(node_id, tags, detailed, indent, quiet): @click.argument('node_id', nargs=-1) @click.option('-t', '--tags', default=None, type=str, multiple=True, help='Filter nodes by tags. There are two formats: or =') -@click.option('-f', '--force', default=True, - help='Remove nodes from repository even if fails', show_default=True, - is_flag=True) +@click.option('-f', '--force', default=True, is_flag=True, show_default=True, + help='Remove nodes from repository even if stop operation fails') def node_stop(node_id, tags, force): """ Stop a node (terminating it) and remove it from node repository. - The NODE_ID argument is a list of strings (optional) and can filter nodes to stop by their node ids + The NODE_ID argument is a list of strings (optional) and can filter nodes to + stop by their node ids """ if not node_id and not tags: print('Stopped 0 nodes') @@ -244,16 +242,14 @@ def node_stop(node_id, tags, force): @node.command('alive') @click.argument('node_id', nargs=-1) - # help='Nodes to be checked. If not provided, check all nodes in repository') @click.option('-t', '--tags', default=None, type=str, multiple=True, help='Filter nodes by tags. There are two formats: or =') -@click.option('-cr', '--connection-tries', default=15, - help='Number of the maximum number of SSH connection tries for ' - 'check if node is alive. If zero, nodes is not checked', - show_default=True) -@click.option('-rt', '--retry-delay', default=30, - help='Delay time to try another SSH connection', - show_default=True) +@click.option('-cr', '--connection-tries', default=15, show_default=True, + help="Number of SSH connection tries to check if node is alive. " + "If the value is set to zero, only the node's information is " + "updated and no login attempts(via SSH) is performed.") +@click.option('-rt', '--retry-delay', default=30, show_default=True, + help='Time between an unsuccessful connection and another') def node_alive(node_id, tags, connection_tries, retry_delay): """ Check if nodes are alive (a successful SSH connection can be established). @@ -286,19 +282,19 @@ def node_alive(node_id, tags, connection_tries, retry_delay): @click.argument('node_id', nargs=-1) @click.option('-t', '--tags', default=None, type=str, multiple=True, help='Filter nodes by tags. There are two formats: or =') -@click.option('-st', '--start-timeout', default=600, - help='Timeout to resume nodes', show_default=True) -@click.option('-cr', '--connection-tries', default=15, - help='Number of the maximum number of SSH connection tries for ' - 'check if node is alive. If zero, nodes is not checked', - show_default=True) -@click.option('-rt', '--retry-delay', default=30, - help='Delay time to try another SSH connection', - show_default=True) +@click.option('-st', '--start-timeout', default=600, show_default=True, + help='Timeout to resume nodes') +@click.option('-cr', '--connection-tries', default=15, show_default=True, + help="Number of SSH connection tries to check if node is alive. " + "If the value is set to zero, only the node's information is " + "updated and no login attempts(via SSH) is performed.") +@click.option('-rt', '--retry-delay', default=30, show_default=True, + help='Time between an unsuccessful connection and another') def node_resume(node_id, tags, start_timeout, connection_tries, retry_delay): """ Resume nodes (if possible). - The NODE_ID argument is a list of strings (optional) and can filter nodes to resume by their node ids + The NODE_ID argument is a list of strings (optional) and can filter nodes to + resume by their node ids """ node_manager = get_node_manager() @@ -329,7 +325,8 @@ def node_resume(node_id, tags, start_timeout, connection_tries, retry_delay): def node_pause(node_id, tags): """ Pause nodes (if possible). - The NODE_ID argument is a list of strings (optional) and can filter nodes to pause by their node ids + The NODE_ID argument is a list of strings (optional) and can filter nodes to + pause by their node ids """ node_manager = get_node_manager() @@ -370,7 +367,7 @@ def node_connect(node_id): def node_add_tag(node_id, tags): """ Add tags to a set of nodes. - The NODE_ID argument is a list of strings (optional) and can filter nodes to add tags by their node ids + The NODE_ID argument is a list of node_ids to add tags. """ node_manager = get_node_manager() final_tags = dict() @@ -393,7 +390,7 @@ def node_add_tag(node_id, tags): def node_remove_tags(node_id, tags): """ Remove tags from a set of nodes. - The NODE_ID argument is a list of strings (optional) and can filter nodes to remove tags by their node ids + The NODE_ID argument is a list of node_ids to remove tags. """ node_manager = get_node_manager() removeds = node_manager.remove_tags(node_id, tags) @@ -450,7 +447,8 @@ def node_execute(node_id, tags, command, additional, timeout): if not result['ok']: print(f"{node_id[:8]}: Error executing command in node. {result['error']}") continue - print('-' * 80) + print(str_at_middle(node_id, 80, '-')) + print(f'return code {node_id[:8]}: {result["return_code"]}') print(f'stdout {node_id[:8]}: '.join(result['stdout_lines'])) print(f'stderr {node_id[:8]}: '.join(result['stderr_lines'])) @@ -508,10 +506,10 @@ def list_instance_templates(template, detailed, indent, quiet): help='Filter nodes by tags. There are two formats: or =') @click.option('-e', '--extra', default=None, type=str, multiple=True, help='Extra variables to be passed. Format: =', - show_default=True) + show_default=False) @click.option('-nv', '--node-vars', default=None, type=str, multiple=True, help='Host variables to be passed. Format: :=', - show_default=True) + show_default=False) def node_playbook(node_id, playbook, tags, extra, node_vars): """ Execute an Ansible playbook in a set of nodes. @@ -530,6 +528,10 @@ def node_playbook(node_id, playbook, tags, extra, node_vars): print("No nodes informed") return 0 + playbook = path_extend(playbook) + if not os.path.isfile(playbook): + raise ValueError(f"Invalid playbook file `{playbook}`") + extra_args = dict() for e in extra: if '=' not in e: @@ -562,7 +564,7 @@ def node_playbook(node_id, playbook, tags, extra, node_vars): logger.error(f"Playbook {playbook} did not executed successfully...") return 1 - print(f"{'-' * 20} Execution summary {'-' * 20}") + print(str_at_middle("Execution Summary", 80)) for node_id in sorted(list(result.hosts.keys())): r = result.hosts[node_id] print(f"{node_id}: {'ok' if r else 'not ok'}") diff --git a/app/cli/modules/role.py b/app/cli/modules/role.py index 63646a71..adbfcb56 100644 --- a/app/cli/modules/role.py +++ b/app/cli/modules/role.py @@ -4,9 +4,9 @@ from dataclasses import asdict from clap.node_manager import NodeRepositoryController from clap.repository import RepositoryFactory -from clap.role_manager import RoleManager +from clap.role_manager import RoleManager, NodeRoleError from clap.utils import path_extend, get_logger, Singleton, defaultdict_to_dict -from app.cli.cliapp import clap_command, Defaults +from app.cli.cliapp import clap_command, Defaults, ArgumentError logger = get_logger(__name__) @@ -133,7 +133,7 @@ def role_add(role, node, node_vars, host_vars, extra): role, hosts_node_map=nodes, host_vars=host_vars, node_vars=node_vars, extra_args=extra_args) - print(f"{len(added_nodes)} nodes were added to role {role}: {added_nodes}") + print(f"{len(added_nodes)} nodes were added to role {role}: {', '.join(sorted(added_nodes))}") return 0 @@ -161,9 +161,26 @@ def role_action(role, action, node, node_vars, host_vars, extra): role_manager = get_role_manager() nodes, node_vars, host_vars, extra_args = _split_vars( node, node_vars, host_vars, extra) - nodes = role_manager.get_role_nodes(role, from_node_ids=nodes) + if not nodes: + nodes = role_manager.get_all_role_nodes_hosts(role) + else: + if type(nodes) is list: + d = defaultdict(list) + for n in nodes: + hosts = role_manager.get_role_node_hosts(role, n) + if not hosts: + raise NodeRoleError(n, role) + for hname in hosts: + d[hname].append(n) + nodes = defaultdict_to_dict(d) + else: + nodes = nodes + + all_values = [n for v in nodes.values() for n in v] + if not all_values: raise ValueError(f"No nodes to perform the action '{action} of role {role}") + result = role_manager.perform_action( role, action, hosts_node_map=nodes, host_vars=host_vars, node_vars=node_vars, extra_args=extra_args) @@ -173,6 +190,46 @@ def role_action(role, action, node, node_vars, host_vars, extra): f"executed successfully...") return 1 + print(f"Action {action} from role {role} was successfully performed!") + return 0 + + +@role.command('remove') +@click.argument('role', nargs=1, type=str, required=True) +@click.option('-n', '--node', nargs=1, type=str, multiple=True, required=True, + help='Nodes to perform the action. Can use multiple "-n" commands and it ' + 'can be a list of colon-separated node as ",,..." ' + 'or ":,". The formats are ' + 'mutually exclusive. If not is passed, the action will be ' + 'performed in all nodes that belongs to the role.') +def role_remove(role, node): + """ Perform an group action at a set of nodes. + + The ROLE argument specify the role which the action will be performed. + """ + role_manager = get_role_manager() + nodes, node_vars, host_vars, extra_args = _split_vars(node, [], [], []) + + if not nodes: + raise ArgumentError('No nodes informed') + + if type(nodes) is list: + d = defaultdict(list) + for n in nodes: + hosts = role_manager.get_role_node_hosts(role, n) + if not hosts: + raise NodeRoleError(n, role) + for hname in hosts: + d[hname].append(n) + nodes = defaultdict_to_dict(d) + else: + nodes = nodes + + if not nodes: + raise ValueError(f"No nodes to remove from role {role}") + + result = role_manager.remove_role(role, nodes) + print(f"{len(result)} nodes were removed from {role}: {', '.join(sorted(result))}") return 0 diff --git a/clap/cluster_manager.py b/clap/cluster_manager.py index d984a22a..5a936575 100644 --- a/clap/cluster_manager.py +++ b/clap/cluster_manager.py @@ -11,8 +11,8 @@ from clap.executor import SSHCommandExecutor, AnsiblePlaybookExecutor from clap.node_manager import NodeManager, NodeRepositoryController from clap.repository import Repository, InvalidEntryError -from clap.role_manager import RoleManager -from clap.utils import yaml_load, get_logger, get_random_object +from clap.role_manager import RoleManager, NodeRoleError +from clap.utils import yaml_load, get_logger, get_random_object, defaultdict_to_dict logger = get_logger(__name__) @@ -323,6 +323,41 @@ def get_cluster_by_id(self, cluster_id: str) -> ClusterDescriptor: def get_all_clusters(self) -> List[ClusterDescriptor]: return self.cluster_repository.get_all_clusters() + def grow(self, cluster_id: str, node_type: str, count: int = 1, + min_count: int = 0, start_timeout: int = 600): + if min_count < 0: + raise ValueError("min_count value must be >= 0") + if count <= 0: + raise ValueError("count value must be higher than 0") + if min_count > count: + raise ValueError("min_count must be smaller then count") + cluster = self.get_cluster_by_id(cluster_id) + if node_type not in cluster.cluster_config.nodes: + raise ValueError(f"Invalid node of type '{node_type}' from cluster " + f"with config: {cluster.cluster_config.cluster_config_id}") + node_config_name = cluster.cluster_config.nodes[node_type].type + instance_info = self.config_db.instance_descriptors[node_config_name] + nodes = self.start_cluster_node( + cluster_id, node_type, instance_info, count, start_timeout) + + if len(nodes) < min_count: + logger.error(f"Minimum count of nodes to start ({min_count}) was not " + f"reached. Terminating started nodes.") + self.node_manager.stop_nodes(nodes) + raise ClusterError("Minimum number of nodes not reached") + + # Check aliveness + alive_nodes = self.node_manager.is_alive(nodes, retries=15) + reachable_nodes = [nid for nid, status in alive_nodes.items() if status] + if len(reachable_nodes) < min_count: + logger.error(f"Minimum count of nodes to start ({min_count}) was not " + f"reached (some of them are unreachable). " + f"Terminating started nodes.") + self.node_manager.stop_nodes(nodes) + raise ClusterError("Minimum number of nodes not reached") + + return nodes + def start_cluster_node(self, cluster_id: str, node_type: str, instance_info: InstanceInfo, count: int, start_timeout: int = 600) -> List[str]: @@ -334,10 +369,12 @@ def start_cluster(self, cluster_config: ClusterConfig, start_timeout: int = 600, max_workers: int = 1, destroy_on_min_count: bool = True) -> str: - node_types: Dict[str, Tuple[NodeConfig, InstanceInfo]] = { - node_name: (node_values, self.config_db.instance_descriptors[node_values.type]) - for node_name, node_values in cluster_config.nodes.items() - } + node_types: Dict[str, Tuple[NodeConfig, InstanceInfo]] = {} + for node_name, node_values in cluster_config.nodes.items(): + instance = self.config_db.instance_descriptors.get(node_values.type, None) + if instance is None: + raise ValueError(f"Invalid instance config: {node_values.type}") + node_types[node_name] = (node_values, instance) creation_time = time.time() random_obj = ''.join([n.capitalize() for n in get_random_object().split(' ')]) @@ -391,6 +428,7 @@ def _start_cluster_node(node_type: str) -> Tuple[str, List[str]]: logger.error("Destroying cluster... Stopping all nodes: " f"{', '.join(nodes_to_stop)}") self.node_manager.stop_nodes(nodes_to_stop) + raise ClusterError("Minimum number of nodes not reached") self.cluster_repository.upsert_cluster(cluster) return cluster.cluster_id @@ -405,18 +443,25 @@ def add_existing_nodes_to_cluster(self, cluster_id: str, self.setup_cluster(cluster_id, node_types, max_workers) def run_action(self, action: ActionType, node_ids: List[str]) -> bool: + logger.info(f"Executing action: {action} at nodes: {node_ids}") try: nodes = self.node_manager.get_nodes_by_id(node_ids) if type(action) is CommandActionType: e = SSHCommandExecutor(action.command, nodes, self.private_dir) result = e.run() - return result['ok'] + return all(r['ok'] for r in result.values()) elif type(action) is RoleActionType: - role_node_dict = self.role_manager.get_role_nodes( - action.role, from_node_ids=node_ids) + d = defaultdict(list) + for n in node_ids: + hosts = self.role_manager.get_role_node_hosts(action.role, n) + if not hosts: + raise NodeRoleError(n, action.role) + for hname in hosts: + d[hname].append(n) + _nodes_ids = defaultdict_to_dict(d) result = self.role_manager.perform_action( - action.role, action.action, role_node_dict, extra_args=action.extra) + action.role, action.action, _nodes_ids, extra_args=action.extra) return result.ok elif type(action) is PlaybookActionType: @@ -430,25 +475,28 @@ def run_action(self, action: ActionType, node_ids: List[str]) -> bool: else: logger.error(f"Invalid action type: {type(action)}") return False + except Exception as e: - logger.error(e) + logger.error(f"{e.__class__.__name__}: {e}") return False def run_role_add(self, role: RoleAdd, node_ids: List[str]) -> bool: try: if '/' in role.name: host_map = {role.name.split('/')[1]: node_ids} + role_name = role.name.split('/')[0] else: host_map = node_ids + role_name = role.name added_nodes = self.role_manager.add_role( - role.name, host_map, extra_args=role.extra) + role_name, host_map, extra_args=role.extra) return all(n in added_nodes for n in node_ids) except Exception as e: logger.error(e) return False def run_setup(self, setup: SetupConfig, node_ids: List[str]) -> bool: - logger.info(f"* Running setup {setup} at nodes: {node_ids}") + logger.info(f"Running setup {setup} at nodes: {node_ids}") for role in setup.roles: if not self.run_role_add(role, node_ids): return False @@ -458,24 +506,23 @@ def run_setup(self, setup: SetupConfig, node_ids: List[str]) -> bool: return True def _run_setup_list(self, setups: List[SetupConfig], node_ids: List[str]) -> bool: - logger.info(f"*** Running {len(setups)} setups at nodes: {node_ids}") for setup in setups: if not self.run_setup(setup, node_ids): return False return True - def setup_cluster(self, cluster_id: str, nodes_types: Dict[str, List[str]] = None, + def setup_cluster(self, cluster_id: str, nodes_being_added: Dict[str, List[str]] = None, max_workers: int = 1, start_at_stage: str = 'before_all'): cluster = self.cluster_repository.get_cluster_by_id(cluster_id) cluster.is_setup = False self.cluster_repository.upsert_cluster(cluster) - if not nodes_types: - nodes_types = self.get_cluster_nodes_types(cluster_id) + if not nodes_being_added: + nodes_being_added = self.get_cluster_nodes_types(cluster_id) all_nodes = self.get_all_cluster_nodes(cluster_id) all_being_added = list( - {n for _, list_nodes in nodes_types.items() for n in list_nodes} + {n for _, list_nodes in nodes_being_added.items() for n in list_nodes} ) stages = { 'before_all': 1, @@ -504,7 +551,7 @@ def setup_cluster(self, cluster_id: str, nodes_types: Dict[str, List[str]] = Non with ThreadPool(processes=max_workers) as pool: values: List[Tuple[List[SetupConfig], List[str]]] = [ (cluster.cluster_config.nodes[node_type].setups, node_list) - for node_type, node_list in nodes_types.items() + for node_type, node_list in nodes_being_added.items() ] results = pool.starmap(self._run_setup_list, values) @@ -557,3 +604,6 @@ def is_alive(self, cluster_id: str, retries: int = 5, nodes, retries=retries, wait_timeout=wait_timeout, update_timeout=update_timeout, max_workers=max_workers, test_command=test_command) + + def upsert_cluster(self, cluster: ClusterDescriptor): + self.cluster_repository.upsert_cluster(cluster) \ No newline at end of file diff --git a/clap/role_manager.py b/clap/role_manager.py index 64546748..4f38429c 100644 --- a/clap/role_manager.py +++ b/clap/role_manager.py @@ -42,10 +42,12 @@ class RoleAssignmentError(RoleError): class NodeRoleError(RoleError): - def __init__(self, node_id: str, role_name: str): + def __init__(self, node_id: str, role_name: str, host_name: str = None): self.node_id = node_id self.role_name = role_name - super().__init__(f"Node {node_id} does not belong to {role_name}") + self.host_name = host_name + rname = role_name if not host_name else f"{role_name}/{host_name}" + super().__init__(f"Node {node_id} does not belong to {rname}") class MissingActionVariableError(RoleError): @@ -90,6 +92,51 @@ def __init__(self, node_repository_controller: NodeRepositoryController, if load: self.load_roles() + def get_all_role_nodes(self, role_name: str) -> List[str]: + nodes = self.node_repository.get_nodes_filter( + lambda n: role_name in n.roles or f"{role_name}/" in n.roles + ) + return [n.node_id for n in nodes] + + def get_role_node_hosts(self, role_name: str, node_id: str) -> List[str]: + role = self.roles[role_name] + node = self.node_repository.get_nodes_by_id([node_id])[0] + + hosts = [] + if role.hosts: + for hname in role.hosts: + search_for = f"{role_name}/{hname}" + if search_for in node.roles: + hosts.append(hname) + else: + if role_name in node.roles: + hosts = [''] + + return hosts + + def get_all_role_nodes_hosts(self, role_name: str) -> \ + Dict[str, List[str]]: + role = self.roles[role_name] + if role.hosts: + search_for = [f"{role_name}/{host}" for host in role.hosts] + else: + search_for = [role_name] + + host_nodes_map = { + rname.split('/')[-1]: [ + node.node_id + for node in self.node_repository.get_nodes_filter( + lambda n: rname in n.roles + ) + ] + for rname in search_for + } + + if not role.hosts: + host_nodes_map = {'': host_nodes_map[role_name]} + + return host_nodes_map + def get_role_nodes(self, role_name: str, from_node_ids: List[str] = None) -> \ Dict[str, List[str]]: role = self.roles[role_name] @@ -189,6 +236,25 @@ def add_role(self, role_name: str, return list(added_nodes) + def _check_nodes_role(self, role_name: str, host_map: Dict[str, List[NodeDescriptor]]): + if role_name not in self.roles: + raise InvalidRoleError(role_name) + role: Role = self.roles[role_name] + + if role.hosts: + for hname, nodes in host_map.items(): + search_for = f"{role_name}/{hname}" + for node in nodes: + if search_for not in node.roles: + raise NodeRoleError(node.node_id, role_name, hname) + else: + if '' not in host_map: + raise ValueError( + "host_map variable must define key empty string key") + for node in host_map['']: + if role_name not in node.roles: + raise NodeRoleError(node.node_id, role_name) + def perform_action(self, role_name: str, action_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]], host_vars: Dict[str, Dict[str, str]] = None, @@ -197,6 +263,25 @@ def perform_action(self, role_name: str, action_name: str, quiet: bool = False, validate_nodes_in_role: bool = True) -> \ AnsiblePlaybookExecutor.PlaybookResult: + """ + + :param role_name: + :param action_name: + :param hosts_node_map: If the role does not defines hosts, this value can be: + - A list of node_ids, e.g.: [id1, id2] + - A dictionary with a empty string key and the value is + a list of node_ids, e.g.: {'': [id1, id2]} + If the role defines hosts, this value can be: + - A dictionary, where key is the host name and the + values are lists of node_ids, e.g. + { hostA: [id1, id2], hostB: [id2, id3] } + :param host_vars: + :param node_vars: + :param extra_args: + :param quiet: + :param validate_nodes_in_role: + :return: + """ host_vars = host_vars or dict() node_vars = node_vars or dict() extra_args = extra_args or dict() @@ -209,65 +294,39 @@ def perform_action(self, role_name: str, action_name: str, raise InvalidActionError(role_name, action_name) action = role.actions[action_name] - # The role has hosts? If True, hosts_node_map must provide a dict like: - # hosts_node_map = { - # 'host-a': ['node-1', 'node-2', ...], - # 'host-b': ['node-x', 'node-y'] - # } - if role.hosts: - if type(hosts_node_map) is not dict: - raise TypeError(f"The role '{role_name}' defines " - f"{len(role.hosts)} hosts. It must be informed " - f"which nodes belong to each role's host, as a dict") - # Check if provided host_names are valid - for host_name in hosts_node_map.keys(): - if host_name not in role.hosts: - raise InvalidHostError(role_name, host_name) - inventory: Dict[str, List[str]] = hosts_node_map - # The role has hosts? If false, hosts_node_map must provide a list like: - # ['node-1', 'node-2'] - # or a dict like (dict must have only one entry): - # { role_name: ['node-1', 'node-2'] } - # It will be expanded (result) to: - # { role_name: ['node-1', 'node-2'] } - else: - if type(hosts_node_map) is dict: - # Check format: {role_name: ['node-1', 'node-2']} - if len(hosts_node_map) != 1 or role_name not in hosts_node_map: - raise ValueError(f"Invalid hosts {list(hosts_node_map.keys())} " - f"for role {role_name}") - inventory: Dict[str, List[str]] = hosts_node_map - elif type(hosts_node_map) is list: - # If it's a list, simple expand to { role_name: ['node-1, ...] } - inventory: Dict[str, List[str]] = {role_name: hosts_node_map} + # Check hosts_node_map variable + if not role.hosts: + if type(hosts_node_map) is list: + _inventory = {'': hosts_node_map} + elif type(hosts_node_map) is dict: + if '' not in hosts_node_map: + raise ValueError("hosts_node_map variable must contain " + "'None' key.") + _inventory = {'': hosts_node_map['']} else: - raise TypeError(f"The role '{role_name}' does not define any " - f"host. It must be informed the nodes as a list " - f"or a valid dict.") + raise TypeError(f"hosts_node_map variable expects a list or a dict, " + f"not a {type(hosts_node_map)}") + else: + if type(hosts_node_map) is not dict: + raise TypeError(f"As role {role_name} defines hosts, hosts_node_map " + f"variable expects a dict, not a {type(hosts_node_map)}") + _inventory = dict() + for hname, node_list in hosts_node_map.items(): + if hname not in role.hosts: + raise InvalidHostError(role_name, hname) + _inventory[hname] = node_list # Expand node_ids to NodeDescriptors inventory: Dict[str, List[NodeDescriptor]] = { host_name: self.node_repository.get_nodes_by_id(list_nodes) - for host_name, list_nodes in inventory.items() + for host_name, list_nodes in _inventory.items() } - # Validate if a node belongs to a role. if validate_nodes_in_role: - # { role_name: ['node-1', 'node-2'] } - if role_name in inventory: - for n in inventory[role_name]: - if role_name not in n.roles: - raise NodeRoleError(n.node_id, role_name) - # { - # 'host-a': ['node-1', 'node-2', ...], - # 'host-b': ['node-x', 'node-y'] - # } - else: - for host_name, list_nodes in inventory.items(): - for node in list_nodes: - if f"{role_name}/{host_name}" not in node.roles: - raise NodeRoleError( - node.node_id, f"{role_name}/{host_name}") + self._check_nodes_role(role_name, inventory) + + if not role.hosts: + inventory = {role_name: inventory['']} # Check if every required role's action variable is informed via extra_args for var in action.vars: @@ -294,4 +353,40 @@ def perform_action(self, role_name: str, action_name: str, def remove_role(self, role_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]]) -> \ List[str]: - pass + role = self.roles[role_name] + + if not role.hosts: + if type(hosts_node_map) is list: + _inventory = {'': hosts_node_map} + elif type(hosts_node_map) is dict: + if '' not in hosts_node_map: + raise ValueError("hosts_node_map variable must contain " + "'None' key.") + _inventory = {'': hosts_node_map['']} + else: + raise TypeError(f"hosts_node_map variable expects a list or a dict, " + f"not a {type(hosts_node_map)}") + else: + _inventory = hosts_node_map + + # Expand node_ids to NodeDescriptors + inventory: Dict[str, List[NodeDescriptor]] = { + host_name: self.node_repository.get_nodes_by_id(list_nodes) + for host_name, list_nodes in _inventory.items() + } + + self._check_nodes_role(role_name, inventory) + node_set = set() + + for h, node_list in hosts_node_map.items(): + if h == '': + h = role_name + else: + h = f"{role_name}/{h}" + + for node in self.node_repository.get_nodes_by_id(node_list): + node.roles.remove(h) + self.node_repository.upsert_node(node) + node_set.add(node.node_id) + + return list(node_set) diff --git a/clap/utils.py b/clap/utils.py index 8d8d12af..5356c0cb 100644 --- a/clap/utils.py +++ b/clap/utils.py @@ -121,3 +121,11 @@ def sorted_groupby(iterable: Iterable, key=None) -> dict: def get_logger(name): return logging.getLogger(f'{APP_NAME}.{name}') + + +def str_at_middle(text: str, maximum: int, delimiter: str = '-'): + if len(text) > maximum-2: + return text + size = (maximum - len(text)) // 2 + return delimiter*size + ' ' + text + ' ' + delimiter*size + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..e41c06f7 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,21 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +# SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build +SPHINXBUILD = python3 -msphinx + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/doctrees/architecture.doctree b/docs/build/doctrees/architecture.doctree new file mode 100644 index 00000000..1b6bd2e2 Binary files /dev/null and b/docs/build/doctrees/architecture.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/abstract_provider/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/abstract_provider/index.doctree new file mode 100644 index 00000000..21de3d37 Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/abstract_provider/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/cluster_manager/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/cluster_manager/index.doctree new file mode 100644 index 00000000..3df006c0 Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/cluster_manager/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/configs/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/configs/index.doctree new file mode 100644 index 00000000..9158159a Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/configs/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/executor/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/executor/index.doctree new file mode 100644 index 00000000..5e13601d Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/executor/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/index.doctree new file mode 100644 index 00000000..8cf8bb7b Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/node/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/node/index.doctree new file mode 100644 index 00000000..6f14e896 Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/node/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/node_manager/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/node_manager/index.doctree new file mode 100644 index 00000000..6713b508 Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/node_manager/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/repository/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/repository/index.doctree new file mode 100644 index 00000000..81b0e37b Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/repository/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/role_manager/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/role_manager/index.doctree new file mode 100644 index 00000000..170418ff Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/role_manager/index.doctree differ diff --git a/docs/build/doctrees/autoapi/CLAP/clap/utils/index.doctree b/docs/build/doctrees/autoapi/CLAP/clap/utils/index.doctree new file mode 100644 index 00000000..ffa2d77c Binary files /dev/null and b/docs/build/doctrees/autoapi/CLAP/clap/utils/index.doctree differ diff --git a/docs/build/doctrees/autoapi/index.doctree b/docs/build/doctrees/autoapi/index.doctree new file mode 100644 index 00000000..b1ae3b7e Binary files /dev/null and b/docs/build/doctrees/autoapi/index.doctree differ diff --git a/docs/build/doctrees/configuration.doctree b/docs/build/doctrees/configuration.doctree new file mode 100644 index 00000000..f8b877ab Binary files /dev/null and b/docs/build/doctrees/configuration.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 00000000..fe01c4a8 Binary files /dev/null and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree new file mode 100644 index 00000000..1fbad778 Binary files /dev/null and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/introduction.doctree b/docs/build/doctrees/introduction.doctree new file mode 100644 index 00000000..717b8611 Binary files /dev/null and b/docs/build/doctrees/introduction.doctree differ diff --git a/docs/build/doctrees/shared_roles.doctree b/docs/build/doctrees/shared_roles.doctree new file mode 100644 index 00000000..b7f50f7b Binary files /dev/null and b/docs/build/doctrees/shared_roles.doctree differ diff --git a/docs/build/doctrees/troubleshooting.doctree b/docs/build/doctrees/troubleshooting.doctree new file mode 100644 index 00000000..a0ad309d Binary files /dev/null and b/docs/build/doctrees/troubleshooting.doctree differ diff --git a/docs/build/doctrees/tutorials.doctree b/docs/build/doctrees/tutorials.doctree new file mode 100644 index 00000000..22deb230 Binary files /dev/null and b/docs/build/doctrees/tutorials.doctree differ diff --git a/docs/build/doctrees/usage.doctree b/docs/build/doctrees/usage.doctree new file mode 100644 index 00000000..f6d4f98c Binary files /dev/null and b/docs/build/doctrees/usage.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo new file mode 100644 index 00000000..6b7e0ddb --- /dev/null +++ b/docs/build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 64e23d65e4acd78b8e57ca437bf6a32a +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/architecture.rst.txt b/docs/build/html/_sources/architecture.rst.txt new file mode 100644 index 00000000..2a48247d --- /dev/null +++ b/docs/build/html/_sources/architecture.rst.txt @@ -0,0 +1,7 @@ +.. _architecture: + +====================== +Architecture +====================== + +Sorry, to be written... \ No newline at end of file diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/abstract_provider/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/abstract_provider/index.rst.txt new file mode 100644 index 00000000..ddbeebc2 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/abstract_provider/index.rst.txt @@ -0,0 +1,68 @@ +:mod:`CLAP.clap.abstract_provider` +================================== + +.. py:module:: CLAP.clap.abstract_provider + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.abstract_provider.AbstractInstanceProvider + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.abstract_provider.logger + + +.. data:: logger + + + + +.. exception:: InstanceDeploymentError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. class:: AbstractInstanceProvider + + Bases: :py:obj:`abc.ABC` + + Helper class that provides a standard way to create an ABC using + inheritance. + + .. method:: start_instances(self, instance: clap.configs.InstanceInfo, count: int, timeout: int = 600) -> List[clap.node.NodeDescriptor] + :abstractmethod: + + + .. method:: stop_instances(self, nodes_to_stop: List[clap.node.NodeDescriptor], timeout: int = 600) -> List[clap.node.NodeDescriptor] + :abstractmethod: + + + .. method:: pause_instances(self, nodes_to_pause: List[clap.node.NodeDescriptor], timeout: int = 600) -> List[clap.node.NodeDescriptor] + :abstractmethod: + + + .. method:: resume_instances(self, nodes_to_resume: List[clap.node.NodeDescriptor], timeout: int = 600) -> List[clap.node.NodeDescriptor] + :abstractmethod: + + + .. method:: update_instance_info(self, nodes_to_check: List[clap.node.NodeDescriptor], timeout: int = 600) -> List[clap.node.NodeDescriptor] + :abstractmethod: + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/cluster_manager/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/cluster_manager/index.rst.txt new file mode 100644 index 00000000..7d28b8a8 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/cluster_manager/index.rst.txt @@ -0,0 +1,438 @@ +:mod:`CLAP.clap.cluster_manager` +================================ + +.. py:module:: CLAP.clap.cluster_manager + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.cluster_manager.RoleActionType + CLAP.clap.cluster_manager.CommandActionType + CLAP.clap.cluster_manager.PlaybookActionType + CLAP.clap.cluster_manager.RoleAdd + CLAP.clap.cluster_manager.SetupConfig + CLAP.clap.cluster_manager.ClusterOptions + CLAP.clap.cluster_manager._NodeConfig + CLAP.clap.cluster_manager._ClusterConfig + CLAP.clap.cluster_manager.ClusterConfigFile + CLAP.clap.cluster_manager.NodeConfig + CLAP.clap.cluster_manager.ClusterConfig + CLAP.clap.cluster_manager.ClusterConfigDatabase + CLAP.clap.cluster_manager.ClusterDescriptor + CLAP.clap.cluster_manager.ClusterRepositoryController + CLAP.clap.cluster_manager.ClusterManager + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.cluster_manager.validate_valid_role + CLAP.clap.cluster_manager.validate_valid_cluster + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.cluster_manager.logger + CLAP.clap.cluster_manager.ActionType + + +.. data:: logger + + + + +.. exception:: ClusterConfigurationError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: ClusterError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: ClusterSetupError + + + Bases: :py:obj:`ClusterError` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidClusterError(cluster_id: str) + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidSetupError(cluster_name: str, setup_name: str) + + + Bases: :py:obj:`ClusterConfigurationError` + + Common base class for all non-exit exceptions. + + +.. exception:: NodeSizeError + + + Bases: :py:obj:`ClusterConfigurationError` + + Common base class for all non-exit exceptions. + + +.. class:: RoleActionType + + .. attribute:: role + :annotation: :str + + + + .. attribute:: action + :annotation: :str + + + + .. attribute:: extra + :annotation: :Optional[Dict[str, str]] + + + + +.. class:: CommandActionType + + .. attribute:: command + :annotation: :str + + + + +.. class:: PlaybookActionType + + .. attribute:: playbook + :annotation: :str + + + + .. attribute:: extra + :annotation: :Optional[Dict[str, str]] + + + + +.. data:: ActionType + + + + +.. class:: RoleAdd + + .. attribute:: name + :annotation: :str + + + + .. attribute:: extra + :annotation: :Optional[Dict[str, str]] + + + + +.. class:: SetupConfig + + .. attribute:: roles + :annotation: :Optional[List[RoleAdd]] + + + + .. attribute:: actions + :annotation: :Optional[List[ActionType]] + + + + +.. class:: ClusterOptions + + .. attribute:: ssh_to + :annotation: :Optional[str] + + + + +.. class:: _NodeConfig + + .. attribute:: type + :annotation: :str + + + + .. attribute:: count + :annotation: :int + + + + .. attribute:: min_count + :annotation: :Optional[int] + + + + .. attribute:: setups + :annotation: :List[str] + + + + +.. class:: _ClusterConfig + + .. attribute:: options + :annotation: :Optional[ClusterOptions] + + + + .. attribute:: before_all + :annotation: :Optional[List[str]] + + + + .. attribute:: before + :annotation: :Optional[List[str]] + + + + .. attribute:: after_all + :annotation: :Optional[List[str]] + + + + .. attribute:: after + :annotation: :Optional[List[str]] + + + + .. attribute:: nodes + :annotation: :Optional[Dict[str, _NodeConfig]] + + + + +.. class:: ClusterConfigFile + + .. attribute:: setups + :annotation: :Optional[Dict[str, SetupConfig]] + + + + .. attribute:: clusters + :annotation: :Optional[Dict[str, _ClusterConfig]] + + + + +.. class:: NodeConfig + + .. attribute:: type + :annotation: :str + + + + .. attribute:: count + :annotation: :int + + + + .. attribute:: min_count + :annotation: :Optional[int] + + + + .. attribute:: setups + :annotation: :List[SetupConfig] + + + + +.. class:: ClusterConfig + + .. attribute:: cluster_config_id + :annotation: :str + + + + .. attribute:: options + :annotation: :Optional[ClusterOptions] + + + + .. attribute:: before_all + :annotation: :Optional[List[SetupConfig]] + + + + .. attribute:: before + :annotation: :Optional[List[SetupConfig]] + + + + .. attribute:: after_all + :annotation: :Optional[List[SetupConfig]] + + + + .. attribute:: after + :annotation: :Optional[List[SetupConfig]] + + + + .. attribute:: nodes + :annotation: :Optional[Dict[str, NodeConfig]] + + + + +.. function:: validate_valid_role() + + +.. function:: validate_valid_cluster() + + +.. class:: ClusterConfigDatabase(cluster_files: List[str], discard_invalids: bool = True, load: bool = True) + + + .. method:: _load_cluster_and_setups(self) + + + .. method:: load(self) + + + +.. class:: ClusterDescriptor + + .. attribute:: cluster_id + :annotation: :str + + + + .. attribute:: cluster_name + :annotation: :str + + + + .. attribute:: cluster_config + :annotation: :ClusterConfig + + + + .. attribute:: creation_time + :annotation: :float + + + + .. attribute:: update_time + :annotation: :float + + + + .. attribute:: is_setup + :annotation: :bool = False + + + + +.. class:: ClusterRepositoryController(repository: clap.repository.Repository) + + + .. method:: upsert_cluster(self, cluster: ClusterDescriptor) + + + .. method:: remove_cluster(self, cluster_id: str) + + + .. method:: get_cluster_by_id(self, cluster_id: str) -> ClusterDescriptor + + + .. method:: get_all_clusters(self) -> List[ClusterDescriptor] + + + +.. class:: ClusterManager(node_manager: clap.node_manager.NodeManager, role_manager: clap.role_manager.RoleManager, config_db: clap.configs.ConfigurationDatabase, cluster_repository_controller: ClusterRepositoryController, private_dir: str, cluster_tag_prefix: str = '.cluster:') + + + .. method:: add_cluster_tag(self, node_ids: List[str], cluster_id: str, node_type: str) -> List[str] + + + .. method:: get_all_cluster_nodes(self, cluster_id: str) -> List[str] + + + .. method:: get_cluster_nodes_types(self, cluster_id: str) -> Dict[str, List[str]] + + + .. method:: get_cluster_by_id(self, cluster_id: str) -> ClusterDescriptor + + + .. method:: get_all_clusters(self) -> List[ClusterDescriptor] + + + .. method:: grow(self, cluster_id: str, node_type: str, count: int = 1, min_count: int = 0, start_timeout: int = 600) + + + .. method:: start_cluster_node(self, cluster_id: str, node_type: str, instance_info: clap.configs.InstanceInfo, count: int, start_timeout: int = 600) -> List[str] + + + .. method:: start_cluster(self, cluster_config: ClusterConfig, start_timeout: int = 600, max_workers: int = 1, destroy_on_min_count: bool = True) -> str + + + .. method:: add_existing_nodes_to_cluster(self, cluster_id: str, node_types: Dict[str, List[str]], max_workers: int = 1) + + + .. method:: run_action(self, action: ActionType, node_ids: List[str]) -> bool + + + .. method:: run_role_add(self, role: RoleAdd, node_ids: List[str]) -> bool + + + .. method:: run_setup(self, setup: SetupConfig, node_ids: List[str]) -> bool + + + .. method:: _run_setup_list(self, setups: List[SetupConfig], node_ids: List[str]) -> bool + + + .. method:: setup_cluster(self, cluster_id: str, nodes_being_added: Dict[str, List[str]] = None, max_workers: int = 1, start_at_stage: str = 'before_all') + + + .. method:: pause_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1) -> List[str] + + + .. method:: resume_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1) -> List[str] + + + .. method:: stop_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1, remove_cluster: bool = True) -> List[str] + + + .. method:: is_alive(self, cluster_id: str, retries: int = 5, wait_timeout: int = 30, update_timeout: int = 30, max_workers: int = 1, test_command: str = 'echo "OK"') -> Dict[str, bool] + + + .. method:: upsert_cluster(self, cluster: ClusterDescriptor) + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/configs/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/configs/index.rst.txt new file mode 100644 index 00000000..075c5255 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/configs/index.rst.txt @@ -0,0 +1,283 @@ +:mod:`CLAP.clap.configs` +======================== + +.. py:module:: CLAP.clap.configs + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.configs.ProviderConfigAWS + CLAP.clap.configs.ProviderConfigLocal + CLAP.clap.configs.LoginConfig + CLAP.clap.configs.InstanceConfigAWS + CLAP.clap.configs.InstanceInfo + CLAP.clap.configs.ConfigurationDatabase + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.configs.logger + CLAP.clap.configs.provider_handlers + CLAP.clap.configs.ProviderConfigs + CLAP.clap.configs.LoginConfigs + CLAP.clap.configs.InstanceConfigs + + +.. data:: logger + + + + +.. exception:: ConfigurationError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidConfigurationError(name: str) + + + Bases: :py:obj:`ConfigurationError` + + Common base class for all non-exit exceptions. + + +.. class:: ProviderConfigAWS + + .. attribute:: provider_config_id + :annotation: :str + + + + .. attribute:: region + :annotation: :str + + + + .. attribute:: access_keyfile + :annotation: :str + + + + .. attribute:: secret_access_keyfile + :annotation: :str + + + + .. attribute:: vpc + :annotation: :Optional[str] + + + + .. attribute:: url + :annotation: :Optional[str] + + + + .. attribute:: provider + :annotation: :str = aws + + + + +.. class:: ProviderConfigLocal + + .. attribute:: provider_config_id + :annotation: :str + + + + .. attribute:: provider + :annotation: :str = local + + + + +.. class:: LoginConfig + + .. attribute:: login_config_id + :annotation: :str + + + + .. attribute:: user + :annotation: :str + + + + .. attribute:: keypair_name + :annotation: :str + + + + .. attribute:: keypair_public_file + :annotation: :str + + + + .. attribute:: keypair_private_file + :annotation: :str + + + + .. attribute:: ssh_port + :annotation: :Optional[int] = 22 + + + + .. attribute:: sudo + :annotation: :Optional[bool] = True + + + + .. attribute:: sudo_user + :annotation: :Optional[str] = root + + + + +.. class:: InstanceConfigAWS + + .. attribute:: instance_config_id + :annotation: :str + + + + .. attribute:: provider + :annotation: :str + + + + .. attribute:: login + :annotation: :str + + + + .. attribute:: flavor + :annotation: :str + + + + .. attribute:: image_id + :annotation: :str + + + + .. attribute:: security_group + :annotation: :Optional[str] + + + + .. attribute:: boot_disk_size + :annotation: :Optional[int] + + + + .. attribute:: boot_disk_device + :annotation: :Optional[str] + + + + .. attribute:: boot_disk_type + :annotation: :Optional[str] + + + + .. attribute:: boot_disk_iops + :annotation: :Optional[str] + + + + .. attribute:: boot_disk_snapshot + :annotation: :Optional[str] + + + + .. attribute:: placement_group + :annotation: :Optional[str] + + + + .. attribute:: price + :annotation: :Optional[float] + + + + .. attribute:: timeout + :annotation: :Optional[int] + + + + .. attribute:: network_ids + :annotation: :Optional[List[str]] + + + + +.. data:: provider_handlers + + + + +.. data:: ProviderConfigs + + + + +.. data:: LoginConfigs + + + + +.. data:: InstanceConfigs + + + + +.. class:: InstanceInfo + + .. attribute:: provider + :annotation: :ProviderConfigs + + + + .. attribute:: login + :annotation: :LoginConfigs + + + + .. attribute:: instance + :annotation: :InstanceConfigs + + + + +.. class:: ConfigurationDatabase(providers_file: str, logins_file: str, instances_file: str, discard_invalids: bool = True, load: bool = True) + + + .. method:: _load_provider_configs(self) + + + .. method:: _load_login_configs(self) + + + .. method:: _load_instance_configs(self) + + + .. method:: load_all(self) + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/executor/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/executor/index.rst.txt new file mode 100644 index 00000000..9c249bc7 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/executor/index.rst.txt @@ -0,0 +1,108 @@ +:mod:`CLAP.clap.executor` +========================= + +.. py:module:: CLAP.clap.executor + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.executor.Executor + CLAP.clap.executor.SSHCommandExecutor + CLAP.clap.executor.AnsiblePlaybookExecutor + CLAP.clap.executor.ShellInvoker + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.executor.logger + + +.. data:: logger + + + + +.. class:: Executor + + .. method:: run(self) -> Any + :abstractmethod: + + + +.. class:: SSHCommandExecutor(command: str, nodes: List[clap.node.NodeDescriptor], private_path: str, max_workers: int = 0, connection_timeout: float = 10.0, execution_timeout: float = None, environment: dict = None) + + + Bases: :py:obj:`Executor` + + .. method:: connect_and_execute(self, node: clap.node.NodeDescriptor) -> dict + + + .. method:: run(self) -> dict + + + +.. class:: AnsiblePlaybookExecutor(playbook_file: str, private_path: str, inventory: Union[list, dict] = None, extra_args: Dict[str, str] = None, env_vars: Dict[str, str] = None, quiet: bool = False, verbosity: int = 0) + + + Bases: :py:obj:`Executor` + + .. class:: PlaybookResult + + .. attribute:: ok + :annotation: :bool + + + + .. attribute:: ret_code + :annotation: :int + + + + .. attribute:: hosts + :annotation: :Dict[str, bool] + + + + .. attribute:: events + :annotation: :Dict[str, List[dict]] + + + + .. attribute:: vars + :annotation: :Dict[str, Dict[str, Any]] + + + + + .. method:: create_inventory(hosts_node_map: Union[List[clap.node.NodeDescriptor], Dict[str, List[clap.node.NodeDescriptor]]], private_path: str, host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None) -> dict + :staticmethod: + + + .. method:: create_extra_vars(output_dir: str, nodes: List[clap.node.NodeDescriptor], private_path: str) -> dict + :staticmethod: + + + .. method:: run(self) -> PlaybookResult + + + +.. class:: ShellInvoker(node: clap.node.NodeDescriptor, private_path: str, verbosity: int = 0, ssh_binary: str = 'ssh') + + + Bases: :py:obj:`Executor` + + .. method:: run(self) + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/index.rst.txt new file mode 100644 index 00000000..f0a70c09 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/index.rst.txt @@ -0,0 +1,23 @@ +:mod:`CLAP.clap` +================ + +.. py:module:: CLAP.clap + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + abstract_provider/index.rst + cluster_manager/index.rst + configs/index.rst + executor/index.rst + node/index.rst + node_manager/index.rst + repository/index.rst + role_manager/index.rst + utils/index.rst + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/node/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/node/index.rst.txt new file mode 100644 index 00000000..e65f6be7 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/node/index.rst.txt @@ -0,0 +1,162 @@ +:mod:`CLAP.clap.node` +===================== + +.. py:module:: CLAP.clap.node + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.node.NodeStatus + CLAP.clap.node.NodeType + CLAP.clap.node.NodeLifecycle + CLAP.clap.node.NodeDescriptor + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.node.logger + + +.. data:: logger + + + + +.. class:: NodeStatus + + .. attribute:: UNKNOWN + :annotation: = unknown + + + + .. attribute:: STARTED + :annotation: = started + + + + .. attribute:: UNREACHABLE + :annotation: = unreachable + + + + .. attribute:: REACHABLE + :annotation: = reachable + + + + .. attribute:: PAUSED + :annotation: = paused + + + + .. attribute:: STOPPED + :annotation: = stopped + + + + +.. class:: NodeType + + .. attribute:: TYPE_CLOUD + :annotation: = cloud + + + + .. attribute:: TYPE_LOCAL + :annotation: = local + + + + +.. class:: NodeLifecycle + + .. attribute:: NORMAL + :annotation: = normal + + + + .. attribute:: PREEMPTIBLE + :annotation: = preemptible + + + + +.. class:: NodeDescriptor + + .. attribute:: node_id + :annotation: :str + + + + .. attribute:: configuration + :annotation: :clap.configs.InstanceInfo + + + + .. attribute:: nickname + :annotation: :Optional[str] = + + + + .. attribute:: ip + :annotation: :Optional[str] = + + + + .. attribute:: type + :annotation: :Optional[str] + + + + .. attribute:: cloud_instance_id + :annotation: :Optional[str] = + + + + .. attribute:: cloud_lifecycle + :annotation: :Optional[str] + + + + .. attribute:: status + :annotation: :Optional[str] + + + + .. attribute:: creation_time + :annotation: :Optional[float] = 0.0 + + + + .. attribute:: update_time + :annotation: :Optional[float] = 0.0 + + + + .. attribute:: roles + :annotation: :List[str] + + + + .. attribute:: tags + :annotation: :Dict[str, str] + + + + .. attribute:: extra + :annotation: :Dict[str, Any] + + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/node_manager/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/node_manager/index.rst.txt new file mode 100644 index 00000000..e23ea94c --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/node_manager/index.rst.txt @@ -0,0 +1,153 @@ +:mod:`CLAP.clap.node_manager` +============================= + +.. py:module:: CLAP.clap.node_manager + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.node_manager.NodeRepositoryController + CLAP.clap.node_manager.NodeManager + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.node_manager.logger + + +.. data:: logger + + + + +.. exception:: InvalidProvider + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: UnhandledProviderError(provider: str) + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: DeploymentError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidNodeError(node_id: str) + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. class:: NodeRepositoryController(repository: clap.repository.Repository) + + + .. method:: upsert_node(self, node: clap.node.NodeDescriptor) + + + .. method:: remove_node(self, node_id: str) + + + .. method:: remove_nodes(self, node_ids: List[str]) + + + .. method:: get_nodes_by_id(self, node_ids: List[str]) -> List[clap.node.NodeDescriptor] + + + .. method:: get_all_nodes(self) -> List[clap.node.NodeDescriptor] + + + .. method:: get_nodes_filter(self, filter_func: Callable[[clap.node.NodeDescriptor], bool]) -> List[clap.node.NodeDescriptor] + + + +.. class:: NodeManager(node_repository_controller: NodeRepositoryController, providers: Dict[str, clap.abstract_provider.AbstractInstanceProvider], private_dir: str) + + + .. method:: _group_instances_by_provider(instances: List[Tuple[clap.configs.InstanceInfo, int]]) -> Dict[str, List[Tuple[clap.configs.InstanceInfo, int]]] + :staticmethod: + + + .. method:: group_nodes_by_provider(nodes: List[clap.node.NodeDescriptor]) -> Dict[str, List[clap.node.NodeDescriptor]] + :staticmethod: + + + .. method:: get_nodes_by_id(self, node_ids: List[str]) -> List[clap.node.NodeDescriptor] + + + .. method:: get_nodes(self, filter_func: Callable[[clap.node.NodeDescriptor], bool], from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: get_all_nodes(self) -> List[clap.node.NodeDescriptor] + + + .. method:: get_not_running_nodes(self, from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: get_up_nodes(self, from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: get_reachable_nodes(self, from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: get_nodes_with_tag(self, key: str, from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: get_nodes_with_tag_value(self, key: str, value: str, from_node_ids: List[str] = None) -> List[clap.node.NodeDescriptor] + + + .. method:: start_node(self, instance: clap.configs.InstanceInfo, count: int = 1, start_timeout: int = 600) -> List[str] + + + .. method:: start_nodes(self, instance_counts: List[Tuple[clap.configs.InstanceInfo, int]], start_timeout: int = 600, max_workers: int = 1) -> List[str] + + + .. method:: is_alive(self, node_ids: List[str], retries: int = 5, wait_timeout: int = 30, update_timeout: int = 30, max_workers: int = 1, test_command: str = 'echo "OK"') -> Dict[str, bool] + + + .. method:: stop_nodes(self, node_ids: List[str], timeout: int = 180, max_workers: int = 1, remove_nodes: bool = True) -> List[str] + + + .. method:: resume_nodes(self, node_ids: List[str], timeout: int = 600, connection_retries: int = 10, retry_timeout: int = 30, max_workers: int = 1) -> List[str] + + + .. method:: pause_nodes(self, node_ids: List[str], timeout: int = 180, max_workers: int = 1) -> List[str] + + + .. method:: add_tags(self, node_ids: List[str], tags: Dict[str, str]) -> List[str] + + + .. method:: remove_tags(self, node_ids: List[str], tags: List[str]) -> List[str] + + + .. method:: upsert_node(self, node: clap.node.NodeDescriptor) + + + .. method:: remove_node(self, node_id: str) + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/repository/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/repository/index.rst.txt new file mode 100644 index 00000000..7ef6516d --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/repository/index.rst.txt @@ -0,0 +1,182 @@ +:mod:`CLAP.clap.repository` +=========================== + +.. py:module:: CLAP.clap.repository + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.repository.Repository + CLAP.clap.repository.SQLiteRepository + CLAP.clap.repository.RepositoryFactory + + + + +.. exception:: RepositoryError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidEntryError(entry) + + + Bases: :py:obj:`RepositoryError` + + Common base class for all non-exit exceptions. + + +.. class:: Repository(repository_path: str, commit_on_close: bool = True, verbosity: int = 0) + + + Bases: :py:obj:`abc.ABC` + + Helper class that provides a standard way to create an ABC using + inheritance. + + .. attribute:: repository_name + :annotation: :str = AbstractRepository + + + + .. attribute:: extension + :annotation: :str = + + + + .. method:: connect(self, table_name: str) -> Repository + :abstractmethod: + + + .. method:: open(self, table_name: str) + :abstractmethod: + + + .. method:: close(self) + :abstractmethod: + + + .. method:: commit(self) + :abstractmethod: + + + .. method:: keys(self) -> List[str] + :abstractmethod: + + + .. method:: upsert(self, key: str, obj: dict) + :abstractmethod: + + + .. method:: update(self, key: str, update_obj: dict) + :abstractmethod: + + + .. method:: get(self, key: str) -> Dict[str, dict] + :abstractmethod: + + + .. method:: get_multiple(self, key: List[str]) -> dict + :abstractmethod: + + + .. method:: get_all(self) -> Dict[str, dict] + :abstractmethod: + + + .. method:: remove(self, key: str) + :abstractmethod: + + + .. method:: remove_multiple(self, keys: List[str]) + :abstractmethod: + + + .. method:: clear(self) + :abstractmethod: + + + +.. class:: SQLiteRepository(repository_path: str, commit_on_close: bool = True, verbosity: int = 0) + + + Bases: :py:obj:`Repository` + + Helper class that provides a standard way to create an ABC using + inheritance. + + .. attribute:: repository_name + :annotation: :str = sqlite + + + + .. attribute:: extension + :annotation: :str = .db + + + + .. method:: connect(self, table_name: str) -> SQLiteRepository + + + .. method:: open(self, table_name: str) + + + .. method:: close(self) + + + .. method:: commit(self) + + + .. method:: keys(self) -> List[str] + + + .. method:: update(self, key: str, update_obj: dict) + + + .. method:: upsert(self, key: str, obj: dict) + + + .. method:: get(self, key: str) -> dict + + + .. method:: get_multiple(self, keys: List[str]) -> Dict[str, dict] + + + .. method:: get_all(self) -> Dict[str, dict] + + + .. method:: remove(self, key: str) + + + .. method:: remove_multiple(self, keys: List[str]) + + + .. method:: clear(self) + + + .. method:: __repr__(self) + + Return repr(self). + + + +.. class:: RepositoryFactory + + .. attribute:: repositories + + + + + .. method:: get_repository(self, name: str, repository_path: str, commit_on_close: bool = True, verbosity: int = 0) -> Repository + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/role_manager/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/role_manager/index.rst.txt new file mode 100644 index 00000000..4a549e67 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/role_manager/index.rst.txt @@ -0,0 +1,188 @@ +:mod:`CLAP.clap.role_manager` +============================= + +.. py:module:: CLAP.clap.role_manager + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.role_manager.RoleVariableInfo + CLAP.clap.role_manager.RoleActionInfo + CLAP.clap.role_manager.Role + CLAP.clap.role_manager.RoleManager + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.role_manager.logger + + +.. data:: logger + + + + +.. exception:: RoleError + + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidRoleError(role_name: str) + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidActionError(role_name: str, action_name: str) + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. exception:: InvalidHostError(role_name: str, host_name: str) + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. exception:: RoleAssignmentError + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. exception:: NodeRoleError(node_id: str, role_name: str, host_name: str = None) + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. exception:: MissingActionVariableError(role_name: str, action_name: str, var: str) + + + Bases: :py:obj:`RoleError` + + Common base class for all non-exit exceptions. + + +.. class:: RoleVariableInfo + + .. attribute:: name + :annotation: :str + + + + .. attribute:: description + :annotation: :Optional[str] + + + + .. attribute:: optional + :annotation: :Optional[bool] + + + + +.. class:: RoleActionInfo + + .. attribute:: playbook + :annotation: :str + + + + .. attribute:: description + :annotation: :Optional[str] + + + + .. attribute:: vars + :annotation: :Optional[List[RoleVariableInfo]] + + + + +.. class:: Role + + .. attribute:: actions + :annotation: :Optional[Dict[str, RoleActionInfo]] + + + + .. attribute:: hosts + :annotation: :Optional[List[str]] + + + + +.. class:: RoleManager(node_repository_controller: clap.node_manager.NodeRepositoryController, role_dir: str, actions_dir: str, private_dir: str, discard_invalids: bool = True, load: bool = True) + + + .. method:: get_all_role_nodes(self, role_name: str) -> List[str] + + + .. method:: get_role_node_hosts(self, role_name: str, node_id: str) -> List[str] + + + .. method:: get_all_role_nodes_hosts(self, role_name: str) -> Dict[str, List[str]] + + + .. method:: get_role_nodes(self, role_name: str, from_node_ids: List[str] = None) -> Dict[str, List[str]] + + + .. method:: load_roles(self) + + + .. method:: add_role(self, role_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]], host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None, extra_args: Dict[str, str] = None, quiet: bool = False) -> List[str] + + + .. method:: _check_nodes_role(self, role_name: str, host_map: Dict[str, List[clap.node.NodeDescriptor]]) + + + .. method:: perform_action(self, role_name: str, action_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]], host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None, extra_args: Dict[str, str] = None, quiet: bool = False, validate_nodes_in_role: bool = True) -> clap.executor.AnsiblePlaybookExecutor.PlaybookResult + + :param role_name: + :param action_name: + :param hosts_node_map: If the role does not defines hosts, this value can be: + - A list of node_ids, e.g.: [id1, id2] + - A dictionary with a empty string key and the value is + a list of node_ids, e.g.: {'': [id1, id2]} + If the role defines hosts, this value can be: + - A dictionary, where key is the host name and the + values are lists of node_ids, e.g. + { hostA: [id1, id2], hostB: [id2, id3] } + :param host_vars: + :param node_vars: + :param extra_args: + :param quiet: + :param validate_nodes_in_role: + :return: + + + .. method:: remove_role(self, role_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]]) -> List[str] + + + diff --git a/docs/build/html/_sources/autoapi/CLAP/clap/utils/index.rst.txt b/docs/build/html/_sources/autoapi/CLAP/clap/utils/index.rst.txt new file mode 100644 index 00000000..05235555 --- /dev/null +++ b/docs/build/html/_sources/autoapi/CLAP/clap/utils/index.rst.txt @@ -0,0 +1,125 @@ +:mod:`CLAP.clap.utils` +====================== + +.. py:module:: CLAP.clap.utils + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.utils.CLAPFilter + CLAP.clap.utils.Singleton + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.utils.tmpdir + CLAP.clap.utils.path_extend + CLAP.clap.utils.yaml_load + CLAP.clap.utils.float_time_to_string + CLAP.clap.utils.setup_log + CLAP.clap.utils.get_random_name + CLAP.clap.utils.get_random_object + CLAP.clap.utils.defaultdict_to_dict + CLAP.clap.utils.sorted_groupby + CLAP.clap.utils.get_logger + CLAP.clap.utils.str_at_middle + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + CLAP.clap.utils.APP_NAME + + +.. data:: APP_NAME + :annotation: = clap + + + +.. class:: CLAPFilter(name='') + + + Bases: :py:obj:`logging.Filter` + + Filter instances are used to perform arbitrary filtering of LogRecords. + + Loggers and Handlers can optionally use Filter instances to filter + records as desired. The base filter class only allows events which are + below a certain point in the logger hierarchy. For example, a filter + initialized with "A.B" will allow events logged by loggers "A.B", + "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If + initialized with the empty string, all events are passed. + + .. method:: filter(self, record) + + Determine if the specified record is to be logged. + + Is the specified record to be logged? Returns 0 for no, nonzero for + yes. If deemed appropriate, the record may be modified in-place. + + + +.. class:: Singleton + + Bases: :py:obj:`type` + + Creates a single instance class + + + .. attribute:: _instances + + + + + .. method:: __call__(cls, *args, **kwargs) + + Call self as a function. + + + +.. function:: tmpdir(suffix=None, prefix='clap.', dir: str = None, remove: bool = True) + + +.. function:: path_extend(*args) -> str + + +.. function:: yaml_load(filename: str) -> dict + + +.. function:: float_time_to_string(timespec: float) + + +.. function:: setup_log(name: str = 'clap', verbosity_level: int = 0, filename: str = None) + + +.. function:: get_random_name(in_use_names: List[str] = None, retries: int = 10) -> str + + +.. function:: get_random_object() -> str + + +.. function:: defaultdict_to_dict(d) + + +.. function:: sorted_groupby(iterable: Iterable, key=None) -> dict + + +.. function:: get_logger(name) + + +.. function:: str_at_middle(text: str, maximum: int, delimiter: str = '-') + + diff --git a/docs/build/html/_sources/autoapi/index.rst.txt b/docs/build/html/_sources/autoapi/index.rst.txt new file mode 100644 index 00000000..448b407b --- /dev/null +++ b/docs/build/html/_sources/autoapi/index.rst.txt @@ -0,0 +1,10 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/docs/build/html/_sources/configuration.rst.txt b/docs/build/html/_sources/configuration.rst.txt new file mode 100644 index 00000000..5ed7ba6a --- /dev/null +++ b/docs/build/html/_sources/configuration.rst.txt @@ -0,0 +1,274 @@ +.. _configuration: + +============================ +Basic Configuration Setup +============================ + +In order to create compute nodes and interact with them you will need provide +some information about how to connect to the cloud provider +(:ref:`providers configuration `), how to the login into +the machines (:ref:`logins configuration `) and details +about the cloud's virtual machines that can be used (:ref:`instances configuration `). +The following sections will show how to configure these sections and the valid +values for each one. All configuration files use the +`YAML File Format `_ as default format. + + +.. note:: + + YAML use spaces instead of tabs. Be careful to do not messing up! + +.. _cloud configuration: + +Cloud Provider Configuration +------------------------------- + +The ``~/.clap/configs/providers.yaml`` file defines all properties needed to connect +to a specific cloud provider, such as the region, IAM access keys, among others. +In this file you can define multiple provider configurations that is used by +other configurations. An example ``providers.yaml`` file is shown below. + +.. code-block:: yaml + + aws-east-1-config: # Name of the provider configuration ID + provider: aws # Provider (currently only 'aws') + access_keyfile: ec2_access_key.pub # Name of the file in the ~/.clap/private/ directory containing the IAM AWS access key ID + secret_access_keyfile: ec2_access_key.pem # Name of the file in the ~/.clap/private directory containing the IAM AWS Secret Access Key (access ID) + region: us-east-1 # The availability zone you want to use + + my-cool-config-2: + provider: aws + access_keyfile: acesss.pub + secret_access_keyfile: private_access.pem + region: us-east-2 + + my-cool-config-3: + provider: aws + ... + +The YAML dictionary keys (``aws-east-1-config``, ``my-cool-config-2`` and +``my-cool-config-3`` in the above example) are the provider configuration names +(provider IDs) that can be referenced in other files. The values for each provider ID +are specific cloud provider information. You can define as many provider +configurations as you want just adding a new provider ID and the values for it. +Note that each provider ID must be unique. The valid values for a provider +configuration showed in the table below. + +.. list-table:: Valid cloud provider configuration key and values + :header-rows: 1 + + * - **Name** + - **Valid Values or Type** + - **Description** + + * - **provider** + - **valid values**: aws + - Name of the cloud provider to be used + + * - **access_keyfile** + - **type**: string + - **Name of the file** containing the AWS access key ID. The file must be placed at ``~/.clap/private`` and this field must be filled only with the name of file, not the whole path. + + * - **secret_access_keyfile** + - **type**: string + - **Name of the file** containing the AWS Secret Access Key (access ID). The file must be placed at ``~/.clap/private`` and this field must be filled only with the name of file, not the whole path. + + * - **region** + - **type**: string + - The availability zone you want to use (e.g. ``us-east-1``) + + * - **vpc (optional)** + - **type**: string + - Name or ID of the AWS Virtual Private Cloud to provision resources in. + + +.. note:: + For CLAP, **all keys** must be stored at ``~/.clap/private/`` directory with + 400 permission (use the ``chmod 400`` command to set the read-only permission). + + +Note for AWS provider +++++++++++++++++++++++++ + +IAM Access keys consist of two parts: an access key ID (for example, ``AKIAIOSFODNN7EXAMPLE``) +and a secret access key (for example, ``wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY``). +These keys are **required** and is used to connect to the aws provider via third-party +applications (see the `AWS Access Keys documentation `_ for more information). +So you must place your access key ID string inside a file in the ``~/.clap/private/``. +For instance, copy and paste access key ID in a file and save at ``~/.clap/private/ec2_access_key.pub``, +or other filename and the same for the secret access key. + + +.. _login configuration: + +Login Configuration +------------------------------- + +The ``~/.clap/configs/logins.yaml`` defines all properties needed to access a +started virtual machine via SSH, such as login user name, SSH key file used to +access, etc. In this file you can define multiple login information that is used +by other configurations. An example ``logins.yaml`` file is shown below. + +.. code-block:: yaml + + ubuntu-login: # Name of the login config (Login ID) + user: ubuntu # Login name used to SSH into the virtual machine + keypair_name: key_us_east_1 # Name of the keypair to use on the cloud provider + keypair_public_file: key_us_east_1.pub # Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file + keypair_private_file: key_us_east_1.pem # Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine. + sudo: true # True if the sudo_user can execute commands as root by running the sudo command + sudo_user: root # (OPTIONAL) Login name of the super user (default is root) + + example-centos: + user: centos + ... + + +The YAML dictionary keys (``ubuntu-login`` and ``example-centos`` in the above example) +are login's configuration name (also called login ID). The values are the specific +information about that configuration. You can define as many login configurations +as you want just adding a new login ID and the values for it. Note that each login +ID must be unique. The valid values for a login configuration are: + + +.. list-table:: Valid login configuration key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **user** + - **type**: string + - Name of the user used to perform SSH into the virtual machine. + + * - **keypair_name** + - **type**: string + - Name of the keypair used on the cloud provider. + + * - **keypair_public_file** + - **type**: string + - Name of the file in the ``~/.clap/private`` directory containing the RSA/DSA public key corresponding to the private key file. + + * - **keypair_private_file** + - **type**: string + - Name of the file in the ``~/.clap/private`` directory containing a valid SSH private key to be used to connect to the virtual machine. + + * - **sudo** + - **type**: boolean + - True if the sudo user can execute commands as root by running the sudo command. + + * - **sudo_user (optional)** + - **type**: string + - Optional login name of the super user (default is root) + +The keypair is used to login to the machine without password (and perform SSH). + +Note for AWS users +++++++++++++++++++++++++ + +For AWS users, the keypair can be generated in the menu: ``EC2 --> Network & Security --> Key Pairs``. +A keypair can be created using the ``create key pair`` button providing an unique +keypair name (this name is used in the ``keypair_name`` field of the login configuration). +When a keypair is created, a private key file is generated to download. This is +the **private key file** (used to login to the instances). + +For CLAP, all key files must be placed in the ``~/.clap/private/`` directory with +400 permission. In the **keypair_private_file** login configuration field, the name +of the private key file inside the ``~/.clap/private/`` must be inserted (e.g. +**only** the file name: ``key_us_east_1.pem.pem`` and not ``~/.clap/private/key_us_east_1.pem.pem``) + +If you have a private key, the public key can be obtained with the command +``ssh-keygen -y -f /path_to_key_pair/my-key-pair.pem`` (where ``my-key_pair.pem`` is +the private key file. See `AWS Keypair Documentation `_ for more details). +The generated public key must be saved to a file and placed at ``~/.clap/private/`` +directory with 400 permission. So, in the ``keypair_public_file`` field of the +login configuration, the name of the public key file must be inserted. + + +.. _instance configuration: + +Instance Templates Configuration +---------------------------------- + +To start virtual machines in a cloud, you must first setup some instance templates +in the ``~/.clap/configs/instances.yaml`` file. The template contains information +about the virtual machine to start, including its flavor (i.e. instance type, +for instance ``t2.micro`` on AWS clouds), security group information, AMI used, +the disk size and others. The instance template references the provider configuration +and login configuration by its ID. An example of ``instances.yaml`` file is shown below. + +.. code-block:: yaml + + ubuntu-instance-aws: # Name of the instance template (instance template ID) + provider: aws-east-1-config # Provider configuration ID + login: ubuntu-login # Login configuration ID + flavor: t2.medium # The VM "size" to use. Different cloud providers call it differently: could be "instance type", "instance size" or "flavor". + image_id: ami-07d0cf3af28718ef8 # Disk image ID to use in the VM. Amazon EC2 uses IDs like ami-123456 + security_group: xxx-secgroup # Name of security group to use when starting the instance + boot_disk_size: 10 # (OPTIONAL) Size of the instance’s root filesystem volume, in Gibibytes (GiB) + boot_disk_device: /dev/sda1 # (OPTIONAL) Device name of the instance’s root file system in the block device mapping + boot_disk_type: gp2 # (OPTIONAL) Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (the default). + placement_group: XXX # (OPTIONAL) Placement group to enable low-latency networking between compute nodes + image_userdata: '...' # (OPTIONAL) Shell script to be executed (as root) when the machine starts. + network_ids: subnet-abcdfefxx # (OPTIONAL) Subnet IDs the nodes will be connected to + + instance-t2small-us-east-1: + provider: aws-east-1-config + ... + + +The YAML dictionary keys (``ubuntu-instance-aws`` and ``instance-t2small-us-east-1`` +in the above example) are the name of the instance templates (also called instance +template ID) and the values are the specific information about that instance template. +You can define as many instance templates configurations as you want just adding +a new instance template ID and the values for it. Note that each instance template +ID must be unique. Commands will use the instance template ID to start instances +based on this information. The valid values for the instance templates are: + +.. list-table:: Valid instance template key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **provider** + - **type**: string + - The ID of the provider configuration to be used for this instance. The ID must match the provider ID at ``providers.yaml`` + + * - **login** + - **type**: string + - The ID of the login configuration to be used for this instance. The ID must match the login ID at ``logins.yaml`` + + * - **flavor** + - **type**: string + - The provider instance type to use (e.g. ``t2.micro``, ``c5.large``, etc) + + * - **image_id** + - **type**: string + - Disk image ID to use in the VM (basically the OS to be used). Amazon EC2 uses IDs like ``ami-123456``. Note that the image_id is dependent of the provider region and a error may be raised if an invalid AMI id is specified + + * - **security_group** + - **type**: string + - Name of security group to use when starting the instance + + * - **boot_disk_size (optional)** + - **type**: string + - Size of the instance’s root filesystem volume, in Gibibytes (GiB) + + * - **boot_disk_device (optional)** + - **type**: string + - Device name of the instance’s root file system in the block device mapping. For AWS, see `block device mapping docs `_ for more information + + * - **boot_disk_type (optional)** + - **type**: string + - Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (default). See `Root filesystem volume storage type `_ for more information + + * - **placement_group (optional)** + - **type**: string + - Placement group to enable low-latency networking between compute nodes. See `placement groups `_ for more information + + * - **network_ids (optional)** + - **type**: string + - Subnet ID that the nodes of the cluster will be connected to diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt new file mode 100644 index 00000000..e957671e --- /dev/null +++ b/docs/build/html/_sources/index.rst.txt @@ -0,0 +1,51 @@ +===================================================== +Welcome to CLoud Application Provider Documentation! +===================================================== + + +Introduction +--------------- + +CLoud Application Provider (CLAP) provides a user-friendly command line tool to +create, manage and interact with individual instances or a set of instances +hosted in public cloud providers (such as AWS, Google Cloud and Microsoft Azure), +as well as easily creates, manages, resizes and interacts with compute clusters +hosted in public cloud providers. +It was firstly inspired on `elasticluster `_ +project, a tool that allows automated setup of compute clusters (MPI, Spark/Hadoop, etc.) +and `Ansible `_, a framework used for +automation. + +Its main features includes: + +- | `YAML-Style `_ configuration files to define nodes, logins and cloud configurations. +- User-friendly interface to create, setup, manage, interact and stop multiple instances hosted different cloud providers at the same time, transparently. +- Easy and fast creation and configuration of multiple compute clusters hosted in public cloud providers at same time. +- Growing and shrinking running clusters. +- Role system to easily perform actions in different heterogeneous nodes via `Ansible `_. playbooks. +- Easy-to-use python API to bring nodes up and configure them (via ansible or SSH commands). + +Contents +--------------- + +.. toctree:: + :maxdepth: 2 + + introduction + configuration + usage + shared_roles +.. architecture +.. tutorials +.. troubleshooting + + autoapi/index + + + +Indices and tables +------------------- + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/build/html/_sources/introduction.rst.txt b/docs/build/html/_sources/introduction.rst.txt new file mode 100644 index 00000000..39fab58f --- /dev/null +++ b/docs/build/html/_sources/introduction.rst.txt @@ -0,0 +1,106 @@ +.. _installation: + +========================== +Introduction +========================== + +Installation Guide +--------------------- + + +To install CLAP in a linux-based system follow the instructions below. + +1. Install requirement packages + +.. code-block:: bash + + gcc g++ git libc6-dev libffi-dev libssl-dev virtualenv python3 python3-pip + +.. note:: + + CLAP requires Python 3.7 or higher. + + +2. Clone the git repository and enter inside clap's directory + +.. code-block:: bash + + git clone https://github.com/lmcad-unicamp/CLAP.git clap + cd clap + +3. Set execution flags of the install script using the ``chmod`` command. +Then just run the ``install.sh`` script! + +.. code-block:: bash + + chmod +x install.sh + ./install.sh + +4. To use CLAP, you will need to activate the ``virtual-env``, for each shell you are using it. + Inside the ``clap`` root directory, where the ``git`` repository was cloned use the following command: + +.. code-block:: bash + + source clap-env/bin/activate + +5. Finally, test CLAP, via the CLI interface. The ``clapp`` command should be +available to use at this point. + +.. code-block:: bash + + clapp --help + + clapp node list + +.. note:: + + As CLAP is at development stage, use the ``update.sh`` periodically to fetch updates! + + +Quickly CLAP usage description +------------------------------------ + +To use CLAP you will first need to provide some information about how to launch instances in the cloud. By default, CLAP holds all information about configurations in the ``~/.clap/configs`` directory. The ``~/.clap/configs/providers.yaml`` file describes how to connect to the cloud provider, the ``~/.clap/configs/logins.yaml`` file describes how to login into machines and the ``~/.clap/configs/instances.yaml`` describe the instances that can be used with CLAP. +The :ref:`configuration section ` will guide you to write all these configuration sections easily. + +Once configurations written, the :ref:`usage section ` will show you how to execute CLAP commands based on the configurations written. +CLAP can be used to start, configure and manage single or multiple cloud's instances using the :ref:`node module ` as well as entire compute clusters using the :ref:`cluster module `. + + +.. _clap directory archtecture: + +Quickly CLAP directory architecture description +----------------------------------------------- +By default, CLAP holds all of it information needed inside the ``~/.clap`` +directory (where ``~`` stands for the user home directory). The minimal structure +of ``~/.clap`` directory is shown below: + +.. code-block:: + + ~/ (home directory) + └── .clap/ + ├── configs/ + │   ├── clusters/ + │   ├── instances.yaml + │   ├── logins.yaml + │   └── providers.yaml + ├── roles/ + │   ├── actions.d/ + │   ├── group_vars/ + │   │   └── all.yml + │   └── roles/ + ├── private/ + └── storage/ + + +- The ``~/.clap/configs/providers.yaml`` `YAML `_ file inside the ``~/.clap/configs`` directory holds the information about the cloud provider and how to connect to it. + +- The ``~/.clap/configs/logins.yaml`` file holds information about how to connect to an instance (e.g. login user, keyfile, etc) + +- The ``~/.clap/configs/instances.yaml`` holds the information about the instances to launch, i.e. the instance templates. + +- The ``roles`` directory store role's files and actions, used to perform action in several nodes. For more detailed information about roles and actions refer to the :ref:`roles section ` + +- The ``private`` stores keys and passwords files used to connect to the cloud provider and to the instance itself. Every key/secret files needed in the configuration files must be placed inside this directory (usually with 0400 permissions). + +- The ``storage`` directory store metadata information used by CLAP. diff --git a/docs/build/html/_sources/shared_roles.rst.txt b/docs/build/html/_sources/shared_roles.rst.txt new file mode 100644 index 00000000..56847c9b --- /dev/null +++ b/docs/build/html/_sources/shared_roles.rst.txt @@ -0,0 +1,694 @@ +.. _shared_roles: + +========================== +Roles shared with CLAP +========================== + +Here are some roles shared by default with CLAP. Setup action is **always** +executed when adding a node to a role. Also, variables needed by actions must be +passed via ``extra`` parameter, as keyword value. + + +Role ``commands-common`` +-------------------------- + +This role provide means to execute common known commands in several machines in +the role, such as: reboot, copy files to nodes, copy and execute shell scripts, +among others. Consider add nodes to this role to quickly perform common commands +in several nodes in a row. + +The following actions is provided by this role: + +- ``copy``: Copy a file from the localhost to the remote nodes +- ``fetch``: Fetch files from the remote nodes to the localhost +- ``reboot``: Reboot a machine and waits it to become available +- ``run-command``: Execute a shell command in the remote hosts +- ``run-script``: Transfer a script from localhost to remote nodes and execute it in the remote hosts +- ``update-packages``: Update packages in the remote hosts + +Hosts ++++++++++++++++++++ + +No host must be specified by this role. + + +Action ``commands-common copy`` +++++++++++++++++++++++++++++++++++ + +Copy a file from the localhost to the remote nodes + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-commands copy`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied to the remote hosts. If the path **is not absolute** (it is relative), it will search in the role's files directory else the file indicated will be copied. If the path is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into at remote nodes + +Examples +^^^^^^^^^^^^ + +:: + + clapp role action commands-common copy --extra src="/home/ubuntu/file" -e dest="~" + +The above command copy the file at ``/home/ubuntu/file`` (localhost) the the ``~`` directory of the nodes. + + +Action ``commands-common fetch`` ++++++++++++++++++++++++++++++++++ + +Fetch files from the remote nodes to the localhost + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common fetch`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied from the remote hosts. If the file is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into (localhost) + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common fetch --extra src="~/file" --extra dest="/home/ubuntu/fetched_files/" + +The above command fetch a file at ``~/file`` directory from the nodes and place +at the ``/home/ubuntu/fetched_files/`` directory of the localhost. + + +Action ``commands-common install-packages`` +++++++++++++++++++++++++++++++++++++++++++++++ + +Install packages in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common install-packages`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``packages`` + - string + - Comma-separated list of packages to install. + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common install-packages --extra "packages=openmpi-bin,openmpi-common" + +The above command will install ``openmpi-bin`` and ``openmpi-common`` packages to remote hosts + + +Action ``commands-common reboot`` +++++++++++++++++++++++++++++++++++ + +Reboot a machine and waits it to become available + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed. + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common reboot + +The command reboot all machines belonging to the ``commands-common`` role. + +Action ``commands-common run-command`` ++++++++++++++++++++++++++++++++++++++++++ + +Execute a shell command in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common run-command`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``cmd`` + - string + - String with the command to be executed in the nodes + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common run-command --extra cmd="ls" + clapp role action commands-common run-command --extra cmd="ls" -e "workdir=/bin" + +In the above command (first one) runs the command ``ls`` in the remote nodes, +the second one runs the command ``ls`` in the remote nodes, after changing to the +"/bin" directory + + +Action ``commands-common run-script`` +++++++++++++++++++++++++++++++++++++++ + +Transfer a script from localhost to remote nodes and execute it in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common run-script`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - string + - Shell script file to be executed in the remote nodes. The file will be first copied (from localhost) to the nodes and after will be executed. Note: the script file **must begin** with the bash shebang (``#!/bin/bash``). Also the script filepath must be **absolute** else, if relative path is passed, Ansible search in the role's file directory. The script will be deleted from nodes after execution. + + * - ``args`` (optional) + - string + - Command-line arguments to be passed to the script. + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used (Path must be absolute for Unix-aware nodes) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3" + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3" -e workdir="/home" + + +The above command (first one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it (similar to run ``bash -c echo.sh`` in the hosts). + +The above command (second one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it using the arguments "1 2 3" (similar to run ``bash -c echo.sh 1 2 3`` in the hosts). + +The above command (third one) is similar to the second one but will execute the script in the ``/home`` directory. + + +Action ``commands-common update-packages`` +++++++++++++++++++++++++++++++++++++++++++++++ + +Update packages in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common update-packages + +The above command will update the package list from remote hosts (similar to ``apt update`` command) + + + +.. Group ``docker`` +.. ----------------- + +.. This group installs docker-ce in debian and red-hat based systems. The following actions are provided by this group. + +.. - ``setup``: Install docker-ce and start the service + +.. Hosts +.. +++++++++++++++++++ + +.. No host must be specified by this group. + + + +Group ``ec2-efs`` +-------------------- + +This role setup and mount an network EFS filesystem on AWS provider. +The following actions are provided by the role. + +- ``setup``: Install nfs client +- ``mount``: Mount an EFS filesystem +- ``umount``: Unmount EC2 File System + +Hosts ++++++++++++++++++++ + +No hosts must be specified by this role. + +Action ``ec2-efs setup`` +++++++++++++++++++++++++++++ + +Install nfs client at remote host. This action is executed when nodes are added +to the role. + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed + +Action ``ec2-efs mount`` +++++++++++++++++++++++++++++ + +Mount an AWS EC2 EFS filesystem at remote host. + +Required Variables +^^^^^^^^^^^^^^^^^^^ +.. list-table:: ``ec2-efs mount`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_ip`` + - string + - Mount IP of the filesystem (see `AWS EFS Documentation `_ for more information) + + * - ``efs_mount_point`` (OPTIONAL) + - path + - Directory path where the filesystem will be mounted. Default path is: ``/efs`` + + * - ``efs_owner`` (OPTIONAL) + - string + - Name of the user owner (e.g. ubuntu). Default user is the currently logged user + + * - ``efs_group`` (OPTIONAL) + - string + - Name of the group owner (e.g. ubuntu). Default group is the currently logged user + + * - ``efs_mount_permissions`` (OPTIONAL) + - string + - Permission used to mount the filesystem (e.g. 0644). Default permission is ``0744`` + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action ec2-efs mount --extra "efs_mount_ip="192.168.0.1" -e "efs_mount_point=/tmp" + +The above command will mount the EFS Filesystem from ``192.168.0.1`` it at ``/tmp`` +with ``744`` permissions (read-write-execute for user and read-only for group and others). + +Action ``ec2-efs umount`` +++++++++++++++++++++++++++++ + +Unmount the EC2 File System + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``ec2-efs umount`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_point`` (OPTIONAL) + - path + - Directory path where the filesystem will be mounted. Default path is: ``/efs`` + + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action ec2-efs umount --nodes node-0 --extra efs_mount_point="/efs" + +The above command will unmount EC2 EFS filesystem at ``/efs`` directory from ``node-0`` + + + +Role ``spits`` +------------------- + +Install `spits runtime for the SPITS programming model `_ +in nodes, deploy SPITS applications and collect results from execution. The +following actions are provided by this role. + +- ``add-nodes``: This action informs to the job manager node, the public address of all task managers. +- ``job-copy``: Copy the results (job directory) from the job manager to the localhost. +- ``job-create``: Create a SPITS job in nodes +- ``job-status``: Query job manager nodes the status and the metrics of a running SPITS job +- ``setup``: Install SPITS runtime and its dependencies at nodes +- ``start``: Start a SPITS job at job manager and task manager nodes + +.. note:: + + For now, shared filesystem is **not supported** for SPITS runtime. + +.. warning:: + + SPITS application are started using random TCP ports. For now, your security group must allows the communication from/to random IP addresses and ports. So, set inbound and outbound rules from you security group to allow the communication from anywhere to anywhere at any port. + +Hosts ++++++++++++++++++++ + +This role defines two host types: + +- ``jobmanager``: Nodes where job manager will be executed for a job +- ``taskmanager``: Nodes where task manager will be executed for a job + +Typical Workflow ++++++++++++++++++++ + +The ``spits`` role is used to run SPITS applications. For each SPITS application to run, you must create a SPITS job, with an unique Job ID. One node can execute multiple SPITS jobs. + +Thus, a typical workflow for usage is: + +1. Add job manager desired nodes to ``spits/jobmanager`` role and task manager desired nodes to ``spits/taskmanager`` +2. Use ``job-create`` action the create a new SPITS job in all machines belonging to ``spits`` role (filter nodes if you want to create a job at selected nodes only). +3. Use ``start`` action to start the SPITS job manager and SPITS task manager at nodes to run the SPITS job +4. Use the ``add-nodes`` action to copy public addresses from task managers nodes to the job manager node. +5. Optionally, check the job status using the ``job-status`` action. +6. When job is finished, use ``job-copy`` action to get the results. + +Action ``spits add-nodes`` +++++++++++++++++++++++++++++ + +This action informs to the job manager node, the public address of all task managers. + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits add-nodes`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits add-nodes --extra "jobid=my-job-123" + +The above example will add all task manager addresses, from nodes belonging to +the ``spits/taskmanager`` role to the ``spits/jobmanager`` nodes at job ``my-job-123``. +At this point, the job manager nodes recognizes all task managers. + +.. note:: + + - This action is not needed if job manager and task managers are running at same node + + +Action ``spits job-copy`` +++++++++++++++++++++++++++++ + +Copy the results (job directory) from the job manager to the localhost + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-copy`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``outputdir`` + - path + - Path where job will be copied to + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits job-copy -e "jobid=my-job-123" -e "outputdir=/home/app-output" + +The above example will copy the entire job folder (including logs/results) to the +localhost and put at ``/home/app-output`` directory. + + +Action ``spits job-create`` +++++++++++++++++++++++++++++ + +Create a SPITS job in nodes to run an SPITS application. If you are using a shared +filesystem, use this action in only one node and set the ``SPITS_JOB_PATH`` +variable to the desired location. + + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-create`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job ID to identify the SPITS job. + + * - ``spits_binary`` + - path + - Absolute path to the SPITS binary (at localhost) that will be copied to nodes + + * - ``spits_args`` + - string + - Arguments that will be passed to the SPITS binary when executing the SPITS application + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits job-create --extra "jobid=my-job-123" -e "spits_binary=/home/xxx/spits-app" -e "spits_args=foo bar 10" + +The above example create the a job called ``my-job-123`` in all nodes belonging +to the ``spits`` role. The job will execute the SPITS runtime with the binary +``/home/xxx/spits-app`` (that will be copied from localhost to nodes) with +arguments ``foo bar 10``. + +Action ``spits job-status`` +++++++++++++++++++++++++++++ + +Query job manager nodes the status and the metrics of a running SPITS job + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-status`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + + +Examples +^^^^^^^^^^^^^^^^^^^ +.. code-block:: none + + clapp role action spits job-status --extra "jobid=my-job-123" + +The above example query the status of a SPITS job with ID ``my-job-123`` from +nodes belonging to ``spits/jobmanager`` role. The job status will be displayed +at the command output (in green). + + +Action ``spits setup`` +++++++++++++++++++++++++++++ + +Install SPITS runtime and its dependencies at nodes + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed. Optional +variables can be passed. + +.. list-table:: ``spits setup`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role add -n jobmanager:node-0 -n taskmanager:node-1,node-2 + +The above example install SPITS runtime at ``node-0``, ``node-1`` and ``node-2``. +``node-0`` is set as job manager host and nodes ``node-1`` and ``node-2`` are +set as task manager host. + + +Action ``spits start`` +++++++++++++++++++++++++++++ + +Start a SPITS job at job manager and task manager nodes + + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits start`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``jm_args`` + - string + - Arguments to be passed to the job manager SPITS runtime + + * - ``tm_args`` + - string + - Arguments to be passed to the task manager SPITS runtime + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits start --extra "jobid=my-job-123" -e "jm_args=-vv" + +The above example starts job managers and task managers for job ``my-job-123`` in +nodes belonging to ``spits`` role. Also, job managers SPITS runtime are executed +passing the ``-vv`` parameter. + +.. note:: + + The ``job-create`` action must be used before to create the SPITS job at nodes belonging to ``spits`` role. + + +.. Group ``nfs-client`` +.. --------------------- + +.. This group setup and mount an network EFS filesystem on AWS provider. + +.. - ``setup``: Install nfs client and mount EC2 file system +.. - ``umount``: Unmount EC2 File System + +.. Hosts +.. +++++++++++++++++++ + +.. No host must be specified by this group. + +.. Action ``ec2-efs setup`` +.. ++++++++++++++++++++++++++++ + +.. Install nfs client and mount EC2 file system. This action is executed when nodes are added to the group. + +.. Required Variables +.. ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/build/html/_sources/troubleshooting.rst.txt b/docs/build/html/_sources/troubleshooting.rst.txt new file mode 100644 index 00000000..45ea597e --- /dev/null +++ b/docs/build/html/_sources/troubleshooting.rst.txt @@ -0,0 +1,7 @@ +.. _troubleshooting: + +==================== +Troubleshooting +==================== + +Sorry, to be written... \ No newline at end of file diff --git a/docs/build/html/_sources/tutorials.rst.txt b/docs/build/html/_sources/tutorials.rst.txt new file mode 100644 index 00000000..c038c492 --- /dev/null +++ b/docs/build/html/_sources/tutorials.rst.txt @@ -0,0 +1,7 @@ +.. _tutorials: + +========================== +Tutorials +========================== + +Sorry, to be written... \ No newline at end of file diff --git a/docs/build/html/_sources/usage.rst.txt b/docs/build/html/_sources/usage.rst.txt new file mode 100644 index 00000000..40cd4e6f --- /dev/null +++ b/docs/build/html/_sources/usage.rst.txt @@ -0,0 +1,1177 @@ +.. _usage: + +============= +Basic Usage +============= + +CLAP is a platform to start, stop and manage cloud's instances (called CLAP nodes +or simply, nodes) at different cloud providers transparently, based on configuration +files. Also, it offers mechanisms to perform actions via SSH commands or Ansible +playbooks in single nodes or in a set of nodes in a row. To provide this, in a modular +way, CLAP provides modules to allow performing several operations. +You can use ``clapp --help`` command to list the available modules. + +The most common modules are: ``node``, ``role`` and ``cluster``. + +.. _node section: + +Node Module +--------------------- + +The node module provides mechanisms to create, manage and interact with cloud's +instances. It provides the following features: + +* Start nodes based on the instance templates with the ``start`` command. +* Stop (terminate) already started nodes using the ``stop`` command. +* Pause or resume already instantiated nodes using the ``pause`` and ``resume`` commands, respectively. +* Check the status of a node (if its accessible by SSH) using the ``alive`` command. +* List started nodes using the ``list`` command. +* Execute a shell command via SSH, using the ``execute`` command. +* Execute an Ansible Playbook using the ``playbook`` command. +* Obtain a shell session (via SSH) using the ``connect`` command. +* Add and remove tags from nodes using ``add-tag`` and ``remove-tag`` commands. +* List all available instance templates configurations using the ``list-templates`` command. + +All these commands are detailed below. + + +Command ``node start`` ++++++++++++++++++++++++++++ + +To launch a cloud's instance based on an instance template, defined in the +``~/.clap/configs/instances.yaml`` file, you can use the command below, where the +``ubuntu-instance-aws`` refers to the instance template ID defined in the +``~/.clap/configs/instances.yaml`` file. In this way, you need to configure the +files only once and launch instances at any time. + +:: + + clapp node start ubuntu-instance-aws + +Once instances are successfully started, CLAP will assign an unique node ID to each +instance, used to perform other CLAP operation. Also, CLAP will try to login at +the instance with the login information provided, via SSH. + +To launch more than one instance with the same instance template ID, you can +put the desired number after the instance template ID preceded by an ``:`` character. +For instance, the command below, launches 4 ``ubuntu-instance-aws`` instances in a row. + +:: + + clapp node start ubuntu-instance-aws:4 + + +You can also launch different instances in a row using the same command, but just +appending more instance template IDs to it, as below. The above command launches +2 ``ubuntu-instance-aws`` VMs and 2 ``example-instance-aws`` VMs in a row. + +:: + + clapp node start ubuntu-instance-aws:2 example-instance-aws:2 + + +Command ``node list`` ++++++++++++++++++++++++++++ + +The ``clapp node list`` command can be used to show managed CLAP's nodes. +An example output of this command is shown below. + +:: + + * Node: ebcd658bacdf485487543cbcc721d1b3, config: type-a, nickname: MarjoryLang, status: reachable, ip: 3.87.87.154, tags: {}, roles: [], creation at: 21-05-21 14:11:55 + Listed 1 nodes + + +The node id (``ebcd658bacdf485487543cbcc721d1b3`` in the above example) is used +across all other modules and commands to perform commands in this node. + + +Command ``node alive`` ++++++++++++++++++++++++++++ + +This command updates several node's information (such as IP) and check if the +node is reachable (if a SSH connection can be established). + +The node's status can be: + +* **started**: when the VM is up. +* **reachable**: when the VM is up and a SSH connection was successfully established. +* **unreachable**: when the SHH connection was not successfully established. +* **paused**: when VM is paused. +* **stopped**: when VM is terminated. + +.. note:: + + CLAP does not check the status of VM periodically. Use this command to update node status and information. + + + +Command ``node stop`` ++++++++++++++++++++++++++++ + +The ``clapp node stop`` command can be used to **terminate** an running VM (destroying it). The syntax is shown below: + + +Command ``node pause`` ++++++++++++++++++++++++++++ + +The ``clapp node pause`` command can be used to **pause** an running instance. +When a node is paused, its status is changed to **paused** and its public IP is +changed to ``None``. + +.. note:: + + The command has no effect for nodes that already been paused. + + +Command ``node resume`` ++++++++++++++++++++++++++++ + +The ``clapp node resume`` command can be used to **resume** a paused instance. +When a node is resumed, it status is changed to **started**. Then, it checked if +it is alive, testing its connection and updating its public IP (and changing its +status to **reachable**). + +.. note:: + + The command has no effect at nodes that were not paused. It will only check for its aliveness. + + +Command ``node connect`` ++++++++++++++++++++++++++++ + +The ``clapp node connect`` command can be used to obtain a shell to a specific +node. + +.. note:: + + The connection may fail if node has an invalid public IP or a invalid login information. You may want to check if node is alive first to update node's information. + + +Command ``node execute`` ++++++++++++++++++++++++++++ + +The ``clapp node execute`` command can be used to execute a shell command on an +reachable node. The syntax is shown below: + +:: + + Usage: clapp node execute [OPTIONS] [NODE_ID]... + + Execute a shell command in nodes (via SSH) + + Options: + -t, --tags TEXT Filter nodes by tags. There are two formats: or + = + -cmd, --command TEXT Shell Command to be executed in nodes [required] + --timeout INTEGER Timeout to execute command in host (0 to no timeout) + [default: 0] + -a, --additional TEXT Additional arguments to connection. Format: + = + --help Show this message and exit. + +One or more nodes can be passed as argument, or can be selected based on their tags. +The ``--command`` parameter specify the command that will be executed in nodes. + +An example is shown below, executing a simple ``ls -lha`` command in the node +``ebcd658bacdf485487543cbcc721d1b3`` + +:: + + clapp node execute ebcd658bacdf485487543cbcc721d1b3 -cmd "ls -lha" + +And the result: + +:: + + ------------------------ ebcd658bacdf485487543cbcc721d1b3 ------------------------ + return code ebcd658b: 0 + stdout ebcd658b: drwxr-xr-x 5 ubuntu ubuntu 4.0K May 21 17:12 . + stdout ebcd658b: drwxr-xr-x 3 root root 4.0K May 21 17:12 .. + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 220 Apr 4 2018 .bash_logout + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 3.7K Apr 4 2018 .bashrc + stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .cache + stdout ebcd658b: drwx------ 3 ubuntu ubuntu 4.0K May 21 17:12 .gnupg + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 807 Apr 4 2018 .profile + stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .ssh + + +.. note:: + + You may want to check for nodes aliveness first. + + +Command ``node playbook`` ++++++++++++++++++++++++++++ + +The ``clapp node playbook`` command can be used to execute an Ansible playbook +in a set of reachable nodes. The syntax is shown below: + +:: + + clapp node playbook [OPTIONS] [NODE_ID]... + + Execute an Ansible playbook in a set of nodes. + + The NODE_ID argument is a list of strings (optional) and can filter nodes to + execute the playbook by their node ids + + Options: + -p, --playbook TEXT Path of the playbook to be executed [required] + -t, --tags TEXT Filter nodes by tags. There are two formats: or + = + -e, --extra TEXT Extra variables to be passed. Format: = + -nv, --node-vars TEXT Host variables to be passed. Format: + :=,=,... + --help Show this message and exit. + + +One or more nodes can be passed as argument, or can be selected based on their tags. + +The ``--playbook`` parameter specify the playbook to execute in nodes. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +An example is shown below. The playbook ``install_packages.yml`` is executed in node +``ebcd658bacdf485487543cbcc721d1b3``. +Extra playbook variables (in jinja format, e.g. "{{ var1 }}") will be replaced by +the extra variables informed. In the example below the playbook's variable +``packages`` will be replaced by ``gcc``. + +:: + + clapp node playbook ebcd658bacdf485487543cbcc721d1b3 -p install_packages.yml -e "packages=gcc" + + +.. _tags section: + +Command ``node add-tag`` ++++++++++++++++++++++++++ + +This ``clapp node add-tag`` command adds a tag to a set of nodes and has the +following syntax: + +:: + + Usage: clapp node add-tag [OPTIONS] NODE_ID... + + Add tags to a set of nodes. + + The NODE_ID argument is a list of node_ids to add tags. + + Options: + -t, --tags TEXT Tags to add. Format: = [required] + --help Show this message and exit. + + +One or more nodes can be passed as argument. The ``tags`` parameter must be a +keyword value in the format ``key=value``. You can add as many tags to a node as +you want. An example of adding tags is shown below: + +:: + + clapp node add-tag ebcd658bacdf485487543cbcc721d1b3 -t x=10 + +Where tag ``x=10`` is added to nodes ``ebcd658bacdf485487543cbcc721d1b3``. + +Command ``node remove-tag`` +++++++++++++++++++++++++++++ + +This ``clapp tag remove`` command removes a tag from a set of nodes and has the +following syntax: + +:: + + clapp node remove-tag [OPTIONS] NODE_ID... + + Remove tags from a set of nodes. + + The NODE_ID argument is a list of node_ids to remove tags. + + Options: + -t, --tags TEXT Tags to remove. Format: [required] + --help Show this message and exit. + +One or more nodes can be passed as argument. The ``tag`` parameter must be a string. +The tags from nodes that matches to the informed tag is removed (tag and value). + +.. _role section: + +Role Module +------------------- + +The role module allows to perform pre-defined actions to a set of nodes that +belongs to a role. When a node is added to a role, it is said that this node +is ready to perform tasks of this role. +Thus, each role defines their set of specific actions that can be performed to +nodes that belongs to that particular role. + +In this way, the role module consists of three steps: + +1. Add nodes to a role. +2. Perform role's action to nodes that belongs to a role. +3. Optionally, remove nodes from the group. + +The nodes of a role can also be logically divided in hosts. Thus, role actions +can be performed to all nodes of the role or to a subset of nodes of role (hosts). + +CLAP's roles and actions +++++++++++++++++++++++++++++++ + +Role's actions are `Ansible playbooks `_ that are +executed when an action is invoked (e.g. using ``role action`` command). By +default CLAP's roles are stored in the ``~/.clap/roles/`` directory and each +role consists in at minimum of two files: + +* A YAML description file describing the actions that can be performed (and informing the playbook that must be called) and, optionally, the hosts (subset of role's nodes to execute the playbook) +* The Ansible Playbook called when each action is invoked. + +You can see some roles shared with CLAP and their requirements at :ref:`shared_roles` section. + + +Role description file +^^^^^^^^^^^^^^^^^^^^^^^ + +The role's description files are python files placed at ``~/.clap/groups/actions.d`` +directory. The name of the YAML file defines the role's name. +Each role description file defines the key ``actions`` and, optionally, the ``hosts`` +key. Inside ``actions`` key, each dictionary defines a role action where the +key name is the action name and the values informs characteristic of that action. + +An example role description file is shown below, for a role named ``commands-common`` +(placed at ``~/.clap/roles/actions.d/commands-common.yaml``). + +.. code-block:: yaml + + --- + actions: # Defines the actions of this group + setup: # Action called setup + playbook: roles/commands-common_setup.yml # Playbook to be executed when this group action is invoked + + copy: # Action called copy + playbook: roles/commands-common_copy.yml # Playbook to be executed when this group action is invoked + description: Copy files from localhost to remote hosts # Optional action's description + vars: # Optional variables required + - name: src # src variable + description: Source files/directory to be copied # Optional variable's description + optional: no # Informs if this variable is optional + - name: dest # dest variable + description: Destination directory where files will be placed # Optional variable's description + + fetch: + playbook: roles/commands-common_fetch.yml + description: Fetch files from remote hosts to localhost + vars: + - name: src + description: Source files/directory to be fetched + - name: dest + description: Destination directory where files will be placed + + hosts: # (optional) List of hosts that are used in this role. The host name can be used in the playbooks. + - master + - slave + +.. note:: + + Action's playbook is relative to the ``~/.clap/roles/`` directory. + +For role's description files, ``actions`` dictionary is required, and ``hosts`` optional. +The keys inside ``actions`` dictionary are the action names and the possible +values for each action are described in table below. + +.. list-table:: Valid values for actions + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``playbook`` + - path + - Playbook to be executed when this action is invoked. The path is relative to ``~/.clap/roles/`` directory. + + * - ``description`` (optional) + - string + - Action's descriptive information + + * - ``vars`` (optional) + - List of variable dictionaries + - List informing variables needed for this action + +And optionally, the actions can define their variables to use. The possible +values are listed table below + +.. list-table:: Valid action's values + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``name`` + - string + - Name of the variable + + * - ``description`` (optional) + - string + - Variable's descriptive information + + * - ``optional`` (optional) + - boolean + - Inform if variable is optional (default is ``no``) + + +Finally the hosts specify the ``hosts`` used by role actions. It's optional and +when specified Ansible playbooks can segment their execution using the ``hosts`` +variable at each play. If no hosts are specified you must use ``hosts: all`` +to perform the action over all nodes that belong to the role. + + +Command ``role list`` ++++++++++++++++++++++++++++ + +The ``clapp role list`` command can be used to list all available role and their +respective actions and hosts. An example of output is shown below + +:: + + * name: commands-common + Has 7 actions and 2 hosts defined + actions: copy, fetch, install-packages, reboot, run-command, run-script, update-packages + hosts: h1, h2 + + * name: ec2-efs + Has 3 actions and 0 hosts defined + actions: mount, setup, unmount + hosts: + + * name: spits + Has 6 actions and 2 hosts defined + actions: add-nodes, job-copy, job-create, job-status, setup, start + hosts: jobmanager, taskmanager + + Listed 3 roles + + + +Command ``role add`` ++++++++++++++++++++++++++++ + +The ``clapp role add`` command can be used to add a node to a role. The syntax +is shown below: + +:: + + clapp role add [OPTIONS] ROLE + + Add a set of nodes to a role. + + The ROLE argument specify the role which the nodes will be added. + + Options: + -n, --node TEXT Nodes to be added. Can use multiple "-n" commands and + it can be a list of colon-separated nodes as + ",,..." or + ":,". The formats are + mutually exclusive [required] + -nv, --node-vars TEXT Node's arguments. Format + :=,= + -hv, --host-vars TEXT Role's host arguments. Format + :=,... + -e, --extra TEXT Extra arguments. Format = + --help Show this message and exit. + + +The nodes can be supplied with ``--node`` parameter using two formats (mutually +exclusive): with host or without host. + +If the role does not define any host, nodes must be informed supplying only their +node ids in the ``--node`` parameter. Multiple ``--node`` parameters can be used +to indicate multiple nodes ids. Besides that, multiple nodes ids can be passed to +``--node`` parameter by separating them with comma. +The both examples below add nodes ``ebcd658bacdf485487543cbcc721d1b3`` and +``455e9c5da5c4417abc757f587a31c105`` to role ``commands-common``. + +:: + + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3,455e9c5da5c4417abc757f587a31c105 + +If the role defines one or more hosts, the ``--node`` parameter can be supplied +with the ",,..." format (1) or with the ":," +format (2) (both are mutually exclusive). If the format (1) is used, the nodes +are added to all role's hosts defined . +Two examples are shown below, one for format (1) and other for format (2). + +:: + + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role add commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105 + +Supposing the role ``commands-common`` defines 2 hosts: ``masters`` and ``slaves``, +the first one adds nodes ``ebcd658bacdf485487543cbcc721d1b3`` and ``ebcd658bacdf485487543cbcc721d1b3`` +to both role's host. +The second one adds node ``ebcd658bacdf485487543cbcc721d1b3`` as commands-common +masters and node ``455e9c5da5c4417abc757f587a31c105`` as commands-common slaves host. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +The ``--host-vars`` parameter can be used to pass keyword arguments to a hosts. + +.. note:: + + If the role's setup action is defined this action is immediately executed + when adding a role to a node. If this action fails, the node is not added to + the role. + + +Command ``role action`` ++++++++++++++++++++++++++++ + +The ``clapp role action`` command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below: + +.. code-block:: none + + clapp role action [OPTIONS] ROLE + + Perform an group action at a set of nodes. + + The ROLE argument specify the role which the action will be performed. + + Options: + -a, --action TEXT Name of the group's action to perform [required] + -n, --node TEXT Nodes to perform the action. Can use multiple "-n" + commands and it can be a list of colon-separated node + as ",,..." or + ":,". The formats are + mutually exclusive. If not is passed, the action will + be performed in all nodes that belongs to the role. + -nv, --node-vars TEXT Node's arguments. Format + :=,= + -hv, --host-vars TEXT Role's host arguments. Format + :=,... + -e, --extra TEXT Extra arguments. Format = + --help Show this message and exit. + + +The ``--node`` parameter is optional and if is not supplied, the role action will +be executed in all nodes that belongs to the role. If ``--node`` parameter is +supplied it may be in two formats (mutually exclusive): with host or without host. + +If nodes are informed in format without host, the selected nodes will be automatically +placed in their correct hosts (if any). Otherwise, the nodes will be placed in +informed hosts. + +Examples are shown below: + +:: + + clapp role action commands-common -a install-packages -n ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc + clapp role action commands-common -a install-packages -n masters:ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc + clapp role action commands-common -a install-packages -e packages=gcc + + +The first command perform ``install-packages`` action, from ``commands-common`` role +in nodes ``ebcd658bacdf485487543cbcc721d1b3``. The node's hosts are the same when +the nodes added. The second command perform ``install-packages`` action, from +``commands-common`` role in node ``ebcd658bacdf485487543cbcc721d1b3``. The node's hosts +acts only as ``masters``, additional hosts from this node are discarded. +The last command perform ``install-packages`` action, from ``commands-common`` role +at all nodes that belongs to ``commands-common``. +For all commands, the extra variable ``package`` with value ``gcc`` is passed. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +The ``--host-vars`` parameter can be used to pass keyword arguments to a hosts. + +Command ``role remove`` ++++++++++++++++++++++++++++ + +The ``clapp role action`` command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below: + +:: + + clapp role remove [OPTIONS] ROLE + + Perform an group action at a set of nodes. + + The ROLE argument specify the role which the action will be performed. + + Options: + -n, --node TEXT Nodes to perform the action. Can use multiple "-n" commands + and it can be a list of colon-separated node as + ",,..." or ":,". + The formats are mutually exclusive. If not is passed, the + action will be performed in all nodes that belongs to the + role. [required] + --help Show this message and exit. + +The ``--node`` parameter is used to inform the nodes to remove from a role. +The parameter can be supplied using two formats (mutually exclusive): with host +or without host. +If host is passed, the node is removed from the host's role else the node is removed +from all hosts in the role (if any). An example is shown below: + +:: + + clapp role remove commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role remove commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105 + +The first example remove nodes ``ebcd658bacdf485487543cbcc721d1b3`` and ``455e9c5da5c4417abc757f587a31c105`` +from role ``commands-common`` and from all ``commands-common`` role hosts (if any). +The second example removes node ``ebcd658bacdf485487543cbcc721d1b3`` from host +called ``masters`` from ``commands-common`` role and node ``455e9c5da5c4417abc757f587a31c105`` +from hosts called ``slaves`` from ``commands-common`` role. + + +.. _cluster module: + +Cluster Module +------------------- + +The cluster module allows CLAP to work with cluster, which is a set of CLAP's nodes +tagged with a specific tag. A CLAP's cluster is created taking as input configuration +files, in YAML format, which will create nodes and setup each of them properly. +After created, the cluster can be resized (adding or removing nodes), paused, +resumed, stopped, among other things. + +By default, the CLAP's cluster module will find configurations inside +``~/clap/configs/clusters`` directory. At next sections, we will assume that +files will be created inside this directory (in ``.yaml`` format). + +The next section will guide you to write a cluster configuration and then, +module's commands will be presented. + +Cluster Configuration +++++++++++++++++++++++++++ + +To create a CLAP's cluster you will need to write: + +- **Setup configuration sections**: which define a series of groups and actions that must be performed. +- **Cluster configuration sections**: which define a set of nodes that must be created and the setups that must be performed in each node. + +Setups and cluster section may be written in multiple different files (or at the +same file), as CLAP's cluster modules will read all files (and setups and clusters +configurations, respectively) inside the cluster's directory. + +Setup Configuration Sections ++++++++++++++++++++++++++++++ + +Setup configuration sections define a series of roles and/or actions that must be +performed at cluster's nodes. An example of a setup configuration section is +shown below. + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common + setup-common: + roles: + - name: commands-common # Add nodes to commands-common role + - name: another-role # Add nodes to another-role role + actions: + - role: commands-common + action: update-packages # Perform action update-packages from role commands-common + - command: "git init" # Perform shell command 'git init' + + # This is a setup configuration called setup-spits-jobmanager + setup-spits-jobmanager: + roles: + - name: spits/jobmanager # Add nodes to spits' role as jobmanager host + + # This is a setup configuration called setup-spits-taskmanager + setup-spits-taskmanager: + roles: + - name: spits/taskmanager # Add nodes to spits' role as taskmanager host + +Setup configurations must be written inside ``setups`` YAML-dictionary. You can +define as many setup configurations as you want, even at different files but each +one must have a unique name. Inside the ``setups`` section, each dictionary +represents a setup configuration. The dictionary key (``setup-common``, +``setup-spits-jobmanager`` and ``setup-spits-taskmanager`` in above example) +represent the setup configuration ID. + +Each setup configuration may contain two dictionaries: ``roles`` and ``actions`` +(both are optional). Both sections, for a setup configuration is described in the +next two subsections. + +Roles key at setups configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``role`` section inside a setup configuration tells to add nodes, whose perform +this setup, to the defined roles. The ``roles`` section contains a **list** describing +each role that the nodes must be added. Also, the role is always added in the order +defined in the list. + +Each element of the list must have a ``name`` key, which describe the name of the role +that the node must be added. For instance, the ``setup-common`` at above example, +defines two roles which nodes that perform this setup must be added: ``commands-common`` +and ``another-role`` (in this order). + +Optionally an ``extra`` key can be defined by each role, as a dictionary. The key +and values is passed as ``extra`` parameter similar to the ``role add`` module +command. For instance, the setup below, will add nodes that perform this setup +(``setup-common-2``) to role ``example-role`` passing variables, ``foo`` and +``another_var`` with values ``bar`` and ``10``, respectively. + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common + setup-common-2: + roles: + - name: example-group # Add nodes to example-role role + extra: + foo: bar + another_var: 10 + + +Actions key at an setups configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ``actions`` section inside a setup configuration tells to perform actions at +nodes which perform this setup. The ``actions`` section contains a **list** +describing each action that must be performed (in order). +There are three types of actions: + +- **role action**: will perform an role action. Thus, the ``role`` and ``action`` keys must be informed. The ``role`` key will tell the name of the role and the ``action`` key will tell which action from that role which will be performed. Optionally, an ``extra`` dictionary can be informed to pass keyword variables to the role's action. +- **playbook**: will execute an Ansible Playbook. Thus, the ``playbook`` key must be informed, telling the absolute path of the playbook that will be executed. Optionally an ``extra`` dictionary can be informed to pass keyword variables to the playbook. +- **command**: will execute a shell command. Thus, the ``command`` key must be informed, telling which shell command must be executed. + +Some action examples are briefly shown below: + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common. The actions are executed sequentially + another-setup-example: + actions: + # Perform mount action from role nfs-client, passing the variable mount_path with value /mnt + - action: mount + role: nfs-client + extra: + mount_path: /mnt + # Execute the playbook /home/my-cool-ansible-playbook with an variable foo with value bar + - playbook: /home/my-cool-ansible-playbook + extra: + foo: bar + # Execute a shell command: hostname + - command: hostname + # Perform reboot action from commands-common role + - role: commands-common + action: reboot + +.. note:: + + If a setup configuration contains both ``roles`` and ``actions`` sections, + the ``roles`` section will **always** be executed before ``actions`` section. + + +Cluster Configuration Sections +++++++++++++++++++++++++++++++ + +The cluster configuration defines a set of nodes that must be created and setups +that must be executed. Clusters are written inside ``clusters`` YAML-dictionary +key and each dictionary inside ``clusters`` key denotes a cluster (where the +dictionary key is the cluster's name). +Above is an example of a cluster configuration: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + +Clusters must have the ``nodes`` section, which defines the nodes that must be +created when the cluster is instantiated. As example above, each cluster's node +have a type (``master-node`` and ``slave-node``) and values, that specify the +cluster's node characteristics. Each node may have the values listed in is table +below. + +.. list-table:: Cluster's nodes valid parameters + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``type`` + - string + - Instance type that must to be created. The type must match the node name at ``instances.yaml`` file + + * - ``count`` + - Integer + - Number of instances of this type to be launched + + * - ``min_count`` (OPTIONAL) + - Positive integer (less then or equal ``count`` parameter) + - Minimum number of instances of this type that must effectively be launched. If this parameter is not supplied the value of ``count`` parameter is assumed + + * - ``setups`` + - List of strings + - List with the name of the setup configurations that must be executed after nodes are created + +When a cluster is created, the instance types specified in the each node section +is created with the desired ``count`` number. The cluster is considered created +when all nodes are effectively created. The ``min_count`` parameter at each node +specify the minimum number of instances of that type that must effectively be +launched. If some instances could not be instantiated (or created wwith less than +``min_count`` parameter) the cluster creation process fails and all nodes are terminated. + +After the cluster is created, i.e. the minimum number of nodes of each type is +successfully created, the ``setups`` for each node is executed, in order. If some +setup does not execute correctly, the cluster remains created and the ``setup`` +phase can be executed again. + +Controlling cluster's setups execution phases +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +CLAP's cluster module also offers some other facilities to configure the cluster. +By default the cluster module create nodes and run the setup from each node type. +You can control the flow of the setup execution using some optional keys at your +cluster configuration. The keys: ``before_all``, ``before``, ``after`` and +``after_all`` can be plugged into a cluster's configuration, in order to execute +setups in different set of nodes, before and after the nodes setups. These keys +takes a list of setups to execute. CLAP's setup phases are executed in the order, +as shown in table bellow. + + +.. list-table:: Cluster's setups execution phases (in order) + :header-rows: 1 + + * - **Phase name** + - **Description** + + * - ``before_all`` (#1) + - Setups inside this key are executed in all cluster's nodes before specific setup of the nodes (#3). + + * - ``before`` (#2) + - Setups inside this key are executed only in nodes that are currently being added to the cluster, before the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster. + + * - ``node`` (#3) + - The setup for each node is executed. The setup (inventory generated) is executed only at nodes of this type + + * - ``after`` (#4) + - Setups inside this key are executed only in nodes that are currently being added to the cluster, after the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster. + + * - ``after_all`` (#5) + - Setups inside this key are executed in all cluster's nodes after specific setup of the nodes (#3). + +.. note:: + + All setups are optional + + +An example is shown below: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # These setups are executed at all cluster's nodes, before setups at nodes section + before_all: + - my-custom-setup-1 + + # These setups are executed at nodes that are currently being added to cluster, before setups at nodes section + before: + - my-custom-setup-2 + + # These setups are executed at nodes that are currently being added to cluster, after setups at nodes section + after: + - my-custom-setup-3 + - my-custom-setup-4 + + # These setups are executed at all cluster's nodes, after setups at nodes section + after_all: + - final_setup + + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + + +In the above example, supposing you are creating a new cluster, after the creation +of nodes the following setups are executed (in order): + +- ``before_all`` setups: ``my-custom-setup-1`` at all nodes +- ``before`` setups: ``my-custom-setup-2`` at all nodes +- ``nodes`` setups (not necessary in order): ``another-example-setup`` and ``master-setup`` at ``master-nodes`` nodes and ``setup-slave-node`` at ``slave-nodes`` nodes. +- ``after`` setups: ``my-custom-setup-3`` and ``my-custom-setup-4`` at all nodes +- ``after_all`` setups: ``final_setup`` at all nodes + +Now supposing you are resizing the already created cluster (adding more +``slave-nodes`` to it), the ``before_all`` and ``after_all`` setups will be executed +in all cluster's nodes (including the new ones, that are being added) and +``before``, ``nodes`` and ``after`` phase setups will only be executed at nodes +that are being added to the the cluster. + +Other cluster's setups optional keys +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``options`` key can be plugged at a cluster configuration allowing some special +options to cluster. The ``options`` key may have the following parameters: + +.. list-table:: code-block:: none Cluster's options keys + :header-rows: 1 + + * - **Option name** + - **Description** + + * - ``ssh_to`` + - Connect to a specific node when performing the ``cluster connect`` command + +A example is shown below: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # Additional cluster's options (optional) + options: + # When connecting to a cluster, connect to a master-node + ssh_to: master-node + + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + + +Command ``cluster start`` +++++++++++++++++++++++++++ + +Start a cluster given a cluster configuration name. The syntax of the command is +shown below + +:: + + clapp cluster start [OPTIONS] CLUSTER_TEMPLATE + + Start cluster based on a cluster template. + + The CLUSTER TEMPLATE is the ID of the cluster configuration at cluster + configuration files. + + Options: + -n, --no-setup Do not perform setup [default: False] + --help Show this message and exit. + + + +By default, the CLAP's cluster module search for configurations at all ``.yaml`` +files inside ``~/.clap/configs/clusters`` directory. After cluster is created, +the setups are automatically executed. You can omit this phase by using the +``--no-setup`` option. + +An example of the command is shown below, which starts a cluster called +``example-cluster``. + +:: + + clapp cluster start example-cluster + +.. note:: + - After the cluster's creation a new ``cluster_id`` will be assigned to it. Thus, multiple clusters with same cluster configuration can be launched Also, all commands will reference to ``cluster_id`` to perform their actions. + - When a cluster is started its initial configuration is copied to cluster metadata. If you update the cluster configuration while having already started clusters use the ``clapp cluster update`` command to update the cluster configuration. + + +Command ``cluster setup`` +++++++++++++++++++++++++++ + +Setup an existing cluster. The command has the following syntax: + +:: + + clapp cluster setup [OPTIONS] CLUSTER_ID + + Perform cluster setup operation at a cluster. + + The CLUSTER_ID argument is the id of the cluster to perform the setup + + Options: + -a, --at TEXT Stage to start the setup action [default: before_all] + --help Show this message and exit. + + +Given the ``cluster_id``, the command will execute all setup phases in all cluster +nodes. Some phases of the setup pipeline can be skipped informing at which phase +the setup must begin with the ``at`` parameter. +Examples are shown below: + +:: + + clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9 + clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9 --at "before" + +In the above examples, the first one setups all cluster nodes from +``cluster-faa4017e10094e698aed56bb1f3369f9``, the second one setups all nodes, +but starting at ``before`` phase. + +.. note:: + + The ``before_all`` and ``after_all`` phases will be executed at all cluster's nodes, even if setting the ``nodes`` parameter. + + +Command ``cluster grow`` +++++++++++++++++++++++++++ + +Start and add a new node to cluster, based on its cluster's node name. The command +has the following syntax: + +:: + + clapp cluster grow [OPTIONS] CLUSTER_ID + + Start more nodes at a cluster by cluster node type. + + The CLUSTER_ID argument is the id of the cluster to add more nodes. + + Options: + -n, --node TEXT Type of node to start. Format: : + [required] + -n, --no-setup Do not perform setup [default: False] + --help Show this message and exit. + + +The ``--node`` parameter determines how much nodes will be added to cluster. +If ``--no-setup`` is provided no setup phase will be executed. + +Command ``cluster list`` +++++++++++++++++++++++++++ + +List all available CLAP's clusters. + +Command ``cluster alive`` +++++++++++++++++++++++++++ + +Check if all nodes of the cluster are alive. + +Command ``cluster resume`` +++++++++++++++++++++++++++ + +Resume all nodes of the cluster. + +Command ``cluster pause`` +++++++++++++++++++++++++++ + +Pause all nodes of the cluster. + +Command ``cluster stop`` +++++++++++++++++++++++++++ + +Stop all nodes of the cluster, terminating them (destroying). + +Command ``cluster list-templates`` ++++++++++++++++++++++++++++++++++++ + +List all available cluster templates at ``~/clap/configs/clusters`` directory. + +Command ``cluster update`` ++++++++++++++++++++++++++++++ + +Update a cluster configuration of an already created cluster. The command's +syntax is shown below. + +:: + + clapp cluster update [OPTIONS] CLUSTER_ID + + Perform cluster setup operation at a cluster. + + The CLUSTER_ID argument is the id of the cluster to perform the setup + + Options: + -c, --config TEXT New cluster config name + --help Show this message and exit. + +If ``--config`` option is provided, the cluster configuration will be replaced +with the informed configuration. Otherwise, the cluster will be updated with the +same configuration. + +.. note:: + + The configurations will be searched in ``~/clap/configs/clusters`` directory. + + +Command ``cluster connect`` ++++++++++++++++++++++++++++++ + +Get a SSH shell to a node of the cluster. Given a ``cluster_id`` it will try to +get an SSH shell to a node type specified in ``ssh_to`` cluster configuration +option. If no ``ssh_to`` option is informed at cluster's configuration the command +will try to connect to any other node that belongs to the cluster. + +Command ``cluster execute`` ++++++++++++++++++++++++++++++ + +Execute a shell command in nodes of the cluster. + +Command ``cluster playbook`` ++++++++++++++++++++++++++++++ + +Execute an Ansible Playbook in nodes of the cluster. \ No newline at end of file diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css new file mode 100644 index 00000000..b3bdc004 --- /dev/null +++ b/docs/build/html/_static/basic.css @@ -0,0 +1,861 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/build/html/_static/css/badge_only.css b/docs/build/html/_static/css/badge_only.css new file mode 100644 index 00000000..e380325b --- /dev/null +++ b/docs/build/html/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/build/html/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/build/html/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/build/html/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-bold.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/build/html/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/build/html/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/build/html/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/docs/build/html/_static/css/fonts/lato-normal.woff2 differ diff --git a/docs/build/html/_static/css/theme.css b/docs/build/html/_static/css/theme.css new file mode 100644 index 00000000..8cd4f101 --- /dev/null +++ b/docs/build/html/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li span.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li span.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p.caption .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.btn .wy-menu-vertical li span.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p.caption .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.nav .wy-menu-vertical li span.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p.caption .btn .headerlink,.rst-content p.caption .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li span.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol li,.rst-content ol.arabic li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content ol.arabic li p:last-child,.rst-content ol.arabic li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover span.toctree-expand,.wy-menu-vertical li.on a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content .code-block-caption .headerlink:after,.rst-content .toctree-wrapper>p.caption .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"\f0c1";font-family:FontAwesome}.rst-content .code-block-caption:hover .headerlink:after,.rst-content .toctree-wrapper>p.caption:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl dt span.classifier:before{content:" : "}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code,html.writer-html4 .rst-content dl:not(.docutils) tt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/docs/build/html/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js new file mode 100644 index 00000000..569b91af --- /dev/null +++ b/docs/build/html/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.2.1', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/docs/build/html/_static/file.png differ diff --git a/docs/build/html/_static/fonts/Inconsolata-Bold.ttf b/docs/build/html/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..809c1f58 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/Inconsolata-Regular.ttf b/docs/build/html/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 00000000..fc981ce7 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/Inconsolata.ttf b/docs/build/html/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/docs/build/html/_static/fonts/Inconsolata.ttf differ diff --git a/docs/build/html/_static/fonts/Lato-Bold.ttf b/docs/build/html/_static/fonts/Lato-Bold.ttf new file mode 100644 index 00000000..1d23c706 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/Lato-Regular.ttf b/docs/build/html/_static/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..0f3d0f83 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.eot b/docs/build/html/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.ttf b/docs/build/html/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.woff b/docs/build/html/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bold.woff2 b/docs/build/html/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot b/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf b/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.eot b/docs/build/html/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.ttf b/docs/build/html/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.woff b/docs/build/html/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-italic.woff2 b/docs/build/html/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.eot b/docs/build/html/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.ttf b/docs/build/html/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.woff b/docs/build/html/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/build/html/_static/fonts/Lato/lato-regular.woff2 b/docs/build/html/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/docs/build/html/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf b/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf b/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/docs/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.eot b/docs/build/html/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.eot differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.svg b/docs/build/html/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/docs/build/html/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.ttf differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.woff b/docs/build/html/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.woff differ diff --git a/docs/build/html/_static/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/docs/build/html/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/build/html/_static/graphviz.css b/docs/build/html/_static/graphviz.css new file mode 100644 index 00000000..b340734c --- /dev/null +++ b/docs/build/html/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/docs/build/html/_static/jquery-3.5.1.js b/docs/build/html/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/docs/build/html/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Architecture

+

Sorry, to be written…

+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/abstract_provider/index.html b/docs/build/html/autoapi/CLAP/clap/abstract_provider/index.html new file mode 100644 index 00000000..cf9c5b69 --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/abstract_provider/index.html @@ -0,0 +1,289 @@ + + + + + + + + + + CLAP.clap.abstract_provider — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.abstract_provider

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + +

AbstractInstanceProvider

Helper class that provides a standard way to create an ABC using

+
+
+

Attributes

+ ++++ + + + + + +

logger

+
+
+CLAP.clap.abstract_provider.logger
+
+ +
+
+exception CLAP.clap.abstract_provider.InstanceDeploymentError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.abstract_provider.AbstractInstanceProvider
+

Bases: abc.ABC

+

Helper class that provides a standard way to create an ABC using +inheritance.

+
+
+abstract start_instances(self, instance: clap.configs.InstanceInfo, count: int, timeout: int = 600) → List[clap.node.NodeDescriptor]
+
+ +
+
+abstract stop_instances(self, nodes_to_stop: List[clap.node.NodeDescriptor], timeout: int = 600) → List[clap.node.NodeDescriptor]
+
+ +
+
+abstract pause_instances(self, nodes_to_pause: List[clap.node.NodeDescriptor], timeout: int = 600) → List[clap.node.NodeDescriptor]
+
+ +
+
+abstract resume_instances(self, nodes_to_resume: List[clap.node.NodeDescriptor], timeout: int = 600) → List[clap.node.NodeDescriptor]
+
+ +
+
+abstract update_instance_info(self, nodes_to_check: List[clap.node.NodeDescriptor], timeout: int = 600) → List[clap.node.NodeDescriptor]
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/cluster_manager/index.html b/docs/build/html/autoapi/CLAP/clap/cluster_manager/index.html new file mode 100644 index 00000000..1225c29d --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/cluster_manager/index.html @@ -0,0 +1,768 @@ + + + + + + + + + + CLAP.clap.cluster_manager — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.cluster_manager

+
+

Module Contents

+ +
+

Functions

+ ++++ + + + + + + + + +

validate_valid_role()

validate_valid_cluster()

+
+
+

Attributes

+ ++++ + + + + + + + + +

logger

ActionType

+
+
+CLAP.clap.cluster_manager.logger
+
+ +
+
+exception CLAP.clap.cluster_manager.ClusterConfigurationError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.cluster_manager.ClusterError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.cluster_manager.ClusterSetupError
+

Bases: ClusterError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.cluster_manager.InvalidClusterError(cluster_id: str)
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.cluster_manager.InvalidSetupError(cluster_name: str, setup_name: str)
+

Bases: ClusterConfigurationError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.cluster_manager.NodeSizeError
+

Bases: ClusterConfigurationError

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.cluster_manager.RoleActionType
+
+
+role :str
+
+ +
+
+action :str
+
+ +
+
+extra :Optional[Dict[str, str]]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.CommandActionType
+
+
+command :str
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.PlaybookActionType
+
+
+playbook :str
+
+ +
+
+extra :Optional[Dict[str, str]]
+
+ +
+ +
+
+CLAP.clap.cluster_manager.ActionType
+
+ +
+
+class CLAP.clap.cluster_manager.RoleAdd
+
+
+name :str
+
+ +
+
+extra :Optional[Dict[str, str]]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.SetupConfig
+
+
+roles :Optional[List[RoleAdd]]
+
+ +
+
+actions :Optional[List[ActionType]]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterOptions
+
+
+ssh_to :Optional[str]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager._NodeConfig
+
+
+type :str
+
+ +
+
+count :int
+
+ +
+
+min_count :Optional[int]
+
+ +
+
+setups :List[str]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager._ClusterConfig
+
+
+options :Optional[ClusterOptions]
+
+ +
+
+before_all :Optional[List[str]]
+
+ +
+
+before :Optional[List[str]]
+
+ +
+
+after_all :Optional[List[str]]
+
+ +
+
+after :Optional[List[str]]
+
+ +
+
+nodes :Optional[Dict[str, _NodeConfig]]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterConfigFile
+
+
+setups :Optional[Dict[str, SetupConfig]]
+
+ +
+
+clusters :Optional[Dict[str, _ClusterConfig]]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.NodeConfig
+
+
+type :str
+
+ +
+
+count :int
+
+ +
+
+min_count :Optional[int]
+
+ +
+
+setups :List[SetupConfig]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterConfig
+
+
+cluster_config_id :str
+
+ +
+
+options :Optional[ClusterOptions]
+
+ +
+
+before_all :Optional[List[SetupConfig]]
+
+ +
+
+before :Optional[List[SetupConfig]]
+
+ +
+
+after_all :Optional[List[SetupConfig]]
+
+ +
+
+after :Optional[List[SetupConfig]]
+
+ +
+
+nodes :Optional[Dict[str, NodeConfig]]
+
+ +
+ +
+
+CLAP.clap.cluster_manager.validate_valid_role()
+
+ +
+
+CLAP.clap.cluster_manager.validate_valid_cluster()
+
+ +
+
+class CLAP.clap.cluster_manager.ClusterConfigDatabase(cluster_files: List[str], discard_invalids: bool = True, load: bool = True)
+
+
+_load_cluster_and_setups(self)
+
+ +
+
+load(self)
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterDescriptor
+
+
+cluster_id :str
+
+ +
+
+cluster_name :str
+
+ +
+
+cluster_config :ClusterConfig
+
+ +
+
+creation_time :float
+
+ +
+
+update_time :float
+
+ +
+
+is_setup :bool = False
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterRepositoryController(repository: clap.repository.Repository)
+
+
+upsert_cluster(self, cluster: ClusterDescriptor)
+
+ +
+
+remove_cluster(self, cluster_id: str)
+
+ +
+
+get_cluster_by_id(self, cluster_id: str) → ClusterDescriptor
+
+ +
+
+get_all_clusters(self) → List[ClusterDescriptor]
+
+ +
+ +
+
+class CLAP.clap.cluster_manager.ClusterManager(node_manager: clap.node_manager.NodeManager, role_manager: clap.role_manager.RoleManager, config_db: clap.configs.ConfigurationDatabase, cluster_repository_controller: ClusterRepositoryController, private_dir: str, cluster_tag_prefix: str = '.cluster:')
+
+
+add_cluster_tag(self, node_ids: List[str], cluster_id: str, node_type: str) → List[str]
+
+ +
+
+get_all_cluster_nodes(self, cluster_id: str) → List[str]
+
+ +
+
+get_cluster_nodes_types(self, cluster_id: str) → Dict[str, List[str]]
+
+ +
+
+get_cluster_by_id(self, cluster_id: str) → ClusterDescriptor
+
+ +
+
+get_all_clusters(self) → List[ClusterDescriptor]
+
+ +
+
+grow(self, cluster_id: str, node_type: str, count: int = 1, min_count: int = 0, start_timeout: int = 600)
+
+ +
+
+start_cluster_node(self, cluster_id: str, node_type: str, instance_info: clap.configs.InstanceInfo, count: int, start_timeout: int = 600) → List[str]
+
+ +
+
+start_cluster(self, cluster_config: ClusterConfig, start_timeout: int = 600, max_workers: int = 1, destroy_on_min_count: bool = True) → str
+
+ +
+
+add_existing_nodes_to_cluster(self, cluster_id: str, node_types: Dict[str, List[str]], max_workers: int = 1)
+
+ +
+
+run_action(self, action: ActionType, node_ids: List[str]) → bool
+
+ +
+
+run_role_add(self, role: RoleAdd, node_ids: List[str]) → bool
+
+ +
+
+run_setup(self, setup: SetupConfig, node_ids: List[str]) → bool
+
+ +
+
+_run_setup_list(self, setups: List[SetupConfig], node_ids: List[str]) → bool
+
+ +
+
+setup_cluster(self, cluster_id: str, nodes_being_added: Dict[str, List[str]] = None, max_workers: int = 1, start_at_stage: str = 'before_all')
+
+ +
+
+pause_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1) → List[str]
+
+ +
+
+resume_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1) → List[str]
+
+ +
+
+stop_cluster(self, cluster_id: str, timeout: int = 180, max_workers: int = 1, remove_cluster: bool = True) → List[str]
+
+ +
+
+is_alive(self, cluster_id: str, retries: int = 5, wait_timeout: int = 30, update_timeout: int = 30, max_workers: int = 1, test_command: str = 'echo "OK"') → Dict[str, bool]
+
+ +
+
+upsert_cluster(self, cluster: ClusterDescriptor)
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/configs/index.html b/docs/build/html/autoapi/CLAP/clap/configs/index.html new file mode 100644 index 00000000..f61c100f --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/configs/index.html @@ -0,0 +1,535 @@ + + + + + + + + + + CLAP.clap.configs — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.configs

+
+

Module Contents

+ +
+

Attributes

+ ++++ + + + + + + + + + + + + + + + + + +

logger

provider_handlers

ProviderConfigs

LoginConfigs

InstanceConfigs

+
+
+CLAP.clap.configs.logger
+
+ +
+
+exception CLAP.clap.configs.ConfigurationError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.configs.InvalidConfigurationError(name: str)
+

Bases: ConfigurationError

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.configs.ProviderConfigAWS
+
+
+provider_config_id :str
+
+ +
+
+region :str
+
+ +
+
+access_keyfile :str
+
+ +
+
+secret_access_keyfile :str
+
+ +
+
+vpc :Optional[str]
+
+ +
+
+url :Optional[str]
+
+ +
+
+provider :str = aws
+
+ +
+ +
+
+class CLAP.clap.configs.ProviderConfigLocal
+
+
+provider_config_id :str
+
+ +
+
+provider :str = local
+
+ +
+ +
+
+class CLAP.clap.configs.LoginConfig
+
+
+login_config_id :str
+
+ +
+
+user :str
+
+ +
+
+keypair_name :str
+
+ +
+
+keypair_public_file :str
+
+ +
+
+keypair_private_file :str
+
+ +
+
+ssh_port :Optional[int] = 22
+
+ +
+
+sudo :Optional[bool] = True
+
+ +
+
+sudo_user :Optional[str] = root
+
+ +
+ +
+
+class CLAP.clap.configs.InstanceConfigAWS
+
+
+instance_config_id :str
+
+ +
+
+provider :str
+
+ +
+
+login :str
+
+ +
+
+flavor :str
+
+ +
+
+image_id :str
+
+ +
+
+security_group :Optional[str]
+
+ +
+
+boot_disk_size :Optional[int]
+
+ +
+
+boot_disk_device :Optional[str]
+
+ +
+
+boot_disk_type :Optional[str]
+
+ +
+
+boot_disk_iops :Optional[str]
+
+ +
+
+boot_disk_snapshot :Optional[str]
+
+ +
+
+placement_group :Optional[str]
+
+ +
+
+price :Optional[float]
+
+ +
+
+timeout :Optional[int]
+
+ +
+
+network_ids :Optional[List[str]]
+
+ +
+ +
+
+CLAP.clap.configs.provider_handlers
+
+ +
+
+CLAP.clap.configs.ProviderConfigs
+
+ +
+
+CLAP.clap.configs.LoginConfigs
+
+ +
+
+CLAP.clap.configs.InstanceConfigs
+
+ +
+
+class CLAP.clap.configs.InstanceInfo
+
+
+provider :ProviderConfigs
+
+ +
+
+login :LoginConfigs
+
+ +
+
+instance :InstanceConfigs
+
+ +
+ +
+
+class CLAP.clap.configs.ConfigurationDatabase(providers_file: str, logins_file: str, instances_file: str, discard_invalids: bool = True, load: bool = True)
+
+
+_load_provider_configs(self)
+
+ +
+
+_load_login_configs(self)
+
+ +
+
+_load_instance_configs(self)
+
+ +
+
+load_all(self)
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/executor/index.html b/docs/build/html/autoapi/CLAP/clap/executor/index.html new file mode 100644 index 00000000..786d6536 --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/executor/index.html @@ -0,0 +1,346 @@ + + + + + + + + + + CLAP.clap.executor — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.executor

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + + + + + + + +

Executor

SSHCommandExecutor

AnsiblePlaybookExecutor

ShellInvoker

+
+
+

Attributes

+ ++++ + + + + + +

logger

+
+
+CLAP.clap.executor.logger
+
+ +
+
+class CLAP.clap.executor.Executor
+
+
+abstract run(self) → Any
+
+ +
+ +
+
+class CLAP.clap.executor.SSHCommandExecutor(command: str, nodes: List[clap.node.NodeDescriptor], private_path: str, max_workers: int = 0, connection_timeout: float = 10.0, execution_timeout: float = None, environment: dict = None)
+

Bases: Executor

+
+
+connect_and_execute(self, node: clap.node.NodeDescriptor) → dict
+
+ +
+
+run(self) → dict
+
+ +
+ +
+
+class CLAP.clap.executor.AnsiblePlaybookExecutor(playbook_file: str, private_path: str, inventory: Union[list, dict] = None, extra_args: Dict[str, str] = None, env_vars: Dict[str, str] = None, quiet: bool = False, verbosity: int = 0)
+

Bases: Executor

+
+
+class PlaybookResult
+
+
+ok :bool
+
+ +
+
+ret_code :int
+
+ +
+
+hosts :Dict[str, bool]
+
+ +
+
+events :Dict[str, List[dict]]
+
+ +
+
+vars :Dict[str, Dict[str, Any]]
+
+ +
+ +
+
+static create_inventory(hosts_node_map: Union[List[clap.node.NodeDescriptor], Dict[str, List[clap.node.NodeDescriptor]]], private_path: str, host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None) → dict
+
+ +
+
+static create_extra_vars(output_dir: str, nodes: List[clap.node.NodeDescriptor], private_path: str) → dict
+
+ +
+
+run(self) → PlaybookResult
+
+ +
+ +
+
+class CLAP.clap.executor.ShellInvoker(node: clap.node.NodeDescriptor, private_path: str, verbosity: int = 0, ssh_binary: str = 'ssh')
+

Bases: Executor

+
+
+run(self)
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/index.html b/docs/build/html/autoapi/CLAP/clap/index.html new file mode 100644 index 00000000..08a364ae --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/index.html @@ -0,0 +1,229 @@ + + + + + + + + + + CLAP.clap — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/node/index.html b/docs/build/html/autoapi/CLAP/clap/node/index.html new file mode 100644 index 00000000..365aa423 --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/node/index.html @@ -0,0 +1,393 @@ + + + + + + + + + + CLAP.clap.node — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.node

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + + + + + + + +

NodeStatus

NodeType

NodeLifecycle

NodeDescriptor

+
+
+

Attributes

+ ++++ + + + + + +

logger

+
+
+CLAP.clap.node.logger
+
+ +
+
+class CLAP.clap.node.NodeStatus
+
+
+UNKNOWN = unknown
+
+ +
+
+STARTED = started
+
+ +
+
+UNREACHABLE = unreachable
+
+ +
+
+REACHABLE = reachable
+
+ +
+
+PAUSED = paused
+
+ +
+
+STOPPED = stopped
+
+ +
+ +
+
+class CLAP.clap.node.NodeType
+
+
+TYPE_CLOUD = cloud
+
+ +
+
+TYPE_LOCAL = local
+
+ +
+ +
+
+class CLAP.clap.node.NodeLifecycle
+
+
+NORMAL = normal
+
+ +
+
+PREEMPTIBLE = preemptible
+
+ +
+ +
+
+class CLAP.clap.node.NodeDescriptor
+
+
+node_id :str
+
+ +
+
+configuration :clap.configs.InstanceInfo
+
+ +
+
+nickname :Optional[str] =
+
+ +
+
+ip :Optional[str] =
+
+ +
+
+type :Optional[str]
+
+ +
+
+cloud_instance_id :Optional[str] =
+
+ +
+
+cloud_lifecycle :Optional[str]
+
+ +
+
+status :Optional[str]
+
+ +
+
+creation_time :Optional[float] = 0.0
+
+ +
+
+update_time :Optional[float] = 0.0
+
+ +
+
+roles :List[str]
+
+ +
+
+tags :Dict[str, str]
+
+ +
+
+extra :Dict[str, Any]
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/node_manager/index.html b/docs/build/html/autoapi/CLAP/clap/node_manager/index.html new file mode 100644 index 00000000..687e2757 --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/node_manager/index.html @@ -0,0 +1,420 @@ + + + + + + + + + + CLAP.clap.node_manager — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.node_manager

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + +

NodeRepositoryController

NodeManager

+
+
+

Attributes

+ ++++ + + + + + +

logger

+
+
+CLAP.clap.node_manager.logger
+
+ +
+
+exception CLAP.clap.node_manager.InvalidProvider
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.node_manager.UnhandledProviderError(provider: str)
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.node_manager.DeploymentError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.node_manager.InvalidNodeError(node_id: str)
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.node_manager.NodeRepositoryController(repository: clap.repository.Repository)
+
+
+upsert_node(self, node: clap.node.NodeDescriptor)
+
+ +
+
+remove_node(self, node_id: str)
+
+ +
+
+remove_nodes(self, node_ids: List[str])
+
+ +
+
+get_nodes_by_id(self, node_ids: List[str]) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_all_nodes(self) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_nodes_filter(self, filter_func: Callable[[clap.node.NodeDescriptor], bool]) → List[clap.node.NodeDescriptor]
+
+ +
+ +
+
+class CLAP.clap.node_manager.NodeManager(node_repository_controller: NodeRepositoryController, providers: Dict[str, clap.abstract_provider.AbstractInstanceProvider], private_dir: str)
+
+
+static _group_instances_by_provider(instances: List[Tuple[clap.configs.InstanceInfo, int]]) → Dict[str, List[Tuple[clap.configs.InstanceInfo, int]]]
+
+ +
+
+static group_nodes_by_provider(nodes: List[clap.node.NodeDescriptor]) → Dict[str, List[clap.node.NodeDescriptor]]
+
+ +
+
+get_nodes_by_id(self, node_ids: List[str]) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_nodes(self, filter_func: Callable[[clap.node.NodeDescriptor], bool], from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_all_nodes(self) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_not_running_nodes(self, from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_up_nodes(self, from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_reachable_nodes(self, from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_nodes_with_tag(self, key: str, from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+get_nodes_with_tag_value(self, key: str, value: str, from_node_ids: List[str] = None) → List[clap.node.NodeDescriptor]
+
+ +
+
+start_node(self, instance: clap.configs.InstanceInfo, count: int = 1, start_timeout: int = 600) → List[str]
+
+ +
+
+start_nodes(self, instance_counts: List[Tuple[clap.configs.InstanceInfo, int]], start_timeout: int = 600, max_workers: int = 1) → List[str]
+
+ +
+
+is_alive(self, node_ids: List[str], retries: int = 5, wait_timeout: int = 30, update_timeout: int = 30, max_workers: int = 1, test_command: str = 'echo "OK"') → Dict[str, bool]
+
+ +
+
+stop_nodes(self, node_ids: List[str], timeout: int = 180, max_workers: int = 1, remove_nodes: bool = True) → List[str]
+
+ +
+
+resume_nodes(self, node_ids: List[str], timeout: int = 600, connection_retries: int = 10, retry_timeout: int = 30, max_workers: int = 1) → List[str]
+
+ +
+
+pause_nodes(self, node_ids: List[str], timeout: int = 180, max_workers: int = 1) → List[str]
+
+ +
+
+add_tags(self, node_ids: List[str], tags: Dict[str, str]) → List[str]
+
+ +
+
+remove_tags(self, node_ids: List[str], tags: List[str]) → List[str]
+
+ +
+
+upsert_node(self, node: clap.node.NodeDescriptor)
+
+ +
+
+remove_node(self, node_id: str)
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/repository/index.html b/docs/build/html/autoapi/CLAP/clap/repository/index.html new file mode 100644 index 00000000..64bd558d --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/repository/index.html @@ -0,0 +1,437 @@ + + + + + + + + + + CLAP.clap.repository — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.repository

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + + + + +

Repository

Helper class that provides a standard way to create an ABC using

SQLiteRepository

Helper class that provides a standard way to create an ABC using

RepositoryFactory

+
+
+exception CLAP.clap.repository.RepositoryError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.repository.InvalidEntryError(entry)
+

Bases: RepositoryError

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.repository.Repository(repository_path: str, commit_on_close: bool = True, verbosity: int = 0)
+

Bases: abc.ABC

+

Helper class that provides a standard way to create an ABC using +inheritance.

+
+
+repository_name :str = AbstractRepository
+
+ +
+
+extension :str =
+
+ +
+
+abstract connect(self, table_name: str) → Repository
+
+ +
+
+abstract open(self, table_name: str)
+
+ +
+
+abstract close(self)
+
+ +
+
+abstract commit(self)
+
+ +
+
+abstract keys(self) → List[str]
+
+ +
+
+abstract upsert(self, key: str, obj: dict)
+
+ +
+
+abstract update(self, key: str, update_obj: dict)
+
+ +
+
+abstract get(self, key: str) → Dict[str, dict]
+
+ +
+
+abstract get_multiple(self, key: List[str]) → dict
+
+ +
+
+abstract get_all(self) → Dict[str, dict]
+
+ +
+
+abstract remove(self, key: str)
+
+ +
+
+abstract remove_multiple(self, keys: List[str])
+
+ +
+
+abstract clear(self)
+
+ +
+ +
+
+class CLAP.clap.repository.SQLiteRepository(repository_path: str, commit_on_close: bool = True, verbosity: int = 0)
+

Bases: Repository

+

Helper class that provides a standard way to create an ABC using +inheritance.

+
+
+repository_name :str = sqlite
+
+ +
+
+extension :str = .db
+
+ +
+
+connect(self, table_name: str) → SQLiteRepository
+
+ +
+
+open(self, table_name: str)
+
+ +
+
+close(self)
+
+ +
+
+commit(self)
+
+ +
+
+keys(self) → List[str]
+
+ +
+
+update(self, key: str, update_obj: dict)
+
+ +
+
+upsert(self, key: str, obj: dict)
+
+ +
+
+get(self, key: str) → dict
+
+ +
+
+get_multiple(self, keys: List[str]) → Dict[str, dict]
+
+ +
+
+get_all(self) → Dict[str, dict]
+
+ +
+
+remove(self, key: str)
+
+ +
+
+remove_multiple(self, keys: List[str])
+
+ +
+
+clear(self)
+
+ +
+
+__repr__(self)
+

Return repr(self).

+
+ +
+ +
+
+class CLAP.clap.repository.RepositoryFactory
+
+
+repositories
+
+ +
+
+get_repository(self, name: str, repository_path: str, commit_on_close: bool = True, verbosity: int = 0) → Repository
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/role_manager/index.html b/docs/build/html/autoapi/CLAP/clap/role_manager/index.html new file mode 100644 index 00000000..3c03776d --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/role_manager/index.html @@ -0,0 +1,441 @@ + + + + + + + + + + CLAP.clap.role_manager — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.role_manager

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + + + + + + + +

RoleVariableInfo

RoleActionInfo

Role

RoleManager

+
+
+

Attributes

+ ++++ + + + + + +

logger

+
+
+CLAP.clap.role_manager.logger
+
+ +
+
+exception CLAP.clap.role_manager.RoleError
+

Bases: Exception

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.InvalidRoleError(role_name: str)
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.InvalidActionError(role_name: str, action_name: str)
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.InvalidHostError(role_name: str, host_name: str)
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.RoleAssignmentError
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.NodeRoleError(node_id: str, role_name: str, host_name: str = None)
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+exception CLAP.clap.role_manager.MissingActionVariableError(role_name: str, action_name: str, var: str)
+

Bases: RoleError

+

Common base class for all non-exit exceptions.

+
+ +
+
+class CLAP.clap.role_manager.RoleVariableInfo
+
+
+name :str
+
+ +
+
+description :Optional[str]
+
+ +
+
+optional :Optional[bool]
+
+ +
+ +
+
+class CLAP.clap.role_manager.RoleActionInfo
+
+
+playbook :str
+
+ +
+
+description :Optional[str]
+
+ +
+
+vars :Optional[List[RoleVariableInfo]]
+
+ +
+ +
+
+class CLAP.clap.role_manager.Role
+
+
+actions :Optional[Dict[str, RoleActionInfo]]
+
+ +
+
+hosts :Optional[List[str]]
+
+ +
+ +
+
+class CLAP.clap.role_manager.RoleManager(node_repository_controller: clap.node_manager.NodeRepositoryController, role_dir: str, actions_dir: str, private_dir: str, discard_invalids: bool = True, load: bool = True)
+
+
+get_all_role_nodes(self, role_name: str) → List[str]
+
+ +
+
+get_role_node_hosts(self, role_name: str, node_id: str) → List[str]
+
+ +
+
+get_all_role_nodes_hosts(self, role_name: str) → Dict[str, List[str]]
+
+ +
+
+get_role_nodes(self, role_name: str, from_node_ids: List[str] = None) → Dict[str, List[str]]
+
+ +
+
+load_roles(self)
+
+ +
+
+add_role(self, role_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]], host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None, extra_args: Dict[str, str] = None, quiet: bool = False) → List[str]
+
+ +
+
+_check_nodes_role(self, role_name: str, host_map: Dict[str, List[clap.node.NodeDescriptor]])
+
+ +
+
+perform_action(self, role_name: str, action_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]], host_vars: Dict[str, Dict[str, str]] = None, node_vars: Dict[str, Dict[str, str]] = None, extra_args: Dict[str, str] = None, quiet: bool = False, validate_nodes_in_role: bool = True) → clap.executor.AnsiblePlaybookExecutor.PlaybookResult
+
+
Parameters
+
    +

  • role_name –

    • +

  • action_name –

    • +

  • hosts_node_map –

    If the role does not defines hosts, this value can be: +- A list of node_ids, e.g.: [id1, id2] +- A dictionary with a empty string key and the value is

    +
    +

    a list of node_ids, e.g.: {‘’: [id1, id2]}

    +
    +

    If the role defines hosts, this value can be: +- A dictionary, where key is the host name and the

    +
    +

    values are lists of node_ids, e.g. +{ hostA: [id1, id2], hostB: [id2, id3] }

    +
    +

    • +

  • host_vars –

    • +

  • node_vars –

    • +

  • extra_args –

    • +

  • quiet –

    • +

  • validate_nodes_in_role –

    • +
+
+
Returns
+

+
+
+
+ +
+
+remove_role(self, role_name: str, hosts_node_map: Union[List[str], Dict[str, List[str]]]) → List[str]
+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/CLAP/clap/utils/index.html b/docs/build/html/autoapi/CLAP/clap/utils/index.html new file mode 100644 index 00000000..38da609f --- /dev/null +++ b/docs/build/html/autoapi/CLAP/clap/utils/index.html @@ -0,0 +1,390 @@ + + + + + + + + + + CLAP.clap.utils — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP.clap.utils

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + + + + +

CLAPFilter

Filter instances are used to perform arbitrary filtering of LogRecords.

Singleton

Creates a single instance class

+
+
+

Functions

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

tmpdir(suffix=None, prefix='clap.', dir: str = None, remove: bool = True)

path_extend(*args) → str

yaml_load(filename: str) → dict

float_time_to_string(timespec: float)

setup_log(name: str = 'clap', verbosity_level: int = 0, filename: str = None)

get_random_name(in_use_names: List[str] = None, retries: int = 10) → str

get_random_object() → str

defaultdict_to_dict(d)

sorted_groupby(iterable: Iterable, key=None) → dict

get_logger(name)

str_at_middle(text: str, maximum: int, delimiter: str = '-')

+
+
+

Attributes

+ ++++ + + + + + +

APP_NAME

+
+
+CLAP.clap.utils.APP_NAME = clap
+
+ +
+
+class CLAP.clap.utils.CLAPFilter(name='')
+

Bases: logging.Filter

+

Filter instances are used to perform arbitrary filtering of LogRecords.

+

Loggers and Handlers can optionally use Filter instances to filter +records as desired. The base filter class only allows events which are +below a certain point in the logger hierarchy. For example, a filter +initialized with “A.B” will allow events logged by loggers “A.B”, +“A.B.C”, “A.B.C.D”, “A.B.D” etc. but not “A.BB”, “B.A.B” etc. If +initialized with the empty string, all events are passed.

+
+
+filter(self, record)
+

Determine if the specified record is to be logged.

+

Is the specified record to be logged? Returns 0 for no, nonzero for +yes. If deemed appropriate, the record may be modified in-place.

+
+ +
+ +
+
+class CLAP.clap.utils.Singleton
+

Bases: type

+

Creates a single instance class

+
+
+_instances
+
+ +
+
+__call__(cls, *args, **kwargs)
+

Call self as a function.

+
+ +
+ +
+
+CLAP.clap.utils.tmpdir(suffix=None, prefix='clap.', dir: str = None, remove: bool = True)
+
+ +
+
+CLAP.clap.utils.path_extend(*args) → str
+
+ +
+
+CLAP.clap.utils.yaml_load(filename: str) → dict
+
+ +
+
+CLAP.clap.utils.float_time_to_string(timespec: float)
+
+ +
+
+CLAP.clap.utils.setup_log(name: str = 'clap', verbosity_level: int = 0, filename: str = None)
+
+ +
+
+CLAP.clap.utils.get_random_name(in_use_names: List[str] = None, retries: int = 10) → str
+
+ +
+
+CLAP.clap.utils.get_random_object() → str
+
+ +
+
+CLAP.clap.utils.defaultdict_to_dict(d)
+
+ +
+
+CLAP.clap.utils.sorted_groupby(iterable: Iterable, key=None) → dict
+
+ +
+
+CLAP.clap.utils.get_logger(name)
+
+ +
+
+CLAP.clap.utils.str_at_middle(text: str, maximum: int, delimiter: str = '-')
+
+ +
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/autoapi/index.html b/docs/build/html/autoapi/index.html new file mode 100644 index 00000000..4507a7a0 --- /dev/null +++ b/docs/build/html/autoapi/index.html @@ -0,0 +1,221 @@ + + + + + + + + + + API Reference — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

API Reference

+

This page contains auto-generated API reference documentation 1.

+
+
+
+
1
+

Created with sphinx-autoapi

+
+
+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/configuration.html b/docs/build/html/configuration.html new file mode 100644 index 00000000..6df9a2a5 --- /dev/null +++ b/docs/build/html/configuration.html @@ -0,0 +1,498 @@ + + + + + + + + + + Basic Configuration Setup — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Basic Configuration Setup

+

In order to create compute nodes and interact with them you will need provide +some information about how to connect to the cloud provider +(providers configuration), how to the login into +the machines (logins configuration) and details +about the cloud’s virtual machines that can be used (instances configuration). +The following sections will show how to configure these sections and the valid +values for each one. All configuration files use the +YAML File Format as default format.

+
+

Note

+

YAML use spaces instead of tabs. Be careful to do not messing up!

+
+
+

Cloud Provider Configuration

+

The ~/.clap/configs/providers.yaml file defines all properties needed to connect +to a specific cloud provider, such as the region, IAM access keys, among others. +In this file you can define multiple provider configurations that is used by +other configurations. An example providers.yaml file is shown below.

+
aws-east-1-config:                              # Name of the provider configuration ID
+    provider: aws                               # Provider (currently only 'aws')
+    access_keyfile: ec2_access_key.pub          # Name of the file in the ~/.clap/private/ directory containing the IAM AWS access key ID
+    secret_access_keyfile: ec2_access_key.pem   # Name of the file in the ~/.clap/private directory containing the IAM AWS Secret Access Key (access ID)
+    region: us-east-1                           # The availability zone you want to use
+
+my-cool-config-2:
+    provider: aws
+    access_keyfile: acesss.pub
+    secret_access_keyfile: private_access.pem
+    region: us-east-2
+
+my-cool-config-3:
+    provider: aws
+    ...
+
+
+

The YAML dictionary keys (aws-east-1-config, my-cool-config-2 and +my-cool-config-3 in the above example) are the provider configuration names +(provider IDs) that can be referenced in other files. The values for each provider ID +are specific cloud provider information. You can define as many provider +configurations as you want just adding a new provider ID and the values for it. +Note that each provider ID must be unique. The valid values for a provider +configuration showed in the table below.

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid cloud provider configuration key and values

Name

Valid Values or Type

Description

provider

valid values: aws

Name of the cloud provider to be used

access_keyfile

type: string

Name of the file containing the AWS access key ID. The file must be placed at ~/.clap/private and this field must be filled only with the name of file, not the whole path.

secret_access_keyfile

type: string

Name of the file containing the AWS Secret Access Key (access ID). The file must be placed at ~/.clap/private and this field must be filled only with the name of file, not the whole path.

region

type: string

The availability zone you want to use (e.g. us-east-1)

vpc (optional)

type: string

Name or ID of the AWS Virtual Private Cloud to provision resources in.

+
+

Note

+

For CLAP, all keys must be stored at ~/.clap/private/ directory with +400 permission (use the chmod 400 command to set the read-only permission).

+
+
+

Note for AWS provider

+

IAM Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) +and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). +These keys are required and is used to connect to the aws provider via third-party +applications (see the AWS Access Keys documentation for more information). +So you must place your access key ID string inside a file in the ~/.clap/private/. +For instance, copy and paste access key ID in a file and save at ~/.clap/private/ec2_access_key.pub, +or other filename and the same for the secret access key.

+
+
+
+

Login Configuration

+

The ~/.clap/configs/logins.yaml defines all properties needed to access a +started virtual machine via SSH, such as login user name, SSH key file used to +access, etc. In this file you can define multiple login information that is used +by other configurations. An example logins.yaml file is shown below.

+
ubuntu-login:                                       # Name of the login config (Login ID)
+    user: ubuntu                                    # Login name used to SSH into the virtual machine
+    keypair_name: key_us_east_1                     # Name of the keypair to use on the cloud provider
+    keypair_public_file: key_us_east_1.pub          # Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file
+    keypair_private_file: key_us_east_1.pem         # Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine.
+    sudo: true                                      # True if the sudo_user can execute commands as root by running the sudo command
+    sudo_user: root                                 # (OPTIONAL) Login name of the super user (default is root)
+
+example-centos:
+    user: centos
+    ...
+
+
+

The YAML dictionary keys (ubuntu-login and example-centos in the above example) +are login’s configuration name (also called login ID). The values are the specific +information about that configuration. You can define as many login configurations +as you want just adding a new login ID and the values for it. Note that each login +ID must be unique. The valid values for a login configuration are:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid login configuration key and values

Name

Values/Type

Description

user

type: string

Name of the user used to perform SSH into the virtual machine.

keypair_name

type: string

Name of the keypair used on the cloud provider.

keypair_public_file

type: string

Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file.

keypair_private_file

type: string

Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine.

sudo

type: boolean

True if the sudo user can execute commands as root by running the sudo command.

sudo_user (optional)

type: string

Optional login name of the super user (default is root)

+

The keypair is used to login to the machine without password (and perform SSH).

+
+

Note for AWS users

+

For AWS users, the keypair can be generated in the menu: EC2 --> Network & Security --> Key Pairs. +A keypair can be created using the create key pair button providing an unique +keypair name (this name is used in the keypair_name field of the login configuration). +When a keypair is created, a private key file is generated to download. This is +the private key file (used to login to the instances).

+

For CLAP, all key files must be placed in the ~/.clap/private/ directory with +400 permission. In the keypair_private_file login configuration field, the name +of the private key file inside the ~/.clap/private/ must be inserted (e.g. +only the file name: key_us_east_1.pem.pem and not ~/.clap/private/key_us_east_1.pem.pem)

+

If you have a private key, the public key can be obtained with the command +ssh-keygen -y -f /path_to_key_pair/my-key-pair.pem (where my-key_pair.pem is +the private key file. See AWS Keypair Documentation for more details). +The generated public key must be saved to a file and placed at ~/.clap/private/ +directory with 400 permission. So, in the keypair_public_file field of the +login configuration, the name of the public key file must be inserted.

+
+
+
+

Instance Templates Configuration

+

To start virtual machines in a cloud, you must first setup some instance templates +in the ~/.clap/configs/instances.yaml file. The template contains information +about the virtual machine to start, including its flavor (i.e. instance type, +for instance t2.micro on AWS clouds), security group information, AMI used, +the disk size and others. The instance template references the provider configuration +and login configuration by its ID. An example of instances.yaml file is shown below.

+
ubuntu-instance-aws:                    # Name of the instance template (instance template ID)
+    provider: aws-east-1-config         # Provider configuration ID
+    login: ubuntu-login                 # Login configuration ID
+    flavor: t2.medium                   # The VM "size" to use. Different cloud providers call it differently: could be "instance type", "instance size" or "flavor".
+    image_id: ami-07d0cf3af28718ef8     # Disk image ID to use in the VM. Amazon EC2 uses IDs like ami-123456
+    security_group: xxx-secgroup        # Name of security group to use when starting the instance
+    boot_disk_size: 10                  # (OPTIONAL) Size of the instance’s root filesystem volume, in Gibibytes (GiB)
+    boot_disk_device: /dev/sda1         # (OPTIONAL) Device name of the instance’s root file system in the block device mapping
+    boot_disk_type: gp2                 # (OPTIONAL) Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (the default).
+    placement_group: XXX                # (OPTIONAL) Placement group to enable low-latency networking between compute nodes
+    image_userdata: '...'               # (OPTIONAL) Shell script to be executed (as root) when the machine starts.
+    network_ids:  subnet-abcdfefxx      # (OPTIONAL) Subnet IDs the nodes will be connected to
+
+instance-t2small-us-east-1:
+    provider: aws-east-1-config
+    ...
+
+
+

The YAML dictionary keys (ubuntu-instance-aws and instance-t2small-us-east-1 +in the above example) are the name of the instance templates (also called instance +template ID) and the values are the specific information about that instance template. +You can define as many instance templates configurations as you want just adding +a new instance template ID and the values for it. Note that each instance template +ID must be unique. Commands will use the instance template ID to start instances +based on this information. The valid values for the instance templates are:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid instance template key and values

Name

Values/Type

Description

provider

type: string

The ID of the provider configuration to be used for this instance. The ID must match the provider ID at providers.yaml

login

type: string

The ID of the login configuration to be used for this instance. The ID must match the login ID at logins.yaml

flavor

type: string

The provider instance type to use (e.g. t2.micro, c5.large, etc)

image_id

type: string

Disk image ID to use in the VM (basically the OS to be used). Amazon EC2 uses IDs like ami-123456. Note that the image_id is dependent of the provider region and a error may be raised if an invalid AMI id is specified

security_group

type: string

Name of security group to use when starting the instance

boot_disk_size (optional)

type: string

Size of the instance’s root filesystem volume, in Gibibytes (GiB)

boot_disk_device (optional)

type: string

Device name of the instance’s root file system in the block device mapping. For AWS, see block device mapping docs for more information

boot_disk_type (optional)

type: string

Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (default). See Root filesystem volume storage type for more information

placement_group (optional)

type: string

Placement group to enable low-latency networking between compute nodes. See placement groups for more information

network_ids (optional)

type: string

Subnet ID that the nodes of the cluster will be connected to

+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html new file mode 100644 index 00000000..37fad791 --- /dev/null +++ b/docs/build/html/genindex.html @@ -0,0 +1,1223 @@ + + + + + + + + + + Index — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Index
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + | V + | Y + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + +
+ +

I

+ + + +
+ +

K

+ + + +
+ +

L

+ + + +
+ +

M

+ + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ +

Y

+ + +
+ + + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html new file mode 100644 index 00000000..5b9b5c8b --- /dev/null +++ b/docs/build/html/index.html @@ -0,0 +1,283 @@ + + + + + + + + + + Welcome to CLoud Application Provider Documentation! — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Welcome to CLoud Application Provider Documentation!
    • + + +
  • + + + View page source + + +
    • + +
+ + +
+
+
+
+ +
+

Welcome to CLoud Application Provider Documentation!

+
+

Introduction

+

CLoud Application Provider (CLAP) provides a user-friendly command line tool to +create, manage and interact with individual instances or a set of instances +hosted in public cloud providers (such as AWS, Google Cloud and Microsoft Azure), +as well as easily creates, manages, resizes and interacts with compute clusters +hosted in public cloud providers. +It was firstly inspired on elasticluster +project, a tool that allows automated setup of compute clusters (MPI, Spark/Hadoop, etc.) +and Ansible, a framework used for +automation.

+

Its main features includes:

+
    +
  • +
    YAML-Style configuration files to define nodes, logins and cloud configurations.
    +
    +
    • +

  • User-friendly interface to create, setup, manage, interact and stop multiple instances hosted different cloud providers at the same time, transparently.

    • +

  • Easy and fast creation and configuration of multiple compute clusters hosted in public cloud providers at same time.

    • +

  • Growing and shrinking running clusters.

    • +

  • Role system to easily perform actions in different heterogeneous nodes via Ansible. playbooks.

    • +

  • Easy-to-use python API to bring nodes up and configure them (via ansible or SSH commands).

    • +
+
+ +
+

Indices and tables

+ +
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/introduction.html b/docs/build/html/introduction.html new file mode 100644 index 00000000..9c044b0b --- /dev/null +++ b/docs/build/html/introduction.html @@ -0,0 +1,306 @@ + + + + + + + + + + Introduction — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Introduction

+
+

Installation Guide

+

To install CLAP in a linux-based system follow the instructions below.

+
    +

  1. Install requirement packages

    2. +
+
gcc g++ git libc6-dev libffi-dev libssl-dev virtualenv python3 python3-pip
+
+
+
+

Note

+

CLAP requires Python 3.7 or higher.

+
+
    +

  1. Clone the git repository and enter inside clap’s directory

    2. +
+
git clone https://github.com/lmcad-unicamp/CLAP.git clap
+cd clap
+
+
+

3. Set execution flags of the install script using the chmod command. +Then just run the install.sh script!

+
chmod +x install.sh
+./install.sh
+
+
+
    +

  1. To use CLAP, you will need to activate the virtual-env, for each shell you are using it. +Inside the clap root directory, where the git repository was cloned use the following command:

    2. +
+
source clap-env/bin/activate
+
+
+

5. Finally, test CLAP, via the CLI interface. The clapp command should be +available to use at this point.

+
clapp --help
+
+clapp node list
+
+
+
+

Note

+

As CLAP is at development stage, use the update.sh periodically to fetch updates!

+
+
+
+

Quickly CLAP usage description

+

To use CLAP you will first need to provide some information about how to launch instances in the cloud. By default, CLAP holds all information about configurations in the ~/.clap/configs directory. The ~/.clap/configs/providers.yaml file describes how to connect to the cloud provider, the ~/.clap/configs/logins.yaml file describes how to login into machines and the ~/.clap/configs/instances.yaml describe the instances that can be used with CLAP. +The configuration section will guide you to write all these configuration sections easily.

+

Once configurations written, the usage section will show you how to execute CLAP commands based on the configurations written. +CLAP can be used to start, configure and manage single or multiple cloud’s instances using the node module as well as entire compute clusters using the cluster module.

+
+
+

Quickly CLAP directory architecture description

+

By default, CLAP holds all of it information needed inside the ~/.clap +directory (where ~ stands for the user home directory). The minimal structure +of ~/.clap directory is shown below:

+
~/ (home directory)
+└── .clap/
+    ├── configs/
+    │   ├── clusters/
+    │   ├── instances.yaml
+    │   ├── logins.yaml
+    │   └── providers.yaml
+    ├── roles/
+    │   ├── actions.d/
+    │   ├── group_vars/
+    │   │   └── all.yml
+    │   └── roles/
+    ├── private/
+    └── storage/
+
+
+
    +

  • The ~/.clap/configs/providers.yaml YAML file inside the ~/.clap/configs directory holds the information about the cloud provider and how to connect to it.

    • +

  • The ~/.clap/configs/logins.yaml file holds information about how to connect to an instance (e.g. login user, keyfile, etc)

    • +

  • The ~/.clap/configs/instances.yaml holds the information about the instances to launch, i.e. the instance templates.

    • +

  • The roles directory store role’s files and actions, used to perform action in several nodes. For more detailed information about roles and actions refer to the roles section

    • +

  • The private stores keys and passwords files used to connect to the cloud provider and to the instance itself. Every key/secret files needed in the configuration files must be placed inside this directory (usually with 0400 permissions).

    • +

  • The storage directory store metadata information used by CLAP.

    • +
+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv new file mode 100644 index 00000000..8e8dab26 Binary files /dev/null and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html new file mode 100644 index 00000000..a9fef80c --- /dev/null +++ b/docs/build/html/py-modindex.html @@ -0,0 +1,277 @@ + + + + + + + + + + Python Module Index — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Python Module Index
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + +

Python Module Index

+ +
+ c +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ CLAP +
    + CLAP.clap +
    + CLAP.clap.abstract_provider +
    + CLAP.clap.cluster_manager +
    + CLAP.clap.configs +
    + CLAP.clap.executor +
    + CLAP.clap.node +
    + CLAP.clap.node_manager +
    + CLAP.clap.repository +
    + CLAP.clap.role_manager +
    + CLAP.clap.utils +
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html new file mode 100644 index 00000000..7cb02c16 --- /dev/null +++ b/docs/build/html/search.html @@ -0,0 +1,227 @@ + + + + + + + + + + Search — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
    + +
  • »
    • + +
  • Search
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js new file mode 100644 index 00000000..bd4927d7 --- /dev/null +++ b/docs/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["autoapi/CLAP/clap/abstract_provider/index","autoapi/CLAP/clap/cluster_manager/index","autoapi/CLAP/clap/configs/index","autoapi/CLAP/clap/executor/index","autoapi/CLAP/clap/index","autoapi/CLAP/clap/node/index","autoapi/CLAP/clap/node_manager/index","autoapi/CLAP/clap/repository/index","autoapi/CLAP/clap/role_manager/index","autoapi/CLAP/clap/utils/index","autoapi/index","configuration","index","introduction","shared_roles","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["autoapi/CLAP/clap/abstract_provider/index.rst","autoapi/CLAP/clap/cluster_manager/index.rst","autoapi/CLAP/clap/configs/index.rst","autoapi/CLAP/clap/executor/index.rst","autoapi/CLAP/clap/index.rst","autoapi/CLAP/clap/node/index.rst","autoapi/CLAP/clap/node_manager/index.rst","autoapi/CLAP/clap/repository/index.rst","autoapi/CLAP/clap/role_manager/index.rst","autoapi/CLAP/clap/utils/index.rst","autoapi/index.rst","configuration.rst","index.rst","introduction.rst","shared_roles.rst","usage.rst"],objects:{"CLAP.clap":{abstract_provider:[0,0,0,"-"],cluster_manager:[1,0,0,"-"],configs:[2,0,0,"-"],executor:[3,0,0,"-"],node:[5,0,0,"-"],node_manager:[6,0,0,"-"],repository:[7,0,0,"-"],role_manager:[8,0,0,"-"],utils:[9,0,0,"-"]},"CLAP.clap.abstract_provider":{AbstractInstanceProvider:[0,1,1,""],InstanceDeploymentError:[0,3,1,""],logger:[0,4,1,""]},"CLAP.clap.abstract_provider.AbstractInstanceProvider":{pause_instances:[0,2,1,""],resume_instances:[0,2,1,""],start_instances:[0,2,1,""],stop_instances:[0,2,1,""],update_instance_info:[0,2,1,""]},"CLAP.clap.cluster_manager":{ActionType:[1,4,1,""],ClusterConfig:[1,1,1,""],ClusterConfigDatabase:[1,1,1,""],ClusterConfigFile:[1,1,1,""],ClusterConfigurationError:[1,3,1,""],ClusterDescriptor:[1,1,1,""],ClusterError:[1,3,1,""],ClusterManager:[1,1,1,""],ClusterOptions:[1,1,1,""],ClusterRepositoryController:[1,1,1,""],ClusterSetupError:[1,3,1,""],CommandActionType:[1,1,1,""],InvalidClusterError:[1,3,1,""],InvalidSetupError:[1,3,1,""],NodeConfig:[1,1,1,""],NodeSizeError:[1,3,1,""],PlaybookActionType:[1,1,1,""],RoleActionType:[1,1,1,""],RoleAdd:[1,1,1,""],SetupConfig:[1,1,1,""],_ClusterConfig:[1,1,1,""],_NodeConfig:[1,1,1,""],logger:[1,4,1,""],validate_valid_cluster:[1,6,1,""],validate_valid_role:[1,6,1,""]},"CLAP.clap.cluster_manager.ClusterConfig":{after:[1,5,1,""],after_all:[1,5,1,""],before:[1,5,1,""],before_all:[1,5,1,""],cluster_config_id:[1,5,1,""],nodes:[1,5,1,""],options:[1,5,1,""]},"CLAP.clap.cluster_manager.ClusterConfigDatabase":{_load_cluster_and_setups:[1,2,1,""],load:[1,2,1,""]},"CLAP.clap.cluster_manager.ClusterConfigFile":{clusters:[1,5,1,""],setups:[1,5,1,""]},"CLAP.clap.cluster_manager.ClusterDescriptor":{cluster_config:[1,5,1,""],cluster_id:[1,5,1,""],cluster_name:[1,5,1,""],creation_time:[1,5,1,""],is_setup:[1,5,1,""],update_time:[1,5,1,""]},"CLAP.clap.cluster_manager.ClusterManager":{_run_setup_list:[1,2,1,""],add_cluster_tag:[1,2,1,""],add_existing_nodes_to_cluster:[1,2,1,""],get_all_cluster_nodes:[1,2,1,""],get_all_clusters:[1,2,1,""],get_cluster_by_id:[1,2,1,""],get_cluster_nodes_types:[1,2,1,""],grow:[1,2,1,""],is_alive:[1,2,1,""],pause_cluster:[1,2,1,""],resume_cluster:[1,2,1,""],run_action:[1,2,1,""],run_role_add:[1,2,1,""],run_setup:[1,2,1,""],setup_cluster:[1,2,1,""],start_cluster:[1,2,1,""],start_cluster_node:[1,2,1,""],stop_cluster:[1,2,1,""],upsert_cluster:[1,2,1,""]},"CLAP.clap.cluster_manager.ClusterOptions":{ssh_to:[1,5,1,""]},"CLAP.clap.cluster_manager.ClusterRepositoryController":{get_all_clusters:[1,2,1,""],get_cluster_by_id:[1,2,1,""],remove_cluster:[1,2,1,""],upsert_cluster:[1,2,1,""]},"CLAP.clap.cluster_manager.CommandActionType":{command:[1,5,1,""]},"CLAP.clap.cluster_manager.NodeConfig":{count:[1,5,1,""],min_count:[1,5,1,""],setups:[1,5,1,""],type:[1,5,1,""]},"CLAP.clap.cluster_manager.PlaybookActionType":{extra:[1,5,1,""],playbook:[1,5,1,""]},"CLAP.clap.cluster_manager.RoleActionType":{action:[1,5,1,""],extra:[1,5,1,""],role:[1,5,1,""]},"CLAP.clap.cluster_manager.RoleAdd":{extra:[1,5,1,""],name:[1,5,1,""]},"CLAP.clap.cluster_manager.SetupConfig":{actions:[1,5,1,""],roles:[1,5,1,""]},"CLAP.clap.cluster_manager._ClusterConfig":{after:[1,5,1,""],after_all:[1,5,1,""],before:[1,5,1,""],before_all:[1,5,1,""],nodes:[1,5,1,""],options:[1,5,1,""]},"CLAP.clap.cluster_manager._NodeConfig":{count:[1,5,1,""],min_count:[1,5,1,""],setups:[1,5,1,""],type:[1,5,1,""]},"CLAP.clap.configs":{ConfigurationDatabase:[2,1,1,""],ConfigurationError:[2,3,1,""],InstanceConfigAWS:[2,1,1,""],InstanceConfigs:[2,4,1,""],InstanceInfo:[2,1,1,""],InvalidConfigurationError:[2,3,1,""],LoginConfig:[2,1,1,""],LoginConfigs:[2,4,1,""],ProviderConfigAWS:[2,1,1,""],ProviderConfigLocal:[2,1,1,""],ProviderConfigs:[2,4,1,""],logger:[2,4,1,""],provider_handlers:[2,4,1,""]},"CLAP.clap.configs.ConfigurationDatabase":{_load_instance_configs:[2,2,1,""],_load_login_configs:[2,2,1,""],_load_provider_configs:[2,2,1,""],load_all:[2,2,1,""]},"CLAP.clap.configs.InstanceConfigAWS":{boot_disk_device:[2,5,1,""],boot_disk_iops:[2,5,1,""],boot_disk_size:[2,5,1,""],boot_disk_snapshot:[2,5,1,""],boot_disk_type:[2,5,1,""],flavor:[2,5,1,""],image_id:[2,5,1,""],instance_config_id:[2,5,1,""],login:[2,5,1,""],network_ids:[2,5,1,""],placement_group:[2,5,1,""],price:[2,5,1,""],provider:[2,5,1,""],security_group:[2,5,1,""],timeout:[2,5,1,""]},"CLAP.clap.configs.InstanceInfo":{instance:[2,5,1,""],login:[2,5,1,""],provider:[2,5,1,""]},"CLAP.clap.configs.LoginConfig":{keypair_name:[2,5,1,""],keypair_private_file:[2,5,1,""],keypair_public_file:[2,5,1,""],login_config_id:[2,5,1,""],ssh_port:[2,5,1,""],sudo:[2,5,1,""],sudo_user:[2,5,1,""],user:[2,5,1,""]},"CLAP.clap.configs.ProviderConfigAWS":{access_keyfile:[2,5,1,""],provider:[2,5,1,""],provider_config_id:[2,5,1,""],region:[2,5,1,""],secret_access_keyfile:[2,5,1,""],url:[2,5,1,""],vpc:[2,5,1,""]},"CLAP.clap.configs.ProviderConfigLocal":{provider:[2,5,1,""],provider_config_id:[2,5,1,""]},"CLAP.clap.executor":{AnsiblePlaybookExecutor:[3,1,1,""],Executor:[3,1,1,""],SSHCommandExecutor:[3,1,1,""],ShellInvoker:[3,1,1,""],logger:[3,4,1,""]},"CLAP.clap.executor.AnsiblePlaybookExecutor":{PlaybookResult:[3,1,1,""],create_extra_vars:[3,2,1,""],create_inventory:[3,2,1,""],run:[3,2,1,""]},"CLAP.clap.executor.AnsiblePlaybookExecutor.PlaybookResult":{events:[3,5,1,""],hosts:[3,5,1,""],ok:[3,5,1,""],ret_code:[3,5,1,""],vars:[3,5,1,""]},"CLAP.clap.executor.Executor":{run:[3,2,1,""]},"CLAP.clap.executor.SSHCommandExecutor":{connect_and_execute:[3,2,1,""],run:[3,2,1,""]},"CLAP.clap.executor.ShellInvoker":{run:[3,2,1,""]},"CLAP.clap.node":{NodeDescriptor:[5,1,1,""],NodeLifecycle:[5,1,1,""],NodeStatus:[5,1,1,""],NodeType:[5,1,1,""],logger:[5,4,1,""]},"CLAP.clap.node.NodeDescriptor":{cloud_instance_id:[5,5,1,""],cloud_lifecycle:[5,5,1,""],configuration:[5,5,1,""],creation_time:[5,5,1,""],extra:[5,5,1,""],ip:[5,5,1,""],nickname:[5,5,1,""],node_id:[5,5,1,""],roles:[5,5,1,""],status:[5,5,1,""],tags:[5,5,1,""],type:[5,5,1,""],update_time:[5,5,1,""]},"CLAP.clap.node.NodeLifecycle":{NORMAL:[5,5,1,""],PREEMPTIBLE:[5,5,1,""]},"CLAP.clap.node.NodeStatus":{PAUSED:[5,5,1,""],REACHABLE:[5,5,1,""],STARTED:[5,5,1,""],STOPPED:[5,5,1,""],UNKNOWN:[5,5,1,""],UNREACHABLE:[5,5,1,""]},"CLAP.clap.node.NodeType":{TYPE_CLOUD:[5,5,1,""],TYPE_LOCAL:[5,5,1,""]},"CLAP.clap.node_manager":{DeploymentError:[6,3,1,""],InvalidNodeError:[6,3,1,""],InvalidProvider:[6,3,1,""],NodeManager:[6,1,1,""],NodeRepositoryController:[6,1,1,""],UnhandledProviderError:[6,3,1,""],logger:[6,4,1,""]},"CLAP.clap.node_manager.NodeManager":{_group_instances_by_provider:[6,2,1,""],add_tags:[6,2,1,""],get_all_nodes:[6,2,1,""],get_nodes:[6,2,1,""],get_nodes_by_id:[6,2,1,""],get_nodes_with_tag:[6,2,1,""],get_nodes_with_tag_value:[6,2,1,""],get_not_running_nodes:[6,2,1,""],get_reachable_nodes:[6,2,1,""],get_up_nodes:[6,2,1,""],group_nodes_by_provider:[6,2,1,""],is_alive:[6,2,1,""],pause_nodes:[6,2,1,""],remove_node:[6,2,1,""],remove_tags:[6,2,1,""],resume_nodes:[6,2,1,""],start_node:[6,2,1,""],start_nodes:[6,2,1,""],stop_nodes:[6,2,1,""],upsert_node:[6,2,1,""]},"CLAP.clap.node_manager.NodeRepositoryController":{get_all_nodes:[6,2,1,""],get_nodes_by_id:[6,2,1,""],get_nodes_filter:[6,2,1,""],remove_node:[6,2,1,""],remove_nodes:[6,2,1,""],upsert_node:[6,2,1,""]},"CLAP.clap.repository":{InvalidEntryError:[7,3,1,""],Repository:[7,1,1,""],RepositoryError:[7,3,1,""],RepositoryFactory:[7,1,1,""],SQLiteRepository:[7,1,1,""]},"CLAP.clap.repository.Repository":{clear:[7,2,1,""],close:[7,2,1,""],commit:[7,2,1,""],connect:[7,2,1,""],extension:[7,5,1,""],get:[7,2,1,""],get_all:[7,2,1,""],get_multiple:[7,2,1,""],keys:[7,2,1,""],open:[7,2,1,""],remove:[7,2,1,""],remove_multiple:[7,2,1,""],repository_name:[7,5,1,""],update:[7,2,1,""],upsert:[7,2,1,""]},"CLAP.clap.repository.RepositoryFactory":{get_repository:[7,2,1,""],repositories:[7,5,1,""]},"CLAP.clap.repository.SQLiteRepository":{__repr__:[7,2,1,""],clear:[7,2,1,""],close:[7,2,1,""],commit:[7,2,1,""],connect:[7,2,1,""],extension:[7,5,1,""],get:[7,2,1,""],get_all:[7,2,1,""],get_multiple:[7,2,1,""],keys:[7,2,1,""],open:[7,2,1,""],remove:[7,2,1,""],remove_multiple:[7,2,1,""],repository_name:[7,5,1,""],update:[7,2,1,""],upsert:[7,2,1,""]},"CLAP.clap.role_manager":{InvalidActionError:[8,3,1,""],InvalidHostError:[8,3,1,""],InvalidRoleError:[8,3,1,""],MissingActionVariableError:[8,3,1,""],NodeRoleError:[8,3,1,""],Role:[8,1,1,""],RoleActionInfo:[8,1,1,""],RoleAssignmentError:[8,3,1,""],RoleError:[8,3,1,""],RoleManager:[8,1,1,""],RoleVariableInfo:[8,1,1,""],logger:[8,4,1,""]},"CLAP.clap.role_manager.Role":{actions:[8,5,1,""],hosts:[8,5,1,""]},"CLAP.clap.role_manager.RoleActionInfo":{description:[8,5,1,""],playbook:[8,5,1,""],vars:[8,5,1,""]},"CLAP.clap.role_manager.RoleManager":{_check_nodes_role:[8,2,1,""],add_role:[8,2,1,""],get_all_role_nodes:[8,2,1,""],get_all_role_nodes_hosts:[8,2,1,""],get_role_node_hosts:[8,2,1,""],get_role_nodes:[8,2,1,""],load_roles:[8,2,1,""],perform_action:[8,2,1,""],remove_role:[8,2,1,""]},"CLAP.clap.role_manager.RoleVariableInfo":{description:[8,5,1,""],name:[8,5,1,""],optional:[8,5,1,""]},"CLAP.clap.utils":{APP_NAME:[9,4,1,""],CLAPFilter:[9,1,1,""],Singleton:[9,1,1,""],defaultdict_to_dict:[9,6,1,""],float_time_to_string:[9,6,1,""],get_logger:[9,6,1,""],get_random_name:[9,6,1,""],get_random_object:[9,6,1,""],path_extend:[9,6,1,""],setup_log:[9,6,1,""],sorted_groupby:[9,6,1,""],str_at_middle:[9,6,1,""],tmpdir:[9,6,1,""],yaml_load:[9,6,1,""]},"CLAP.clap.utils.CLAPFilter":{filter:[9,2,1,""]},"CLAP.clap.utils.Singleton":{__call__:[9,2,1,""],_instances:[9,5,1,""]},CLAP:{clap:[4,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"],"4":["py","data","Python data"],"5":["py","attribute","Python attribute"],"6":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:data","5":"py:attribute","6":"py:function"},terms:{"0400":13,"0644":14,"0744":14,"07d0cf3af28718ef8":11,"123":14,"123456":11,"154":15,"168":14,"180":[1,6],"192":14,"2018":15,"220":15,"400":11,"455e9c5da5c4417abc757f587a31c105":15,"600":[0,1,6],"744":14,"807":15,"abstract":[0,3,7],"boolean":[11,15],"default":[11,13,14,15],"final":[13,15],"float":[1,2,3,5,9],"int":[0,1,2,3,6,7,9],"new":[11,14,15],"public":[11,12,14,15],"return":[7,8,9,15],"static":[3,6],"super":11,"true":[1,2,6,7,8,9,11],"try":15,"var":[3,8,15],"while":15,AWS:[12,14],And:15,EFS:14,For:[9,11,13,14,15],Has:15,IDs:[11,15],Its:[12,15],One:[14,15],The:[9,11,13,14,15],Then:[13,15],There:15,These:[11,15],Use:[14,15],VMs:15,__call__:9,__repr__:7,_check_nodes_rol:8,_clusterconfig:1,_group_instances_by_provid:6,_instanc:9,_load_cluster_and_setup:1,_load_instance_config:2,_load_login_config:2,_load_provider_config:2,_nodeconfig:1,_run_setup_list:1,abc:[0,7],abcdfefxx:11,about:[11,13],abov:[11,14,15],absolut:[14,15],abstract_provid:[4,6],abstractinstanceprovid:[0,6],abstractrepositori:7,access:[11,15],access_keyfil:[2,11],acesss:11,across:15,act:15,action:[1,8,12,13],action_nam:8,actions_dir:8,actiontyp:1,activ:13,add_cluster_tag:1,add_existing_nodes_to_clust:1,add_rol:8,add_tag:6,added:[14,15],adding:[11,14,15],addit:[14,15],address:14,after:[1,14,15],after_al:[1,15],again:15,akiaiosfodnn7exampl:11,all:[0,1,2,6,7,8,9,11,13,14,15],allow:[9,12,14,15],alreadi:15,also:[11,14,15],alwai:[14,15],amazon:11,ami:11,among:[11,14,15],ani:[3,5,14,15],anoth:15,another_var:15,ansibl:[12,14,15],ansibleplaybookexecutor:[3,8],anywher:14,api:12,app:14,app_nam:9,append:15,applic:[11,14],appropri:9,apr:15,apt:14,arbitrari:9,architectur:12,arg:[9,14],argument:[14,15],assign:15,assum:15,auto:10,autoapi:10,autom:12,automat:15,avail:[11,13,14,15],awar:14,aws:[2,11,15],azur:12,bar:[14,15],base:[0,1,2,3,6,7,8,9,11,13,15],bash:14,bash_logout:15,bashrc:15,basic:12,becom:14,been:15,befor:[1,14,15],before_al:[1,15],begin:[14,15],being:15,bellow:15,belong:[14,15],below:[9,11,13,15],besid:15,between:11,bin:[13,14],binari:14,block:11,bool:[1,2,3,6,7,8,9],boot_disk_devic:[2,11],boot_disk_iop:2,boot_disk_s:[2,11],boot_disk_snapshot:2,boot_disk_typ:[2,11],both:15,bpxrficyexamplekei:11,briefli:15,bring:12,build:15,button:11,cach:15,call:[9,11,14,15],callabl:6,can:[8,9,11,13,14,15],care:11,cento:11,certain:9,chang:[14,15],charact:15,characterist:15,check:[14,15],chmod:[11,13],clap:[11,12],clapfilt:9,clapp:[13,14,15],clear:7,cli:13,client:[14,15],clone:13,close:7,cloud:[5,13,15],cloud_instance_id:5,cloud_lifecycl:5,cls:9,cluster:[1,11,12,13],cluster_config:1,cluster_config_id:1,cluster_fil:1,cluster_id:[1,15],cluster_manag:4,cluster_nam:1,cluster_repository_control:1,cluster_tag_prefix:1,cluster_templ:15,clusterconfig:1,clusterconfigdatabas:1,clusterconfigfil:1,clusterconfigurationerror:1,clusterdescriptor:1,clustererror:1,clustermanag:1,clusteropt:1,clusterrepositorycontrol:1,clustersetuperror:1,cmd:[14,15],collect:14,colon:15,com:13,comma:[14,15],command:[1,3,11,12,13],commandactiontyp:1,commit:7,commit_on_clos:7,common:[0,1,2,6,7,8,12,15],common_copi:15,common_fetch:15,common_setup:15,commun:14,comput:[11,12,13],config:[0,1,4,5,6,11,13,15],config_db:1,configur:[5,12,13],configurationdatabas:[1,2],configurationerror:2,connect:[7,11,13],connect_and_execut:3,connection_retri:6,connection_timeout:3,consid:[14,15],consist:[11,15],contain:[10,11,15],cool:[11,15],copi:[11,15],correct:15,correctli:15,correspond:11,could:[11,15],count:[0,1,6,15],creat:[0,7,9,10,11,12,15],create_extra_var:3,create_inventori:3,creation:[12,15],creation_tim:[1,5],current:[11,14,15],custom:15,declar:15,deem:9,defaultdict_to_dict:9,defin:[8,11,12,14,15],delet:14,delimit:9,denot:15,depend:[11,14],deploi:14,deploymenterror:6,describ:[13,15],descript:[8,11,12,14],desir:[9,14,15],dest:[14,15],destin:[14,15],destroi:15,destroy_on_min_count:1,detail:[11,13,15],determin:[9,15],dev:[11,13],develop:13,devic:11,dict:[1,3,5,6,7,8,9],dictionari:[8,11,15],differ:[11,12,15],dir:9,directori:[11,12,14,15],discard:15,discard_invalid:[1,2,8],disk:11,displai:14,divid:15,doc:11,document:[10,11,14],doe:[8,14,15],download:11,drwx:15,drwxr:15,dsa:11,each:[11,13,14,15],easi:12,easili:[12,13],east:11,ebcd658b:15,ebcd658bacdf485487543cbcc721d1b3:15,ec2:[11,12,15],ec2_access_kei:11,echo:[1,6,14],effect:15,efs:[12,15],efs_group:14,efs_mount_ip:14,efs_mount_permiss:14,efs_mount_point:14,efs_own:14,elasticlust:12,element:15,els:[14,15],empti:[8,9],enabl:11,enter:13,entir:[13,14],entri:7,env:13,env_var:3,environ:3,equal:15,error:11,establish:15,etc:[9,11,12,13],even:15,event:[3,9],everi:13,exampl:[9,11,15],except:[0,1,2,6,7,8],exclus:15,execut:[11,13,14],execution_timeout:3,executor:[4,8],exist:15,exit:[0,1,2,6,7,8,15],extens:7,extra:[1,5,14,15],extra_arg:[3,8],faa4017e10094e698aed56bb1f3369f9:15,facil:15,fail:15,fals:[1,3,8,15],fast:12,featur:[12,15],fetch:[13,15],fetched_fil:14,field:11,file:[11,12,13,14],filenam:[9,11],filepath:14,filesystem:[11,14],fill:11,filter:[9,14,15],filter_func:6,final_setup:15,find:15,finish:14,first:[11,13,14,15],firstli:12,flag:13,flavor:[2,11],float_time_to_str:9,flow:15,folder:14,follow:[11,13,14,15],foo:[14,15],format:[11,15],framework:12,friendli:12,from:[14,15],from_node_id:[6,8],gcc:[13,15],gener:[10,11,15],get:[7,14,15],get_al:7,get_all_clust:1,get_all_cluster_nod:1,get_all_nod:6,get_all_role_nod:8,get_all_role_nodes_host:8,get_cluster_by_id:1,get_cluster_nodes_typ:1,get_logg:9,get_multipl:7,get_nod:6,get_nodes_by_id:6,get_nodes_filt:6,get_nodes_with_tag:6,get_nodes_with_tag_valu:6,get_not_running_nod:6,get_random_nam:9,get_random_object:9,get_reachable_nod:6,get_repositori:7,get_role_nod:8,get_role_node_host:8,get_up_nod:6,gib:11,gibibyt:11,git:[13,15],github:13,given:15,gnupg:15,googl:12,gp2:11,green:14,group:[11,12,15],group_nodes_by_provid:6,group_var:13,grow:[1,12],guid:[12,15],hadoop:12,handler:9,has:15,have:[11,15],help:[13,15],helper:[0,7],here:14,heterogen:12,hierarchi:9,higher:13,hold:13,home:[13,14,15],host:[3,8,12,15],host_map:8,host_nam:[8,15],host_var:[3,8],hosta:8,hostb:8,hostnam:15,hosts_node_map:[3,8],how:[11,13,15],http:13,iam:11,id1:8,id2:8,id3:8,identifi:14,ids:15,imag:11,image_id:[2,11],image_userdata:11,immedi:15,in_use_nam:9,inbound:14,includ:[11,12,14,15],index:12,indic:[14,15],individu:12,inform:[11,13,14,15],inherit:[0,7],init:15,initi:[9,15],input:15,insert:11,insid:[11,13,15],inspir:12,instal:[12,15],install_packag:15,instanc:[0,2,6,9,12,13,15],instance_config_id:2,instance_count:6,instance_info:1,instanceconfig:2,instanceconfigaw:2,instancedeploymenterror:0,instanceinfo:[0,1,2,5,6],instances_fil:2,instanti:15,instead:11,instruct:13,integ:15,interact:[11,12,15],interfac:[12,13],invalid:[11,15],invalidactionerror:8,invalidclustererror:1,invalidconfigurationerror:2,invalidentryerror:7,invalidhosterror:8,invalidnodeerror:6,invalidprovid:6,invalidroleerror:8,invalidsetuperror:1,inventori:[3,15],invok:15,io1:11,iop:11,is_al:[1,6],is_setup:1,iter:9,its:[11,14,15],itself:13,jinja:15,jm_arg:14,job:15,jobid:14,jobmanag:[14,15],just:[11,13,15],k7mdeng:11,kei:[6,7,8,9,13],key_pair:11,key_us_east_1:11,keyfil:13,keygen:11,keypair:11,keypair_nam:[2,11],keypair_private_fil:[2,11],keypair_public_fil:[2,11],keyword:[14,15],known:14,kwarg:9,larg:[11,15],last:15,latenc:11,launch:[13,15],less:15,lha:15,libc6:13,libffi:13,libssl:13,like:11,line:[12,14],linux:13,list:[0,1,2,3,5,6,7,8,9,13,14],lmcad:13,load:[1,2,8],load_al:2,load_rol:8,local:[2,5],localhost:[14,15],locat:14,log:[9,14],logger:[0,1,2,3,5,6,8,9],logic:15,login:[2,12,13,15],login_config_id:2,loginconfig:2,logins_fil:2,logrecord:9,low:11,machin:[11,13,14],mai:[9,11,15],main:12,manag:[12,13,14,15],mani:[11,15],map:11,marjorylang:15,master:15,match:[11,14,15],max_work:[1,3,6],maximum:9,mean:14,mechan:15,medium:11,menu:11,mess:11,messag:15,metadata:[13,15],metric:14,micro:11,microsoft:12,min_count:[1,15],minim:13,minimum:15,missingactionvariableerror:8,mnt:15,model:14,modifi:9,modul:[12,13],modular:15,more:[11,13,14,15],most:15,mount:15,mount_path:15,mpi:12,much:15,multipl:[11,12,13,14,15],must:[11,13,14,15],mutual:15,name:[1,2,7,8,9,11,14,15],necessari:15,need:[11,13,14,15],network:[11,14],network_id:[2,11],next:15,nfs:[14,15],nicknam:[5,15],node:[0,1,3,4,6,8,11,12,13],node_id:[1,5,6,8,15],node_manag:[1,4,8],node_repository_control:[6,8],node_typ:[1,15],node_var:[3,8],nodeconfig:1,nodedescriptor:[0,3,5,6,8],nodelifecycl:5,nodemanag:[1,6],noderepositorycontrol:[6,8],noderoleerror:8,nodes_being_ad:1,nodes_to_check:0,nodes_to_paus:0,nodes_to_resum:0,nodes_to_stop:0,nodesizeerror:1,nodestatu:5,nodetyp:5,non:[0,1,2,6,7,8],none:[1,3,6,8,9,14],nonzero:9,normal:5,note:14,now:[14,15],num:15,number:15,obj:7,obtain:[11,15],offer:15,omit:15,onc:[13,15],one:[11,14,15],ones:15,onli:[9,11,14,15],open:7,openmpi:14,oper:15,option:[1,2,5,8,9,11,14],order:11,other:[11,14],otherwis:15,outbound:14,output:[14,15],output_dir:3,outputdir:14,over:15,owner:14,packag:[13,15],page:[10,12],pair:11,paramet:[8,14],part:11,parti:11,particular:15,pass:[9,14,15],password:[11,13],past:11,path:[11,14,15],path_extend:9,path_to_key_pair:11,paus:5,pause_clust:1,pause_inst:0,pause_nod:6,pem:11,perform:[9,11,12,13,14,15],perform_act:8,period:[13,15],permiss:[11,13,14],pip:13,pipelin:15,place:[9,11,13,14,15],placement:11,placement_group:[2,11],plai:15,platform:15,playbook:[1,8,12],playbook_fil:3,playbookactiontyp:1,playbookresult:[3,8],plug:15,point:[9,13,14],port:14,posit:15,possibl:15,pre:15,preced:15,preemptibl:5,prefix:9,present:15,price:2,privat:[11,13],private_access:11,private_dir:[1,6,8],private_path:3,process:15,profil:15,program:14,project:12,properli:15,properti:11,provid:[0,2,6,7,13,14,15],provider_config_id:2,provider_handl:2,providerconfig:2,providerconfigaw:2,providerconfigloc:2,providers_fil:2,provis:11,pub:11,purpos:11,put:[14,15],pypit:14,pypits_path:14,python3:13,python:[12,13,15],queri:14,quickli:[12,14],quiet:[3,8],rais:11,random:14,reachabl:[5,15],read:[11,14,15],readi:15,reboot:15,recogn:14,record:9,recurs:14,refer:[11,12,13,15],referenc:11,region:[2,11],rel:[14,15],remain:15,remot:[14,15],remov:[7,9],remove_clust:1,remove_multipl:7,remove_nod:6,remove_rol:8,remove_tag:6,replac:15,repositori:[1,4,6,13],repository_nam:7,repository_path:7,repositoryerror:7,repositoryfactori:7,repr:7,repres:15,requir:[11,13,15],resiz:[12,15],resourc:11,respect:15,result:[14,15],resume_clust:1,resume_inst:0,resume_nod:6,ret_cod:3,retri:[1,6,9],retry_timeout:6,role:[1,5,8,12,13],role_dir:8,role_host_nam:15,role_manag:[1,4],role_nam:8,roleactioninfo:8,roleactiontyp:1,roleadd:1,roleassignmenterror:8,roleerror:8,rolemanag:[1,8],rolevariableinfo:8,root:[2,11,13,15],row:[14,15],rsa:11,rule:14,run:[3,11,12,13,15],run_act:1,run_role_add:1,run_setup:1,runtim:14,said:15,same:[11,12,14,15],save:11,script:[11,13,15],sda1:11,search:[12,14,15],secgroup:11,second:[14,15],secret:[11,13],secret_access_keyfil:[2,11],section:[11,13],secur:[11,14],security_group:[2,11],see:[11,14,15],segment:15,select:[14,15],self:[0,1,2,3,6,7,8,9],separ:[14,15],sequenti:15,seri:15,session:15,set:[11,12,13,14,15],setup:[1,12],setup_clust:1,setup_log:9,setup_nam:1,setupconfig:1,sever:[13,14,15],share:[12,15],shebang:14,shell:[11,13,14,15],shellinvok:3,shh:15,should:13,show:[11,13,15],shown:[11,13,15],shrink:12,similar:[14,15],simpl:15,simpli:15,singl:[9,13,15],singleton:9,size:11,skip:15,slave:15,small:15,some:[11,13,14,15],sorri:[],sorted_groupbi:9,sourc:[13,15],space:11,spark:12,special:15,specif:[11,15],specifi:[9,11,14,15],sphinx:10,spit:[12,15],spits_arg:14,spits_binari:14,spits_job_path:14,sqlite:7,sqliterepositori:7,src:[14,15],ssd:11,ssh:[3,11,12,15],ssh_binari:3,ssh_port:2,ssh_to:[1,15],sshcommandexecutor:3,stage:[13,15],stand:13,standard:[0,7,11],start:[5,11,13],start_at_stag:1,start_clust:1,start_cluster_nod:1,start_inst:0,start_nod:6,start_timeout:[1,6],statu:[5,15],stdout:15,step:15,stop:[5,12],stop_clust:1,stop_inst:0,stop_nod:6,storag:[11,13],store:[11,13,15],str:[1,2,3,5,6,7,8,9],str_at_middl:9,string:[8,9,11,14,15],structur:13,style:12,subnet:11,subsect:15,subset:15,successfulli:15,sudo:[2,11],sudo_us:[2,11],suffix:9,suppli:15,support:14,suppos:15,syntax:15,system:[11,12,13,14],t2small:11,tab:11,tabl:[11,15],table_nam:7,tag:[5,6],take:15,task:[14,15],taskmanag:[14,15],tcp:14,tell:15,templat:[12,13],termin:15,test:[13,15],test_command:[1,6],text:[9,15],than:15,them:[11,12,15],thi:[8,10,11,13,14,15],thing:15,third:[11,14],three:15,thu:[14,15],time:[12,15],timeout:[0,1,2,6,15],timespec:9,tm_arg:14,tmp:14,tmpdir:9,tool:12,transfer:14,transpar:[12,15],tupl:6,two:[11,14,15],type:[1,5,9,11,14,15],type_cloud:5,type_loc:5,ubuntu:[11,14,15],unhandledprovidererror:6,unicamp:13,union:[3,8],uniqu:[11,14,15],unix:14,unknown:5,unmount:[14,15],unreach:[5,15],updat:[7,13],update_instance_info:0,update_obj:7,update_tim:[1,5],update_timeout:[1,6],upsert:7,upsert_clust:1,upsert_nod:6,url:2,usag:[12,14],use:[9,11,12,13,14,15],used:[9,11,12,13,14,15],useful:15,user:[2,12,13,14],uses:11,using:[0,7,11,13,14,15],usual:13,util:4,val:15,validate_nodes_in_rol:8,validate_valid_clust:1,validate_valid_rol:1,valu:[6,8,14],var1:15,variabl:15,verbos:[3,7],verbosity_level:9,via:[11,12,13,14,15],virtual:[11,13],virtualenv:13,volum:11,vpc:[2,11],wai:[0,7,15],wait:14,wait_timeout:[1,6],want:[11,14,15],well:[12,13],were:15,when:[11,14,15],where:[8,11,13,14,15],which:[9,15],whole:11,whose:15,without:[11,15],wjalrxutnfemi:11,work:15,workdir:14,write:[13,14,15],written:[13,15],wwith:15,xxx:[11,14],yaml:[11,12,13,15],yaml_load:9,yes:9,yml:[13,15],you:[11,13,14,15],your:[11,14,15],zone:11},titles:["CLAP.clap.abstract_provider","CLAP.clap.cluster_manager","CLAP.clap.configs","CLAP.clap.executor","CLAP.clap","CLAP.clap.node","CLAP.clap.node_manager","CLAP.clap.repository","CLAP.clap.role_manager","CLAP.clap.utils","API Reference","Basic Configuration Setup","Welcome to CLoud Application Provider Documentation!","Introduction","Roles shared with CLAP","Basic Usage"],titleterms:{"class":[0,1,2,3,5,6,7,8,9],"function":[1,9],AWS:11,abstract_provid:0,action:[14,15],add:[14,15],aliv:15,api:10,applic:12,architectur:13,attribut:[0,1,2,3,5,6,8,9],basic:[11,15],block:15,clap:[0,1,2,3,4,5,6,7,8,9,13,14,15],cloud:[11,12],cluster:15,cluster_manag:1,code:15,command:[14,15],common:14,config:2,configur:[11,15],connect:15,content:[0,1,2,3,5,6,7,8,9,12],control:15,copi:14,creat:14,descript:[13,15],directori:13,document:12,ec2:14,efs:14,exampl:14,execut:15,executor:3,fetch:14,file:15,group:14,grow:15,guid:13,host:14,indic:12,instal:[13,14],instanc:11,introduct:[12,13],job:14,kei:[11,15],list:15,login:11,modul:[0,1,2,3,5,6,7,8,9,15],mount:14,node:[5,14,15],node_manag:6,none:15,note:11,option:15,order:15,other:15,packag:14,paramet:15,paus:15,phase:15,playbook:15,provid:[11,12],quickli:13,reboot:14,refer:10,remov:15,repositori:7,requir:14,resum:15,role:[14,15],role_manag:8,run:14,script:14,section:15,setup:[11,14,15],share:14,spit:14,start:[14,15],statu:14,stop:15,submodul:4,tabl:12,tag:15,templat:[11,15],troubleshoot:[],tutori:[],typic:14,umount:14,updat:[14,15],usag:[13,15],user:11,util:9,valid:[11,15],valu:[11,15],variabl:14,welcom:12,workflow:14}}) \ No newline at end of file diff --git a/docs/build/html/shared_roles.html b/docs/build/html/shared_roles.html new file mode 100644 index 00000000..5271829c --- /dev/null +++ b/docs/build/html/shared_roles.html @@ -0,0 +1,1007 @@ + + + + + + + + + + Roles shared with CLAP — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Roles shared with CLAP

+

Here are some roles shared by default with CLAP. Setup action is always +executed when adding a node to a role. Also, variables needed by actions must be +passed via extra parameter, as keyword value.

+
+

Role commands-common

+

This role provide means to execute common known commands in several machines in +the role, such as: reboot, copy files to nodes, copy and execute shell scripts, +among others. Consider add nodes to this role to quickly perform common commands +in several nodes in a row.

+

The following actions is provided by this role:

+
    +

  • copy: Copy a file from the localhost to the remote nodes

    • +

  • fetch: Fetch files from the remote nodes to the localhost

    • +

  • reboot: Reboot a machine and waits it to become available

    • +

  • run-command: Execute a shell command in the remote hosts

    • +

  • run-script: Transfer a script from localhost to remote nodes and execute it in the remote hosts

    • +

  • update-packages: Update packages in the remote hosts

    • +
+
+

Hosts

+

No host must be specified by this role.

+
+
+

Action commands-common copy

+

Copy a file from the localhost to the remote nodes

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + +
commands-commands copy action variables

Name

Type

Description

src

path

File to be copied to the remote hosts. If the path is not absolute (it is relative), it will search in the role’s files directory else the file indicated will be copied. If the path is a directory, it will be recursive copied.

dest

path

Destination path where the files will be put into at remote nodes

+
+
+

Examples

+
clapp role action commands-common copy --extra src="/home/ubuntu/file" -e dest="~"
+
+
+

The above command copy the file at /home/ubuntu/file (localhost) the the ~ directory of the nodes.

+
+
+
+

Action commands-common fetch

+

Fetch files from the remote nodes to the localhost

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + +
commands-common fetch action variables

Name

Type

Description

src

path

File to be copied from the remote hosts. If the file is a directory, it will be recursive copied.

dest

path

Destination path where the files will be put into (localhost)

+
+
+

Examples

+
clapp role action commands-common fetch --extra src="~/file" --extra dest="/home/ubuntu/fetched_files/"
+
+
+

The above command fetch a file at ~/file directory from the nodes and place +at the /home/ubuntu/fetched_files/ directory of the localhost.

+
+
+
+

Action commands-common install-packages

+

Install packages in the remote hosts

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + +
commands-common install-packages action variables

Name

Type

Description

packages

string

Comma-separated list of packages to install.

+
+
+

Examples

+
clapp role action commands-common install-packages --extra "packages=openmpi-bin,openmpi-common"
+
+
+

The above command will install openmpi-bin and openmpi-common packages to remote hosts

+
+
+
+

Action commands-common reboot

+

Reboot a machine and waits it to become available

+
+

Required Variables

+

This action does not require any additional variable to be passed.

+
+
+

Examples

+
clapp role action commands-common reboot
+
+
+

The command reboot all machines belonging to the commands-common role.

+
+
+
+

Action commands-common run-command

+

Execute a shell command in the remote hosts

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + +
commands-common run-command action variables

Name

Type

Description

cmd

string

String with the command to be executed in the nodes

workdir (optional)

path

Change into this directory before running the command. If none is passed, home directory of the remote node will be used

+
+
+

Examples

+
clapp role action commands-common run-command --extra cmd="ls"
+clapp role action commands-common run-command --extra cmd="ls" -e "workdir=/bin"
+
+
+

In the above command (first one) runs the command ls in the remote nodes, +the second one runs the command ls in the remote nodes, after changing to the +“/bin” directory

+
+
+
+

Action commands-common run-script

+

Transfer a script from localhost to remote nodes and execute it in the remote hosts

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
commands-common run-script action variables

Name

Type

Description

src

string

Shell script file to be executed in the remote nodes. The file will be first copied (from localhost) to the nodes and after will be executed. Note: the script file must begin with the bash shebang (#!/bin/bash). Also the script filepath must be absolute else, if relative path is passed, Ansible search in the role’s file directory. The script will be deleted from nodes after execution.

args (optional)

string

Command-line arguments to be passed to the script.

workdir (optional)

path

Change into this directory before running the command. If none is passed, home directory of the remote node will be used (Path must be absolute for Unix-aware nodes)

+
+
+

Examples

+
clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh"
+clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3"
+clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3" -e workdir="/home"
+
+
+

The above command (first one) will copy the /home/ubuntu/echo.sh script from localhost to the remote nodes and execute it (similar to run bash -c echo.sh in the hosts).

+

The above command (second one) will copy the /home/ubuntu/echo.sh script from localhost to the remote nodes and execute it using the arguments “1 2 3” (similar to run bash -c echo.sh 1 2 3 in the hosts).

+

The above command (third one) is similar to the second one but will execute the script in the /home directory.

+
+
+
+

Action commands-common update-packages

+

Update packages in the remote hosts

+
+

Required Variables

+

This action does not require any additional variable to be passed

+
+
+

Examples

+
clapp role action commands-common update-packages
+
+
+

The above command will update the package list from remote hosts (similar to apt update command)

+
+
+
+
+

Group ec2-efs

+

This role setup and mount an network EFS filesystem on AWS provider. +The following actions are provided by the role.

+
    +

  • setup: Install nfs client

    • +

  • mount: Mount an EFS filesystem

    • +

  • umount: Unmount EC2 File System

    • +
+
+

Hosts

+

No hosts must be specified by this role.

+
+
+

Action ec2-efs setup

+

Install nfs client at remote host. This action is executed when nodes are added +to the role.

+
+

Required Variables

+

This action does not require any additional variable to be passed

+
+
+
+

Action ec2-efs mount

+

Mount an AWS EC2 EFS filesystem at remote host.

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ec2-efs mount action variables

Name

Type

Description

efs_mount_ip

string

Mount IP of the filesystem (see AWS EFS Documentation for more information)

efs_mount_point (OPTIONAL)

path

Directory path where the filesystem will be mounted. Default path is: /efs

efs_owner (OPTIONAL)

string

Name of the user owner (e.g. ubuntu). Default user is the currently logged user

efs_group (OPTIONAL)

string

Name of the group owner (e.g. ubuntu). Default group is the currently logged user

efs_mount_permissions (OPTIONAL)

string

Permission used to mount the filesystem (e.g. 0644). Default permission is 0744

+
+
+

Examples

+
clapp role action ec2-efs mount --extra "efs_mount_ip="192.168.0.1" -e "efs_mount_point=/tmp"
+
+
+

The above command will mount the EFS Filesystem from 192.168.0.1 it at /tmp +with 744 permissions (read-write-execute for user and read-only for group and others).

+
+
+
+

Action ec2-efs umount

+

Unmount the EC2 File System

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + +
ec2-efs umount action variables

Name

Type

Description

efs_mount_point (OPTIONAL)

path

Directory path where the filesystem will be mounted. Default path is: /efs

+
+
+

Examples

+
clapp role action ec2-efs umount --nodes node-0 --extra efs_mount_point="/efs"
+
+
+

The above command will unmount EC2 EFS filesystem at /efs directory from node-0

+
+
+
+
+

Role spits

+

Install spits runtime for the SPITS programming model +in nodes, deploy SPITS applications and collect results from execution. The +following actions are provided by this role.

+
    +

  • add-nodes: This action informs to the job manager node, the public address of all task managers.

    • +

  • job-copy: Copy the results (job directory) from the job manager to the localhost.

    • +

  • job-create: Create a SPITS job in nodes

    • +

  • job-status: Query job manager nodes the status and the metrics of a running SPITS job

    • +

  • setup: Install SPITS runtime and its dependencies at nodes

    • +

  • start: Start a SPITS job at job manager and task manager nodes

    • +
+
+

Note

+

For now, shared filesystem is not supported for SPITS runtime.

+
+
+

Warning

+

SPITS application are started using random TCP ports. For now, your security group must allows the communication from/to random IP addresses and ports. So, set inbound and outbound rules from you security group to allow the communication from anywhere to anywhere at any port.

+
+
+

Hosts

+

This role defines two host types:

+
    +

  • jobmanager: Nodes where job manager will be executed for a job

    • +

  • taskmanager: Nodes where task manager will be executed for a job

    • +
+
+
+

Typical Workflow

+

The spits role is used to run SPITS applications. For each SPITS application to run, you must create a SPITS job, with an unique Job ID. One node can execute multiple SPITS jobs.

+

Thus, a typical workflow for usage is:

+
    +

  1. Add job manager desired nodes to spits/jobmanager role and task manager desired nodes to spits/taskmanager

    2. +

  2. Use job-create action the create a new SPITS job in all machines belonging to spits role (filter nodes if you want to create a job at selected nodes only).

    3. +

  3. Use start action to start the SPITS job manager and SPITS task manager at nodes to run the SPITS job

    4. +

  4. Use the add-nodes action to copy public addresses from task managers nodes to the job manager node.

    5. +

  5. Optionally, check the job status using the job-status action.

    6. +

  6. When job is finished, use job-copy action to get the results.

    7. +
+
+
+

Action spits add-nodes

+

This action informs to the job manager node, the public address of all task managers.

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
spits add-nodes action variables

Name

Type

Description

jobid

string

Unique job identifier (must match the job ID used in the job-create action)

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role action spits add-nodes --extra "jobid=my-job-123"
+
+
+

The above example will add all task manager addresses, from nodes belonging to +the spits/taskmanager role to the spits/jobmanager nodes at job my-job-123. +At this point, the job manager nodes recognizes all task managers.

+
+

Note

+
    +

  • This action is not needed if job manager and task managers are running at same node

    • +
+
+
+
+
+

Action spits job-copy

+

Copy the results (job directory) from the job manager to the localhost

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
spits job-copy action variables

Name

Type

Description

jobid

string

Unique job identifier (must match the job ID used in the job-create action)

outputdir

path

Path where job will be copied to

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role action spits job-copy -e "jobid=my-job-123" -e "outputdir=/home/app-output"
+
+
+

The above example will copy the entire job folder (including logs/results) to the +localhost and put at /home/app-output directory.

+
+
+
+

Action spits job-create

+

Create a SPITS job in nodes to run an SPITS application. If you are using a shared +filesystem, use this action in only one node and set the SPITS_JOB_PATH +variable to the desired location.

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
spits job-create action variables

Name

Type

Description

jobid

string

Unique job ID to identify the SPITS job.

spits_binary

path

Absolute path to the SPITS binary (at localhost) that will be copied to nodes

spits_args

string

Arguments that will be passed to the SPITS binary when executing the SPITS application

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role action spits job-create --extra "jobid=my-job-123" -e "spits_binary=/home/xxx/spits-app" -e "spits_args=foo bar 10"
+
+
+

The above example create the a job called my-job-123 in all nodes belonging +to the spits role. The job will execute the SPITS runtime with the binary +/home/xxx/spits-app (that will be copied from localhost to nodes) with +arguments foo bar 10.

+
+
+
+

Action spits job-status

+

Query job manager nodes the status and the metrics of a running SPITS job

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
spits job-status action variables

Name

Type

Description

jobid

string

Unique job identifier (must match the job ID used in the job-create action)

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role action spits job-status --extra "jobid=my-job-123"
+
+
+

The above example query the status of a SPITS job with ID my-job-123 from +nodes belonging to spits/jobmanager role. The job status will be displayed +at the command output (in green).

+
+
+
+

Action spits setup

+

Install SPITS runtime and its dependencies at nodes

+
+

Required Variables

+

This action does not require any additional variable to be passed. Optional +variables can be passed.

+ + +++++ + + + + + + + + + + + + + + + + +
spits setup action variables

Name

Type

Description

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role add -n jobmanager:node-0 -n taskmanager:node-1,node-2
+
+
+

The above example install SPITS runtime at node-0, node-1 and node-2. +node-0 is set as job manager host and nodes node-1 and node-2 are +set as task manager host.

+
+
+
+

Action spits start

+

Start a SPITS job at job manager and task manager nodes

+
+

Required Variables

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
spits start action variables

Name

Type

Description

jobid

string

Unique job identifier (must match the job ID used in the job-create action)

jm_args

string

Arguments to be passed to the job manager SPITS runtime

tm_args

string

Arguments to be passed to the task manager SPITS runtime

PYPITS_PATH (OPTIONAL)

path

Directory path where the pypits will be installed (default: ${HOME}/pypits/)

SPITS_JOB_PATH (OPTIONAL)

path

Directory path where the spits jobs will be created (default: ${HOME}/spits-jobs/)

+
+
+

Examples

+
clapp role action spits start --extra "jobid=my-job-123" -e "jm_args=-vv"
+
+
+

The above example starts job managers and task managers for job my-job-123 in +nodes belonging to spits role. Also, job managers SPITS runtime are executed +passing the -vv parameter.

+
+

Note

+

The job-create action must be used before to create the SPITS job at nodes belonging to spits role.

+
+
+
+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/troubleshooting.html b/docs/build/html/troubleshooting.html new file mode 100644 index 00000000..b6eabdbd --- /dev/null +++ b/docs/build/html/troubleshooting.html @@ -0,0 +1,214 @@ + + + + + + + + + + Troubleshooting — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Troubleshooting

+

Sorry, to be written…

+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/tutorials.html b/docs/build/html/tutorials.html new file mode 100644 index 00000000..d82bf90c --- /dev/null +++ b/docs/build/html/tutorials.html @@ -0,0 +1,214 @@ + + + + + + + + + + Tutorials — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Tutorials

+

Sorry, to be written…

+
+ + +
+ +
+
+ +
+ +
+

+ © Copyright 2020, Otávio Napoli. + +

+
+ + + + Built with Sphinx using a + + theme + + provided by Read the Docs. + +
+
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/build/html/usage.html b/docs/build/html/usage.html new file mode 100644 index 00000000..41c69996 --- /dev/null +++ b/docs/build/html/usage.html @@ -0,0 +1,1316 @@ + + + + + + + + + + Basic Usage — CLoud Application Platform 0.2.1 + documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Basic Usage

+

CLAP is a platform to start, stop and manage cloud’s instances (called CLAP nodes +or simply, nodes) at different cloud providers transparently, based on configuration +files. Also, it offers mechanisms to perform actions via SSH commands or Ansible +playbooks in single nodes or in a set of nodes in a row. To provide this, in a modular +way, CLAP provides modules to allow performing several operations. +You can use clapp --help command to list the available modules.

+

The most common modules are: node, role and cluster.

+
+

Node Module

+

The node module provides mechanisms to create, manage and interact with cloud’s +instances. It provides the following features:

+
    +

  • Start nodes based on the instance templates with the start command.

    • +

  • Stop (terminate) already started nodes using the stop command.

    • +

  • Pause or resume already instantiated nodes using the pause and resume commands, respectively.

    • +

  • Check the status of a node (if its accessible by SSH) using the alive command.

    • +

  • List started nodes using the list command.

    • +

  • Execute a shell command via SSH, using the execute command.

    • +

  • Execute an Ansible Playbook using the playbook command.

    • +

  • Obtain a shell session (via SSH) using the connect command.

    • +

  • Add and remove tags from nodes using add-tag and remove-tag commands.

    • +

  • List all available instance templates configurations using the list-templates command.

    • +
+

All these commands are detailed below.

+
+

Command node start

+

To launch a cloud’s instance based on an instance template, defined in the +~/.clap/configs/instances.yaml file, you can use the command below, where the +ubuntu-instance-aws refers to the instance template ID defined in the +~/.clap/configs/instances.yaml file. In this way, you need to configure the +files only once and launch instances at any time.

+
clapp node start ubuntu-instance-aws
+
+
+

Once instances are successfully started, CLAP will assign an unique node ID to each +instance, used to perform other CLAP operation. Also, CLAP will try to login at +the instance with the login information provided, via SSH.

+

To launch more than one instance with the same instance template ID, you can +put the desired number after the instance template ID preceded by an : character. +For instance, the command below, launches 4 ubuntu-instance-aws instances in a row.

+
clapp node start ubuntu-instance-aws:4
+
+
+

You can also launch different instances in a row using the same command, but just +appending more instance template IDs to it, as below. The above command launches +2 ubuntu-instance-aws VMs and 2 example-instance-aws VMs in a row.

+
clapp node start ubuntu-instance-aws:2 example-instance-aws:2
+
+
+
+
+

Command node list

+

The clapp node list command can be used to show managed CLAP’s nodes. +An example output of this command is shown below.

+
* Node: ebcd658bacdf485487543cbcc721d1b3, config: type-a, nickname: MarjoryLang, status: reachable, ip: 3.87.87.154, tags: {}, roles: [], creation at: 21-05-21 14:11:55
+Listed 1 nodes
+
+
+

The node id (ebcd658bacdf485487543cbcc721d1b3 in the above example) is used +across all other modules and commands to perform commands in this node.

+
+
+

Command node alive

+

This command updates several node’s information (such as IP) and check if the +node is reachable (if a SSH connection can be established).

+

The node’s status can be:

+
    +

  • started: when the VM is up.

    • +

  • reachable: when the VM is up and a SSH connection was successfully established.

    • +

  • unreachable: when the SHH connection was not successfully established.

    • +

  • paused: when VM is paused.

    • +

  • stopped: when VM is terminated.

    • +
+
+

Note

+

CLAP does not check the status of VM periodically. Use this command to update node status and information.

+
+
+
+

Command node stop

+

The clapp node stop command can be used to terminate an running VM (destroying it). The syntax is shown below:

+
+
+

Command node pause

+

The clapp node pause command can be used to pause an running instance. +When a node is paused, its status is changed to paused and its public IP is +changed to None.

+
+

Note

+

The command has no effect for nodes that already been paused.

+
+
+
+

Command node resume

+

The clapp node resume command can be used to resume a paused instance. +When a node is resumed, it status is changed to started. Then, it checked if +it is alive, testing its connection and updating its public IP (and changing its +status to reachable).

+
+

Note

+

The command has no effect at nodes that were not paused. It will only check for its aliveness.

+
+
+
+

Command node connect

+

The clapp node connect command can be used to obtain a shell to a specific +node.

+
+

Note

+

The connection may fail if node has an invalid public IP or a invalid login information. You may want to check if node is alive first to update node’s information.

+
+
+
+

Command node execute

+

The clapp node execute command can be used to execute a shell command on an +reachable node. The syntax is shown below:

+
Usage: clapp node execute [OPTIONS] [NODE_ID]...
+
+  Execute a shell command in nodes (via SSH)
+
+Options:
+  -t, --tags TEXT        Filter nodes by tags. There are two formats: <key> or
+                         <key>=<val>
+  -cmd, --command TEXT   Shell Command to be executed in nodes  [required]
+  --timeout INTEGER      Timeout to execute command in host (0 to no timeout)
+                         [default: 0]
+  -a, --additional TEXT  Additional arguments to connection. Format:
+                         <key>=<val>
+  --help                 Show this message and exit.
+
+
+

One or more nodes can be passed as argument, or can be selected based on their tags. +The --command parameter specify the command that will be executed in nodes.

+

An example is shown below, executing a simple ls -lha command in the node +ebcd658bacdf485487543cbcc721d1b3

+
clapp node execute ebcd658bacdf485487543cbcc721d1b3 -cmd "ls -lha"
+
+
+

And the result:

+
------------------------ ebcd658bacdf485487543cbcc721d1b3 ------------------------
+return code ebcd658b: 0
+stdout ebcd658b: drwxr-xr-x 5 ubuntu ubuntu 4.0K May 21 17:12 .
+stdout ebcd658b: drwxr-xr-x 3 root   root   4.0K May 21 17:12 ..
+stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu  220 Apr  4  2018 .bash_logout
+stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 3.7K Apr  4  2018 .bashrc
+stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .cache
+stdout ebcd658b: drwx------ 3 ubuntu ubuntu 4.0K May 21 17:12 .gnupg
+stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu  807 Apr  4  2018 .profile
+stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .ssh
+
+
+
+

Note

+

You may want to check for nodes aliveness first.

+
+
+
+

Command node playbook

+

The clapp node playbook command can be used to execute an Ansible playbook +in a set of reachable nodes. The syntax is shown below:

+
clapp node playbook [OPTIONS] [NODE_ID]...
+
+    Execute an Ansible playbook in a set of nodes.
+
+    The NODE_ID argument is a list of strings (optional) and can filter nodes to
+    execute the playbook by their node ids
+
+Options:
+    -p, --playbook TEXT    Path of the playbook to be executed  [required]
+    -t, --tags TEXT        Filter nodes by tags. There are two formats: <key> or
+                         <key>=<val>
+    -e, --extra TEXT       Extra variables to be passed. Format: <key>=<val>
+    -nv, --node-vars TEXT  Host variables to be passed. Format:
+                         <node_id>:<key>=<val>,<key>=<val>,...
+    --help                 Show this message and exit.
+
+
+

One or more nodes can be passed as argument, or can be selected based on their tags.

+

The --playbook parameter specify the playbook to execute in nodes.

+

The --extra parameter can be used to pass keyword arguments to the playbook.

+

The --node-vars parameter can be used to pass keyword arguments to a specific node +when building the inventory.

+

An example is shown below. The playbook install_packages.yml is executed in node +ebcd658bacdf485487543cbcc721d1b3. +Extra playbook variables (in jinja format, e.g. “{{ var1 }}”) will be replaced by +the extra variables informed. In the example below the playbook’s variable +packages will be replaced by gcc.

+
clapp node playbook ebcd658bacdf485487543cbcc721d1b3 -p install_packages.yml -e "packages=gcc"
+
+
+
+
+

Command node add-tag

+

This clapp node add-tag command adds a tag to a set of nodes and has the +following syntax:

+
Usage: clapp node add-tag [OPTIONS] NODE_ID...
+
+  Add tags to a set of nodes.
+
+  The NODE_ID argument is a list of node_ids to add tags.
+
+Options:
+  -t, --tags TEXT  Tags to add. Format: <key>=<val>  [required]
+  --help           Show this message and exit.
+
+
+

One or more nodes can be passed as argument. The tags parameter must be a +keyword value in the format key=value. You can add as many tags to a node as +you want. An example of adding tags is shown below:

+
clapp node add-tag ebcd658bacdf485487543cbcc721d1b3 -t x=10
+
+
+

Where tag x=10 is added to nodes ebcd658bacdf485487543cbcc721d1b3.

+
+
+

Command node remove-tag

+

This clapp tag remove command removes a tag from a set of nodes and has the +following syntax:

+
clapp node remove-tag [OPTIONS] NODE_ID...
+
+  Remove tags from a set of nodes.
+
+  The NODE_ID argument is a list of node_ids to remove tags.
+
+Options:
+  -t, --tags TEXT  Tags to remove. Format: <key>  [required]
+  --help           Show this message and exit.
+
+
+

One or more nodes can be passed as argument. The tag parameter must be a string. +The tags from nodes that matches to the informed tag is removed (tag and value).

+
+
+
+

Role Module

+

The role module allows to perform pre-defined actions to a set of nodes that +belongs to a role. When a node is added to a role, it is said that this node +is ready to perform tasks of this role. +Thus, each role defines their set of specific actions that can be performed to +nodes that belongs to that particular role.

+

In this way, the role module consists of three steps:

+
    +

  1. Add nodes to a role.

    2. +

  2. Perform role’s action to nodes that belongs to a role.

    3. +

  3. Optionally, remove nodes from the group.

    4. +
+

The nodes of a role can also be logically divided in hosts. Thus, role actions +can be performed to all nodes of the role or to a subset of nodes of role (hosts).

+
+

CLAP’s roles and actions

+

Role’s actions are Ansible playbooks that are +executed when an action is invoked (e.g. using role action command). By +default CLAP’s roles are stored in the ~/.clap/roles/ directory and each +role consists in at minimum of two files:

+
    +

  • A YAML description file describing the actions that can be performed (and informing the playbook that must be called) and, optionally, the hosts (subset of role’s nodes to execute the playbook)

    • +

  • The Ansible Playbook called when each action is invoked.

    • +
+

You can see some roles shared with CLAP and their requirements at Roles shared with CLAP section.

+
+

Role description file

+

The role’s description files are python files placed at ~/.clap/groups/actions.d +directory. The name of the YAML file defines the role’s name. +Each role description file defines the key actions and, optionally, the hosts +key. Inside actions key, each dictionary defines a role action where the +key name is the action name and the values informs characteristic of that action.

+

An example role description file is shown below, for a role named commands-common +(placed at ~/.clap/roles/actions.d/commands-common.yaml).

+
---
+actions:                                                        # Defines the actions of this group
+    setup:                                                      # Action called setup
+        playbook: roles/commands-common_setup.yml               # Playbook to be executed when this group action is invoked
+
+    copy:                                                       # Action called copy
+        playbook: roles/commands-common_copy.yml                # Playbook to be executed when this group action is invoked
+        description: Copy files from localhost to remote hosts  # Optional action's description
+        vars:                                                   # Optional variables required
+        - name: src                                             # src variable
+          description: Source files/directory to be copied      # Optional variable's description
+          optional: no                                          # Informs if this variable is optional
+        - name: dest                                            # dest variable
+          description: Destination directory where files will be placed # Optional variable's description
+
+    fetch:
+        playbook: roles/commands-common_fetch.yml
+        description: Fetch files from remote hosts to localhost
+        vars:
+        - name: src
+          description: Source files/directory to be fetched
+        - name: dest
+          description: Destination directory where files will be placed
+
+hosts:                                                          # (optional) List of hosts that are used in this role. The host name can be used in the playbooks.
+- master
+- slave
+
+
+
+

Note

+

Action’s playbook is relative to the ~/.clap/roles/ directory.

+
+

For role’s description files, actions dictionary is required, and hosts optional. +The keys inside actions dictionary are the action names and the possible +values for each action are described in table below.

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
Valid values for actions

Name

Type

Description

playbook

path

Playbook to be executed when this action is invoked. The path is relative to ~/.clap/roles/ directory.

description (optional)

string

Action’s descriptive information

vars (optional)

List of variable dictionaries

List informing variables needed for this action

+

And optionally, the actions can define their variables to use. The possible +values are listed table below

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
Valid action’s values

Name

Type

Description

name

string

Name of the variable

description (optional)

string

Variable’s descriptive information

optional (optional)

boolean

Inform if variable is optional (default is no)

+

Finally the hosts specify the hosts used by role actions. It’s optional and +when specified Ansible playbooks can segment their execution using the hosts +variable at each play. If no hosts are specified you must use hosts: all +to perform the action over all nodes that belong to the role.

+
+
+
+

Command role list

+

The clapp role list command can be used to list all available role and their +respective actions and hosts. An example of output is shown below

+
* name: commands-common
+  Has 7 actions and 2 hosts defined
+    actions: copy, fetch, install-packages, reboot, run-command, run-script, update-packages
+    hosts: h1, h2
+
+* name: ec2-efs
+  Has 3 actions and 0 hosts defined
+    actions: mount, setup, unmount
+    hosts:
+
+* name: spits
+  Has 6 actions and 2 hosts defined
+    actions: add-nodes, job-copy, job-create, job-status, setup, start
+    hosts: jobmanager, taskmanager
+
+Listed 3 roles
+
+
+
+
+

Command role add

+

The clapp role add command can be used to add a node to a role. The syntax +is shown below:

+
clapp role add [OPTIONS] ROLE
+
+  Add a set of nodes to a role.
+
+  The ROLE argument specify the role which the nodes will be added.
+
+Options:
+  -n, --node TEXT        Nodes to be added. Can use multiple "-n" commands and
+                         it can be a list of colon-separated nodes as
+                         "<node>,<node>,..." or
+                         "<role_host_name>:<node>,<node>". The formats are
+                         mutually exclusive  [required]
+  -nv, --node-vars TEXT  Node's arguments. Format
+                         <node_id>:<key>=<value>,<key>=<val>
+  -hv, --host-vars TEXT  Role's host arguments. Format
+                         <host_name>:<key>=<value>,...
+  -e, --extra TEXT       Extra arguments. Format <key>=<value>
+  --help                 Show this message and exit.
+
+
+

The nodes can be supplied with --node parameter using two formats (mutually +exclusive): with host or without host.

+

If the role does not define any host, nodes must be informed supplying only their +node ids in the --node parameter. Multiple --node parameters can be used +to indicate multiple nodes ids. Besides that, multiple nodes ids can be passed to +--node parameter by separating them with comma. +The both examples below add nodes ebcd658bacdf485487543cbcc721d1b3 and +455e9c5da5c4417abc757f587a31c105 to role commands-common.

+
clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105
+clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3,455e9c5da5c4417abc757f587a31c105
+
+
+

If the role defines one or more hosts, the --node parameter can be supplied +with the “<node>,<node>,…” format (1) or with the “<role_host_name>:<node>,<node>” +format (2) (both are mutually exclusive). If the format (1) is used, the nodes +are added to all role’s hosts defined . +Two examples are shown below, one for format (1) and other for format (2).

+
clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105
+clapp role add commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105
+
+
+

Supposing the role commands-common defines 2 hosts: masters and slaves, +the first one adds nodes ebcd658bacdf485487543cbcc721d1b3 and ebcd658bacdf485487543cbcc721d1b3 +to both role’s host. +The second one adds node ebcd658bacdf485487543cbcc721d1b3 as commands-common +masters and node 455e9c5da5c4417abc757f587a31c105 as commands-common slaves host.

+

The --extra parameter can be used to pass keyword arguments to the playbook.

+

The --node-vars parameter can be used to pass keyword arguments to a specific node +when building the inventory.

+

The --host-vars parameter can be used to pass keyword arguments to a hosts.

+
+

Note

+

If the role’s setup action is defined this action is immediately executed +when adding a role to a node. If this action fails, the node is not added to +the role.

+
+
+
+

Command role action

+

The clapp role action command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below:

+
clapp role action [OPTIONS] ROLE
+
+  Perform an group action at a set of nodes.
+
+  The ROLE argument specify the role which the action will be performed.
+
+Options:
+  -a, --action TEXT      Name of the group's action to perform  [required]
+  -n, --node TEXT        Nodes to perform the action. Can use multiple "-n"
+                         commands and it can be a list of colon-separated node
+                         as "<node>,<node>,..." or
+                         "<role_host_name>:<node>,<node>". The formats are
+                         mutually exclusive. If not is passed, the action will
+                         be performed in all nodes that belongs to the role.
+  -nv, --node-vars TEXT  Node's arguments. Format
+                         <node_id>:<key>=<value>,<key>=<val>
+  -hv, --host-vars TEXT  Role's host arguments. Format
+                         <host_name>:<key>=<value>,...
+  -e, --extra TEXT       Extra arguments. Format <key>=<value>
+  --help                 Show this message and exit.
+
+
+

The --node parameter is optional and if is not supplied, the role action will +be executed in all nodes that belongs to the role. If --node parameter is +supplied it may be in two formats (mutually exclusive): with host or without host.

+

If nodes are informed in format without host, the selected nodes will be automatically +placed in their correct hosts (if any). Otherwise, the nodes will be placed in +informed hosts.

+

Examples are shown below:

+
clapp role action commands-common -a install-packages -n ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc
+clapp role action commands-common -a install-packages -n masters:ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc
+clapp role action commands-common -a install-packages -e packages=gcc
+
+
+

The first command perform install-packages action, from commands-common role +in nodes ebcd658bacdf485487543cbcc721d1b3. The node’s hosts are the same when +the nodes added. The second command perform install-packages action, from +commands-common role in node ebcd658bacdf485487543cbcc721d1b3. The node’s hosts +acts only as masters, additional hosts from this node are discarded. +The last command perform install-packages action, from commands-common role +at all nodes that belongs to commands-common. +For all commands, the extra variable package with value gcc is passed.

+

The --extra parameter can be used to pass keyword arguments to the playbook.

+

The --node-vars parameter can be used to pass keyword arguments to a specific node +when building the inventory.

+

The --host-vars parameter can be used to pass keyword arguments to a hosts.

+
+
+

Command role remove

+

The clapp role action command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below:

+
clapp role remove [OPTIONS] ROLE
+
+  Perform an group action at a set of nodes.
+
+  The ROLE argument specify the role which the action will be performed.
+
+Options:
+  -n, --node TEXT  Nodes to perform the action. Can use multiple "-n" commands
+                   and it can be a list of colon-separated node as
+                   "<node>,<node>,..." or "<role_host_name>:<node>,<node>".
+                   The formats are mutually exclusive. If not is passed, the
+                   action will be performed in all nodes that belongs to the
+                   role.  [required]
+  --help           Show this message and exit.
+
+
+

The --node parameter is used to inform the nodes to remove from a role. +The parameter can be supplied using two formats (mutually exclusive): with host +or without host. +If host is passed, the node is removed from the host’s role else the node is removed +from all hosts in the role (if any). An example is shown below:

+
clapp role remove commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105
+clapp role remove commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105
+
+
+

The first example remove nodes ebcd658bacdf485487543cbcc721d1b3 and 455e9c5da5c4417abc757f587a31c105 +from role commands-common and from all commands-common role hosts (if any). +The second example removes node ebcd658bacdf485487543cbcc721d1b3 from host +called masters from commands-common role and node 455e9c5da5c4417abc757f587a31c105 +from hosts called slaves from commands-common role.

+
+
+
+

Cluster Module

+

The cluster module allows CLAP to work with cluster, which is a set of CLAP’s nodes +tagged with a specific tag. A CLAP’s cluster is created taking as input configuration +files, in YAML format, which will create nodes and setup each of them properly. +After created, the cluster can be resized (adding or removing nodes), paused, +resumed, stopped, among other things.

+

By default, the CLAP’s cluster module will find configurations inside +~/clap/configs/clusters directory. At next sections, we will assume that +files will be created inside this directory (in .yaml format).

+

The next section will guide you to write a cluster configuration and then, +module’s commands will be presented.

+
+

Cluster Configuration

+

To create a CLAP’s cluster you will need to write:

+
    +

  • Setup configuration sections: which define a series of groups and actions that must be performed.

    • +

  • Cluster configuration sections: which define a set of nodes that must be created and the setups that must be performed in each node.

    • +
+

Setups and cluster section may be written in multiple different files (or at the +same file), as CLAP’s cluster modules will read all files (and setups and clusters +configurations, respectively) inside the cluster’s directory.

+
+
+

Setup Configuration Sections

+

Setup configuration sections define a series of roles and/or actions that must be +performed at cluster’s nodes. An example of a setup configuration section is +shown below.

+
# Setup configurations must be declared inside setups key
+setups:
+
+    # This is a setup configuration called setup-common
+    setup-common:
+        roles:
+        - name: commands-common         # Add nodes to commands-common role
+        - name: another-role            # Add nodes to another-role role
+        actions:
+        - role: commands-common
+          action: update-packages       # Perform action update-packages from role commands-common
+        - command: "git init"           # Perform shell command 'git init'
+
+    # This is a setup configuration called setup-spits-jobmanager
+    setup-spits-jobmanager:
+        roles:
+        - name: spits/jobmanager        # Add nodes to spits' role as jobmanager host
+
+    # This is a setup configuration called setup-spits-taskmanager
+    setup-spits-taskmanager:
+        roles:
+        - name: spits/taskmanager       # Add nodes to spits' role as taskmanager host
+
+
+

Setup configurations must be written inside setups YAML-dictionary. You can +define as many setup configurations as you want, even at different files but each +one must have a unique name. Inside the setups section, each dictionary +represents a setup configuration. The dictionary key (setup-common, +setup-spits-jobmanager and setup-spits-taskmanager in above example) +represent the setup configuration ID.

+

Each setup configuration may contain two dictionaries: roles and actions +(both are optional). Both sections, for a setup configuration is described in the +next two subsections.

+
+

Roles key at setups configuration

+

The role section inside a setup configuration tells to add nodes, whose perform +this setup, to the defined roles. The roles section contains a list describing +each role that the nodes must be added. Also, the role is always added in the order +defined in the list.

+

Each element of the list must have a name key, which describe the name of the role +that the node must be added. For instance, the setup-common at above example, +defines two roles which nodes that perform this setup must be added: commands-common +and another-role (in this order).

+

Optionally an extra key can be defined by each role, as a dictionary. The key +and values is passed as extra parameter similar to the role add module +command. For instance, the setup below, will add nodes that perform this setup +(setup-common-2) to role example-role passing variables, foo and +another_var with values bar and 10, respectively.

+
# Setup configurations must be declared inside setups key
+setups:
+
+    # This is a setup configuration called setup-common
+    setup-common-2:
+        roles:
+        - name: example-group     # Add nodes to example-role role
+          extra:
+            foo: bar
+            another_var: 10
+
+
+
+
+

Actions key at an setups configuration

+

The actions section inside a setup configuration tells to perform actions at +nodes which perform this setup. The actions section contains a list +describing each action that must be performed (in order). +There are three types of actions:

+
    +

  • role action: will perform an role action. Thus, the role and action keys must be informed. The role key will tell the name of the role and the action key will tell which action from that role which will be performed. Optionally, an extra dictionary can be informed to pass keyword variables to the role’s action.

    • +

  • playbook: will execute an Ansible Playbook. Thus, the playbook key must be informed, telling the absolute path of the playbook that will be executed. Optionally an extra dictionary can be informed to pass keyword variables to the playbook.

    • +

  • command: will execute a shell command. Thus, the command key must be informed, telling which shell command must be executed.

    • +
+

Some action examples are briefly shown below:

+
# Setup configurations must be declared inside setups key
+setups:
+
+    # This is a setup configuration called setup-common. The actions are executed sequentially
+    another-setup-example:
+        actions:
+        # Perform mount action from role nfs-client, passing the variable mount_path with value /mnt
+        - action: mount
+          role: nfs-client
+          extra:
+            mount_path: /mnt
+        # Execute the playbook /home/my-cool-ansible-playbook with an variable foo with value bar
+        - playbook: /home/my-cool-ansible-playbook
+          extra:
+            foo: bar
+        # Execute a shell command: hostname
+        - command: hostname
+        # Perform reboot action from commands-common role
+        - role: commands-common
+          action: reboot
+
+
+
+

Note

+

If a setup configuration contains both roles and actions sections, +the roles section will always be executed before actions section.

+
+
+
+
+

Cluster Configuration Sections

+

The cluster configuration defines a set of nodes that must be created and setups +that must be executed. Clusters are written inside clusters YAML-dictionary +key and each dictionary inside clusters key denotes a cluster (where the +dictionary key is the cluster’s name). +Above is an example of a cluster configuration:

+
# Clusters must be defined inside clusters key
+clusters:
+  # This is the cluster name
+  my-cool-cluster-1:
+    # Nodes that must be created when a cluster is instantiated
+    nodes:
+      # Node named master-node
+      master-node:
+        type: aws-instance-t2.large   # Instance type that must be created (must match instances.yaml name)
+        count: 1                      # Number of instances that must be created
+        setups:                       # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section)
+        - another-example-setup
+        - master-setup
+
+      # Node named taskmanager
+      slave-nodes:
+        type: aws-instance-t2.small  # Instance type that must be created (must match instances.yaml name)
+        count: 2                     # Number of instances that must be created
+        min_count: 1                 # Minimum desired number of instances that must effectively be created
+        setups:                      # Optionally, list of setups to be executed when the slave-nodes is created
+        - setup-slave-node
+
+
+

Clusters must have the nodes section, which defines the nodes that must be +created when the cluster is instantiated. As example above, each cluster’s node +have a type (master-node and slave-node) and values, that specify the +cluster’s node characteristics. Each node may have the values listed in is table +below.

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
Cluster’s nodes valid parameters

Name

Type

Description

type

string

Instance type that must to be created. The type must match the node name at instances.yaml file

count

Integer

Number of instances of this type to be launched

min_count (OPTIONAL)

Positive integer (less then or equal count parameter)

Minimum number of instances of this type that must effectively be launched. If this parameter is not supplied the value of count parameter is assumed

setups

List of strings

List with the name of the setup configurations that must be executed after nodes are created

+

When a cluster is created, the instance types specified in the each node section +is created with the desired count number. The cluster is considered created +when all nodes are effectively created. The min_count parameter at each node +specify the minimum number of instances of that type that must effectively be +launched. If some instances could not be instantiated (or created wwith less than +min_count parameter) the cluster creation process fails and all nodes are terminated.

+

After the cluster is created, i.e. the minimum number of nodes of each type is +successfully created, the setups for each node is executed, in order. If some +setup does not execute correctly, the cluster remains created and the setup +phase can be executed again.

+
+

Controlling cluster’s setups execution phases

+

CLAP’s cluster module also offers some other facilities to configure the cluster. +By default the cluster module create nodes and run the setup from each node type. +You can control the flow of the setup execution using some optional keys at your +cluster configuration. The keys: before_all, before, after and +after_all can be plugged into a cluster’s configuration, in order to execute +setups in different set of nodes, before and after the nodes setups. These keys +takes a list of setups to execute. CLAP’s setup phases are executed in the order, +as shown in table bellow.

+ + ++++ + + + + + + + + + + + + + + + + + + + + + + +
Cluster’s setups execution phases (in order)

Phase name

Description

before_all (#1)

Setups inside this key are executed in all cluster’s nodes before specific setup of the nodes (#3).

before (#2)

Setups inside this key are executed only in nodes that are currently being added to the cluster, before the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster.

node (#3)

The setup for each node is executed. The setup (inventory generated) is executed only at nodes of this type

after (#4)

Setups inside this key are executed only in nodes that are currently being added to the cluster, after the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster.

after_all (#5)

Setups inside this key are executed in all cluster’s nodes after specific setup of the nodes (#3).

+
+

Note

+

All setups are optional

+
+

An example is shown below:

+
# Clusters must be defined inside clusters key
+clusters:
+  # This is the cluster name
+  my-cool-cluster-1:
+    # These setups are executed at all cluster's nodes, before setups at nodes section
+    before_all:
+    - my-custom-setup-1
+
+    # These setups are executed at nodes that are currently being added to cluster, before setups at nodes section
+    before:
+    - my-custom-setup-2
+
+    # These setups are executed at nodes that are currently being added to cluster, after setups at nodes section
+    after:
+    - my-custom-setup-3
+    - my-custom-setup-4
+
+    # These setups are executed at all cluster's nodes, after setups at nodes section
+    after_all:
+    - final_setup
+
+    # Nodes that must be created when a cluster is instantiated
+    nodes:
+      # Node named master-node
+      master-node:
+        type: aws-instance-t2.large   # Instance type that must be created (must match instances.yaml name)
+        count: 1                      # Number of instances that must be created
+        setups:                       # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section)
+        - another-example-setup
+        - master-setup
+
+      # Node named taskmanager
+      slave-nodes:
+        type: aws-instance-t2.small  # Instance type that must be created (must match instances.yaml name)
+        count: 2                     # Number of instances that must be created
+        min_count: 1                 # Minimum desired number of instances that must effectively be created
+        setups:                      # Optionally, list of setups to be executed when the slave-nodes is created
+        - setup-slave-node
+
+
+

In the above example, supposing you are creating a new cluster, after the creation +of nodes the following setups are executed (in order):

+
    +

  • before_all setups: my-custom-setup-1 at all nodes

    • +

  • before setups: my-custom-setup-2 at all nodes

    • +

  • nodes setups (not necessary in order): another-example-setup and master-setup at master-nodes nodes and setup-slave-node at slave-nodes nodes.

    • +

  • after setups: my-custom-setup-3 and my-custom-setup-4 at all nodes

    • +

  • after_all setups: final_setup at all nodes

    • +
+

Now supposing you are resizing the already created cluster (adding more +slave-nodes to it), the before_all and after_all setups will be executed +in all cluster’s nodes (including the new ones, that are being added) and +before, nodes and after phase setups will only be executed at nodes +that are being added to the the cluster.

+
+
+

Other cluster’s setups optional keys

+

The options key can be plugged at a cluster configuration allowing some special +options to cluster. The options key may have the following parameters:

+ + ++++ + + + + + + + + + + +
code-block:: none Cluster’s options keys

Option name

Description

ssh_to

Connect to a specific node when performing the cluster connect command

+

A example is shown below:

+
# Clusters must be defined inside clusters key
+clusters:
+  # This is the cluster name
+  my-cool-cluster-1:
+    # Additional cluster's options (optional)
+    options:
+      # When connecting to a cluster, connect to a master-node
+      ssh_to: master-node
+
+    # Nodes that must be created when a cluster is instantiated
+    nodes:
+      # Node named master-node
+      master-node:
+        type: aws-instance-t2.large   # Instance type that must be created (must match instances.yaml name)
+        count: 1                      # Number of instances that must be created
+        setups:                       # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section)
+        - another-example-setup
+        - master-setup
+
+      # Node named taskmanager
+      slave-nodes:
+        type: aws-instance-t2.small  # Instance type that must be created (must match instances.yaml name)
+        count: 2                     # Number of instances that must be created
+        min_count: 1                 # Minimum desired number of instances that must effectively be created
+        setups:                      # Optionally, list of setups to be executed when the slave-nodes is created
+        - setup-slave-node
+
+
+
+
+
+

Command cluster start

+

Start a cluster given a cluster configuration name. The syntax of the command is +shown below

+
clapp cluster start [OPTIONS] CLUSTER_TEMPLATE
+
+  Start cluster based on a cluster template.
+
+  The CLUSTER TEMPLATE is the ID of the cluster configuration at cluster
+  configuration files.
+
+Options:
+  -n, --no-setup  Do not perform setup  [default: False]
+  --help          Show this message and exit.
+
+
+

By default, the CLAP’s cluster module search for configurations at all .yaml +files inside ~/.clap/configs/clusters directory. After cluster is created, +the setups are automatically executed. You can omit this phase by using the +--no-setup option.

+

An example of the command is shown below, which starts a cluster called +example-cluster.

+
clapp cluster start example-cluster
+
+
+
+

Note

+
    +

  • After the cluster’s creation a new cluster_id will be assigned to it. Thus, multiple clusters with same cluster configuration can be launched Also, all commands will reference to cluster_id to perform their actions.

    • +

  • When a cluster is started its initial configuration is copied to cluster metadata. If you update the cluster configuration while having already started clusters use the clapp cluster update command to update the cluster configuration.

    • +
+
+
+
+

Command cluster setup

+

Setup an existing cluster. The command has the following syntax:

+
clapp cluster setup [OPTIONS] CLUSTER_ID
+
+  Perform cluster setup operation at a cluster.
+
+  The CLUSTER_ID argument is the id of the cluster to perform the setup
+
+Options:
+  -a, --at TEXT  Stage to start the setup action  [default: before_all]
+  --help         Show this message and exit.
+
+
+

Given the cluster_id, the command will execute all setup phases in all cluster +nodes. Some phases of the setup pipeline can be skipped informing at which phase +the setup must begin with the at parameter. +Examples are shown below:

+
clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9
+clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9 --at "before"
+
+
+

In the above examples, the first one setups all cluster nodes from +cluster-faa4017e10094e698aed56bb1f3369f9, the second one setups all nodes, +but starting at before phase.

+
+

Note

+

The before_all and after_all phases will be executed at all cluster’s nodes, even if setting the nodes parameter.

+
+
+
+

Command cluster grow

+

Start and add a new node to cluster, based on its cluster’s node name. The command +has the following syntax:

+
clapp cluster grow [OPTIONS] CLUSTER_ID
+
+  Start more nodes at a cluster by cluster node type.
+
+  The CLUSTER_ID argument is the id of the cluster to add more nodes.
+
+Options:
+  -n, --node TEXT  Type of node to start. Format: <node_type>:<num>
+                   [required]
+  -n, --no-setup   Do not perform setup  [default: False]
+  --help           Show this message and exit.
+
+
+

The --node parameter determines how much nodes will be added to cluster. +If --no-setup is provided no setup phase will be executed.

+
+
+

Command cluster list

+

List all available CLAP’s clusters.

+
+
+

Command cluster alive

+

Check if all nodes of the cluster are alive.

+
+
+

Command cluster resume

+

Resume all nodes of the cluster.

+
+
+

Command cluster pause

+

Pause all nodes of the cluster.

+
+
+

Command cluster stop

+

Stop all nodes of the cluster, terminating them (destroying).

+
+
+

Command cluster list-templates

+

List all available cluster templates at ~/clap/configs/clusters directory.

+
+
+

Command cluster update

+

Update a cluster configuration of an already created cluster. The command’s +syntax is shown below.

+
clapp cluster update [OPTIONS] CLUSTER_ID
+
+  Perform cluster setup operation at a cluster.
+
+  The CLUSTER_ID argument is the id of the cluster to perform the setup
+
+Options:
+  -c, --config TEXT  New cluster config name
+  --help             Show this message and exit.
+
+
+

If --config option is provided, the cluster configuration will be replaced +with the informed configuration. Otherwise, the cluster will be updated with the +same configuration.

+
+

Note

+

The configurations will be searched in ~/clap/configs/clusters directory.

+
+
+
+

Command cluster connect

+

Get a SSH shell to a node of the cluster. Given a cluster_id it will try to +get an SSH shell to a node type specified in ssh_to cluster configuration +option. If no ssh_to option is informed at cluster’s configuration the command +will try to connect to any other node that belongs to the cluster.

+
+
+

Command cluster execute

+

Execute a shell command in nodes of the cluster.

+
+
+

Command cluster playbook

+

Execute an Ansible Playbook in nodes of the cluster.

+
+
+
+ + +
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..9534b018 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..cb614189 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx-autoapi +sphinx_rtd_theme diff --git a/docs/source/_build/html/.buildinfo b/docs/source/_build/html/.buildinfo new file mode 100644 index 00000000..1b91fb71 --- /dev/null +++ b/docs/source/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 66d72d26908c36ab4553f1337ccff774 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/cluster_repository/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/cluster_repository/index.doctree new file mode 100644 index 00000000..d30b1c60 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/cluster_repository/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/commands/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/commands/index.doctree new file mode 100644 index 00000000..eb38b854 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/commands/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/config/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/config/index.doctree new file mode 100644 index 00000000..9db37a82 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/config/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/driver/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/driver/index.doctree new file mode 100644 index 00000000..14d5f208 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/driver/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/exceptions/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/exceptions/index.doctree new file mode 100644 index 00000000..fc727e39 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/exceptions/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/factory/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/factory/index.doctree new file mode 100644 index 00000000..bb528712 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/factory/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/index.doctree new file mode 100644 index 00000000..b29a6eb4 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/platform/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/platform/index.doctree new file mode 100644 index 00000000..43389305 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/platform/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/repository/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/repository/index.doctree new file mode 100644 index 00000000..0fb4162e Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/repository/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/common/utils/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/common/utils/index.doctree new file mode 100644 index 00000000..63446739 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/common/utils/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/driver/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/driver/index.doctree new file mode 100644 index 00000000..bfc70d4b Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/driver/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/index.doctree new file mode 100644 index 00000000..50bf4e06 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/elasticluster/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/drivers/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/index.doctree new file mode 100644 index 00000000..dc42fbac Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/drivers/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/clap/index.doctree b/docs/source/_build/html/.doctrees/autoapi/clap/index.doctree new file mode 100644 index 00000000..4b9832d8 Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/clap/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/autoapi/index.doctree b/docs/source/_build/html/.doctrees/autoapi/index.doctree new file mode 100644 index 00000000..1a9b79ac Binary files /dev/null and b/docs/source/_build/html/.doctrees/autoapi/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/configuration.doctree b/docs/source/_build/html/.doctrees/configuration.doctree new file mode 100644 index 00000000..3615f628 Binary files /dev/null and b/docs/source/_build/html/.doctrees/configuration.doctree differ diff --git a/docs/source/_build/html/.doctrees/environment.pickle b/docs/source/_build/html/.doctrees/environment.pickle new file mode 100644 index 00000000..c9b4363e Binary files /dev/null and b/docs/source/_build/html/.doctrees/environment.pickle differ diff --git a/docs/source/_build/html/.doctrees/groups.doctree b/docs/source/_build/html/.doctrees/groups.doctree new file mode 100644 index 00000000..99aa3337 Binary files /dev/null and b/docs/source/_build/html/.doctrees/groups.doctree differ diff --git a/docs/source/_build/html/.doctrees/index.doctree b/docs/source/_build/html/.doctrees/index.doctree new file mode 100644 index 00000000..59aa5808 Binary files /dev/null and b/docs/source/_build/html/.doctrees/index.doctree differ diff --git a/docs/source/_build/html/.doctrees/installation.doctree b/docs/source/_build/html/.doctrees/installation.doctree new file mode 100644 index 00000000..d2f80106 Binary files /dev/null and b/docs/source/_build/html/.doctrees/installation.doctree differ diff --git a/docs/source/_build/html/.doctrees/pythonapi.doctree b/docs/source/_build/html/.doctrees/pythonapi.doctree new file mode 100644 index 00000000..de3f7406 Binary files /dev/null and b/docs/source/_build/html/.doctrees/pythonapi.doctree differ diff --git a/docs/source/_build/html/.doctrees/shared_groups.doctree b/docs/source/_build/html/.doctrees/shared_groups.doctree new file mode 100644 index 00000000..a3a9f533 Binary files /dev/null and b/docs/source/_build/html/.doctrees/shared_groups.doctree differ diff --git a/docs/source/_build/html/.doctrees/troubleshooting.doctree b/docs/source/_build/html/.doctrees/troubleshooting.doctree new file mode 100644 index 00000000..5beaa7c0 Binary files /dev/null and b/docs/source/_build/html/.doctrees/troubleshooting.doctree differ diff --git a/docs/source/_build/html/.doctrees/tutorials.doctree b/docs/source/_build/html/.doctrees/tutorials.doctree new file mode 100644 index 00000000..c58828bf Binary files /dev/null and b/docs/source/_build/html/.doctrees/tutorials.doctree differ diff --git a/docs/source/_build/html/.doctrees/usage.doctree b/docs/source/_build/html/.doctrees/usage.doctree new file mode 100644 index 00000000..633be38f Binary files /dev/null and b/docs/source/_build/html/.doctrees/usage.doctree differ diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/cluster_repository/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/cluster_repository/index.rst.txt new file mode 100644 index 00000000..92b648b2 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/cluster_repository/index.rst.txt @@ -0,0 +1,236 @@ +:mod:`clap.common.cluster_repository` +===================================== + +.. py:module:: clap.common.cluster_repository + + +Module Contents +--------------- + +.. py:class:: PlatformControlInfo(*args, **kwargs) + + Bases: :class:`clap.common.repository.AbstractEntry` + + This class holds control information used to create nodes and cluster in the repository (database). + It holds an incremental index to be used when creating such elements. + + +.. py:class:: ClusterInfo(**kwargs) + + Bases: :class:`clap.common.repository.AbstractEntry` + + This class holds information about a cluster that is stored in the repository and used by several interfaces + Each cluster is unique and is composed by the following elements: + * cluster_id: The unique identification of the cluster, used to perform operations across modules and instance interfaces + * cluster_name: The name of the cluster used by the driver object that controls this cluster + * cloud: The cluster (or cloud) provider that this cluster is attached (e.g., aws, azure, ...) + * keypair: The name of the keypair used to connect to the machines created in this cluster + * region: The avaliability zone that this cluster was created + * template: Name of the template that was used to create this cluster + * driver_id: ID of the driver that controls this cluster + * driver_version: Version of the driver used by this cluster + * tags: Additional user tags for cluster identification + + .. method:: __repr__(self) + + + + +.. py:class:: NodeInfo(**kwargs) + + Bases: :class:`clap.common.repository.AbstractEntry` + + This class holds information about a node that is stored in the repository and used by several interfaces + Each node is unique and is composed by the following elements: + * node_id: The unique identification of the node, used to perform operations across modules and instance interfaces + * node_name: The name of the node used by the driver object that controls it + * cluster_id: ID of the cluster that this node is attached to + * flavor: Instance flavor (e.g., t2.micro in aws) + * status: Last known status of the node (see PlatformCodes) + * ip: IP address used to connect to this node (address used to perform SSH) + * driver_id: ID of the driver that controls this node + * driver_version: Version of the driver used by this node + * keypair: The name of the keypair used to connect to the machines created in the node cluster + * key: The private key file used to perform SSH and connect to machines + * tags: Additional user tags for node identification + + .. method:: __repr__(self) + + + + +.. py:class:: RepositoryOperations(platform_repository: str, repository_type: str) + + .. method:: _get_platform_repository(self) + + + Get the platform repository connection + + :return: The platform database connection + :rtype: AbstractRepository + + + .. method:: exists_platform_db(self) + + + Check if the platform database exists + + :return: A boolean representing the existence of the platform database + :rtype: bool + + + .. method:: create_platform_db(self, exists: str = 'pass') + + + Creates the platform Database + + :param exists: This parameter can be: + * 'pass' (default): will do nothing if the platform database tables already exists + * 'fail': will raise `TableAlreadyExists` exception + * 'overwrite': will drop and create a new table, if it already exists + :return: A open repository connection + :rtype: AbstractRepository + + + .. method:: write_platform_control_info(self, control: PlatformControlInfo) + + + Helper function to write Platform Control information on the correct table in the repository + + :param control: Control information to be written + :type control: PlatformControlInfo + :return: None + + + .. method:: read_platform_control_info(self) + + + Helper function to read Platform control information from the correct table in the repository + + :return: PlatformControlInfo + + + .. method:: write_cluster_info(self, cluster: ClusterInfo, create: bool = False) + + + Helper function to write Cluster information on the correct table in the repository + + :param cluster: Cluster information to be written + :type cluster: ClusterInfo + :param create: If true, create a new element, else update the one with same id + :type create: str + :return: None + + + .. method:: _read_clusters_info(self, **where) + + + Helper function to read Cluster information from the correct table in the repository + + :param where: Dictionary of criterion to be matched when retrieving elements (e.g., {'cluster.id' == 'xxx'}) + :return: List of cluster matching the criterion passed + :rtype: List[ClusterInfo] + + + .. method:: write_node_info(self, node: NodeInfo, create: bool = False) + + + Helper function to write Node information on the correct table in the repository + + :param node: node information to be written + :type node: NodeInfo + :param create: If true, create a new element, else update the one with same id + :type create: str + :return: None + + + .. method:: _read_nodes_info(self, **where) + + + Helper function to read Nodes information from the correct table in the repository + + :param where: Dictionary of criterion to be matched when retrieving elements (e.g., {'node.id' == 'xxx'}) + :return: List of nodes matching the criterion passed + :rtype: List[NodeInfo] + + + .. method:: _delete_clusters_info(self, **where) + + + + .. method:: _delete_nodes_info(self, **where) + + + + .. method:: get_platform_control(self) + + + + .. method:: get_cluster(self, cluster_id: str) + + + + .. method:: get_clusters(self, cluster_ids: List[str]) + + + Given a list with cluster ids, it returns all the Cluster Information that matches the Ids in the repository + + :param cluster_ids: List of cluster ids to be queried + :type cluster_ids: List[str] + :return: Matched cluster information + :rtype: List[ClusterInfo] + + + .. method:: get_all_clusters(self) + + + Get the information of all created cluster in the repository + + :return: List with the information of all created cluster + :rtype: List[ClusterInfo] + + + .. method:: remove_cluster(self, cluster_id: str) + + + + .. method:: get_node(self, node_id) + + + + .. method:: get_nodes(self, node_ids: List[str]) + + + Given a list with node ids, it returns all the Node Information that matches the ids in the repository + + :param node_ids: List of node ids to be queried + :type node_ids: List[str] + :return: Matched nodes information + :rtype: List[NodeInfo] + + + .. method:: get_all_nodes(self) + + + Get the information of all created nodes in the repository + + :return: List with the information of all created nodes + :rtype: List[NodeInfo] + + + .. method:: get_nodes_from_cluster(self, cluster_id: str) + + + Given a list of cluster ids, return all nodes in cluster that matches the ids passed in the repository + + :param cluster_id: Id of the cluster + :type cluster_id: str + :return: All the nodes that matches the cluster ids passed + :rtype: List[NodeInfo] + + + .. method:: remove_node(self, node_id: str) + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/commands/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/commands/index.rst.txt new file mode 100644 index 00000000..f83dfe42 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/commands/index.rst.txt @@ -0,0 +1,17 @@ +:mod:`clap.common.commands` +=========================== + +.. py:module:: clap.common.commands + + +Module Contents +--------------- + +.. py:class:: AbstractParser + + .. method:: get_parser(self, commands_parser: argparse._SubParsersAction) + :abstractmethod: + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/config/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/config/index.rst.txt new file mode 100644 index 00000000..344db395 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/config/index.rst.txt @@ -0,0 +1,142 @@ +:mod:`clap.common.config` +========================= + +.. py:module:: clap.common.config + + +Module Contents +--------------- + +.. py:class:: Defaults + + .. attribute:: log_level + + + + + .. attribute:: app_name + :annotation: = clap + + + + .. attribute:: REPOSITORY_TYPE + :annotation: = tinydb + + + + .. attribute:: DRIVER_ID + :annotation: = elasticluster + + + + .. attribute:: DEFAULT_CONF_TYPE + :annotation: = json + + + + .. attribute:: configs_path + + + + + .. attribute:: private_path + + + + + .. attribute:: storage_path + + + + + .. attribute:: execution_playbook + + + + + .. attribute:: groups_path + + + + + .. attribute:: modules_path + + + + + .. attribute:: elasticluster_storage_path + + + + + .. attribute:: cloud_conf + + + + + .. attribute:: login_conf + + + + + .. attribute:: instances_conf + + + + + .. attribute:: PLATFORM_REPOSITORY + + + + + +.. data:: PROVIDERS_SCHEMA + + + + +.. data:: LOGIN_SCHEMA + + + + +.. data:: INSTANCE_SCHEMA + + + + +.. py:class:: ConfigReader(providers_file: str, logins_file: str, instances_file: str) + + .. method:: __validate(self, schema: dict, data: dict) + + + + .. method:: __check_instances(self) + + + + .. method:: get_instance(self, instance_name: str) + + + + .. method:: get_instances(self) + + + + .. method:: get_provider(self, provider_name: str) + + + + .. method:: get_providers(self, provider_name: str) + + + + .. method:: get_login(self, login_name: str) + + + + .. method:: get_logins(self, login_name: str) + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/driver/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/driver/index.rst.txt new file mode 100644 index 00000000..caa27d45 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/driver/index.rst.txt @@ -0,0 +1,92 @@ +:mod:`clap.common.driver` +========================= + +.. py:module:: clap.common.driver + + +Module Contents +--------------- + +.. py:class:: AbstractInstanceInterface(repository_operator: RepositoryOperations) + + Abstract class implementing the interface between the driver and the clap objects. + The interface is responsible for create and manage clusters and nodes entries in the clap platform repository. + Clap objects interact with the driver interface instead of the driver directly. + + .. attribute:: __interface_id__ + :annotation: = InterfaceID + + + + .. attribute:: __interface_version__ + :annotation: = 0.1.0 + + + + .. method:: start_nodes(self, instances_num: Dict[str, int]) + :abstractmethod: + + + + .. method:: stop_nodes(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: pause_nodes(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: resume_nodes(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: check_nodes_alive(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs) + :abstractmethod: + + + + .. method:: execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None) + :abstractmethod: + + + + +.. py:class:: Codes + + Status codes for nodes + + + .. attribute:: NODE_STATUS_INIT + :annotation: = initialized + + + + .. attribute:: NODE_STATUS_UNREACHABLE + :annotation: = unreachable + + + + .. attribute:: NODE_STATUS_REACHABLE + :annotation: = reachable + + + + .. attribute:: NODE_STATUS_PAUSED + :annotation: = paused + + + + .. attribute:: NODE_STATUS_STOPPED + :annotation: = stopped + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/exceptions/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/exceptions/index.rst.txt new file mode 100644 index 00000000..438acc08 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/exceptions/index.rst.txt @@ -0,0 +1,43 @@ +:mod:`clap.common.exceptions` +============================= + +.. py:module:: clap.common.exceptions + + +Module Contents +--------------- + +.. py:exception:: RepositoryError + + Bases: :class:`Exception` + + +.. py:exception:: TableAlreadyExists(table_name: str, *args, **kwargs) + + Bases: :class:`clap.common.exceptions.RepositoryError` + + .. method:: __str__(self) + + + + +.. py:exception:: ModuleError + + Bases: :class:`Exception` + + +.. py:exception:: ValueNotFound + + Bases: :class:`clap.common.exceptions.RepositoryError` + + +.. py:exception:: ClusterError + + Bases: :class:`Exception` + + +.. py:exception:: ClusterCreationError + + Bases: :class:`clap.common.exceptions.ClusterError` + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/factory/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/factory/index.rst.txt new file mode 100644 index 00000000..5bef848e --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/factory/index.rst.txt @@ -0,0 +1,42 @@ +:mod:`clap.common.factory` +========================== + +.. py:module:: clap.common.factory + + +Module Contents +--------------- + +.. py:class:: PlatformFactory + + .. attribute:: __multi_instance_api__ + + + + + .. attribute:: __module_iface__ + + + + + .. method:: get_module_interface() + :staticmethod: + + + Get the default ModuleInterface used to pick clap modules + + :return: The modules interface + :rtype: ModuleInterface + + + .. method:: get_instance_api(platform_db: str = Defaults.PLATFORM_REPOSITORY, repository_type: str = Defaults.REPOSITORY_TYPE, default_driver: str = Defaults.DRIVER_ID) + :staticmethod: + + + Get the default MultiInstance API used to manipulate cluster, nodes and modules across different drivers + + :return: The MultiInstanceAPI object to manipulate cluster, nodes and modules + :rtype: MultiInstanceAPI + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/index.rst.txt new file mode 100644 index 00000000..9480fd25 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/index.rst.txt @@ -0,0 +1,23 @@ +:mod:`clap.common` +================== + +.. py:module:: clap.common + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + cluster_repository/index.rst + commands/index.rst + config/index.rst + driver/index.rst + exceptions/index.rst + factory/index.rst + platform/index.rst + repository/index.rst + utils/index.rst + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/platform/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/platform/index.rst.txt new file mode 100644 index 00000000..4da61a93 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/platform/index.rst.txt @@ -0,0 +1,185 @@ +:mod:`clap.common.platform` +=========================== + +.. py:module:: clap.common.platform + + +Module Contents +--------------- + +.. py:class:: ModuleInterface + + Interface to get clap modules from the modules repository + + + .. attribute:: __modules_map__ + + + + + .. method:: __find_modules() + :staticmethod: + + + + .. method:: get_module(self, module_name: str) + + + Get the module package + + :param module_name: Name of the clap module + :type module_name: str + :return: The module + :rtype: Module + + + .. method:: get_modules(self) + + + Get the module package + + :return: List of modules + :rtype: List[module] + + + .. method:: get_module_names(self) + + + Get the name of all the modules in the clap modules repository + + :return: List containing the module names + :rtype: List[str] + + + +.. py:class:: GroupInterface + + .. attribute:: __groups_actions_map__ + + + + + .. attribute:: GROUP_SCHEMA + + + + + .. method:: __find_groups() + :staticmethod: + + + + .. method:: get_group(self, group_name: str) + + + + .. method:: get_group_names(self) + + + + +.. py:class:: MultiInstanceAPI(platform_db: str, repository_type: str, default_driver: str) + + API used to manage and perform operations in cluster and nodes from different driver implementations, + and cloud providers in a transparently manner. + + .. attribute:: __interfaces_map__ + + + + + .. method:: __find_ifaces() + :staticmethod: + + + + .. method:: _get_instance_iface(self, driver_id: str = None) + + + + .. method:: get_instance_templates() + :staticmethod: + + + + .. method:: start_nodes(self, instances_num: Dict[str, int]) + + + + .. method:: stop_nodes(self, node_ids: List[str]) + + + + .. method:: check_nodes_alive(self, node_ids: List[str]) + + + + .. method:: execute_playbook_in_nodes(self, playbook_path: str, hosts: Union[List[str], Dict[str, List[str]]], extra_args: Dict[str, str] = ()) + + + + .. method:: get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs) + + + + .. method:: get_node(self, node_id: str) + + + + .. method:: get_nodes(self, node_ids: List[str] = None) + + + + .. method:: get_nodes_with_tags(self, tags: Dict[str, str]) + + + + .. method:: add_tags_to_nodes(self, node_ids: List[str], tags: Dict[str, str]) + + + + .. method:: remove_tags_from_nodes(self, node_ids: List[str], tags: List[str]) + + + + .. method:: get_groups(self) + + + + .. method:: __execute_group_action_sequence(self, hosts: Dict[str, List[str]], actions: List[str], group_path: str, extra_args: Dict[str, str], error_action: str = 'error') + + + + .. method:: __check_nodes_in_group(self, group: str, node_ids: List[str] = None) + + + + .. method:: add_nodes_to_group(self, node_ids: List[str], group_name: str, group_args: Dict = None, error_action: str = 'error') + + + + .. method:: __add_nodes_to_group(self, group_hosts_map: Dict[str, Union[List[str], Dict[str, List[str]]]], group_args: Dict = None, error_action: str = 'error') + + + + .. method:: execute_group_action(self, group_name: str, action: str, group_args: Dict = None, node_ids: List[str] = None, error_action='ignore') + + + + .. method:: __execute_group_action(self, node_ids: List[str], group_name: str, action: str, group_args: Dict = None, error_action='error') + + + + .. method:: remove_nodes_from_group(self, group_name: str, node_ids: List[str] = None, remove_action: str = None, group_args: Dict = None) + + + + .. method:: export_platform(self, output_filename: str) + + + + .. method:: import_platform(self, zip_filename: str) + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/repository/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/repository/index.rst.txt new file mode 100644 index 00000000..8660506a --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/repository/index.rst.txt @@ -0,0 +1,387 @@ +:mod:`clap.common.repository` +============================= + +.. py:module:: clap.common.repository + + +Module Contents +--------------- + +.. py:class:: AbstractEntry(*args, **kwargs) + + Bases: :class:`clap.common.utils.Struct` + + This class represent a single entry in the Repository. Basically its a dictionary that is a serializable and + is a generic container for a data format. Implementations derived from this class represent specific element types in a repository. + Objects (variables) inside this class can be accessed using `element['variable']` or `element.variable` notations + + +.. py:class:: AbstractRepository(repository: str, create_repository: bool, storage_type: str = None, *args, **kwargs) + + Base class for implementing repositories and their operations. The repository is similar to tabled data models. + The elements are every object inherited from ``AbstractEntry`` class, which are basically, dictionary types. + Tables hold a set of elements of the same type and must be created before adding elements. + The repository then, implement a set of methods to create, retrieve, update and delete elements and tables from the database. + + .. attribute:: __repository_id__ + :annotation: = abstractrepository + + + + .. attribute:: __repository_name__ + :annotation: = Abstract Repository + + + + .. attribute:: __repository_version__ + :annotation: = 0.0.1 + + + + .. method:: create_table(self, table: str, *args, **kwargs) + :abstractmethod: + + + Create a table in the repository (a container to hold elements of the same type) + + :param table: Name of the table to be created + :type table: str + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + + + .. method:: retrieve_tables(self) + :abstractmethod: + + + Retrieve tables from the repository. + + :return: List with the table names + :rtype: List[str] + + + .. method:: exists_table(self, table: str, *args, **kwargs) + :abstractmethod: + + + Check if a table exists in the repsitory + + :param table: Name of the table to be checked + :type table: str + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: True if table exists and False otherwise + :rtype: bool + + + .. method:: drop_tables(self, tables: List[str], *args, **kwargs) + :abstractmethod: + + + Delete tables from the repository + + :param tables: Name of the tables to delete + :type tables: List[str] + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + + + .. method:: create_element(self, table: str, obj: AbstractEntry, *args, **kwargs) + :abstractmethod: + + + Insert a new element in the table + + :param table: Name of the table to create the entry + :type table: str + :param obj: Entry to be inserted, class derived from ``AbstractEntry`` + :type obj: AbstractEntry + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + + + .. method:: retrieve_elements(self, table: str, cast_to: type, **where) + :abstractmethod: + + + Retrieve elements from a table in the database, basing on a simle keyworded query + + :param table: Name of the table to retrieve the elements + :type table: str + :param cast_to: Type to cast the elements after retrieval from the database (Derived from ``AbstractEntry`) + :type cast_to: type + :param where: Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1') + :type where: Dict[str,Any] + :return: List of the elements that matches the creteria + :rtype: List[Any] + + + .. method:: update_element(self, table: str, obj: AbstractEntry, **where) + :abstractmethod: + + + Update an element from the database table with another one, matching a criteria + + :param table: Name of the table do modify the element + :type table: str + :param obj: New element to be inserted (Derived from ``AbstractEntry`) + :type obj: AbstractEntry + :param where: Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1') + :type where: Dict[str,Any] + :return: None + + + .. method:: drop_elements(self, table: str, **where) + :abstractmethod: + + + Delete elements from a database table that matches a criteria + + :param table: Name of the table that elements will be deleted + :type table: str + :param where: + :param where: Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1') + :type where: Dict[str,Any] + :return: None + + + +.. py:class:: TinyDBRepository(repository_path: str, create_repository: bool, storage_type: str = DEFAULT_STORAGE_TYPE, *args, **kwargs) + + Bases: :class:`clap.common.repository.AbstractRepository` + + Repository implementation using the tinydb, document-oriented database. + + + .. attribute:: __repository_id__ + :annotation: = tinydb + + + + .. attribute:: __repository_name__ + :annotation: = TinyDB Repository + + + + .. attribute:: __repository_version__ + :annotation: = 0.1.0 + + + + .. attribute:: DEFAULT_STORAGE_TYPE + :annotation: = json + + + + .. attribute:: __storage_types_map + + + + + .. method:: create_table(self, table: str, *args, **kwargs) + + + Create a new table in the database + + :param table: Name of the table to be created + :type table: str + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + :raises TableAlreadyExists: if a table with the same name already exists in the database + + + .. method:: retrieve_tables(self) + + + Get the names of all tables in the database + + :return: List with the table names + :rtype: List[str] + + + .. method:: exists_table(self, table: str, *args, **kwargs) + + + Check if a table already exists in database + + :param table: Name of the table + :type table: str + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: True if the table exists, False otherwise + :rtype: bool + + + .. method:: drop_tables(self, tables: List[str], *args, **kwargs) + + + Delete tables from the database + + :param tables: Names of the tables to be removed + :type tables: List[str] + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + + + .. method:: create_element(self, table: str, obj: AbstractEntry, *args, **kwargs) + + + Insert elements in a database table + + :param table: Name of the table to insert the element + :type table: str + :param obj: Element to be inserted (derived from ``AbstractEntry``) + :type obj: AbstractEntry + :param args: Additional arguments to be used + :param kwargs: Additional keyword arguments to be used + :return: None + :raises ValueError: If table name is invalid + + + .. method:: retrieve_elements(self, table: str, cast_to: type = dict, **where) + + + Retrieve elements from the database that match a criteria + + :param table: Name of the table to retrieve the elements + :type table: str + :param cast_to: Type that the elements will be casted after retrieved (derived from ``AbstractEntry``) + :type cast_to: type + :param where: Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1'). + If no conditions are passed all elements are retrieved + :type where: Dict[str,Any] + :return: List with the elements retrieved, properly casted to the type passed + :rtype: List[Any] + :raises ValueError: If table name is invalid + + + .. method:: update_element(self, table: str, obj: AbstractEntry, **where) + + + Update an element (or elements) matching some creiterias, replacing it with another one. + + :param table: Name of the table that the element will be updated + :type table: str + :param obj: Entry to be inserted (derived from ``AbstractEntry``) + :type obj: AbstractEntry + :param where: Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1'). + If no conditions are the first retrived element in the table will be updated + :return: None + :raises ValueError: If table name is invalid + + + .. method:: drop_elements(self, table: str, **where) + + + Remove elements from a table + + :param table: Name of the table that the elements will be removed + :type table: str + :param where: Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. + Elements that match the conditions will be retrieved (e.g. person_id='person1'). + A clause must be specified! + :return: + :raises ValueError: If table name is invalid + + + +.. function:: generic_read_entry(info_type: type, repository: AbstractRepository, table: str, **where) -> list + + Helper method to read an entry from a repository + + :param info_type: Type of the entry that will be read. The type of the element must derive from AbstractDescriptorEntry + :type info_type: AbstractEntry + :param repository: Repository object used to read the element from + :type repository: AbstractRepository + :param table: Table of the repository where the element will be retrieved + :type table: str + :param where: The clauses to be matched when searching an entry + :type where: Dict[Any, Any] + :return: List of elements matching the criteria passed. The elements are all converted to `info_type` argument type + :rtype: list + + +.. function:: generic_write_entry(info: AbstractEntry, repository: AbstractRepository, table: str, create: bool = False, **where) + + Helper method to write an entry in a repository + + :param info: Information to be written in repository (derived from AbstractDescriptorEntry class) + :type info: AbstractEntry + :param repository: Repository object used to write the element to + :type repository: AbstractRepository + :param table: Table of the repository where the element will be created/updated + :type table: str + :param create: If true it will create a element in the repository and if false, it will update. If the repository implementation supports insertion upon update, the element will be created when updating, else an exception will be raised + :type create: bool + :param where: The clauses to be matched when updating an entry + :type where: Dict[Any, Any] + + +.. function:: check_and_create_table(repository: AbstractRepository, table_name: str, exists: str) -> bool + + Check if table exists and creates table based on `exists` variable policy. The table is always created if it does not exists + + :param repository: Repository that the table will be created + :type repository: AbstractRepository + :param table_name: Name of the table to be created + :param table_name: str + :param exists: Policy taken when the table already exists. This parameter can be: + 'pass' (default): will do nothing + 'fail': will raise `TableAlreadyExists` exception + 'overwrite': will drop the old table and create a new table + :return: True indicating if the a new table was created, False otherwise + :rtype: bool + :raises: + TableAlreadyExists + If table already exists and 'fail' parameter is passed + ValueError + If exists parameter is invalid + + +.. py:class:: RepositoryFactory + + .. method:: get_repository(repository: str, repository_type: str = Defaults.REPOSITORY_TYPE, storage_type: str = None, create_new: bool = True) + :staticmethod: + + + Get a repository, based on a implementation of the ``AbstractRepository`` class. + + :param repository: Name of the repository to get + :type repository: str + :param repository_type: Repository implementation type (default is ``tinydb`` repository imlpementation) + :type repository_type: str + :param storage_type: Type of the storage (default is json) + :type storage_type: str + :param create_new: True to create a new repository (overwriting an existent one), false otherwise (default is True) + :type create_new: bool + :return: The repository in the specified implementation (derived from ``AbstractRepository``) + :rtype: AbstractRepository + :raises ValueError: If the repository implementation type is invalid + + + .. method:: exists_repository(repository: str, repository_type=Defaults.REPOSITORY_TYPE) + :staticmethod: + + + Check if a repository already exists + + :param repository: Name of the repository + :type repository: str + :param repository_type: Repository implementation type (default is ``tinydb`` repository imlpementation) + :type repository_type: str + :return: True of the repository already exists and false otherwise + :rtype: bool + :raises ValueError: If the repository implementation type is invalid + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/common/utils/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/common/utils/index.rst.txt new file mode 100644 index 00000000..7e2e6f24 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/common/utils/index.rst.txt @@ -0,0 +1,61 @@ +:mod:`clap.common.utils` +======================== + +.. py:module:: clap.common.utils + + +Module Contents +--------------- + +.. data:: log + + + + +.. function:: setup_log(log_name: str = None, verbosity_level: int = logging.INFO, filename: str = '') + + +.. py:class:: Struct(initializer=None, **kwargs) + + Bases: :class:`collections.abc.MutableMapping`, :class:`object` + + .. method:: copy(self) + + + Return a (shallow) copy of this `Struct` instance. + + + .. method:: __delitem__(self, name) + + + + .. method:: __getitem__(self, name) + + + + .. method:: __setitem__(self, name, val) + + + + .. method:: __iter__(self) + + + + .. method:: __len__(self) + + + + .. method:: keys(self) + + + + +.. function:: path_extend(*args) -> str + + +.. function:: get_file_checksum(file_path: str) -> str + + +.. function:: yaml_load(filename: str) -> dict + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/driver/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/driver/index.rst.txt new file mode 100644 index 00000000..bce9f11b --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/driver/index.rst.txt @@ -0,0 +1,145 @@ +:mod:`clap.drivers.elasticluster.driver` +======================================== + +.. py:module:: clap.drivers.elasticluster.driver + + +Module Contents +--------------- + +.. py:class:: ElasticCreator + + .. method:: create_cluster_obj(cluster_name: str, provider_config: dict, login_config: dict, instances: dict, login_name: str, provider_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = Defaults.DEFAULT_CONF_TYPE) + :staticmethod: + + + + .. method:: update_cluster_config(cluster_name: str, provider_config: dict, login_config: dict, instances: dict, login_name: str, provider_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = Defaults.DEFAULT_CONF_TYPE) + :staticmethod: + + + + .. method:: upddate_cluster_node(cluster: Cluster, node: Node) + :staticmethod: + + + + .. method:: __to_elasticluster_config(cluster_name: str, instances: Dict[str, Any], login_configs: Dict[str, Any], provider_configs: Dict[str, Any], login_name: str, provider_name: str) + :staticmethod: + + + + .. method:: get_all_cluster_objs(storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json') + :staticmethod: + + + + .. method:: get_cluster_obj(cluster_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json') + :staticmethod: + + + + .. method:: exists_cluster(cluster_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json') + :staticmethod: + + + + .. method:: get_node_from_cluster(cluster_name: str, node_name: str) + :staticmethod: + + + + .. method:: get_nodes_from_cluster(cluster_name: str, nodes: List[str]) + :staticmethod: + + + + .. method:: get_final_config(eclasticluster_config_file: str) + :staticmethod: + + + + +.. py:class:: AnsibleSetupProviderWrapper(ansible_provider: AnsibleSetupProvider, kind_groups_map: Dict[str, List[str]], kind_key_value_vars: Dict[str, Dict[str, str]], node_name_id_map: Dict[str, str]) + + Bases: :class:`elasticluster.providers.ansible_provider.AnsibleSetupProvider` + + .. method:: run_playbook(self, cluster: Cluster, nodes: List[Node], playbook: str, extra_args=tuple()) + + + + .. method:: build_inventory(self, cluster: Cluster, nodes: List[Node]) + + + + .. method:: _write_extra_vars(self, cluster, filename='extra_vars.yml') + + + + +.. function:: elaticluster_start_nodes(cluster_name: str, instances_num: Dict[str, int], storage_path: str = Defaults.elasticluster_storage_path, max_concurrent_requests: int = 0) -> Tuple[Cluster, Set[Node]] + + +.. function:: elasticluster_check_starting_nodes(cluster: Cluster, node_objs: Set[Node]) + + +.. function:: elasticluster_stop_nodes(cluster_name: str, nodes: List[str], *args, **kwargs) -> None + + +.. function:: elasticluster_pause_nodes(cluster_name: str, nodes: List[str]) -> None + + +.. function:: elasticluster_get_connection_to_node(cluster_name: str, node_name: str, *args, **kwargs) -> paramiko.SSHClient + + +.. py:class:: ElasticlusterInterface(repository_operator: RepositoryOperations) + + Bases: :class:`clap.common.driver.AbstractInstanceInterface` + + .. attribute:: __interface_id__ + :annotation: = elasticluster + + + + .. method:: __get_updated_cluster(self, cluster_id: str) + + + + .. method:: __get_or_create_cluster(self, cloud_conf: str, login_conf: str) + + + + .. method:: __stop_cluster(self, cluster_id: str, *args, **kwargs) + + + + .. method:: start_nodes(self, instances_num: Dict[str, int]) + + + + .. method:: stop_nodes(self, node_ids: List[str]) + + + + .. method:: pause_nodes(self, node_ids: List[str]) + + + + .. method:: resume_nodes(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: check_nodes_alive(self, node_ids: List[str]) + + + + .. method:: get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs) + + + + .. method:: execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None) + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/index.rst.txt new file mode 100644 index 00000000..152f151a --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/drivers/elasticluster/index.rst.txt @@ -0,0 +1,74 @@ +:mod:`clap.drivers.elasticluster` +================================= + +.. py:module:: clap.drivers.elasticluster + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + driver/index.rst + + +Package Contents +---------------- + +.. py:class:: ElasticlusterInterface(repository_operator: RepositoryOperations) + + Bases: :class:`clap.common.driver.AbstractInstanceInterface` + + .. attribute:: __interface_id__ + :annotation: = elasticluster + + + + .. method:: __get_updated_cluster(self, cluster_id: str) + + + + .. method:: __get_or_create_cluster(self, cloud_conf: str, login_conf: str) + + + + .. method:: __stop_cluster(self, cluster_id: str, *args, **kwargs) + + + + .. method:: start_nodes(self, instances_num: Dict[str, int]) + + + + .. method:: stop_nodes(self, node_ids: List[str]) + + + + .. method:: pause_nodes(self, node_ids: List[str]) + + + + .. method:: resume_nodes(self, node_ids: List[str]) + :abstractmethod: + + + + .. method:: check_nodes_alive(self, node_ids: List[str]) + + + + .. method:: get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs) + + + + .. method:: execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None) + + + + +.. data:: interface + + + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/drivers/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/drivers/index.rst.txt new file mode 100644 index 00000000..a5cf02bd --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/drivers/index.rst.txt @@ -0,0 +1,15 @@ +:mod:`clap.drivers` +=================== + +.. py:module:: clap.drivers + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + elasticluster/index.rst + + diff --git a/docs/source/_build/html/_sources/autoapi/clap/index.rst.txt b/docs/source/_build/html/_sources/autoapi/clap/index.rst.txt new file mode 100644 index 00000000..cec14d6c --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/clap/index.rst.txt @@ -0,0 +1,16 @@ +:mod:`clap` +=========== + +.. py:module:: clap + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + common/index.rst + drivers/index.rst + + diff --git a/docs/source/_build/html/_sources/autoapi/index.rst.txt b/docs/source/_build/html/_sources/autoapi/index.rst.txt new file mode 100644 index 00000000..a9340c14 --- /dev/null +++ b/docs/source/_build/html/_sources/autoapi/index.rst.txt @@ -0,0 +1,11 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + /autoapi/clap/index + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/docs/source/_build/html/_sources/configuration.rst.txt b/docs/source/_build/html/_sources/configuration.rst.txt new file mode 100644 index 00000000..9c3c049e --- /dev/null +++ b/docs/source/_build/html/_sources/configuration.rst.txt @@ -0,0 +1,272 @@ +========================== +Basic Configuration Setup +========================== + +In order to create compute nodes and interact with them, you will need provide some information about the cloud provider, the login used to connect to the instances and the desired instances. +By default, CLAP holds all of it information inside the ``~/.clap`` directory (``~`` stands for the user home directory). The minimal structure of ``~/.clap`` directory is shown below: + +:: + + ~/ + └── .clap/ + ├── configs/ + │   ├── instances.yaml + │   ├── logins.yaml + │   └── providers.yaml + ├── groups/ + │   ├── groups/ + │   ├── group_vars/ + │   │   └── all.yml + │   ├── main.yml + │   └── roles/ + ├── modules/ + ├── private/ + └── storage/ + ├── clusters.d/ + └── platform.json + + +- The ``~/.clap/configs/providers.yaml`` `YAML `_ file inside the ``~/.clap/configs`` directory holds the information about the cloud provider and how to connect to it. + +- The ``~/.clap/configs/logins.yaml`` file holds information about how to connect to an instance (e.g. login user, keyfile, etc) + +- The ``~/.clap/configs/instances.yaml`` holds the information about the instances to launch, i.e. the instance templates. + +- The ``groups`` directory store groups file and actions, used to perform action in several nodes. More detailed information about groups and actions will be presented at :doc:`groups section ` + +- The ``modules`` directory store module files, used to extend clap CLI application. + +- The ``private`` stores keys and passwords files used to connect to the cloud provider and to the instance itself. Every key/secret files needed in the configuration sections must be placed inside this directory + +- The ``storage`` directory store metadata information used by ``clap`` (this directory may also contain sensitive information) + +To launch an instance and use the CLAP capabilities, you will first need to configure an instance template. + +In the following sections, it will be shown how to configure the above files used to launch instances and all the valid information that can be used in it. + +============================= +Cloud provider configuration +============================= + +The ``~/.clap/configs/providers.yaml`` file defines all properties needed to connect to a specific cloud provider. +An example ``providers.yaml`` file is shown below (in YAML format). + +:: + + aws-east-1-config: # Name of the provider config (Provider ID) + provider: aws # Provider (currently only aws) + access_keyfile: ec2_access_key.pub # Name of the file in the ~/.clap/private/ directory containing the AWS access key ID + secret_access_keyfile: ec2_access_key.pem # Name of the file in the ~/.clap/private directory containing the AWS Secret Access Key (access ID) + url: https://ec2.us-east-1.amazonaws.com # URL of the EC2 endpoint (usually something like this one...) + region: us-east-1 # The availability zone you want to use + + my-config2: + provider: aws + ... + +The YAML dictionary keys are the name of the provider configuration (also called provider ID, ``aws-east-1-config`` and ``my-config2`` in this example) and the values are the specific information about that configuration. +You can define as many provider configurations as you want just adding a new provider ID and the values for it. Note that each provider ID must be unique. +Other sections will refer to a provider configuration by its provider ID. +The valid values for a provider configuration are: + +.. list-table:: Valid provider configuration key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **provider** + - 'aws' + - Name of the cloud provider to be used + + * - **access_keyfile** + - + - Name of the file containing the AWS access key ID. The file must be at ``~/.clap/private`` (see below) + + * - **secret_access_keyfile** + - + - Name of the file containing the AWS Secret Access Key (access ID). The file must be at ``~/.clap/private`` (see below) + + * - **url** + - + - URL of the EC2 endpoint (usually something like ``https://ec2.us-east-1.amazonaws.com``) + + * - **region** + - + - The availability zone you want to use (e.g. ``us-east-1``) + + * - **vpc (optional)** + - + - Name or ID of the AWS Virtual Private Cloud to provision resources in. + + +Access keys consist of two parts: an access key ID (for example, ``AKIAIOSFODNN7EXAMPLE``) and a secret access key (for example, ``wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY``). +These keys are **required** and is used to connect to the aws provider via third-party applications. (See the `AWS Access Keys documentation `_ for more information). + +For CLAP, all keys must be stored at ``~/.clap/private/`` directory with 400 permission (use the ``chmod 400`` command to set the read-only permission). +So you must place your access key ID string inside a file in the ``~/.clap/private/`` (e.g, copy and paste access key ID in a file and save at ``~/.clap/private/ec2_access_key.pub``) and the same for the secret access key. + +Once the files are in the ``~/.clap/private/`` directory, the values of the ``access_keyfile`` and ``secret_access_keyfile`` keys in your provider configuration must only contain the filename, not the whole path. (e.g. **only** the file name: ``ec2_access_key.pub`` and not ``~/.clap/private/ec2_access_key.pub``) + + +============================= +Login provider configuration +============================= + +The login contains information on how to access the instances started on the cloud via SSH. So, the section holds information about the userto perform login, the SSH keyfile to log in the machine and others. +The ``~/.clap/configs/logins.yaml`` file must be populated with desired information. +An example ``logins.yaml`` file is shown below (in YAML format). + +:: + + ubuntu-login: # Name of the login config (Login ID) + user: ubuntu # Login name used to SSH into the virtual machine + keypair_name: key_us_east_1 # Name of the keypair to use on the cloud provider + keypair_public_file: key_us_east_1.pub # Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file + keypair_private_file: key_us_east_1.pem # Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine. + sudo: true # True if the sudo_user can execute commands as root by running the sudo command + sudo_user: root # (OPTIONAL) Login name of the super user (default is root) + + example-centos: + user: centos + ... + + +The YAML dictionary keys are the name of the login configuration (also called login ID, ``ubuntu-login`` and ``example-centos`` in this example) and the values are the specific information about that configuration. +You can define as many login configurations as you want just adding a new login ID and the values for it. Note that each login ID must be unique. +Other sections will refer to a login configuration by its provider ID. +The valid values for a login configuration are: + + +.. list-table:: Valid login configuration key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **user** + - + - Name of the user used to perform SSH into the virtual machine + + * - **keypair_name** + - + - Name of the keypair to use on the cloud provider (see more below) + + * - **keypair_public_file** + - + - Name of the file in the ``~/.clap/private`` directory containing the RSA/DSA public key corresponding to the private key file + + * - **keypair_private_file** + - + - Name of the file in the ``~/.clap/private`` directory containing a valid SSH private key to be used to connect to the virtual machine + + * - **sudo** + - + - True if the sudo user can execute commands as root by running the sudo command + + * - **sudo_user (optional)** + - + - Optional login name of the super user (default is root) + +The keypair is used to login to the machine without password (and perform SSH). For AWS users, the keypair can be generated in the menu: ``EC2 --> Network & Security --> Key Pairs``. +A keypair can be created using the ``create key pair`` button providing an unique keypair name (this name is used in the ``keypair_name`` field of the login configuration). +When a keypair is created, a private key file is generated to download. This is the **private key file** (used to login to the instances). + +For CLAP, all key files must be placed in the ``~/.clap/private/`` directory with 400 permission. +In the **keypair_private_file** login configuration field, the name of the private key file inside the ``~/.clap/private/`` must be inserted (e.g. **only** the file name: ``key_us_east_1.pem.pem`` and not ``~/.clap/private/key_us_east_1.pem.pem``) + +Having the private key, the public key can be obtained with the command ``ssh-keygen -y -f /path_to_key_pair/my-key-pair.pem`` (where ``my-key_pair.pem`` is the private key file. See `AWS Keypair Documentation `_ for more details). +The generated public key must be saved to a file and placed at ``~/.clap/private/`` directory with 400 permission. So, in the ``keypair_public_file`` field of the login configuration, the name of the public key file must be inserted. + +================================= +Instance templates configuration +================================= + +To start virtual machines in a cloud, you must first setup some instance templates in the ``~/.clap/configs/instances.yaml`` file. +The template contains information about the virtual machine to start, including the flavor (instance type, e.g. t2.micro on EC2 provider), security group information, AMI used, the disk size and others. +The instance template references the provider configuration and login configuration by its ID. + +To create a new instance template you can edit the ``~/.clap/configs/instances.yaml`` file. +An example of ``instances.yaml`` is shown below. + +:: + + ubuntu-instance-aws # Name of the instance template (instance template ID) + provider: aws-east-1-config # Provider configuration ID + login: ubuntu-login # Login configuration ID + flavor: t2.medium # The VM "size" to use. Different cloud providers call it differently: could be "instance type", "instance size" or "flavor". + image_id: ami-07d0cf3af28718ef8 # Disk image ID to use in the VM. Amazon EC2 uses IDs like ami-123456 + security_group: xxx-secgroup # (OPTIONAL) Name of security group to use when starting the instance + boot_disk_size: 10 # (OPTIONAL) Size of the instance’s root filesystem volume, in Gibibytes (GiB) + boot_disk_device: /dev/sda1 # (OPTIONAL) Device name of the instance’s root file system in the block device mapping + boot_disk_type: gp2 # (OPTIONAL) Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (the default). + placement_group: XXX # (OPTIONAL) Placement group to enable low-latency networking between compute nodes + image_userdata: '...' # (OPTIONAL) Shell script to be executed (as root) when the machine starts. + network_ids: subnet-abcdfefxx # (OPTIONAL) Subnet IDs the nodes will be connected to + + instance-t2small-us-east-1: + provider: aws-east-1-config + ... + + +The YAML dictionary keys are the name of the instance templates (also called instance template ID, ``ubuntu-instance-aws`` and ``instance-t2small-us-east-1`` in this example) and the values are the specific information about that instance template. +You can define as many instance templates configurations as you want just adding a new instance template ID and the values for it. Note that each instance template ID must be unique. +Commands will use the instance template ID to launch instances based on this information. +The valid values for the instance templates are: + +.. list-table:: Valid instance template key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **provider** + - + - The ID of the provider configuration to be used for this instance. The ID must match the provider ID at ``providers.yaml`` + + * - **login** + - + - The ID of the login configuration to be used for this instance. The ID must match the login ID at ``logins.yaml`` + + * - **flavor** + - + - The provider instance type to use (e.g. t2.micro, c5.large, etc) + + * - **image_id** + - + - Disk image ID to use in the VM (basically the OS to be used). Amazon EC2 uses IDs like ``ami-123456``. Note that the image_id is dependent of the provider region and a error may be raised if an invalid ami is specified + + * - **security_group (optional)** + - + - Name of security group to use when starting the instance. The default security group is ``default`` + + * - **boot_disk_size (optional)** + - + - Size of the instance’s root filesystem volume, in Gibibytes (GiB) + + * - **boot_disk_device (optional)** + - + - Device name of the instance’s root file system in the block device mapping. For AWS, see `block device mapping docs `_ for more information + + * - **boot_disk_type (optional)** + - + - Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (default). See `Root filesystem volume storage type `_ for more information + + * - **placement_group (optional)** + - + - Placement group to enable low-latency networking between compute nodes. See `placement groups `_ for more information + + * - **image_userdata (optional)** + - + - Shell script to be executed (as root) when the machine starts. This shell script is executed before CLAP even gets a chance to connect to the VM. + + * - **network_ids (optional)** + - + - Subnet ID that the nodes of the cluster will be connected to + + +On Amazon EC2, the "default" security group only allows network communication among hosts in the group and does not allow SSH connections from the outside. +This will make ElastiCluster driver to fail as it cannot connect to the cluster nodes. You will need to add rules to the "default" security group (or create a new one and use that) such that the SSH connections from the network where you run CLAP are allowed. diff --git a/docs/source/_build/html/_sources/groups.rst.txt b/docs/source/_build/html/_sources/groups.rst.txt new file mode 100644 index 00000000..9f9e9307 --- /dev/null +++ b/docs/source/_build/html/_sources/groups.rst.txt @@ -0,0 +1,274 @@ +========================== +Groups +========================== + +In order to perform pre-defined actions in several nodes in a row, CLAP uses the concept of groups, powered by `Ansible playbooks `_. Playbooks can be used to manage configurations of and deployments to remote machines. +Nodes can be added to and removed from a group and also, a node may belong to multiple groups at once. + +Every group have some actions associated with it. For instance, when a node is being added to a group the group's ``setup`` action takes place, +configuring the node to belong to that particular group (e.g. installing desired packages, start services, etc). Basically a group defines a set of actions that can be performed to nodes that belongs to it. +When a node is successfully added to a group we are saying that all operations defined by this group can be performed by that node. + +We now explain better the group concept and the commands used to it. +The :doc:`shared groups section ` describes the groups distributed with the CLAP and the :doc:`tutorials section ` describes how to implement a new group and other tips. + +==================================== +Working Groups in CLAP +==================================== + +By default CLAP groups are stored in the ``~/.clap/groups/`` directory. An example directory tree, starting from ``~/.clap/groups/`` directory is shown below: + +:: + + groups/ + ├── main.yml + ├── groups/ + | ├── group1.py + | └── group2.py + ├── group_vars/ + │   └── all.yml + └── roles/ + ├── group1.yml + ├── group2.yml + ├── group-role-1/ + | └── tasks/ + | └── main.yml + └── group-role-2/ + └── tasks/ + └── main.yml + + +The groups directory tree format follow the `Ansible directory layout `_ for content organization. + +* The ``groups/main.yml`` is the default entry point for all group playbooks (it should not be edited) + +* The ``groups/groups/`` directory contain files specifying the group and which action the nodes of the group can perform. + In general, this directory contains python files, where every python file determines a group (the name of the python file is the group name). + + Let's look at an example group file at ``groups/groups/group1.py`` (where the group is called ``group1``) + +.. code-block:: python + + playbook = 'roles/group1.yml' + actions = ['setup', 'start', 'terminate'] + +This file defines: + 1. The ``playbook`` (string variable) to be executed when a group command is invoked + 2. The ``actions`` (list of strings variable) that can be performed at nodes of this group. + For this example the ``setup``, ``start`` and ``terminate`` actions can be performed in the nodes belonging to the ``group1`` (for a minimal group, at least the ``setup`` action must be defined). + + 3. Then, the ``roles/group1.yml`` may select the desired tasks to execute based on the ``action`` parameter received. + Shortly, we will explain the group action commands to become clearer. + + In this way, you can define as much groups as you want, just creating a new python file in the ``groups/groups/`` directory. + The name of the file will be the group name and the file must contains the ``playbook`` variable (string) and the ``actions`` variable (list of strings). + **NOTE**: The ``setup`` action is mandatory + +* The ``groups/group_vars`` directory holds common variables for all groups (usually you do not need to edit this file) + +* The ``groups/roles`` define the Ansible roles, used by groups. + 1. The ``*.yml`` files inside this directory are the playbooks executed by a group (specified in the group's python file). + This playbook include roles conditionally based on the ``action`` parameter + 2. The directories inside ``groups/roles`` directory are `Ansible Roles `_. + Roles are ways of automatically loading desired variables based on a known file structure. + Inside of every role directory, a exists a ``tasks`` directory. + The ``main.yml`` inside the tasks directory defines the tasks to be executed when the role in included. + + For more information about roles see `Ansible Roles `_. + See the :doc:`tutorials section ` to better understanding how to create a group ans use roles. + +=============================== +Group Commands +=============================== + +You can see the available groups and their actions with the command below: + +:: + + clapp group list + +And the example output would be: + +:: + + * docker-ce (roles/docker-ce.yml) + actions: setup, start-container, stop-container + + * ec2-efs (roles/ec2-efs.yml) + actions: mount, setup, umount + + Listed 2 groups + +As shown, we have the ``ec2-efs`` and ``docker-ce`` groups, each one with their actions associated. + + +Once nodes are up and started you can perform actions in several nodes by using groups. +So, you first must to add the desired nodes to a group which can be accomplished by using the command below: + +:: + + clapp group add example_group node-0 node-1 ... + +This command will add the nodes ``node-0`` and ``node-1`` to the group called ``example_group``. Note that you can add more nodes to the group, just appending more node ids in the list. +When a node is added to a group, the group's ``setup`` action takes place configuring (e.g. installing packages, starting services) the nodes to belong to that particular group. +If the ``setup`` action fails, the node are not added to the group. + + You can see which group belongs each node using the ``clapp node list`` command. Each node can have belong to several groups as desired. + +After a node is added to a group, you can perform group actions using the command below: + +:: + + clapp group action example_group example_action + +Where the ``example_group`` is the group and ``example_action`` is the action to be performed for that group. +In this way, the ``example_action`` is executed in **all** nodes belonging to the ``example_group`` group. + +You can also filter a subset of nodes from the group to execute the action by using ``--nodes`` parameter to the group action command as below: + +:: + + clapp group action example_group example_action --nodes node-0 node-1 ... + +For this example, the ``example_action`` action is just performed in the nodes ``node-0`` and ``node-1``. + + **NOTE**: When filtering nodes with ``--nodes`` parameter, all nodes must belong to the desired group, else the action will fail. + +Sometimes, group actions may require some variables to be passed from the command-line. +You can use the ``extra`` parameter to pass keyworded values to the group, as the command below (also works for ``group add`` and ``group remove`` commands): + +:: + + clapp group action example_group example_action --nodes node-0 node-1 --extra variable1="value1" var2="another value" + +The above command pass the ``variable1``and ``var2`` to the group action. + + **NOTE**: The ``extra`` parameter must be the last in the command + +If a required vaiable is not passed the following error will appear (and action will fail): + +:: + + The task includes an option with an undefined variable. The error was: 'variable' is undefined. + + +And finally, you can remove a node from a group by using the ``group remove`` command as below: + +:: + + clapp group remove example_group node-0 node-1 + +Where in the above command, the nodes ``node-0`` and ``node-1`` will be removed from group ``example_group``. +Usually the remove action may stop services, uninstall packages or copy valuable data from the host. + +Some groups distributed with CLAP and their requirements can be found in the :doc:`groups shared with CLAP section `. + + **NOTE**: You may want to use the ``-v`` (verbose) parameter for clap to show all Ansible messages (not only error messages) + +=============================== +Group Hosts +=============================== + +Group may also have hosts to orchestrate the group action in different nodes. +Hosts are subsets of nodes of a group and can be used to split the action to the different subsets of nodes. + +Suppose you have a group called ``example`` which provide means to execute a program that operates in a master/slave nodes fashion. +For the traditional operation, we instantiate the nodes and them adds them to the ``example`` group using the ``group add`` command. +How can we say each node of the group is the master and which nodes are the slaves? +You can use tags for that, but Ansible provides hosts, that bypass this problem. + +Let's look to an example group python file at ``groups/groups/example.py``: + +.. code-block:: python + + playbook = 'roles/example.yml' + actions = ['setup', 'start', 'terminate'] + hosts = ['master', 'slave'] + +The hosts variable is optional. For the example we have two hosts for group example: ``master`` and ``slave``. +So the nodes belonging to the group example can be master or slave or both. + +When hosts for a group is defined, the node must be added to the group and the host type must be speficied on the ``group add`` command as below: + +:: + + clapp group add example/master node-0 node-1 + +The above command adds the ``node-0`` and ``node-1`` to the group ``example`` being ``master`` hosts. +The backslash (/) character denotes the host of a group. The node can also be added to a group being a slave, using: + +:: + + clapp group add example/slave node-0 node-1 + +The above command adds the ``node-0`` and ``node-1`` to the group ``example`` being ``slave`` hosts. + +This format (group and hosts) CLAP can optimize Ansible execution. Playbooks can use the ``hosts`` keyword to perform a specific action to a group of nodes. +Anyway if no ``hosts`` is specified in the playbook, the playbook will execute in all nodes belonging to the group. + + **NOTE**: + * Hosts are optional + * If the group has hosts defined and in the add command no specific host is passed, this is, only the group name, the node is added to group and for all hosts that the group has defined. + So in the above example if the command below is executed + + :: + + clapp group add example node-0 node-1 + + nodes ``node-0`` and ``node-1`` will be added to hosts ``master`` and ``slaves`` of group ``example`` + +The ``group list`` command also list hosts when available to the group. See the example below (an output for ``group list`` command): + +:: + + * docker-ce (roles/docker-ce.yml) + actions: setup, start-container, stop-container + + * ec2-efs (roles/ec2-efs.yml) + actions: mount, setup, umount + + * example (roles/example.yml) + actions: setup, start-masters, start-slaves, terminate-all + hosts: master, slave + + Listed 3 groups + +In the above example, the group ``example`` has hosts ``master`` and ``slave`` so nodes can belong to ``example/master`` or ``example/slave`` (or both). +Some actions in the ``example`` group may execute in all hosts of the group (for instance ``setup`` and ``terminate-all``) and others may execute only in some hosts. +This is defined in the group implementation. + +Let's suppose the ``start-masters`` action for example group execute only in master hosts of the group, this is, inside the ``example.yml`` playbook the keyword ``hosts: master`` is defined for action ``start-masters``. +You just need to run the action command + +:: + + clapp group action example start-masters + +And the ``start-master`` action will only execute in nodes of the group ``example`` that is ``master`` hosts. + +More information about hosts can be found in the :doc:`tutorials section `. + +=============================== +Special variables tips +=============================== + +For all Ansible playbooks the following variables can be used: + + +.. list-table:: Some Ansible special variables + :header-rows: 1 + + * - **Name** + - **Description** + + * - ``inventory_name`` + - ID of the node performing the task (e.g. ``node-0``) + + * - ``ansible_host`` + - Connection IP used for the host + + * - ``elasticluster.nodes`` + - Dictionary with nodes performing the task. The dictionary key is the node id and the value is another dictionary with several information about the node (e.g. the instance id) + + * - ``ansible_user`` + - Name of the user used for login in the machine from a node \ No newline at end of file diff --git a/docs/source/_build/html/_sources/index.rst.txt b/docs/source/_build/html/_sources/index.rst.txt new file mode 100644 index 00000000..6cbafac8 --- /dev/null +++ b/docs/source/_build/html/_sources/index.rst.txt @@ -0,0 +1,38 @@ +========================== +CLAP +========================== + +CLoud Application Platform (CLAP) provides a interface to manage, interact and deploy HPC applications hosted in different cloud providers. +CLAP is based on the `elasticluster `_. project, a tool that allows automated setup of compute clusters +(MPI, Spark/Hadoop, etc) and their management. CLAP extend the project by allowing a simplified interface to interact with the compute nodes. +Some of the features are: + +- `YAML-Style `_. configuration files to define nodes, logins and cloud configurations +- User-friendly interface to create, setup, manage, interact and stop multiple computing nodes on different cloud providers at the same time +- Group system to easily perform actions in different heterogeneous nodes via `Ansible `_. playbooks +- Easy-to-use python API. + +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Table of Contents + :name: mastertoc + + installation + configuration + usage + groups + shared_groups + pythonapi + tutorials + troubleshooting + autoapi/index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/_build/html/_sources/installation.rst.txt b/docs/source/_build/html/_sources/installation.rst.txt new file mode 100644 index 00000000..5c138300 --- /dev/null +++ b/docs/source/_build/html/_sources/installation.rst.txt @@ -0,0 +1,48 @@ +========================== +Installation Guide +========================== + +1. Install requirement packages + +:: + + gcc g++ git libc6-dev libffi-dev libssl-dev python3-dev virtualenv python3 python3-pip + +2. Clone the repository with + +:: + + git clone https://github.com/lmcad-unicamp/CLAP.git clap + +3. Enter in clap directory with + +:: + + cd clap + +4. Set the install script to execute with ``chmod`` and run the script! + +:: + + chmod +x install.sh + ./install.sh + +5. To use ``clap``, you will need to activate the ``virtual-env``. + In the ``clap`` root directory run: + +:: + + source clap-env/bin/activate + +6. Try ``clap``, via the CLI interface: + +:: + + clapp -vv --show-all-help + +To use ``clap`` you will first need to provide some information to launch instances in the cloud. +The :doc:`configuration section ` section will guide you to write some configuration sections. +After the :doc:`usage section ` will show you how to run ``clap`` commands based on the configurations written. + +Section :doc:`groups ` will show group concepts to run action on several nodes in a row. +Also, the section shows how create your own groups and actions. diff --git a/docs/source/_build/html/_sources/pythonapi.rst.txt b/docs/source/_build/html/_sources/pythonapi.rst.txt new file mode 100644 index 00000000..c280d5f8 --- /dev/null +++ b/docs/source/_build/html/_sources/pythonapi.rst.txt @@ -0,0 +1,5 @@ +========================== +Python API +========================== + +Sorry, to be written... \ No newline at end of file diff --git a/docs/source/_build/html/_sources/shared_groups.rst.txt b/docs/source/_build/html/_sources/shared_groups.rst.txt new file mode 100644 index 00000000..8cc044d4 --- /dev/null +++ b/docs/source/_build/html/_sources/shared_groups.rst.txt @@ -0,0 +1,379 @@ +========================== +Groups shared with CLAP +========================== + +Here are some groups shared with CLAP. Setup action is **always** executed when adding a node to a group. +Also, the ``--nodes`` and ``--tag`` parameters can be passed to the ``clapp group action`` command to selectively select nodes inside the group that will execute the action, else the action will be performed in all nodes belonging to a group. + + +Commands common +=================== + +This group provide means to execute common known commands in several machines in the group, such as: reboot, copy files to nodes, copy and execute shell scripts, among others. +Consider add instances to this group to quickly perform common commands in several nodes in a row. + +No hosts are needed for this group. + +.. list-table:: Common available actions + :header-rows: 1 + + * - **Name** + - **Description** + + * - ``copy`` + - Copy a file from the localhost to the remote nodes + + * - ``fetch`` + - Fetch files from the remote nodes to the localhost + + * - ``reboot`` + - Reboot a machine and waits it to become available + + * - ``run-command`` + - Execute a **shell** command in the remote hosts + + * - ``run-script`` + - Transfer a script from localhost to remote nodes and execute it in the remote hosts + + * - ``update-packages`` + - Update packages in the remote hosts + +Variables and examples for each action is shown below + +-------------------------- +copy action variables +-------------------------- + +The following variables must be informed when running the ``copy`` action (via ``extra`` parameter) + +.. list-table:: Common-commands ``copy`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied to the remote hosts. If the path **is not absolute** (it is relative), it will search in the group's files directory else the file indicated will be copied. + If the file is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into (remote nodes) + + +Examples of the group's ``copy`` action is showed below: + +:: + + clapp group action commands-common copy --extra src="/home/ubuntu/file" dest="~" + +The above command copy the file at ``/home/ubuntu/file`` (localhost) the the ``~`` directory of the remote hosts + +Or, you can use filters such as ``--nodes`` and ``--tag`` to the ``clapp group action`` command to selectively specify which nodes inside the group the action will be executed + +:: + + clapp group action commands-common copy --nodes node-0 node-1 --extra src="/home/ubuntu/file" dest="~" + clapp group action commands-common copy --tag 'x=y' --extra src="/home/ubuntu/file" dest="~" + + +The above (first one) command copy the file at ``/home/ubuntu/file`` (localhost) the the ``~`` directory of the nodes ``node-0`` and ``node-1`` + +The above (second one) command copy the file at ``/home/ubuntu/file`` (localhost) the the ``~`` directory of all nodes in the belonging to the ``commands-common`` group, tagged with ``x=y`` + + +-------------------------- +fetch action variables +-------------------------- + +The following variables must be informed when running the ``fetch`` action (via ``extra`` parameter) + +.. list-table:: Common-commands ``fetch`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied from the remote hosts. + If the file is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into (localhost) + + +Examples of the group ``fetch`` action is showed below: + +:: + + clapp group action commands-common fetch --extra src="~/file" dest="/home/ubuntu/fetched_files/" + +The above command fetch a file at ``~/file`` directory from the nodes and place at the ``/home/ubuntu/fetched_files/`` directory of the localhost + + +-------------------------- +reboot action variables +-------------------------- + +This action does not require any additional variable to be passed + +:: + + clapp group action commands-common reboot + clapp group action commands-common reboot --nodes node-0 + clapp group action commands-common reboot --tag 'x=y' + +The first command reboot all machines belonging to the ``commands-common`` group. + +The second one reboot the ``node-0`` and the third one reboot the machines belonging to the group and tagged with ``'x=y'`` + + +------------------------------ +run-command action variables +------------------------------ + +The following variables must be informed when running the ``run-command`` action (via ``extra`` parameter) + +.. list-table:: Common-commands ``run-command`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``cmd`` + - string + - String with the command to be executed in the nodes + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used + + +Examples of the group ``run-command`` action is showed below: + +:: + + clapp group action commands-common run-command --extra cmd="ls" + clapp group action commands-common run-command --extra cmd="ls" workdir="/bin" + +The above command (first one) runs the command ``ls`` in the remote nodes + +The above command (second one) runs the command ``ls`` in the remote nodes, after changing to the "/bin" directory + +------------------------------ +run-script action variables +------------------------------ + +The following variables must be informed when running the ``run-script`` action (via ``extra`` parameter). + +.. list-table:: Common-commands ``run-script`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - string + - Shell script file to be executed in the remote nodes. The file will be first copied (from localhost) to the nodes and after will be executed. Note: the script file **must begin** with the bash shebang (``#!/bin/bash``). Also the script filepath must be **absolute** else, if relative path is passed, Ansible seach in the group's file directory. The script will be deleted from nodes after execution. + + * - ``args`` (optional) + - string + - Command-line arguments to be passed to the script. + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used (Path must be absolute for Unix-aware nodes) + + +Examples of the group ``run-script`` action is showed below: + +:: + + clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh" + clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh" args="1 2 3" + clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh" args="1 2 3" workdir="/home" + + +The above command (first one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it (similar to run ``bash -c echo.sh`` in the hosts). + +The above command (second one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it using the arguments "1 2 3" (similar to run ``bash -c echo.sh 1 2 3`` in the hosts). + +The above command (third one) is similar to the second one but will execute the script in the ``/home`` directory. + + +---------------------------------- +update-packages action variables +---------------------------------- + +This action does not require any additional variable to be passed + +:: + + clapp group action commands-common update-packages + +The above command will update the package list from remote hosts (similar to ``apt update`` command) + + + +EC2 Common +==================== + +This group provide means to interact with AWS EC2 instances, such as pausing and resuming nodes + +The actions for the group is listed below (the ``setup`` action is automatically executed when the node is added to the group). +No hosts are needed for this group. + +.. list-table:: EC2 Common group actions + :header-rows: 1 + + * - **Name** + - **Description** + + * - ``pause`` + - Pause (stop) instances in the EC2 cloud + + * - ``resume`` + - Resume paused (stopped) instances in the EC2 cloud + +Example of the command is showed below: + +- Adding nodes to the group + +:: + + clapp group add ec2-common node-0 + +The above command add ``node-0`` to the EC2 Common group + + +- Pausing (stopping) intances + +:: + + clapp group action ec2-common pause + clapp group action ec2-common pause --nodes node-0 node-1 + +For the above commands, the first one pause (stop) all EC2 instances belonging tho the EC2 Common group +and the second one pause only the nodes ``node-0`` and ``node-1``. + + +EC2 EFS +==================== + +This group setup and mount an network EFS filesystem on AWS provider. + +The actions for the group is listed below (the ``setup`` action is automatically executed when the node is added to the group). +No hosts are needed for this group. + + +.. list-table:: EC2 EFS group actions + :header-rows: 1 + + * - **Name** + - **Description** + + * - ``setup`` + - Install nfs client and mount EC2 file system + + * - ``umount`` + - Umount EC2 File System + +--------------------------- +Setup action variables +--------------------------- + +The following variables must be informed when running the ``setup`` action (via ``extra`` parameter) + +.. list-table:: EC2 EFS ``setup`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_point`` + - path + - Directory path where the filesystem will be mounted + + * - ``user`` + - string + - Name of the user owner (e.g. ubuntu) + + * - ``group`` + - string + - Name of the group owner (e.g. ubuntu) + + * - ``mount_ip`` + - string + - Mount ip of the filesystem (see `AWS EFS Documentation `_ for more information) + + * - ``mount_permissions`` + - string + - Permission used tomount the filesystem (e.g. 0644) + + +An example of the command would be: + +:: + + clapp group add ec2-efs node-0 --extra efs_mount_point="/efs" user="ubuntu" group="ubuntu" mount_ip="192.168.0.1" mount_permissions="0644" + +The above command will install and mount EC2 EFS filesystem on ``node-0`` + + +--------------------------- +Umount action variables +--------------------------- + +The following variables must be informed when running the ``umount`` action (via ``extra`` parameter) + +.. list-table:: EC2 EFS ``umount`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_point`` + - path + - Directory path where the filesystem will be unmounted + + +An example of the command would be: + +:: + + clapp group action ec2-efs umount --nodes node-0 --extra efs_mount_point="/efs" + +The above command will unmount EC2 EFS filesystem from ``node-0`` + + + + +Docker +==================== + +This group installs docker-ce in debian and red-hat based systems + +The actions for the group is listed below (the ``setup`` action is automatically executed when the node is added to the group). +No hosts are needed for this group. + + +.. list-table:: Docker group + :header-rows: 1 + + * - **Name** + - **Description** + + * - ``setup`` + - Install docker-ce and start the service + + +No additional variables is needed for the group diff --git a/docs/source/_build/html/_sources/troubleshooting.rst.txt b/docs/source/_build/html/_sources/troubleshooting.rst.txt new file mode 100644 index 00000000..0213db2b --- /dev/null +++ b/docs/source/_build/html/_sources/troubleshooting.rst.txt @@ -0,0 +1,5 @@ +...................... +Troubleshooting +...................... + +Sorry, to be written... \ No newline at end of file diff --git a/docs/source/_build/html/_sources/tutorials.rst.txt b/docs/source/_build/html/_sources/tutorials.rst.txt new file mode 100644 index 00000000..b840066d --- /dev/null +++ b/docs/source/_build/html/_sources/tutorials.rst.txt @@ -0,0 +1,5 @@ +========================== +Tutorials +========================== + +Sorry, to be written... \ No newline at end of file diff --git a/docs/source/_build/html/_sources/usage.rst.txt b/docs/source/_build/html/_sources/usage.rst.txt new file mode 100644 index 00000000..f4a4223d --- /dev/null +++ b/docs/source/_build/html/_sources/usage.rst.txt @@ -0,0 +1,199 @@ +========================== +Usage +========================== + +CLAP is a platform to start, stop and manage instances (nodes) in different cloud providers transparently. +CLAP also offer mechanisms to control what is installed in each node and to perform actions in a group of nodes in a row. + +This section describes the common use commands to start, stop and manage instances. + +To use clap, first activate the virtual environment running the following command (inside CLAP directory): + +:: + + source clap-env/bin/activate + +CLAP has several commands, you can use + +:: + + clapp -v --show-all + +command to get information about all available commands. +Alternatively you can use ``--help`` in each command to see the features. +The ``-v`` parameter can always be used, increasing he verbosity level of CLAP. ``-vv`` allows showing DEBUG messages. + + +------------------------- +List available instances +------------------------- + +To list the nodes managed by CLAP, you can use the command: + +:: + + clapp node list + +If there is any node already instantiated, an example output is shown below: + +:: + + * Node(id=`node-1`, instance_type=`type-a`, status=`reachable`, provider_id: `aws-config-us-east-1`, connection_ip=`54.89.209.193`, groups=`spits/jobmanager`, tags=`spits=cluster-spits`) + * Node(id=`node-2`, instance_type=`type-a`, status=`reachable`, provider_id: `aws-config-us-east-1`, connection_ip=`54.157.8.46`, groups=`spits/taskmanager`, tags=`spits=cluster-spits`) + Listed 2 nodes(s) + +For several commands, CLAP uses the node id (e.g. ``node-1``, ``node-2``) to perform operation in the nodes, transparently. +Nodes may have tags (discussed lately) to easily perform selections and mey belong to groups, to perform group actions (discussed later). + +You may want to see the :doc:`troubleshooting page ` if any failure occurs when working with nodes. + +------------------------------------ +Start Instances and Check Aliveness +------------------------------------ + +To instantiate one node based on an instance template defined in the ``~/.clap/configs/instances.yaml`` file, you can use the command: + +:: + + clapp -v node start ubuntu-instance-aws + + +Where the ``ubuntu-instance-aws`` refers to the instance template ID defined in the ``~/.clap/configs/instances.yaml`` file. +In this way, you need to configure the files only once and launch instances any time. + +To launch more than one machine with the same instance template ID, you can put the desired number after the instance template ID preceded by an ``:``. For instance, the command below: + +:: + + clapp -v node start ubuntu-instance-aws:4 + +Instantiates 4 ``ubuntu-instance-aws`` virtual machines in a row! +Once the instance is started, CLAP will try to login (via SSH) with the login information provided. +The machine is considered instantiated when the SSH connection is performed successfully. Machines instantiated that cannot perform SSH in a timeout (600 seconds) are automatically **stopped**. + +You can also instantiate different machines in a row using the same command, but just appending more instance template IDs to it: + +:: + + clapp -v node start ubuntu-instance-aws:2 example-instance-aws:2 + +The above command instantiates 2 ``ubuntu-instance-aws`` machines and 2 ``example-instance-aws`` machines in a row! + +Once instances are successfully started, CLAP will assign to each one an unique node ID used to perform other operations to it. +The ``clapp node list`` command can be used to show managed clap instances and a more detailed information of a specific node can be obtained with the command below: + +:: + + clapp node show node-1 + +Replacing ``node-1`` with the id of the node to be detailed. + +**NOTE** + +* If the message below appears, don't worry, just ignore it. + +:: + + [ERROR] Thread-XXX: Apparently, Amazon does not compute the RSA key fingerprint as we do! We cannot check if the uploaded keypair is correct! + + +After the node is started, you can check if it is alive using the command below: + +:: + + clapp node alive node-1 ... + +Where ``node-0`` must be replaced with the node ID of interest. Also, more nodes can be checked, simple appending their node IDs to the command. + +The ``node alive`` command also updates the node connection IP and can be very useful when the node IP changes (e.g. instance stopped comes alive, or when using floating ips) +Its recommended to run the command periodically to update nodes information. + + +---------------------- +Terminating Instances +---------------------- + +The ``stop`` command can be used to **terminate** an running instance (in AWS, stop/resume instance is **not supported yet**, so the nodes are terminated). +The command is shown below + +:: + + clapp -v node stop node-1 ... + +Where ``node-0`` must be replaced with the node ID of interest. Also, more nodes can be stopped, simple appending their node IDs to the command. + +If an instance is stopped (not terminated) in the AWS EC2 console, it must be resumed from there. +After an instance is resumed it is prudent to run the ``node alive`` command to update instance information. + +------------------------------- +Executing and Connecting +------------------------------- + +CLAP provides three simple commands to interact directly with the nodes. + +* The ``node connect`` command can be used to get an SSH shell to the desired node, as shown in the command below: + +:: + + clapp node connect node-1 + +* The ``node execute`` command can be used to execute an shell script command in a node and print the respective ``stdout`` and ``stderr`` outputs. + An example is shown below, used to execute the command ``echo ola`` in the node ``node-0`` and retrieve its outputs. + +:: + + clapp node execute node-0 'echo ola' + +* The ``node playbook`` command allows to execute an `Ansible playbook `_ in several nodes in a row. + An example is shown below, used to execute the playbook ``example.yml`` in three nodes (``node-0``, ``node-1`` and ``node-2``) + + :: + + clapp node playbook example.yml node-0 node-1 node-2 + + And if your playbook contains variables that must be passed from the command line, you can use the ``extra`` parameter. + The below example shows how to pass a keyworded value to a variable in the playbook. + + :: + + clapp node playbook example.yml node-0 node-1 node-2 --extra variable1="any value" variable2="another value" + + Where the ``variable1`` and ``variable2`` are passed to the playbook in your execution. + + **NOTE** + + * The ``extra`` parameter must be the last one in the ``node playbook`` command + * You may want to set a higher verbosity level to see Ansible outputs (not just errors). For that, use the ``-v`` parameter, just after ``clapp`` command. + + +------------------------------- +Tagging Nodes +------------------------------- + +Tags is a (key, value) pair that can be associated to nodes aiming to easily select it when needed. +Almost every command that you must supply nodes as input may have options to select nodes by tag (will be shown later). + +You can use the command below to added a tag to some nodes: + +:: + + clapp tag add "key=value" node-0 node-1 + +Where the tag must be a string in the format (``"key=value"``) and the nodes must be specified after. + +To remove tags, you can use the ``tag remove`` command, similarly to the ``tag add`` command, as shown below: + +:: + + clapp tag remove "key=value" node-0 node-1 + +Where the tag must be a string in the format (``"key=value"``). + +Finally, you can also start nodes and tag them right after its creation, by using the below command: + +:: + + clapp -v node start ubuntu-instance-aws:4 --tag "key=value" + +The above command instantiates 4 ``ubuntu-instance-aws`` machines and tags them with tag ``"key=value"``, after its creation. + diff --git a/docs/source/_build/html/_static/basic.css b/docs/source/_build/html/_static/basic.css new file mode 100644 index 00000000..01192852 --- /dev/null +++ b/docs/source/_build/html/_static/basic.css @@ -0,0 +1,768 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > p:first-child, +td > p:first-child { + margin-top: 0px; +} + +th > p:last-child, +td > p:last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +li > p:first-child { + margin-top: 0px; +} + +li > p:last-child { + margin-bottom: 0px; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > p:first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/source/_build/html/_static/css/badge_only.css b/docs/source/_build/html/_static/css/badge_only.css new file mode 100644 index 00000000..3c33cef5 --- /dev/null +++ b/docs/source/_build/html/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} diff --git a/docs/source/_build/html/_static/css/theme.css b/docs/source/_build/html/_static/css/theme.css new file mode 100644 index 00000000..aed8cef0 --- /dev/null +++ b/docs/source/_build/html/_static/css/theme.css @@ -0,0 +1,6 @@ +/* sphinx_rtd_theme version 0.4.3 | MIT license */ +/* Built 20190212 16:02 */ +*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.3333333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content .code-block-caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content .code-block-caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-remove:before,.fa-close:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-hotel:before,.fa-bed:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-yc:before,.fa-y-combinator:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-tv:before,.fa-television:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:""}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-signing:before,.fa-sign-language:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-vcard:before,.fa-address-card:before{content:""}.fa-vcard-o:before,.fa-address-card-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .rst-content p.caption .headerlink,.rst-content p.caption a .headerlink,a .rst-content table>caption .headerlink,.rst-content table>caption a .headerlink,a .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption a .headerlink,a .rst-content tt.download span:first-child,.rst-content tt.download a span:first-child,a .rst-content code.download span:first-child,.rst-content code.download a span:first-child,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .btn span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.btn .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .rst-content p.caption .headerlink,.rst-content p.caption .btn .headerlink,.btn .rst-content table>caption .headerlink,.rst-content table>caption .btn .headerlink,.btn .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .btn .headerlink,.btn .rst-content tt.download span:first-child,.rst-content tt.download .btn span:first-child,.btn .rst-content code.download span:first-child,.rst-content code.download .btn span:first-child,.btn .icon,.nav .fa,.nav .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand,.nav .wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .rst-content p.caption .headerlink,.rst-content p.caption .nav .headerlink,.nav .rst-content table>caption .headerlink,.rst-content table>caption .nav .headerlink,.nav .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .nav .headerlink,.nav .rst-content tt.download span:first-child,.rst-content tt.download .nav span:first-child,.nav .rst-content code.download span:first-child,.rst-content code.download .nav span:first-child,.nav .icon{display:inline}.btn .fa.fa-large,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.btn .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .btn .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .btn span.fa-large:first-child,.btn .rst-content code.download span.fa-large:first-child,.rst-content code.download .btn span.fa-large:first-child,.btn .fa-large.icon,.nav .fa.fa-large,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.nav .rst-content .code-block-caption .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.nav .rst-content code.download span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.nav .fa-large.icon{line-height:.9em}.btn .fa.fa-spin,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.btn .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .btn .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .btn span.fa-spin:first-child,.btn .rst-content code.download span.fa-spin:first-child,.rst-content code.download .btn span.fa-spin:first-child,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.nav .rst-content .code-block-caption .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.nav .rst-content code.download span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.wy-menu-vertical li span.btn.toctree-expand:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.rst-content code.download span.btn:first-child:before,.btn.icon:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.rst-content code.download span.btn:first-child:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.rst-content tt.download .btn-mini span:first-child:before,.btn-mini .rst-content code.download span:first-child:before,.rst-content code.download .btn-mini span:first-child:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#6ab0de;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.admonition{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo,.rst-content .wy-alert-warning.admonition{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title,.rst-content .wy-alert-warning.admonition .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.admonition{background:#e7f2fa}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition .admonition-title{background:#6ab0de}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.admonition{background:#dbfaf4}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition .admonition-title{background:#1abc9c}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.admonition{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a{color:#2980B9}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#2980B9}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980B9 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#2980B9;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#9B59B6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980B9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 .3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.3576515979%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.3576515979%;width:48.821174201%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.3576515979%;width:31.7615656014%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type="datetime-local"]{padding:.34375em .625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{position:absolute;content:"";display:block;left:0;top:0;width:36px;height:12px;border-radius:4px;background:#ccc;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{position:absolute;content:"";display:block;width:18px;height:18px;border-radius:4px;background:#999;left:-3px;top:-3px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27AE60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:.3em;display:block}.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980B9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9B59B6}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#2980B9 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,.rst-content .toctree-wrapper p.caption,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2,.rst-content .toctree-wrapper p.caption{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt,.rst-content code{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:before,.wy-breadcrumbs:after{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs li code,.wy-breadcrumbs li .rst-content tt,.rst-content .wy-breadcrumbs li tt{padding:5px;border:none;background:none}.wy-breadcrumbs li code.literal,.wy-breadcrumbs li .rst-content tt.literal,.rst-content .wy-breadcrumbs li tt.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#3a7ca8;height:32px;display:inline-block;line-height:32px;padding:0 1.618em;margin:12px 0 0 0;display:block;font-weight:bold;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li code,.wy-menu-vertical li .rst-content tt,.rst-content .wy-menu-vertical li tt{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.on a:hover span.toctree-expand,.wy-menu-vertical li.current>a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a{color:#404040}.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul{display:none}.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul,.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul{display:block}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{display:block;background:#c9c9c9;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3{font-size:.9em}.wy-menu-vertical li.toctree-l3.current>a{background:#bdbdbd;padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{display:block;background:#bdbdbd;padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand{color:gray}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980B9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980B9;text-align:center;padding:.809em;display:block;color:#fcfcfc;margin-bottom:.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em auto;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-side-nav-search>a img.logo,.wy-side-nav-search .wy-dropdown>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search>a.icon img.logo,.wy-side-nav-search .wy-dropdown>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:normal;color:rgba(255,255,255,0.3)}.wy-nav .wy-menu-vertical header{color:#2980B9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980B9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980B9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980B9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:gray}footer p{margin-bottom:12px}footer span.commit code,footer span.commit .rst-content tt,.rst-content footer span.commit tt{padding:0px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:1em;background:none;border:none;color:gray}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{width:100%}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:before,.rst-breadcrumbs-buttons:after{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-side-scroll{width:auto}.wy-side-nav-search{width:auto}.wy-menu.wy-menu-vertical{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1100px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;display:block;overflow:auto}.rst-content pre.literal-block,.rst-content div[class^='highlight']{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px 0}.rst-content pre.literal-block div[class^='highlight'],.rst-content div[class^='highlight'] div[class^='highlight']{padding:0px;border:none;margin:0}.rst-content div[class^='highlight'] td.code{width:100%}.rst-content .linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;display:block;overflow:auto}.rst-content div[class^='highlight'] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content pre.literal-block,.rst-content div[class^='highlight'] pre,.rst-content .linenodiv pre{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;font-size:12px;line-height:1.4}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^='highlight'],.rst-content div[class^='highlight'] pre{white-space:pre-wrap}}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last,.rst-content .admonition .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .section ol p:last-child,.rst-content .section ul p:last-child{margin-bottom:24px}.rst-content .line-block{margin-left:0px;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content .toctree-wrapper p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink{visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content .toctree-wrapper p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after,.rst-content .code-block-caption .headerlink:after{content:"";font-family:FontAwesome}.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content .toctree-wrapper p.caption:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after,.rst-content .code-block-caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:baseline;position:relative;top:-0.4em;line-height:0;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:gray}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.docutils.citation tt,.rst-content table.docutils.citation code,.rst-content table.docutils.footnote tt,.rst-content table.docutils.footnote code{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}.rst-content table.docutils td .last,.rst-content table.docutils td .last :last-child{margin-bottom:0}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content tt,.rst-content tt,.rst-content code{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace;padding:2px 5px}.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important;line-height:normal}.rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal{color:#E74C3C}.rst-content tt.xref,a .rst-content tt,.rst-content tt.xref,.rst-content code.xref,a .rst-content tt,a .rst-content code{font-weight:bold;color:#404040}.rst-content pre,.rst-content kbd,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",Courier,monospace}.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold;margin-bottom:12px}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980B9;border-top:solid 3px #6ab0de;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#6ab0de}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:#555}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}.rst-content tt.download,.rst-content code.download{background:inherit;padding:inherit;font-weight:normal;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content tt.download span:first-child,.rst-content code.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-regular.eot");src:url("../fonts/Lato/lato-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-regular.woff2") format("woff2"),url("../fonts/Lato/lato-regular.woff") format("woff"),url("../fonts/Lato/lato-regular.ttf") format("truetype");font-weight:400;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bold.eot");src:url("../fonts/Lato/lato-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bold.woff2") format("woff2"),url("../fonts/Lato/lato-bold.woff") format("woff"),url("../fonts/Lato/lato-bold.ttf") format("truetype");font-weight:700;font-style:normal}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-bolditalic.eot");src:url("../fonts/Lato/lato-bolditalic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-bolditalic.woff2") format("woff2"),url("../fonts/Lato/lato-bolditalic.woff") format("woff"),url("../fonts/Lato/lato-bolditalic.ttf") format("truetype");font-weight:700;font-style:italic}@font-face{font-family:"Lato";src:url("../fonts/Lato/lato-italic.eot");src:url("../fonts/Lato/lato-italic.eot?#iefix") format("embedded-opentype"),url("../fonts/Lato/lato-italic.woff2") format("woff2"),url("../fonts/Lato/lato-italic.woff") format("woff"),url("../fonts/Lato/lato-italic.ttf") format("truetype");font-weight:400;font-style:italic}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:400;src:url("../fonts/RobotoSlab/roboto-slab.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.ttf") format("truetype")}@font-face{font-family:"Roboto Slab";font-style:normal;font-weight:700;src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot");src:url("../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-bold.ttf") format("truetype")} diff --git a/docs/source/_build/html/_static/doctools.js b/docs/source/_build/html/_static/doctools.js new file mode 100644 index 00000000..daccd209 --- /dev/null +++ b/docs/source/_build/html/_static/doctools.js @@ -0,0 +1,315 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/source/_build/html/_static/documentation_options.js b/docs/source/_build/html/_static/documentation_options.js new file mode 100644 index 00000000..ec753454 --- /dev/null +++ b/docs/source/_build/html/_static/documentation_options.js @@ -0,0 +1,11 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.1.0', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/docs/source/_build/html/_static/file.png b/docs/source/_build/html/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/docs/source/_build/html/_static/file.png differ diff --git a/docs/source/_build/html/_static/fonts/Inconsolata-Bold.ttf b/docs/source/_build/html/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..809c1f58 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Inconsolata-Regular.ttf b/docs/source/_build/html/_static/fonts/Inconsolata-Regular.ttf new file mode 100644 index 00000000..fc981ce7 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Inconsolata-Regular.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Inconsolata.ttf b/docs/source/_build/html/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Inconsolata.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato-Bold.ttf b/docs/source/_build/html/_static/fonts/Lato-Bold.ttf new file mode 100644 index 00000000..1d23c706 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato-Bold.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato-Regular.ttf b/docs/source/_build/html/_static/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..0f3d0f83 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato-Regular.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bold.eot b/docs/source/_build/html/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bold.ttf b/docs/source/_build/html/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff b/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff2 b/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.eot b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.ttf b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-italic.eot b/docs/source/_build/html/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-italic.ttf b/docs/source/_build/html/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff b/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff2 b/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-regular.eot b/docs/source/_build/html/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-regular.ttf b/docs/source/_build/html/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff b/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff2 b/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab-Bold.ttf b/docs/source/_build/html/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab-Regular.ttf b/docs/source/_build/html/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/docs/source/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/source/_build/html/_static/fonts/fontawesome-webfont.eot b/docs/source/_build/html/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/fontawesome-webfont.eot differ diff --git a/docs/source/_build/html/_static/fonts/fontawesome-webfont.svg b/docs/source/_build/html/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/docs/source/_build/html/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_build/html/_static/fonts/fontawesome-webfont.ttf b/docs/source/_build/html/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/docs/source/_build/html/_static/fonts/fontawesome-webfont.ttf differ diff --git a/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff b/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff differ diff --git a/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff2 b/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/docs/source/_build/html/_static/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/source/_build/html/_static/jquery-3.4.1.js b/docs/source/_build/html/_static/jquery-3.4.1.js new file mode 100644 index 00000000..773ad95c --- /dev/null +++ b/docs/source/_build/html/_static/jquery-3.4.1.js @@ -0,0 +1,10598 @@ +/*! + * jQuery JavaScript Library v3.4.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2019-05-01T21:04Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.4.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code, options ) { + DOMEval( code, { nonce: options && options.nonce } ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.4 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2019-04-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) && + + // Support: IE 8 only + // Exclude object elements + (nodeType !== 1 || context.nodeName.toLowerCase() !== "object") ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && rdescend.test( selector ) ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = (elem.ownerDocument || elem).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( typeof elem.contentDocument !== "undefined" ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + } ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + // Support: IE 9-11 only + // Also use offsetWidth/offsetHeight for when box sizing is unreliable + // We use getClientRects() to check for hidden/disconnected. + // In those cases, the computed value can be trusted to be border-box + if ( ( !support.boxSizingReliable() && isBorderBox || + val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url, options ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.cluster_repository

+
+

Module Contents

+
+
+class clap.common.cluster_repository.PlatformControlInfo(*args, **kwargs)
+

Bases: clap.common.repository.AbstractEntry

+

This class holds control information used to create nodes and cluster in the repository (database). +It holds an incremental index to be used when creating such elements.

+
+ +
+
+class clap.common.cluster_repository.ClusterInfo(**kwargs)
+

Bases: clap.common.repository.AbstractEntry

+

This class holds information about a cluster that is stored in the repository and used by several interfaces +Each cluster is unique and is composed by the following elements:

+
+
    +

  • cluster_id: The unique identification of the cluster, used to perform operations across modules and instance interfaces

    • +

  • cluster_name: The name of the cluster used by the driver object that controls this cluster

    • +

  • cloud: The cluster (or cloud) provider that this cluster is attached (e.g., aws, azure, …)

    • +

  • keypair: The name of the keypair used to connect to the machines created in this cluster

    • +

  • region: The avaliability zone that this cluster was created

    • +

  • template: Name of the template that was used to create this cluster

    • +

  • driver_id: ID of the driver that controls this cluster

    • +

  • driver_version: Version of the driver used by this cluster

    • +

  • tags: Additional user tags for cluster identification

    • +
+
+
+
+__repr__(self)
+
+ +
+ +
+
+class clap.common.cluster_repository.NodeInfo(**kwargs)
+

Bases: clap.common.repository.AbstractEntry

+

This class holds information about a node that is stored in the repository and used by several interfaces +Each node is unique and is composed by the following elements:

+
+
    +

  • node_id: The unique identification of the node, used to perform operations across modules and instance interfaces

    • +

  • node_name: The name of the node used by the driver object that controls it

    • +

  • cluster_id: ID of the cluster that this node is attached to

    • +

  • flavor: Instance flavor (e.g., t2.micro in aws)

    • +

  • status: Last known status of the node (see PlatformCodes)

    • +

  • ip: IP address used to connect to this node (address used to perform SSH)

    • +

  • driver_id: ID of the driver that controls this node

    • +

  • driver_version: Version of the driver used by this node

    • +

  • keypair: The name of the keypair used to connect to the machines created in the node cluster

    • +

  • key: The private key file used to perform SSH and connect to machines

    • +

  • tags: Additional user tags for node identification

    • +
+
+
+
+__repr__(self)
+
+ +
+ +
+
+class clap.common.cluster_repository.RepositoryOperations(platform_repository: str, repository_type: str)
+
+
+_get_platform_repository(self)
+

Get the platform repository connection

+
+
Returns
+

The platform database connection

+
+
Return type
+

AbstractRepository

+
+
+
+ +
+
+exists_platform_db(self)
+

Check if the platform database exists

+
+
Returns
+

A boolean representing the existence of the platform database

+
+
Return type
+

bool

+
+
+
+ +
+
+create_platform_db(self, exists: str = 'pass')
+

Creates the platform Database

+
+
Parameters
+

exists – This parameter can be:

+
+
+
    +

  • ‘pass’ (default): will do nothing if the platform database tables already exists

    • +

  • ‘fail’: will raise TableAlreadyExists exception

    • +

  • ‘overwrite’: will drop and create a new table, if it already exists

    • +
+
+
Returns
+

A open repository connection

+
+
Return type
+

AbstractRepository

+
+
+
+ +
+
+write_platform_control_info(self, control: PlatformControlInfo)
+

Helper function to write Platform Control information on the correct table in the repository

+
+
Parameters
+

control (PlatformControlInfo) – Control information to be written

+
+
Returns
+

None

+
+
+
+ +
+
+read_platform_control_info(self)
+

Helper function to read Platform control information from the correct table in the repository

+
+
Returns
+

PlatformControlInfo

+
+
+
+ +
+
+write_cluster_info(self, cluster: ClusterInfo, create: bool = False)
+

Helper function to write Cluster information on the correct table in the repository

+
+
Parameters
+
    +

  • cluster (ClusterInfo) – Cluster information to be written

    • +

  • create (str) – If true, create a new element, else update the one with same id

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+_read_clusters_info(self, **where)
+

Helper function to read Cluster information from the correct table in the repository

+
+
Parameters
+

where – Dictionary of criterion to be matched when retrieving elements (e.g., {‘cluster.id’ == ‘xxx’})

+
+
Returns
+

List of cluster matching the criterion passed

+
+
Return type
+

List[ClusterInfo]

+
+
+
+ +
+
+write_node_info(self, node: NodeInfo, create: bool = False)
+

Helper function to write Node information on the correct table in the repository

+
+
Parameters
+
    +

  • node (NodeInfo) – node information to be written

    • +

  • create (str) – If true, create a new element, else update the one with same id

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+_read_nodes_info(self, **where)
+

Helper function to read Nodes information from the correct table in the repository

+
+
Parameters
+

where – Dictionary of criterion to be matched when retrieving elements (e.g., {‘node.id’ == ‘xxx’})

+
+
Returns
+

List of nodes matching the criterion passed

+
+
Return type
+

List[NodeInfo]

+
+
+
+ +
+
+_delete_clusters_info(self, **where)
+
+ +
+
+_delete_nodes_info(self, **where)
+
+ +
+
+get_platform_control(self)
+
+ +
+
+get_cluster(self, cluster_id: str)
+
+ +
+
+get_clusters(self, cluster_ids: List[str])
+

Given a list with cluster ids, it returns all the Cluster Information that matches the Ids in the repository

+
+
Parameters
+

cluster_ids (List[str]) – List of cluster ids to be queried

+
+
Returns
+

Matched cluster information

+
+
Return type
+

List[ClusterInfo]

+
+
+
+ +
+
+get_all_clusters(self)
+

Get the information of all created cluster in the repository

+
+
Returns
+

List with the information of all created cluster

+
+
Return type
+

List[ClusterInfo]

+
+
+
+ +
+
+remove_cluster(self, cluster_id: str)
+
+ +
+
+get_node(self, node_id)
+
+ +
+
+get_nodes(self, node_ids: List[str])
+

Given a list with node ids, it returns all the Node Information that matches the ids in the repository

+
+
Parameters
+

node_ids (List[str]) – List of node ids to be queried

+
+
Returns
+

Matched nodes information

+
+
Return type
+

List[NodeInfo]

+
+
+
+ +
+
+get_all_nodes(self)
+

Get the information of all created nodes in the repository

+
+
Returns
+

List with the information of all created nodes

+
+
Return type
+

List[NodeInfo]

+
+
+
+ +
+
+get_nodes_from_cluster(self, cluster_id: str)
+

Given a list of cluster ids, return all nodes in cluster that matches the ids passed in the repository

+
+
Parameters
+

cluster_id (str) – Id of the cluster

+
+
Returns
+

All the nodes that matches the cluster ids passed

+
+
Return type
+

List[NodeInfo]

+
+
+
+ +
+
+remove_node(self, node_id: str)
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/commands/index.html b/docs/source/_build/html/autoapi/clap/common/commands/index.html new file mode 100644 index 00000000..4e570e7b --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/commands/index.html @@ -0,0 +1,255 @@ + + + + + + + + + + + clap.common.commands — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.commands

+
+

Module Contents

+
+
+class clap.common.commands.AbstractParser
+
+
+abstract get_parser(self, commands_parser: argparse._SubParsersAction)
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/config/index.html b/docs/source/_build/html/autoapi/clap/common/config/index.html new file mode 100644 index 00000000..b90012df --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/config/index.html @@ -0,0 +1,390 @@ + + + + + + + + + + + clap.common.config — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.config

+
+

Module Contents

+
+
+class clap.common.config.Defaults
+
+
+log_level
+
+ +
+
+app_name = clap
+
+ +
+
+REPOSITORY_TYPE = tinydb
+
+ +
+
+DRIVER_ID = elasticluster
+
+ +
+
+DEFAULT_CONF_TYPE = json
+
+ +
+
+configs_path
+
+ +
+
+private_path
+
+ +
+
+storage_path
+
+ +
+
+execution_playbook
+
+ +
+
+groups_path
+
+ +
+
+modules_path
+
+ +
+
+elasticluster_storage_path
+
+ +
+
+cloud_conf
+
+ +
+
+login_conf
+
+ +
+
+instances_conf
+
+ +
+
+PLATFORM_REPOSITORY
+
+ +
+ +
+
+clap.common.config.PROVIDERS_SCHEMA
+
+ +
+
+clap.common.config.LOGIN_SCHEMA
+
+ +
+
+clap.common.config.INSTANCE_SCHEMA
+
+ +
+
+class clap.common.config.ConfigReader(providers_file: str, logins_file: str, instances_file: str)
+
+
+__validate(self, schema: dict, data: dict)
+
+ +
+
+__check_instances(self)
+
+ +
+
+get_instance(self, instance_name: str)
+
+ +
+
+get_instances(self)
+
+ +
+
+get_provider(self, provider_name: str)
+
+ +
+
+get_providers(self, provider_name: str)
+
+ +
+
+get_login(self, login_name: str)
+
+ +
+
+get_logins(self, login_name: str)
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/driver/index.html b/docs/source/_build/html/autoapi/clap/common/driver/index.html new file mode 100644 index 00000000..45b40119 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/driver/index.html @@ -0,0 +1,329 @@ + + + + + + + + + + + clap.common.driver — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.driver

+
+

Module Contents

+
+
+class clap.common.driver.AbstractInstanceInterface(repository_operator: RepositoryOperations)
+

Abstract class implementing the interface between the driver and the clap objects. +The interface is responsible for create and manage clusters and nodes entries in the clap platform repository. +Clap objects interact with the driver interface instead of the driver directly.

+
+
+__interface_id__ = InterfaceID
+
+ +
+
+__interface_version__ = 0.1.0
+
+ +
+
+abstract start_nodes(self, instances_num: Dict[str, int])
+
+ +
+
+abstract stop_nodes(self, node_ids: List[str])
+
+ +
+
+abstract pause_nodes(self, node_ids: List[str])
+
+ +
+
+abstract resume_nodes(self, node_ids: List[str])
+
+ +
+
+abstract check_nodes_alive(self, node_ids: List[str])
+
+ +
+
+abstract get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs)
+
+ +
+
+abstract execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None)
+
+ +
+ +
+
+class clap.common.driver.Codes
+

Status codes for nodes

+
+
+NODE_STATUS_INIT = initialized
+
+ +
+
+NODE_STATUS_UNREACHABLE = unreachable
+
+ +
+
+NODE_STATUS_REACHABLE = reachable
+
+ +
+
+NODE_STATUS_PAUSED = paused
+
+ +
+
+NODE_STATUS_STOPPED = stopped
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/exceptions/index.html b/docs/source/_build/html/autoapi/clap/common/exceptions/index.html new file mode 100644 index 00000000..10dcf716 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/exceptions/index.html @@ -0,0 +1,286 @@ + + + + + + + + + + + clap.common.exceptions — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.exceptions

+
+

Module Contents

+
+
+exception clap.common.exceptions.RepositoryError
+

Bases: Exception

+
+ +
+
+exception clap.common.exceptions.TableAlreadyExists(table_name: str, *args, **kwargs)
+

Bases: clap.common.exceptions.RepositoryError

+
+
+__str__(self)
+
+ +
+ +
+
+exception clap.common.exceptions.ModuleError
+

Bases: Exception

+
+ +
+
+exception clap.common.exceptions.ValueNotFound
+

Bases: clap.common.exceptions.RepositoryError

+
+ +
+
+exception clap.common.exceptions.ClusterError
+

Bases: Exception

+
+ +
+
+exception clap.common.exceptions.ClusterCreationError
+

Bases: clap.common.exceptions.ClusterError

+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/factory/index.html b/docs/source/_build/html/autoapi/clap/common/factory/index.html new file mode 100644 index 00000000..245ad04d --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/factory/index.html @@ -0,0 +1,288 @@ + + + + + + + + + + + clap.common.factory — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.factory

+
+

Module Contents

+
+
+class clap.common.factory.PlatformFactory
+
+
+__multi_instance_api__
+
+ +
+
+__module_iface__
+
+ +
+
+static get_module_interface()
+

Get the default ModuleInterface used to pick clap modules

+
+
Returns
+

The modules interface

+
+
Return type
+

ModuleInterface

+
+
+
+ +
+
+static get_instance_api(platform_db: str = Defaults.PLATFORM_REPOSITORY, repository_type: str = Defaults.REPOSITORY_TYPE, default_driver: str = Defaults.DRIVER_ID)
+

Get the default MultiInstance API used to manipulate cluster, nodes and modules across different drivers

+
+
Returns
+

The MultiInstanceAPI object to manipulate cluster, nodes and modules

+
+
Return type
+

MultiInstanceAPI

+
+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/index.html b/docs/source/_build/html/autoapi/clap/common/index.html new file mode 100644 index 00000000..0e892477 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/index.html @@ -0,0 +1,256 @@ + + + + + + + + + + + clap.common — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/platform/index.html b/docs/source/_build/html/autoapi/clap/common/platform/index.html new file mode 100644 index 00000000..b1b34d57 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/platform/index.html @@ -0,0 +1,463 @@ + + + + + + + + + + + clap.common.platform — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.platform

+
+

Module Contents

+
+
+class clap.common.platform.ModuleInterface
+

Interface to get clap modules from the modules repository

+
+
+__modules_map__
+
+ +
+
+static __find_modules()
+
+ +
+
+get_module(self, module_name: str)
+

Get the module package

+
+
Parameters
+

module_name (str) – Name of the clap module

+
+
Returns
+

The module

+
+
Return type
+

Module

+
+
+
+ +
+
+get_modules(self)
+

Get the module package

+
+
Returns
+

List of modules

+
+
Return type
+

List[module]

+
+
+
+ +
+
+get_module_names(self)
+

Get the name of all the modules in the clap modules repository

+
+
Returns
+

List containing the module names

+
+
Return type
+

List[str]

+
+
+
+ +
+ +
+
+class clap.common.platform.GroupInterface
+
+
+__groups_actions_map__
+
+ +
+
+GROUP_SCHEMA
+
+ +
+
+static __find_groups()
+
+ +
+
+get_group(self, group_name: str)
+
+ +
+
+get_group_names(self)
+
+ +
+ +
+
+class clap.common.platform.MultiInstanceAPI(platform_db: str, repository_type: str, default_driver: str)
+

API used to manage and perform operations in cluster and nodes from different driver implementations, +and cloud providers in a transparently manner.

+
+
+__interfaces_map__
+
+ +
+
+static __find_ifaces()
+
+ +
+
+_get_instance_iface(self, driver_id: str = None)
+
+ +
+
+static get_instance_templates()
+
+ +
+
+start_nodes(self, instances_num: Dict[str, int])
+
+ +
+
+stop_nodes(self, node_ids: List[str])
+
+ +
+
+check_nodes_alive(self, node_ids: List[str])
+
+ +
+
+execute_playbook_in_nodes(self, playbook_path: str, hosts: Union[List[str], Dict[str, List[str]]], extra_args: Dict[str, str] = ())
+
+ +
+
+get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs)
+
+ +
+
+get_node(self, node_id: str)
+
+ +
+
+get_nodes(self, node_ids: List[str] = None)
+
+ +
+
+get_nodes_with_tags(self, tags: Dict[str, str])
+
+ +
+
+add_tags_to_nodes(self, node_ids: List[str], tags: Dict[str, str])
+
+ +
+
+remove_tags_from_nodes(self, node_ids: List[str], tags: List[str])
+
+ +
+
+get_groups(self)
+
+ +
+
+__execute_group_action_sequence(self, hosts: Dict[str, List[str]], actions: List[str], group_path: str, extra_args: Dict[str, str], error_action: str = 'error')
+
+ +
+
+__check_nodes_in_group(self, group: str, node_ids: List[str] = None)
+
+ +
+
+add_nodes_to_group(self, node_ids: List[str], group_name: str, group_args: Dict = None, error_action: str = 'error')
+
+ +
+
+__add_nodes_to_group(self, group_hosts_map: Dict[str, Union[List[str], Dict[str, List[str]]]], group_args: Dict = None, error_action: str = 'error')
+
+ +
+
+execute_group_action(self, group_name: str, action: str, group_args: Dict = None, node_ids: List[str] = None, error_action='ignore')
+
+ +
+
+__execute_group_action(self, node_ids: List[str], group_name: str, action: str, group_args: Dict = None, error_action='error')
+
+ +
+
+remove_nodes_from_group(self, group_name: str, node_ids: List[str] = None, remove_action: str = None, group_args: Dict = None)
+
+ +
+
+export_platform(self, output_filename: str)
+
+ +
+
+import_platform(self, zip_filename: str)
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/repository/index.html b/docs/source/_build/html/autoapi/clap/common/repository/index.html new file mode 100644 index 00000000..dcc71c02 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/repository/index.html @@ -0,0 +1,752 @@ + + + + + + + + + + + clap.common.repository — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.repository

+
+

Module Contents

+
+
+class clap.common.repository.AbstractEntry(*args, **kwargs)
+

Bases: clap.common.utils.Struct

+

This class represent a single entry in the Repository. Basically its a dictionary that is a serializable and +is a generic container for a data format. Implementations derived from this class represent specific element types in a repository. +Objects (variables) inside this class can be accessed using element[‘variable’] or element.variable notations

+
+ +
+
+class clap.common.repository.AbstractRepository(repository: str, create_repository: bool, storage_type: str = None, *args, **kwargs)
+

Base class for implementing repositories and their operations. The repository is similar to tabled data models. +The elements are every object inherited from AbstractEntry class, which are basically, dictionary types. +Tables hold a set of elements of the same type and must be created before adding elements. +The repository then, implement a set of methods to create, retrieve, update and delete elements and tables from the database.

+
+
+__repository_id__ = abstractrepository
+
+ +
+
+__repository_name__ = Abstract Repository
+
+ +
+
+__repository_version__ = 0.0.1
+
+ +
+
+abstract create_table(self, table: str, *args, **kwargs)
+

Create a table in the repository (a container to hold elements of the same type)

+
+
Parameters
+
    +

  • table (str) – Name of the table to be created

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+abstract retrieve_tables(self)
+

Retrieve tables from the repository.

+
+
Returns
+

List with the table names

+
+
Return type
+

List[str]

+
+
+
+ +
+
+abstract exists_table(self, table: str, *args, **kwargs)
+

Check if a table exists in the repsitory

+
+
Parameters
+
    +

  • table (str) – Name of the table to be checked

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

True if table exists and False otherwise

+
+
Return type
+

bool

+
+
+
+ +
+
+abstract drop_tables(self, tables: List[str], *args, **kwargs)
+

Delete tables from the repository

+
+
Parameters
+
    +

  • tables (List[str]) – Name of the tables to delete

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+abstract create_element(self, table: str, obj: AbstractEntry, *args, **kwargs)
+

Insert a new element in the table

+
+
Parameters
+
    +

  • table (str) – Name of the table to create the entry

    • +

  • obj (AbstractEntry) – Entry to be inserted, class derived from AbstractEntry

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+abstract retrieve_elements(self, table: str, cast_to: type, **where)
+

Retrieve elements from a table in the database, basing on a simle keyworded query

+
+
Parameters
+
    +

  • table (str) – Name of the table to retrieve the elements

    • +

  • cast_to (type) – Type to cast the elements after retrieval from the database (Derived from ``AbstractEntry`)

    • +

  • where (Dict[str,Any]) – Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’)

    • +
+
+
Returns
+

List of the elements that matches the creteria

+
+
Return type
+

List[Any]

+
+
+
+ +
+
+abstract update_element(self, table: str, obj: AbstractEntry, **where)
+

Update an element from the database table with another one, matching a criteria

+
+
Parameters
+
    +

  • table (str) – Name of the table do modify the element

    • +

  • obj (AbstractEntry) – New element to be inserted (Derived from ``AbstractEntry`)

    • +

  • where (Dict[str,Any]) – Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’)

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+abstract drop_elements(self, table: str, **where)
+

Delete elements from a database table that matches a criteria

+
+
Parameters
+
    +

  • table (str) – Name of the table that elements will be deleted

    • +

  • where (Dict[str,Any]) –

    • +

  • where – Keyworded clauses which specify conditions, the key is he field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’)

    • +
+
+
Returns
+

None

+
+
+
+ +
+ +
+
+class clap.common.repository.TinyDBRepository(repository_path: str, create_repository: bool, storage_type: str = DEFAULT_STORAGE_TYPE, *args, **kwargs)
+

Bases: clap.common.repository.AbstractRepository

+

Repository implementation using the tinydb, document-oriented database.

+
+
+__repository_id__ = tinydb
+
+ +
+
+__repository_name__ = TinyDB Repository
+
+ +
+
+__repository_version__ = 0.1.0
+
+ +
+
+DEFAULT_STORAGE_TYPE = json
+
+ +
+
+__storage_types_map
+
+ +
+
+create_table(self, table: str, *args, **kwargs)
+

Create a new table in the database

+
+
Parameters
+
    +

  • table (str) – Name of the table to be created

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
Raises
+

TableAlreadyExists – if a table with the same name already exists in the database

+
+
+
+ +
+
+retrieve_tables(self)
+

Get the names of all tables in the database

+
+
Returns
+

List with the table names

+
+
Return type
+

List[str]

+
+
+
+ +
+
+exists_table(self, table: str, *args, **kwargs)
+

Check if a table already exists in database

+
+
Parameters
+
    +

  • table (str) – Name of the table

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

True if the table exists, False otherwise

+
+
Return type
+

bool

+
+
+
+ +
+
+drop_tables(self, tables: List[str], *args, **kwargs)
+

Delete tables from the database

+
+
Parameters
+
    +

  • tables (List[str]) – Names of the tables to be removed

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
+
+ +
+
+create_element(self, table: str, obj: AbstractEntry, *args, **kwargs)
+

Insert elements in a database table

+
+
Parameters
+
    +

  • table (str) – Name of the table to insert the element

    • +

  • obj (AbstractEntry) – Element to be inserted (derived from AbstractEntry)

    • +

  • args – Additional arguments to be used

    • +

  • kwargs – Additional keyword arguments to be used

    • +
+
+
Returns
+

None

+
+
Raises
+

ValueError – If table name is invalid

+
+
+
+ +
+
+retrieve_elements(self, table: str, cast_to: type = dict, **where)
+

Retrieve elements from the database that match a criteria

+
+
Parameters
+
    +

  • table (str) – Name of the table to retrieve the elements

    • +

  • cast_to (type) – Type that the elements will be casted after retrieved (derived from AbstractEntry)

    • +

  • where (Dict[str,Any]) – Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’). +If no conditions are passed all elements are retrieved

    • +
+
+
Returns
+

List with the elements retrieved, properly casted to the type passed

+
+
Return type
+

List[Any]

+
+
Raises
+

ValueError – If table name is invalid

+
+
+
+ +
+
+update_element(self, table: str, obj: AbstractEntry, **where)
+

Update an element (or elements) matching some creiterias, replacing it with another one.

+
+
Parameters
+
    +

  • table (str) – Name of the table that the element will be updated

    • +

  • obj (AbstractEntry) – Entry to be inserted (derived from AbstractEntry)

    • +

  • where – Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’). +If no conditions are the first retrived element in the table will be updated

    • +
+
+
Returns
+

None

+
+
Raises
+

ValueError – If table name is invalid

+
+
+
+ +
+
+drop_elements(self, table: str, **where)
+

Remove elements from a table

+
+
Parameters
+
    +

  • table (str) – Name of the table that the elements will be removed

    • +

  • where – Keyworded clauses which specify conditions. The key is the field name (from the entry) and value is the data associated. +Elements that match the conditions will be retrieved (e.g. person_id=’person1’). +A clause must be specified!

    • +
+
+
Returns
+

+
+
Raises
+

ValueError – If table name is invalid

+
+
+
+ +
+ +
+
+clap.common.repository.generic_read_entry(info_type: type, repository: AbstractRepository, table: str, **where) → list
+

Helper method to read an entry from a repository

+
+
Parameters
+
    +

  • info_type (AbstractEntry) – Type of the entry that will be read. The type of the element must derive from AbstractDescriptorEntry

    • +

  • repository (AbstractRepository) – Repository object used to read the element from

    • +

  • table (str) – Table of the repository where the element will be retrieved

    • +

  • where (Dict[Any, Any]) – The clauses to be matched when searching an entry

    • +
+
+
Returns
+

List of elements matching the criteria passed. The elements are all converted to info_type argument type

+
+
Return type
+

list

+
+
+
+ +
+
+clap.common.repository.generic_write_entry(info: AbstractEntry, repository: AbstractRepository, table: str, create: bool = False, **where)
+

Helper method to write an entry in a repository

+
+
Parameters
+
    +

  • info (AbstractEntry) – Information to be written in repository (derived from AbstractDescriptorEntry class)

    • +

  • repository (AbstractRepository) – Repository object used to write the element to

    • +

  • table (str) – Table of the repository where the element will be created/updated

    • +

  • create (bool) – If true it will create a element in the repository and if false, it will update. If the repository implementation supports insertion upon update, the element will be created when updating, else an exception will be raised

    • +

  • where (Dict[Any, Any]) – The clauses to be matched when updating an entry

    • +
+
+
+
+ +
+
+clap.common.repository.check_and_create_table(repository: AbstractRepository, table_name: str, exists: str) → bool
+

Check if table exists and creates table based on exists variable policy. The table is always created if it does not exists

+
+
Parameters
+
    +

  • repository (AbstractRepository) – Repository that the table will be created

    • +

  • table_name – Name of the table to be created

    • +

  • table_name – str

    • +

  • exists – Policy taken when the table already exists. This parameter can be: +‘pass’ (default): will do nothing +‘fail’: will raise TableAlreadyExists exception +‘overwrite’: will drop the old table and create a new table

    • +
+
+
Returns
+

True indicating if the a new table was created, False otherwise

+
+
Return type
+

bool

+
+
Raises
+

+
+
+
TableAlreadyExists

If table already exists and ‘fail’ parameter is passed

+
+
ValueError

If exists parameter is invalid

+
+
+
+ +
+
+class clap.common.repository.RepositoryFactory
+
+
+static get_repository(repository: str, repository_type: str = Defaults.REPOSITORY_TYPE, storage_type: str = None, create_new: bool = True)
+

Get a repository, based on a implementation of the AbstractRepository class.

+
+
Parameters
+
    +

  • repository (str) – Name of the repository to get

    • +

  • repository_type (str) – Repository implementation type (default is tinydb repository imlpementation)

    • +

  • storage_type (str) – Type of the storage (default is json)

    • +

  • create_new (bool) – True to create a new repository (overwriting an existent one), false otherwise (default is True)

    • +
+
+
Returns
+

The repository in the specified implementation (derived from AbstractRepository)

+
+
Return type
+

AbstractRepository

+
+
Raises
+

ValueError – If the repository implementation type is invalid

+
+
+
+ +
+
+static exists_repository(repository: str, repository_type=Defaults.REPOSITORY_TYPE)
+

Check if a repository already exists

+
+
Parameters
+
    +

  • repository (str) – Name of the repository

    • +

  • repository_type (str) – Repository implementation type (default is tinydb repository imlpementation)

    • +
+
+
Returns
+

True of the repository already exists and false otherwise

+
+
Return type
+

bool

+
+
Raises
+

ValueError – If the repository implementation type is invalid

+
+
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/common/utils/index.html b/docs/source/_build/html/autoapi/clap/common/utils/index.html new file mode 100644 index 00000000..31583636 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/common/utils/index.html @@ -0,0 +1,312 @@ + + + + + + + + + + + clap.common.utils — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.common.utils

+
+

Module Contents

+
+
+clap.common.utils.log
+
+ +
+
+clap.common.utils.setup_log(log_name: str = None, verbosity_level: int = logging.INFO, filename: str = '')
+
+ +
+
+class clap.common.utils.Struct(initializer=None, **kwargs)
+

Bases: collections.abc.MutableMapping, object

+
+
+copy(self)
+

Return a (shallow) copy of this Struct instance.

+
+ +
+
+__delitem__(self, name)
+
+ +
+
+__getitem__(self, name)
+
+ +
+
+__setitem__(self, name, val)
+
+ +
+
+__iter__(self)
+
+ +
+
+__len__(self)
+
+ +
+
+keys(self)
+
+ +
+ +
+
+clap.common.utils.path_extend(*args) → str
+
+ +
+
+clap.common.utils.get_file_checksum(file_path: str) → str
+
+ +
+
+clap.common.utils.yaml_load(filename: str) → dict
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/drivers/elasticluster/driver/index.html b/docs/source/_build/html/autoapi/clap/drivers/elasticluster/driver/index.html new file mode 100644 index 00000000..24797750 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/drivers/elasticluster/driver/index.html @@ -0,0 +1,398 @@ + + + + + + + + + + + clap.drivers.elasticluster.driver — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.drivers.elasticluster.driver

+
+

Module Contents

+
+
+class clap.drivers.elasticluster.driver.ElasticCreator
+
+
+static create_cluster_obj(cluster_name: str, provider_config: dict, login_config: dict, instances: dict, login_name: str, provider_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = Defaults.DEFAULT_CONF_TYPE)
+
+ +
+
+static update_cluster_config(cluster_name: str, provider_config: dict, login_config: dict, instances: dict, login_name: str, provider_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = Defaults.DEFAULT_CONF_TYPE)
+
+ +
+
+static upddate_cluster_node(cluster: Cluster, node: Node)
+
+ +
+
+static __to_elasticluster_config(cluster_name: str, instances: Dict[str, Any], login_configs: Dict[str, Any], provider_configs: Dict[str, Any], login_name: str, provider_name: str)
+
+ +
+
+static get_all_cluster_objs(storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json')
+
+ +
+
+static get_cluster_obj(cluster_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json')
+
+ +
+
+static exists_cluster(cluster_name: str, storage_path: str = Defaults.elasticluster_storage_path, storage_type: str = 'json')
+
+ +
+
+static get_node_from_cluster(cluster_name: str, node_name: str)
+
+ +
+
+static get_nodes_from_cluster(cluster_name: str, nodes: List[str])
+
+ +
+
+static get_final_config(eclasticluster_config_file: str)
+
+ +
+ +
+
+class clap.drivers.elasticluster.driver.AnsibleSetupProviderWrapper(ansible_provider: AnsibleSetupProvider, kind_groups_map: Dict[str, List[str]], kind_key_value_vars: Dict[str, Dict[str, str]], node_name_id_map: Dict[str, str])
+

Bases: elasticluster.providers.ansible_provider.AnsibleSetupProvider

+
+
+run_playbook(self, cluster: Cluster, nodes: List[Node], playbook: str, extra_args=tuple())
+
+ +
+
+build_inventory(self, cluster: Cluster, nodes: List[Node])
+
+ +
+
+_write_extra_vars(self, cluster, filename='extra_vars.yml')
+
+ +
+ +
+
+clap.drivers.elasticluster.driver.elaticluster_start_nodes(cluster_name: str, instances_num: Dict[str, int], storage_path: str = Defaults.elasticluster_storage_path, max_concurrent_requests: int = 0) → Tuple[Cluster, Set[Node]]
+
+ +
+
+clap.drivers.elasticluster.driver.elasticluster_check_starting_nodes(cluster: Cluster, node_objs: Set[Node])
+
+ +
+
+clap.drivers.elasticluster.driver.elasticluster_stop_nodes(cluster_name: str, nodes: List[str], *args, **kwargs) → None
+
+ +
+
+clap.drivers.elasticluster.driver.elasticluster_pause_nodes(cluster_name: str, nodes: List[str]) → None
+
+ +
+
+clap.drivers.elasticluster.driver.elasticluster_get_connection_to_node(cluster_name: str, node_name: str, *args, **kwargs) → paramiko.SSHClient
+
+ +
+
+class clap.drivers.elasticluster.driver.ElasticlusterInterface(repository_operator: RepositoryOperations)
+

Bases: clap.common.driver.AbstractInstanceInterface

+
+
+__interface_id__ = elasticluster
+
+ +
+
+__get_updated_cluster(self, cluster_id: str)
+
+ +
+
+__get_or_create_cluster(self, cloud_conf: str, login_conf: str)
+
+ +
+
+__stop_cluster(self, cluster_id: str, *args, **kwargs)
+
+ +
+
+start_nodes(self, instances_num: Dict[str, int])
+
+ +
+
+stop_nodes(self, node_ids: List[str])
+
+ +
+
+pause_nodes(self, node_ids: List[str])
+
+ +
+
+abstract resume_nodes(self, node_ids: List[str])
+
+ +
+
+check_nodes_alive(self, node_ids: List[str])
+
+ +
+
+get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs)
+
+ +
+
+execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None)
+
+ +
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/drivers/elasticluster/index.html b/docs/source/_build/html/autoapi/clap/drivers/elasticluster/index.html new file mode 100644 index 00000000..328d743a --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/drivers/elasticluster/index.html @@ -0,0 +1,311 @@ + + + + + + + + + + + clap.drivers.elasticluster — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

clap.drivers.elasticluster

+
+

Submodules

+
+ +
+
+
+

Package Contents

+
+
+class clap.drivers.elasticluster.ElasticlusterInterface(repository_operator: RepositoryOperations)
+

Bases: clap.common.driver.AbstractInstanceInterface

+
+
+__interface_id__ = elasticluster
+
+ +
+
+__get_updated_cluster(self, cluster_id: str)
+
+ +
+
+__get_or_create_cluster(self, cloud_conf: str, login_conf: str)
+
+ +
+
+__stop_cluster(self, cluster_id: str, *args, **kwargs)
+
+ +
+
+start_nodes(self, instances_num: Dict[str, int])
+
+ +
+
+stop_nodes(self, node_ids: List[str])
+
+ +
+
+pause_nodes(self, node_ids: List[str])
+
+ +
+
+abstract resume_nodes(self, node_ids: List[str])
+
+ +
+
+check_nodes_alive(self, node_ids: List[str])
+
+ +
+
+get_connection_to_nodes(self, node_ids: List[str], *args, **kwargs)
+
+ +
+
+execute_playbook_in_nodes(self, playbook_path: str, group_hosts_map: Dict[str, List[str]], extra_args: Dict[str, str] = None, group_vars: Dict[str, Dict[str, str]] = None)
+
+ +
+ +
+
+clap.drivers.elasticluster.interface
+
+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/drivers/index.html b/docs/source/_build/html/autoapi/clap/drivers/index.html new file mode 100644 index 00000000..5686efea --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/drivers/index.html @@ -0,0 +1,243 @@ + + + + + + + + + + + clap.drivers — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/clap/index.html b/docs/source/_build/html/autoapi/clap/index.html new file mode 100644 index 00000000..10447846 --- /dev/null +++ b/docs/source/_build/html/autoapi/clap/index.html @@ -0,0 +1,253 @@ + + + + + + + + + + + clap — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/autoapi/index.html b/docs/source/_build/html/autoapi/index.html new file mode 100644 index 00000000..2a27d2ba --- /dev/null +++ b/docs/source/_build/html/autoapi/index.html @@ -0,0 +1,253 @@ + + + + + + + + + + + API Reference — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+ + +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/configuration.html b/docs/source/_build/html/configuration.html new file mode 100644 index 00000000..89c4145c --- /dev/null +++ b/docs/source/_build/html/configuration.html @@ -0,0 +1,478 @@ + + + + + + + + + + + Basic Configuration Setup — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Basic Configuration Setup

+

In order to create compute nodes and interact with them, you will need provide some information about the cloud provider, the login used to connect to the instances and the desired instances. +By default, CLAP holds all of it information inside the ~/.clap directory (~ stands for the user home directory). The minimal structure of ~/.clap directory is shown below:

+
~/
+└── .clap/
+    ├── configs/
+    │   ├── instances.yaml
+    │   ├── logins.yaml
+    │   └── providers.yaml
+    ├── groups/
+    │   ├── groups/
+    │   ├── group_vars/
+    │   │   └── all.yml
+    │   ├── main.yml
+    │   └── roles/
+    ├── modules/
+    ├── private/
+    └── storage/
+        ├── clusters.d/
+        └── platform.json
+
+
+
    +

  • The ~/.clap/configs/providers.yaml YAML file inside the ~/.clap/configs directory holds the information about the cloud provider and how to connect to it.

    • +

  • The ~/.clap/configs/logins.yaml file holds information about how to connect to an instance (e.g. login user, keyfile, etc)

    • +

  • The ~/.clap/configs/instances.yaml holds the information about the instances to launch, i.e. the instance templates.

    • +

  • The groups directory store groups file and actions, used to perform action in several nodes. More detailed information about groups and actions will be presented at groups section

    • +

  • The modules directory store module files, used to extend clap CLI application.

    • +

  • The private stores keys and passwords files used to connect to the cloud provider and to the instance itself. Every key/secret files needed in the configuration sections must be placed inside this directory

    • +

  • The storage directory store metadata information used by clap (this directory may also contain sensitive information)

    • +
+

To launch an instance and use the CLAP capabilities, you will first need to configure an instance template.

+

In the following sections, it will be shown how to configure the above files used to launch instances and all the valid information that can be used in it.

+
+
+

Cloud provider configuration

+

The ~/.clap/configs/providers.yaml file defines all properties needed to connect to a specific cloud provider. +An example providers.yaml file is shown below (in YAML format).

+
aws-east-1-config:                              # Name of the provider config (Provider ID)
+    provider: aws                               # Provider (currently only aws)
+    access_keyfile: ec2_access_key.pub          # Name of the file in the ~/.clap/private/ directory containing the AWS access key ID
+    secret_access_keyfile: ec2_access_key.pem   # Name of the file in the ~/.clap/private directory containing the AWS Secret Access Key (access ID)
+    url: https://ec2.us-east-1.amazonaws.com    # URL of the EC2 endpoint (usually something like this one...)
+    region: us-east-1                           # The availability zone you want to use
+
+my-config2:
+    provider: aws
+    ...
+
+
+

The YAML dictionary keys are the name of the provider configuration (also called provider ID, aws-east-1-config and my-config2 in this example) and the values are the specific information about that configuration. +You can define as many provider configurations as you want just adding a new provider ID and the values for it. Note that each provider ID must be unique. +Other sections will refer to a provider configuration by its provider ID. +The valid values for a provider configuration are:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid provider configuration key and values

Name

Values/Type

Description

provider

‘aws’

Name of the cloud provider to be used

access_keyfile

<filename>

Name of the file containing the AWS access key ID. The file must be at ~/.clap/private (see below)

secret_access_keyfile

<filename>

Name of the file containing the AWS Secret Access Key (access ID). The file must be at ~/.clap/private (see below)

url

<string>

URL of the EC2 endpoint (usually something like https://ec2.us-east-1.amazonaws.com)

region

<string>

The availability zone you want to use (e.g. us-east-1)

vpc (optional)

<string>

Name or ID of the AWS Virtual Private Cloud to provision resources in.

+

Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). +These keys are required and is used to connect to the aws provider via third-party applications. (See the AWS Access Keys documentation for more information).

+

For CLAP, all keys must be stored at ~/.clap/private/ directory with 400 permission (use the chmod 400 command to set the read-only permission). +So you must place your access key ID string inside a file in the ~/.clap/private/ (e.g, copy and paste access key ID in a file and save at ~/.clap/private/ec2_access_key.pub) and the same for the secret access key.

+

Once the files are in the ~/.clap/private/ directory, the values of the access_keyfile and secret_access_keyfile keys in your provider configuration must only contain the filename, not the whole path. (e.g. only the file name: ec2_access_key.pub and not ~/.clap/private/ec2_access_key.pub)

+
+
+

Login provider configuration

+

The login contains information on how to access the instances started on the cloud via SSH. So, the section holds information about the userto perform login, the SSH keyfile to log in the machine and others. +The ~/.clap/configs/logins.yaml file must be populated with desired information. +An example logins.yaml file is shown below (in YAML format).

+
ubuntu-login:                                       # Name of the login config (Login ID)
+    user: ubuntu                                    # Login name used to SSH into the virtual machine
+    keypair_name: key_us_east_1                     # Name of the keypair to use on the cloud provider
+    keypair_public_file: key_us_east_1.pub          # Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file
+    keypair_private_file: key_us_east_1.pem         # Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine.
+    sudo: true                                      # True if the sudo_user can execute commands as root by running the sudo command
+    sudo_user: root                                 # (OPTIONAL) Login name of the super user (default is root)
+
+example-centos:
+    user: centos
+    ...
+
+
+

The YAML dictionary keys are the name of the login configuration (also called login ID, ubuntu-login and example-centos in this example) and the values are the specific information about that configuration. +You can define as many login configurations as you want just adding a new login ID and the values for it. Note that each login ID must be unique. +Other sections will refer to a login configuration by its provider ID. +The valid values for a login configuration are:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid login configuration key and values

Name

Values/Type

Description

user

<string>

Name of the user used to perform SSH into the virtual machine

keypair_name

<string>

Name of the keypair to use on the cloud provider (see more below)

keypair_public_file

<filename>

Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file

keypair_private_file

<filename>

Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine

sudo

<boolean>

True if the sudo user can execute commands as root by running the sudo command

sudo_user (optional)

<string>

Optional login name of the super user (default is root)

+

The keypair is used to login to the machine without password (and perform SSH). For AWS users, the keypair can be generated in the menu: EC2 --> Network & Security --> Key Pairs. +A keypair can be created using the create key pair button providing an unique keypair name (this name is used in the keypair_name field of the login configuration). +When a keypair is created, a private key file is generated to download. This is the private key file (used to login to the instances).

+

For CLAP, all key files must be placed in the ~/.clap/private/ directory with 400 permission. +In the keypair_private_file login configuration field, the name of the private key file inside the ~/.clap/private/ must be inserted (e.g. only the file name: key_us_east_1.pem.pem and not ~/.clap/private/key_us_east_1.pem.pem)

+

Having the private key, the public key can be obtained with the command ssh-keygen -y -f /path_to_key_pair/my-key-pair.pem (where my-key_pair.pem is the private key file. See AWS Keypair Documentation for more details). +The generated public key must be saved to a file and placed at ~/.clap/private/ directory with 400 permission. So, in the keypair_public_file field of the login configuration, the name of the public key file must be inserted.

+
+
+

Instance templates configuration

+

To start virtual machines in a cloud, you must first setup some instance templates in the ~/.clap/configs/instances.yaml file. +The template contains information about the virtual machine to start, including the flavor (instance type, e.g. t2.micro on EC2 provider), security group information, AMI used, the disk size and others. +The instance template references the provider configuration and login configuration by its ID.

+

To create a new instance template you can edit the ~/.clap/configs/instances.yaml file. +An example of instances.yaml is shown below.

+
ubuntu-instance-aws                     # Name of the instance template (instance template ID)
+    provider: aws-east-1-config         # Provider configuration ID
+    login: ubuntu-login                 # Login configuration ID
+    flavor: t2.medium                   # The VM "size" to use. Different cloud providers call it differently: could be "instance type", "instance size" or "flavor".
+    image_id: ami-07d0cf3af28718ef8     # Disk image ID to use in the VM. Amazon EC2 uses IDs like ami-123456
+    security_group: xxx-secgroup        # (OPTIONAL) Name of security group to use when starting the instance
+    boot_disk_size: 10                  # (OPTIONAL) Size of the instance’s root filesystem volume, in Gibibytes (GiB)
+    boot_disk_device: /dev/sda1         # (OPTIONAL) Device name of the instance’s root file system in the block device mapping
+    boot_disk_type: gp2                 # (OPTIONAL) Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (the default).
+    placement_group: XXX                # (OPTIONAL) Placement group to enable low-latency networking between compute nodes
+    image_userdata: '...'               # (OPTIONAL) Shell script to be executed (as root) when the machine starts.
+    network_ids:  subnet-abcdfefxx      # (OPTIONAL) Subnet IDs the nodes will be connected to
+
+instance-t2small-us-east-1:
+    provider: aws-east-1-config
+    ...
+
+
+

The YAML dictionary keys are the name of the instance templates (also called instance template ID, ubuntu-instance-aws and instance-t2small-us-east-1 in this example) and the values are the specific information about that instance template. +You can define as many instance templates configurations as you want just adding a new instance template ID and the values for it. Note that each instance template ID must be unique. +Commands will use the instance template ID to launch instances based on this information. +The valid values for the instance templates are:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid instance template key and values

Name

Values/Type

Description

provider

<string>

The ID of the provider configuration to be used for this instance. The ID must match the provider ID at providers.yaml

login

<string>

The ID of the login configuration to be used for this instance. The ID must match the login ID at logins.yaml

flavor

<string>

The provider instance type to use (e.g. t2.micro, c5.large, etc)

image_id

<string>

Disk image ID to use in the VM (basically the OS to be used). Amazon EC2 uses IDs like ami-123456. Note that the image_id is dependent of the provider region and a error may be raised if an invalid ami is specified

security_group (optional)

<string>

Name of security group to use when starting the instance. The default security group is default

boot_disk_size (optional)

<string>

Size of the instance’s root filesystem volume, in Gibibytes (GiB)

boot_disk_device (optional)

<string>

Device name of the instance’s root file system in the block device mapping. For AWS, see block device mapping docs for more information

boot_disk_type (optional)

<string>

Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (default). See Root filesystem volume storage type for more information

placement_group (optional)

<string>

Placement group to enable low-latency networking between compute nodes. See placement groups for more information

image_userdata (optional)

<string>

Shell script to be executed (as root) when the machine starts. This shell script is executed before CLAP even gets a chance to connect to the VM.

network_ids (optional)

<string>

Subnet ID that the nodes of the cluster will be connected to

+

On Amazon EC2, the “default” security group only allows network communication among hosts in the group and does not allow SSH connections from the outside. +This will make ElastiCluster driver to fail as it cannot connect to the cluster nodes. You will need to add rules to the “default” security group (or create a new one and use that) such that the SSH connections from the network where you run CLAP are allowed.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/genindex.html b/docs/source/_build/html/genindex.html new file mode 100644 index 00000000..ae92aafa --- /dev/null +++ b/docs/source/_build/html/genindex.html @@ -0,0 +1,891 @@ + + + + + + + + + + + + Index — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Index
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | G + | I + | K + | L + | M + | N + | P + | R + | S + | T + | U + | V + | W + | Y + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

G

+ + + +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + +
+ +

W

+ + + +
+ +

Y

+ + +
+ + + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/groups.html b/docs/source/_build/html/groups.html new file mode 100644 index 00000000..72feaae5 --- /dev/null +++ b/docs/source/_build/html/groups.html @@ -0,0 +1,454 @@ + + + + + + + + + + + Groups — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Groups

+

In order to perform pre-defined actions in several nodes in a row, CLAP uses the concept of groups, powered by Ansible playbooks. Playbooks can be used to manage configurations of and deployments to remote machines. +Nodes can be added to and removed from a group and also, a node may belong to multiple groups at once.

+

Every group have some actions associated with it. For instance, when a node is being added to a group the group’s setup action takes place, +configuring the node to belong to that particular group (e.g. installing desired packages, start services, etc). Basically a group defines a set of actions that can be performed to nodes that belongs to it. +When a node is successfully added to a group we are saying that all operations defined by this group can be performed by that node.

+

We now explain better the group concept and the commands used to it. +The shared groups section describes the groups distributed with the CLAP and the tutorials section describes how to implement a new group and other tips.

+
+
+

Working Groups in CLAP

+

By default CLAP groups are stored in the ~/.clap/groups/ directory. An example directory tree, starting from ~/.clap/groups/ directory is shown below:

+
groups/
+    ├── main.yml
+    ├── groups/
+    |   ├── group1.py
+    |   └── group2.py
+    ├── group_vars/
+    │   └── all.yml
+    └── roles/
+        ├── group1.yml
+        ├── group2.yml
+        ├── group-role-1/
+        |   └── tasks/
+        |       └── main.yml
+        └── group-role-2/
+            └── tasks/
+                └── main.yml
+
+
+

The groups directory tree format follow the Ansible directory layout for content organization.

+
    +

  • The groups/main.yml is the default entry point for all group playbooks (it should not be edited)

    • +

  • The groups/groups/ directory contain files specifying the group and which action the nodes of the group can perform. +In general, this directory contains python files, where every python file determines a group (the name of the python file is the group name).

    +

    Let’s look at an example group file at groups/groups/group1.py (where the group is called group1)

    +
    • +
+
playbook = 'roles/group1.yml'
+actions = ['setup', 'start', 'terminate']
+
+
+
+
This file defines:
    +

  1. The playbook (string variable) to be executed when a group command is invoked

    2. +

  2. The actions (list of strings variable) that can be performed at nodes of this group. +For this example the setup, start and terminate actions can be performed in the nodes belonging to the group1 (for a minimal group, at least the setup action must be defined).

    3. +

  3. Then, the roles/group1.yml may select the desired tasks to execute based on the action parameter received. +Shortly, we will explain the group action commands to become clearer.

    +

    In this way, you can define as much groups as you want, just creating a new python file in the groups/groups/ directory. +The name of the file will be the group name and the file must contains the playbook variable (string) and the actions variable (list of strings). +NOTE: The setup action is mandatory

    +
    4. +
+
+
+
    +

  • The groups/group_vars directory holds common variables for all groups (usually you do not need to edit this file)

    • +
  • +
    The groups/roles define the Ansible roles, used by groups.
      +

    1. The *.yml files inside this directory are the playbooks executed by a group (specified in the group’s python file). +This playbook include roles conditionally based on the action parameter

      2. +

    2. The directories inside groups/roles directory are Ansible Roles. +Roles are ways of automatically loading desired variables based on a known file structure. +Inside of every role directory, a exists a tasks directory. +The main.yml inside the tasks directory defines the tasks to be executed when the role in included.

      +

      For more information about roles see Ansible Roles. +See the tutorials section to better understanding how to create a group ans use roles.

      +
      3. +
    +
    +
    +
    • +
+
+
+

Group Commands

+

You can see the available groups and their actions with the command below:

+
clapp group list
+
+
+

And the example output would be:

+
* docker-ce (roles/docker-ce.yml)
+  actions: setup, start-container, stop-container
+
+* ec2-efs (roles/ec2-efs.yml)
+  actions: mount, setup, umount
+
+Listed 2 groups
+
+
+

As shown, we have the ec2-efs and docker-ce groups, each one with their actions associated.

+

Once nodes are up and started you can perform actions in several nodes by using groups. +So, you first must to add the desired nodes to a group which can be accomplished by using the command below:

+
clapp group add example_group node-0 node-1 ...
+
+
+

This command will add the nodes node-0 and node-1 to the group called example_group. Note that you can add more nodes to the group, just appending more node ids in the list. +When a node is added to a group, the group’s setup action takes place configuring (e.g. installing packages, starting services) the nodes to belong to that particular group. +If the setup action fails, the node are not added to the group.

+
+

You can see which group belongs each node using the clapp node list command. Each node can have belong to several groups as desired.

+
+

After a node is added to a group, you can perform group actions using the command below:

+
clapp group action example_group example_action
+
+
+

Where the example_group is the group and example_action is the action to be performed for that group. +In this way, the example_action is executed in all nodes belonging to the example_group group.

+

You can also filter a subset of nodes from the group to execute the action by using --nodes parameter to the group action command as below:

+
clapp group action example_group example_action --nodes node-0 node-1 ...
+
+
+

For this example, the example_action action is just performed in the nodes node-0 and node-1.

+
+

NOTE: When filtering nodes with --nodes parameter, all nodes must belong to the desired group, else the action will fail.

+
+

Sometimes, group actions may require some variables to be passed from the command-line. +You can use the extra parameter to pass keyworded values to the group, as the command below (also works for group add and group remove commands):

+
clapp group action example_group example_action --nodes node-0 node-1 --extra variable1="value1" var2="another value"
+
+
+

The above command pass the variable1``and ``var2 to the group action.

+
+

NOTE: The extra parameter must be the last in the command

+
+

If a required vaiable is not passed the following error will appear (and action will fail):

+
The task includes an option with an undefined variable. The error was: 'variable' is undefined.
+
+
+

And finally, you can remove a node from a group by using the group remove command as below:

+
clapp group remove example_group node-0 node-1
+
+
+

Where in the above command, the nodes node-0 and node-1 will be removed from group example_group. +Usually the remove action may stop services, uninstall packages or copy valuable data from the host.

+

Some groups distributed with CLAP and their requirements can be found in the groups shared with CLAP section.

+
+

NOTE: You may want to use the -v (verbose) parameter for clap to show all Ansible messages (not only error messages)

+
+
+
+

Group Hosts

+

Group may also have hosts to orchestrate the group action in different nodes. +Hosts are subsets of nodes of a group and can be used to split the action to the different subsets of nodes.

+

Suppose you have a group called example which provide means to execute a program that operates in a master/slave nodes fashion. +For the traditional operation, we instantiate the nodes and them adds them to the example group using the group add command. +How can we say each node of the group is the master and which nodes are the slaves? +You can use tags for that, but Ansible provides hosts, that bypass this problem.

+

Let’s look to an example group python file at groups/groups/example.py:

+
playbook = 'roles/example.yml'
+actions = ['setup', 'start', 'terminate']
+hosts = ['master', 'slave']
+
+
+

The hosts variable is optional. For the example we have two hosts for group example: master and slave. +So the nodes belonging to the group example can be master or slave or both.

+

When hosts for a group is defined, the node must be added to the group and the host type must be speficied on the group add command as below:

+
clapp group add example/master node-0 node-1
+
+
+

The above command adds the node-0 and node-1 to the group example being master hosts. +The backslash (/) character denotes the host of a group. The node can also be added to a group being a slave, using:

+
clapp group add example/slave node-0 node-1
+
+
+

The above command adds the node-0 and node-1 to the group example being slave hosts.

+

This format (group and hosts) CLAP can optimize Ansible execution. Playbooks can use the hosts keyword to perform a specific action to a group of nodes. +Anyway if no hosts is specified in the playbook, the playbook will execute in all nodes belonging to the group.

+
+
+
NOTE:
    +

  • Hosts are optional

    • +

  • If the group has hosts defined and in the add command no specific host is passed, this is, only the group name, the node is added to group and for all hosts that the group has defined. +So in the above example if the command below is executed

    • +
+
clapp group add example node-0 node-1
+
+
+

nodes node-0 and node-1 will be added to hosts master and slaves of group example

+
+
+
+

The group list command also list hosts when available to the group. See the example below (an output for group list command):

+
* docker-ce (roles/docker-ce.yml)
+  actions: setup, start-container, stop-container
+
+* ec2-efs (roles/ec2-efs.yml)
+  actions: mount, setup, umount
+
+* example (roles/example.yml)
+  actions: setup, start-masters, start-slaves, terminate-all
+  hosts: master, slave
+
+Listed 3 groups
+
+
+

In the above example, the group example has hosts master and slave so nodes can belong to example/master or example/slave (or both). +Some actions in the example group may execute in all hosts of the group (for instance setup and terminate-all) and others may execute only in some hosts. +This is defined in the group implementation.

+

Let’s suppose the start-masters action for example group execute only in master hosts of the group, this is, inside the example.yml playbook the keyword hosts: master is defined for action start-masters. +You just need to run the action command

+
clapp group action example start-masters
+
+
+

And the start-master action will only execute in nodes of the group example that is master hosts.

+

More information about hosts can be found in the tutorials section.

+
+
+

Special variables tips

+

For all Ansible playbooks the following variables can be used:

+ + ++++ + + + + + + + + + + + + + + + + + + + +
Some Ansible special variables

Name

Description

inventory_name

ID of the node performing the task (e.g. node-0)

ansible_host

Connection IP used for the host

elasticluster.nodes

Dictionary with nodes performing the task. The dictionary key is the node id and the value is another dictionary with several information about the node (e.g. the instance id)

ansible_user

Name of the user used for login in the machine from a node

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/index.html b/docs/source/_build/html/index.html new file mode 100644 index 00000000..41725b11 --- /dev/null +++ b/docs/source/_build/html/index.html @@ -0,0 +1,254 @@ + + + + + + + + + + + CLAP — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

CLAP

+

CLoud Application Platform (CLAP) provides a interface to manage, interact and deploy HPC applications hosted in different cloud providers. +CLAP is based on the elasticluster. project, a tool that allows automated setup of compute clusters +(MPI, Spark/Hadoop, etc) and their management. CLAP extend the project by allowing a simplified interface to interact with the compute nodes. +Some of the features are:

+
    +

  • YAML-Style. configuration files to define nodes, logins and cloud configurations

    • +

  • User-friendly interface to create, setup, manage, interact and stop multiple computing nodes on different cloud providers at the same time

    • +

  • Group system to easily perform actions in different heterogeneous nodes via Ansible. playbooks

    • +

  • Easy-to-use python API.

    • +
+ +
+

Indices and tables

+ +
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/installation.html b/docs/source/_build/html/installation.html new file mode 100644 index 00000000..63ccd5fb --- /dev/null +++ b/docs/source/_build/html/installation.html @@ -0,0 +1,261 @@ + + + + + + + + + + + Installation Guide — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Installation Guide

+
    +

  1. Install requirement packages

    2. +
+
gcc g++ git libc6-dev libffi-dev libssl-dev python3-dev virtualenv python3 python3-pip
+
+
+
    +

  1. Clone the repository with

    2. +
+
git clone https://github.com/lmcad-unicamp/CLAP.git clap
+
+
+
    +

  1. Enter in clap directory with

    2. +
+
cd clap
+
+
+
    +

  1. Set the install script to execute with chmod and run the script!

    2. +
+
chmod +x install.sh
+./install.sh
+
+
+
    +

  1. To use clap, you will need to activate the virtual-env. +In the clap root directory run:

    2. +
+
source clap-env/bin/activate
+
+
+
    +

  1. Try clap, via the CLI interface:

    2. +
+
clapp -vv --show-all-help
+
+
+

To use clap you will first need to provide some information to launch instances in the cloud. +The configuration section section will guide you to write some configuration sections. +After the usage section will show you how to run clap commands based on the configurations written.

+

Section groups will show group concepts to run action on several nodes in a row. +Also, the section shows how create your own groups and actions.

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/objects.inv b/docs/source/_build/html/objects.inv new file mode 100644 index 00000000..4ad25088 Binary files /dev/null and b/docs/source/_build/html/objects.inv differ diff --git a/docs/source/_build/html/py-modindex.html b/docs/source/_build/html/py-modindex.html new file mode 100644 index 00000000..88777848 --- /dev/null +++ b/docs/source/_build/html/py-modindex.html @@ -0,0 +1,286 @@ + + + + + + + + + + + Python Module Index — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Python Module Index
    • + + +
  • + +
    • + +
+ + +
+
+
+
+ + +

Python Module Index

+ +
+ c +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ c
+ clap +
    + clap.common +
    + clap.common.cluster_repository +
    + clap.common.commands +
    + clap.common.config +
    + clap.common.driver +
    + clap.common.exceptions +
    + clap.common.factory +
    + clap.common.platform +
    + clap.common.repository +
    + clap.common.utils +
    + clap.drivers +
    + clap.drivers.elasticluster +
    + clap.drivers.elasticluster.driver +
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/pythonapi.html b/docs/source/_build/html/pythonapi.html new file mode 100644 index 00000000..76d40691 --- /dev/null +++ b/docs/source/_build/html/pythonapi.html @@ -0,0 +1,219 @@ + + + + + + + + + + + Python API — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Python API

+

Sorry, to be written…

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/search.html b/docs/source/_build/html/search.html new file mode 100644 index 00000000..1107c9db --- /dev/null +++ b/docs/source/_build/html/search.html @@ -0,0 +1,222 @@ + + + + + + + + + + + Search — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
    + +
  • Docs »
    • + +
  • Search
    • + + +
  • + + + +
    • + +
+ + +
+
+
+
+ + + + +
+ +
+ +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/searchindex.js b/docs/source/_build/html/searchindex.js new file mode 100644 index 00000000..92660eae --- /dev/null +++ b/docs/source/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["autoapi/clap/common/cluster_repository/index","autoapi/clap/common/commands/index","autoapi/clap/common/config/index","autoapi/clap/common/driver/index","autoapi/clap/common/exceptions/index","autoapi/clap/common/factory/index","autoapi/clap/common/index","autoapi/clap/common/platform/index","autoapi/clap/common/repository/index","autoapi/clap/common/utils/index","autoapi/clap/drivers/elasticluster/driver/index","autoapi/clap/drivers/elasticluster/index","autoapi/clap/drivers/index","autoapi/clap/index","autoapi/index","configuration","groups","index","installation","pythonapi","shared_groups","troubleshooting","tutorials","usage"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["autoapi/clap/common/cluster_repository/index.rst","autoapi/clap/common/commands/index.rst","autoapi/clap/common/config/index.rst","autoapi/clap/common/driver/index.rst","autoapi/clap/common/exceptions/index.rst","autoapi/clap/common/factory/index.rst","autoapi/clap/common/index.rst","autoapi/clap/common/platform/index.rst","autoapi/clap/common/repository/index.rst","autoapi/clap/common/utils/index.rst","autoapi/clap/drivers/elasticluster/driver/index.rst","autoapi/clap/drivers/elasticluster/index.rst","autoapi/clap/drivers/index.rst","autoapi/clap/index.rst","autoapi/index.rst","configuration.rst","groups.rst","index.rst","installation.rst","pythonapi.rst","shared_groups.rst","troubleshooting.rst","tutorials.rst","usage.rst"],objects:{"":{clap:[13,0,0,"-"]},"clap.common":{cluster_repository:[0,0,0,"-"],commands:[1,0,0,"-"],config:[2,0,0,"-"],driver:[3,0,0,"-"],exceptions:[4,0,0,"-"],factory:[5,0,0,"-"],platform:[7,0,0,"-"],repository:[8,0,0,"-"],utils:[9,0,0,"-"]},"clap.common.cluster_repository":{ClusterInfo:[0,1,1,""],NodeInfo:[0,1,1,""],PlatformControlInfo:[0,1,1,""],RepositoryOperations:[0,1,1,""]},"clap.common.cluster_repository.ClusterInfo":{__repr__:[0,2,1,""]},"clap.common.cluster_repository.NodeInfo":{__repr__:[0,2,1,""]},"clap.common.cluster_repository.RepositoryOperations":{_delete_clusters_info:[0,2,1,""],_delete_nodes_info:[0,2,1,""],_get_platform_repository:[0,2,1,""],_read_clusters_info:[0,2,1,""],_read_nodes_info:[0,2,1,""],create_platform_db:[0,2,1,""],exists_platform_db:[0,2,1,""],get_all_clusters:[0,2,1,""],get_all_nodes:[0,2,1,""],get_cluster:[0,2,1,""],get_clusters:[0,2,1,""],get_node:[0,2,1,""],get_nodes:[0,2,1,""],get_nodes_from_cluster:[0,2,1,""],get_platform_control:[0,2,1,""],read_platform_control_info:[0,2,1,""],remove_cluster:[0,2,1,""],remove_node:[0,2,1,""],write_cluster_info:[0,2,1,""],write_node_info:[0,2,1,""],write_platform_control_info:[0,2,1,""]},"clap.common.commands":{AbstractParser:[1,1,1,""]},"clap.common.commands.AbstractParser":{get_parser:[1,2,1,""]},"clap.common.config":{ConfigReader:[2,1,1,""],Defaults:[2,1,1,""],INSTANCE_SCHEMA:[2,4,1,""],LOGIN_SCHEMA:[2,4,1,""],PROVIDERS_SCHEMA:[2,4,1,""]},"clap.common.config.ConfigReader":{__check_instances:[2,2,1,""],__validate:[2,2,1,""],get_instance:[2,2,1,""],get_instances:[2,2,1,""],get_login:[2,2,1,""],get_logins:[2,2,1,""],get_provider:[2,2,1,""],get_providers:[2,2,1,""]},"clap.common.config.Defaults":{DEFAULT_CONF_TYPE:[2,3,1,""],DRIVER_ID:[2,3,1,""],PLATFORM_REPOSITORY:[2,3,1,""],REPOSITORY_TYPE:[2,3,1,""],app_name:[2,3,1,""],cloud_conf:[2,3,1,""],configs_path:[2,3,1,""],elasticluster_storage_path:[2,3,1,""],execution_playbook:[2,3,1,""],groups_path:[2,3,1,""],instances_conf:[2,3,1,""],log_level:[2,3,1,""],login_conf:[2,3,1,""],modules_path:[2,3,1,""],private_path:[2,3,1,""],storage_path:[2,3,1,""]},"clap.common.driver":{AbstractInstanceInterface:[3,1,1,""],Codes:[3,1,1,""]},"clap.common.driver.AbstractInstanceInterface":{__interface_id__:[3,3,1,""],__interface_version__:[3,3,1,""],check_nodes_alive:[3,2,1,""],execute_playbook_in_nodes:[3,2,1,""],get_connection_to_nodes:[3,2,1,""],pause_nodes:[3,2,1,""],resume_nodes:[3,2,1,""],start_nodes:[3,2,1,""],stop_nodes:[3,2,1,""]},"clap.common.driver.Codes":{NODE_STATUS_INIT:[3,3,1,""],NODE_STATUS_PAUSED:[3,3,1,""],NODE_STATUS_REACHABLE:[3,3,1,""],NODE_STATUS_STOPPED:[3,3,1,""],NODE_STATUS_UNREACHABLE:[3,3,1,""]},"clap.common.exceptions":{ClusterCreationError:[4,5,1,""],ClusterError:[4,5,1,""],ModuleError:[4,5,1,""],RepositoryError:[4,5,1,""],TableAlreadyExists:[4,5,1,""],ValueNotFound:[4,5,1,""]},"clap.common.exceptions.TableAlreadyExists":{__str__:[4,2,1,""]},"clap.common.factory":{PlatformFactory:[5,1,1,""]},"clap.common.factory.PlatformFactory":{__module_iface__:[5,3,1,""],__multi_instance_api__:[5,3,1,""],get_instance_api:[5,2,1,""],get_module_interface:[5,2,1,""]},"clap.common.platform":{GroupInterface:[7,1,1,""],ModuleInterface:[7,1,1,""],MultiInstanceAPI:[7,1,1,""]},"clap.common.platform.GroupInterface":{GROUP_SCHEMA:[7,3,1,""],__find_groups:[7,2,1,""],__groups_actions_map__:[7,3,1,""],get_group:[7,2,1,""],get_group_names:[7,2,1,""]},"clap.common.platform.ModuleInterface":{__find_modules:[7,2,1,""],__modules_map__:[7,3,1,""],get_module:[7,2,1,""],get_module_names:[7,2,1,""],get_modules:[7,2,1,""]},"clap.common.platform.MultiInstanceAPI":{__add_nodes_to_group:[7,2,1,""],__check_nodes_in_group:[7,2,1,""],__execute_group_action:[7,2,1,""],__execute_group_action_sequence:[7,2,1,""],__find_ifaces:[7,2,1,""],__interfaces_map__:[7,3,1,""],_get_instance_iface:[7,2,1,""],add_nodes_to_group:[7,2,1,""],add_tags_to_nodes:[7,2,1,""],check_nodes_alive:[7,2,1,""],execute_group_action:[7,2,1,""],execute_playbook_in_nodes:[7,2,1,""],export_platform:[7,2,1,""],get_connection_to_nodes:[7,2,1,""],get_groups:[7,2,1,""],get_instance_templates:[7,2,1,""],get_node:[7,2,1,""],get_nodes:[7,2,1,""],get_nodes_with_tags:[7,2,1,""],import_platform:[7,2,1,""],remove_nodes_from_group:[7,2,1,""],remove_tags_from_nodes:[7,2,1,""],start_nodes:[7,2,1,""],stop_nodes:[7,2,1,""]},"clap.common.repository":{AbstractEntry:[8,1,1,""],AbstractRepository:[8,1,1,""],RepositoryFactory:[8,1,1,""],TinyDBRepository:[8,1,1,""],check_and_create_table:[8,6,1,""],generic_read_entry:[8,6,1,""],generic_write_entry:[8,6,1,""]},"clap.common.repository.AbstractRepository":{__repository_id__:[8,3,1,""],__repository_name__:[8,3,1,""],__repository_version__:[8,3,1,""],create_element:[8,2,1,""],create_table:[8,2,1,""],drop_elements:[8,2,1,""],drop_tables:[8,2,1,""],exists_table:[8,2,1,""],retrieve_elements:[8,2,1,""],retrieve_tables:[8,2,1,""],update_element:[8,2,1,""]},"clap.common.repository.RepositoryFactory":{exists_repository:[8,2,1,""],get_repository:[8,2,1,""]},"clap.common.repository.TinyDBRepository":{DEFAULT_STORAGE_TYPE:[8,3,1,""],__repository_id__:[8,3,1,""],__repository_name__:[8,3,1,""],__repository_version__:[8,3,1,""],__storage_types_map:[8,3,1,""],create_element:[8,2,1,""],create_table:[8,2,1,""],drop_elements:[8,2,1,""],drop_tables:[8,2,1,""],exists_table:[8,2,1,""],retrieve_elements:[8,2,1,""],retrieve_tables:[8,2,1,""],update_element:[8,2,1,""]},"clap.common.utils":{Struct:[9,1,1,""],get_file_checksum:[9,6,1,""],log:[9,4,1,""],path_extend:[9,6,1,""],setup_log:[9,6,1,""],yaml_load:[9,6,1,""]},"clap.common.utils.Struct":{__delitem__:[9,2,1,""],__getitem__:[9,2,1,""],__iter__:[9,2,1,""],__len__:[9,2,1,""],__setitem__:[9,2,1,""],copy:[9,2,1,""],keys:[9,2,1,""]},"clap.drivers":{elasticluster:[11,0,0,"-"]},"clap.drivers.elasticluster":{"interface":[11,4,1,""],ElasticlusterInterface:[11,1,1,""],driver:[10,0,0,"-"]},"clap.drivers.elasticluster.ElasticlusterInterface":{__get_or_create_cluster:[11,2,1,""],__get_updated_cluster:[11,2,1,""],__interface_id__:[11,3,1,""],__stop_cluster:[11,2,1,""],check_nodes_alive:[11,2,1,""],execute_playbook_in_nodes:[11,2,1,""],get_connection_to_nodes:[11,2,1,""],pause_nodes:[11,2,1,""],resume_nodes:[11,2,1,""],start_nodes:[11,2,1,""],stop_nodes:[11,2,1,""]},"clap.drivers.elasticluster.driver":{AnsibleSetupProviderWrapper:[10,1,1,""],ElasticCreator:[10,1,1,""],ElasticlusterInterface:[10,1,1,""],elasticluster_check_starting_nodes:[10,6,1,""],elasticluster_get_connection_to_node:[10,6,1,""],elasticluster_pause_nodes:[10,6,1,""],elasticluster_stop_nodes:[10,6,1,""],elaticluster_start_nodes:[10,6,1,""]},"clap.drivers.elasticluster.driver.AnsibleSetupProviderWrapper":{_write_extra_vars:[10,2,1,""],build_inventory:[10,2,1,""],run_playbook:[10,2,1,""]},"clap.drivers.elasticluster.driver.ElasticCreator":{__to_elasticluster_config:[10,2,1,""],create_cluster_obj:[10,2,1,""],exists_cluster:[10,2,1,""],get_all_cluster_objs:[10,2,1,""],get_cluster_obj:[10,2,1,""],get_final_config:[10,2,1,""],get_node_from_cluster:[10,2,1,""],get_nodes_from_cluster:[10,2,1,""],update_cluster_config:[10,2,1,""],upddate_cluster_node:[10,2,1,""]},"clap.drivers.elasticluster.driver.ElasticlusterInterface":{__get_or_create_cluster:[10,2,1,""],__get_updated_cluster:[10,2,1,""],__interface_id__:[10,3,1,""],__stop_cluster:[10,2,1,""],check_nodes_alive:[10,2,1,""],execute_playbook_in_nodes:[10,2,1,""],get_connection_to_nodes:[10,2,1,""],pause_nodes:[10,2,1,""],resume_nodes:[10,2,1,""],start_nodes:[10,2,1,""],stop_nodes:[10,2,1,""]},clap:{common:[6,0,0,"-"],drivers:[12,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","data","Python data"],"5":["py","exception","Python exception"],"6":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:data","5":"py:exception","6":"py:function"},terms:{"07d0cf3af28718ef8":15,"abstract":[1,3,8,10,11],"boolean":[0,15],"class":[0,1,2,3,5,7,8,9,10,11],"default":[0,2,5,8,10,15,16],"final":[16,23],"float":23,"function":0,"int":[3,7,9,10,11],"new":[0,8,15,16],"public":15,"return":[0,5,7,8,9],"static":[5,7,8,10],"super":15,"true":[0,8,15],"try":[18,23],AWS:[15,20,23],Adding:20,And:[16,23],For:[15,16,20,23],IDs:[15,23],Ids:0,Its:23,The:[0,3,5,7,8,15,16,18,20,23],Then:16,These:15,__add_nodes_to_group:7,__check_inst:2,__check_nodes_in_group:7,__delitem__:9,__execute_group_act:7,__execute_group_action_sequ:7,__find_group:7,__find_ifac:7,__find_modul:7,__get_or_create_clust:[10,11],__get_updated_clust:[10,11],__getitem__:9,__groups_actions_map__:7,__interface_id__:[3,10,11],__interface_version__:3,__interfaces_map__:7,__iter__:9,__len__:9,__module_iface__:5,__modules_map__:7,__multi_instance_api__:5,__repository_id__:8,__repository_name__:8,__repository_version__:8,__repr__:0,__setitem__:9,__stop_clust:[10,11],__storage_types_map:8,__str__:4,__to_elasticluster_config:10,__valid:2,_delete_clusters_info:0,_delete_nodes_info:0,_get_instance_ifac:7,_get_platform_repositori:0,_read_clusters_info:0,_read_nodes_info:0,_subparsersact:1,_write_extra_var:10,abc:9,abcdfefxx:15,about:[0,15,16,23],abov:[15,16,20,23],absolut:20,abstractdescriptorentri:8,abstractentri:[0,8],abstractinstanceinterfac:[3,10,11],abstractpars:1,abstractrepositori:[0,8],access:[8,15],access_keyfil:15,accomplish:16,across:[0,5],action:[7,15,16,17,18,23],activ:[18,23],add:[15,16,20,23],add_nodes_to_group:7,add_tags_to_nod:7,added:[16,20,23],adding:[8,15,20],addit:[0,8,20],address:0,after:[8,16,18,20,23],aim:23,akiaiosfodnn7exampl:15,all:[0,7,8,15,16,18,20,23],allow:[15,17,23],almost:23,alreadi:[0,8,23],also:[15,16,18,20,23],altern:23,alwai:[8,20,23],amazon:[15,23],amazonaw:15,ami:15,among:[15,20],ani:[8,10,20,23],anoth:[8,16,23],ans:16,ansibl:[17,20,23],ansible_host:16,ansible_provid:10,ansible_us:16,ansiblesetupprovid:10,ansiblesetupproviderwrapp:10,anywai:16,api:[5,7,17],app_nam:2,appar:23,appear:[16,23],append:[16,23],applic:[15,17],apt:20,arg:[0,3,4,7,8,9,10,11,20],argpars:1,argument:[8,20],assign:23,associ:[8,16,23],attach:0,auto:14,autoapi:14,autom:17,automat:[16,20,23],avail:[15,16],avali:0,awar:20,aws:[0,15,23],azur:0,backslash:16,base:[0,4,8,9,10,11,15,16,17,18,20,23],bash:20,basic:[8,16,17],becom:[16,20],befor:[8,15,20],begin:20,being:16,belong:[16,20,23],below:[15,16,20,23],better:16,between:[3,15],bin:[18,20,23],block:15,bool:[0,8],boot_disk_devic:15,boot_disk_s:15,boot_disk_typ:15,both:16,bpxrficyexamplekei:15,build_inventori:10,button:15,bypass:16,call:[15,16],can:[0,8,15,16,20,23],cannot:[15,23],capabl:15,cast:8,cast_to:8,cento:15,chanc:15,chang:[20,23],charact:16,check:[0,8],check_and_create_t:8,check_nodes_al:[3,7,10,11],chmod:[15,18],clap:[14,15,18,23],clapp:[16,18,20,23],claus:8,clearer:16,cli:[15,18],client:20,clone:18,cloud:[0,7,17,18,20,23],cloud_conf:[2,10,11],cluster:[0,3,5,7,10,15,17,23],cluster_id:[0,10,11],cluster_nam:[0,10],cluster_repositori:[6,13,14],clustercreationerror:4,clustererror:4,clusterinfo:0,cmd:20,code:3,collect:9,com:[15,18],come:23,command:[6,13,14,15,17,18,23],commands_pars:1,common:[10,11,13,14,16,23],commun:15,compos:0,comput:[15,17,23],concept:[16,18],condit:8,condition:16,config2:15,config:[6,13,14,15,23],configread:2,configs_path:2,configur:[16,17,18,23],connect:[0,15,16],connection_ip:23,consid:[20,23],consist:15,consol:23,contain:[7,8,14,15,16,23],content:[16,17],control:[0,23],convert:8,copi:[9,15,16],correct:[0,23],correspond:15,could:15,creat:[0,3,8,14,15,16,17,18],create_cluster_obj:10,create_el:8,create_new:8,create_platform_db:0,create_repositori:8,create_t:8,creation:23,creiteria:8,creteria:8,criteria:8,criterion:0,current:15,data:[2,8,16],databas:[0,8],debian:20,debug:23,default_conf_typ:[2,10],default_driv:[5,7],default_storage_typ:8,defin:[15,16,17,23],delet:[8,20],denot:16,depend:15,deploi:17,deploy:16,deriv:8,describ:[16,23],descript:[15,16,20],desir:[15,16,23],dest:20,destin:20,detail:[15,23],determin:16,dev:[15,18],devic:15,dict:[2,3,7,8,9,10,11],dictionari:[0,8,15,16],differ:[5,7,15,16,17,23],directli:[3,23],directori:[15,16,18,20,23],discuss:23,disk:15,distribut:16,doc:15,docker:16,document:[8,14,15,20],doe:[8,15,20,23],don:23,download:15,driver:[0,5,6,7,13,14,15],driver_id:[0,2,5,7],driver_vers:0,drop:[0,8],drop_el:8,drop_tabl:8,dsa:15,each:[0,15,16,20,23],easi:17,easili:[17,23],east:[15,23],ec2:[15,16,23],ec2_access_kei:15,echo:[20,23],eclasticluster_config_fil:10,edit:[15,16],efs:[16,20],efs_mount_point:20,elasticcr:10,elasticlust:[2,12,13,14,15,16,17],elasticluster_check_starting_nod:10,elasticluster_get_connection_to_nod:10,elasticluster_pause_nod:10,elasticluster_stop_nod:10,elasticluster_storage_path:[2,10],elasticlusterinterfac:[10,11],elaticluster_start_nod:10,element:[0,8],els:[0,8,16,20],enabl:15,endpoint:15,enter:18,entri:[3,8,16],env:[18,23],environ:23,error:[7,15,16,23],error_act:7,etc:[15,16,17],even:15,everi:[8,15,16,23],exampl:[15,16,20,23],example_act:16,example_group:16,except:[0,6,8,13,14],execut:[15,16,18,20],execute_group_act:7,execute_playbook_in_nod:[3,7,10,11],execution_playbook:2,exist:[0,8,16],exists_clust:10,exists_platform_db:0,exists_repositori:8,exists_t:8,explain:16,export_platform:7,extend:[15,17],extra:[16,20,23],extra_arg:[3,7,10,11],extra_var:10,factori:[6,13,14],fail:[0,8,15,16],failur:23,fals:[0,8],fashion:16,featur:[17,23],fetched_fil:20,field:[8,15],file:[0,15,16,17,20,23],file_path:9,filenam:[9,10,15],filepath:20,filesystem:[15,20],filter:[16,20],fingerprint:23,first:[8,15,16,18,20,23],flavor:[0,15],follow:[0,15,16,20,23],format:[8,15,16,23],found:16,friendli:17,from:[0,7,8,15,16,20,23],gcc:18,gener:[8,14,15,16],generic_read_entri:8,generic_write_entri:8,get:[0,5,7,8,15,23],get_all_clust:0,get_all_cluster_obj:10,get_all_nod:0,get_clust:0,get_cluster_obj:10,get_connection_to_nod:[3,7,10,11],get_file_checksum:9,get_final_config:10,get_group:7,get_group_nam:7,get_inst:2,get_instance_api:5,get_instance_templ:7,get_login:2,get_modul:7,get_module_interfac:5,get_module_nam:7,get_nod:[0,7],get_node_from_clust:10,get_nodes_from_clust:[0,10],get_nodes_with_tag:7,get_pars:1,get_platform_control:0,get_provid:2,get_repositori:8,gib:15,gibibyt:15,git:18,github:18,given:0,gp2:15,group1:16,group2:16,group:[7,15,17,18,23],group_arg:7,group_hosts_map:[3,7,10,11],group_nam:7,group_path:7,group_schema:7,group_var:[3,10,11,15,16],groupinterfac:7,groups_path:2,guid:17,hadoop:17,has:[16,23],hat:20,have:[15,16,23],help:[18,23],helper:[0,8],here:20,heterogen:17,higher:23,hold:[0,8,15,16],home:[15,20],host:[7,15,17,20],how:[15,16,18,23],hpc:17,http:[15,18],identif:0,ids:[0,16],ignor:[7,23],imag:15,image_id:15,image_userdata:15,imlpement:8,implement:[3,7,8,16],import_platform:7,includ:[15,16],increas:23,increment:0,index:[0,17],indic:[8,20],info:[8,9],info_typ:8,inform:[0,8,15,16,18,20,23],inherit:8,initi:[3,9],input:23,insert:[8,15],insid:[8,15,16,20,23],instal:[16,17,20,23],instanc:[0,9,10,16,17,18,20],instance_nam:2,instance_schema:2,instance_typ:23,instances_conf:2,instances_fil:2,instances_num:[3,7,10,11],instanti:[16,23],instead:3,intanc:20,interact:[3,15,17,20,23],interest:23,interfac:[0,3,5,7,11,17,18],interfaceid:3,invalid:[8,15],inventory_nam:16,invok:16,io1:15,iop:15,ips:23,its:[8,15,23],itself:15,jobmanag:23,json:[2,8,10,15],just:[15,16,23],k7mdeng:15,kei:[0,8,9,16,23],key_pair:15,key_us_east_1:15,keyfil:15,keygen:15,keypair:[0,15,23],keypair_nam:15,keypair_private_fil:15,keypair_public_fil:15,keyword:[8,16,23],kind_groups_map:10,kind_key_value_var:10,known:[0,16,20],kwarg:[0,3,4,7,8,9,10,11],larg:15,last:[0,16,23],late:23,latenc:15,later:23,launch:[15,18,23],layout:16,least:16,let:16,level:23,libc6:18,libffi:18,libssl:18,like:15,line:[16,20,23],list:[0,3,7,8,10,11,16,20],lmcad:18,load:16,localhost:20,log:[9,15],log_level:2,log_nam:9,login:[16,17,23],login_conf:[2,10,11],login_config:10,login_nam:[2,10],login_schema:2,logins_fil:2,look:16,low:15,machin:[0,15,16,20,23],mai:[15,16,23],main:[15,16],make:15,manag:[3,7,16,17,23],mandatori:16,mani:15,manipul:5,manner:7,map:15,master:16,match:[0,8,15],max_concurrent_request:10,mean:[16,20],mechan:23,medium:15,mei:23,menu:15,messag:[16,23],metadata:15,method:8,micro:[0,15],minim:[15,16],model:8,modifi:8,modul:[15,17],module_nam:7,moduleerror:4,moduleinterfac:[5,7],modules_path:2,more:[15,16,20,23],mount:[16,20],mount_ip:20,mount_permiss:20,mpi:17,much:16,multiinst:5,multiinstanceapi:[5,7],multipl:[16,17],must:[8,15,16,20,23],mutablemap:9,name:[0,7,8,9,15,16,20],need:[15,16,18,20,23],network:[15,20],network_id:15,nfs:20,node:[0,3,5,7,10,15,16,17,18,20],node_id:[0,3,7,10,11],node_nam:[0,10],node_name_id_map:10,node_obj:10,node_status_init:3,node_status_paus:3,node_status_reach:3,node_status_stop:3,node_status_unreach:3,nodeinfo:0,none:[0,3,7,8,9,10,11,20],notat:8,note:[15,16,20,23],noth:[0,8],now:16,number:23,obj:8,object:[0,3,5,8,9],obtain:[15,23],occur:23,offer:23,ola:23,old:8,onc:[15,16,23],one:[0,8,15,16,20,23],onli:[15,16,20,23],open:0,oper:[0,7,8,16,23],optim:16,option:[15,16,20,23],orchestr:16,order:[15,16],organ:16,orient:8,other:[15,16,20,23],otherwis:8,output:[16,23],output_filenam:7,outsid:15,overwrit:[0,8],own:18,owner:20,packag:[7,16,18],page:[14,17,23],pair:[15,23],paramet:[0,7,8,16,20,23],paramiko:10,part:15,parti:15,particular:16,pass:[0,8,16,20,23],password:15,past:15,path:[15,20],path_extend:9,path_to_key_pair:15,paus:[3,20],pause_nod:[3,10,11],pem:15,perform:[0,7,15,16,17,20,23],period:23,permiss:[15,20],person1:8,person_id:8,pick:5,pip:18,place:[15,16,20],placement:15,placement_group:15,platform:[0,3,6,13,14,15,17,23],platform_db:[5,7],platform_repositori:[0,2,5],platformcod:0,platformcontrolinfo:0,platformfactori:5,playbook:[10,16,17,23],playbook_path:[3,7,10,11],point:16,polici:8,popul:15,power:16,pre:16,preced:23,present:15,print:23,privat:[0,15],private_path:2,problem:16,program:16,project:17,properli:8,properti:15,provid:[0,7,10,16,17,18,20,23],provider_config:10,provider_id:23,provider_nam:[2,10],providers_fil:2,providers_schema:2,provis:15,prudent:23,pub:15,purpos:15,put:[20,23],python3:18,python:[16,17],queri:[0,8],quickli:20,rais:[0,8,15],reachabl:[3,23],read:[0,8,15],read_platform_control_info:0,receiv:16,recommend:23,recurs:20,red:20,refer:[15,17,23],region:[0,15],rel:20,remot:[16,20],remov:[8,16,23],remove_act:7,remove_clust:0,remove_nod:0,remove_nodes_from_group:7,remove_tags_from_nod:7,replac:[8,23],repositori:[0,3,6,7,13,14,18],repository_oper:[3,10,11],repository_path:8,repository_typ:[0,2,5,7,8],repositoryerror:4,repositoryfactori:8,repositoryoper:[0,3,10,11],repres:[0,8],repsitori:8,requir:[15,16,18,20],resourc:15,respect:23,respons:3,resum:[20,23],resume_nod:[3,10,11],retriev:[0,8,23],retrieve_el:8,retrieve_t:8,retriv:8,right:23,role:[15,16],root:[15,18],row:[16,18,20,23],rsa:[15,23],rule:15,run:[15,16,18,23],run_playbook:10,sai:16,same:[0,8,15,17,23],save:15,schema:2,script:[15,18,23],sda1:15,seach:20,search:[8,17,20],secgroup:15,second:[20,23],secret:15,secret_access_keyfil:15,section:[15,16,18,23],secur:15,security_group:15,see:[0,15,16,20,23],select:[16,20,23],self:[0,1,2,3,4,7,8,9,10,11],sensit:15,serializ:8,servic:[16,20],set:[8,10,15,16,18,23],setup:[16,17],setup_log:9,sever:[0,15,16,18,20,23],shallow:9,share:[16,17],shebang:20,shell:[15,20,23],shortli:16,should:16,show:[16,18,20,23],shown:[15,16,20,23],similar:[8,20],similarli:23,siml:8,simpl:23,simplifi:17,singl:8,size:15,slave:16,some:[8,15,17,18,20,23],someth:15,sometim:16,sorri:[19,21,22],sourc:[18,23],spark:17,special:17,specif:[8,15,16,23],specifi:[8,15,16,20,23],spefici:16,sphinx:14,spit:23,split:16,src:20,ssd:15,ssh:[0,15,23],sshclient:10,stand:15,standard:15,start:[15,16,20],start_nod:[3,7,10,11],statu:[0,3,23],stderr:23,stdout:23,stop:[3,16,17,20,23],stop_nod:[3,7,10,11],storag:[8,15],storage_path:[2,10],storage_typ:[8,10],store:[0,15,16],str:[0,2,3,4,5,7,8,9,10,11],string:[15,16,20,23],struct:[8,9],structur:[15,16],style:17,subnet:15,subset:16,successfulli:[16,23],sudo:15,sudo_us:15,suppli:23,support:[8,23],suppos:16,system:[15,17,20],t2small:15,tabl:[0,8],table_nam:[4,8],tablealreadyexist:[0,4,8],tag:[0,7,16,20],take:16,taken:8,task:16,taskmanag:23,templat:[0,17,23],termin:16,than:23,them:[15,16,23],thi:[0,8,9,14,15,16,20,23],third:[15,20],tho:20,thread:23,three:23,time:[17,23],timeout:23,tinydb:[2,8],tinydbrepositori:8,tip:17,tomount:20,tool:17,tradit:16,transfer:20,transpar:[7,23],tree:16,troubleshoot:[17,23],tupl:10,tutori:[16,17],two:[15,16],type:[0,5,7,8,15,16,20,23],ubuntu:[15,20,23],umount:16,undefin:16,understand:16,unicamp:18,uninstal:16,union:7,uniqu:[0,15,23],unix:20,unmount:20,unreach:3,updat:[0,8,23],update_cluster_config:10,update_el:8,upddate_cluster_nod:10,upload:23,upon:8,url:15,usag:[17,18],use:[15,16,17,18,20,23],used:[0,5,7,8,15,16,20,23],useful:23,user:[0,15,16,17,20],userto:15,uses:[15,16,23],using:[8,15,16,20,23],usual:[15,16],util:[6,8,13,14],vaiabl:16,val:9,valu:[8,16,23],valuabl:16,value1:16,valueerror:8,valuenotfound:4,var2:16,variabl:[8,17,23],variable1:[16,23],variable2:23,verbos:[16,23],verbosity_level:9,veri:23,version:0,via:[15,17,18,20,23],virtual:[15,18,23],virtualenv:18,volum:15,vpc:15,wai:[16,23],wait:20,want:[15,16,23],what:23,when:[0,8,15,16,20,23],where:[0,8,15,16,20,23],which:[8,16,20],whole:15,without:15,wjalrxutnfemi:15,work:[17,23],workdir:20,worri:23,would:[16,20],write:[0,8,18],write_cluster_info:0,write_node_info:0,write_platform_control_info:0,written:[0,8,18,19,21,22],xxx:[0,15,23],yaml:[15,17,23],yaml_load:9,yet:23,yml:[10,15,16,23],you:[15,16,18,20,23],your:[15,18,23],zip_filenam:7,zone:[0,15]},titles:["clap.common.cluster_repository","clap.common.commands","clap.common.config","clap.common.driver","clap.common.exceptions","clap.common.factory","clap.common","clap.common.platform","clap.common.repository","clap.common.utils","clap.drivers.elasticluster.driver","clap.drivers.elasticluster","clap.drivers","clap","API Reference","Basic Configuration Setup","Groups","CLAP","Installation Guide","Python API","Groups shared with CLAP","Troubleshooting","Tutorials","Usage"],titleterms:{EFS:20,action:20,aliv:23,ansibl:16,api:[14,19],avail:[20,23],basic:15,check:23,clap:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,16,17,20],cloud:15,cluster_repositori:0,command:[1,16,20],common:[0,1,2,3,4,5,6,7,8,9,20],config:2,configur:15,connect:23,content:[0,1,2,3,4,5,7,8,9,10,11],copi:20,docker:20,driver:[3,10,11,12],ec2:20,elasticlust:[10,11],except:4,execut:23,factori:5,fetch:20,group:[16,20],guid:18,host:16,indic:17,instal:18,instanc:[15,23],kei:15,list:23,login:15,modul:[0,1,2,3,4,5,7,8,9,10],node:23,packag:[11,20],platform:7,provid:15,python:19,reboot:20,refer:14,repositori:8,run:20,script:20,setup:[15,20],share:20,some:16,special:16,start:23,submodul:[6,11],subpackag:[12,13],tabl:17,tag:23,templat:15,termin:23,tip:16,troubleshoot:21,tutori:22,umount:20,updat:20,usag:23,util:9,valid:15,valu:15,variabl:[16,20],work:16}}) \ No newline at end of file diff --git a/docs/source/_build/html/shared_groups.html b/docs/source/_build/html/shared_groups.html new file mode 100644 index 00000000..35be7076 --- /dev/null +++ b/docs/source/_build/html/shared_groups.html @@ -0,0 +1,596 @@ + + + + + + + + + + + Groups shared with CLAP — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Groups shared with CLAP

+

Here are some groups shared with CLAP. Setup action is always executed when adding a node to a group. +Also, the --nodes and --tag parameters can be passed to the clapp group action command to selectively select nodes inside the group that will execute the action, else the action will be performed in all nodes belonging to a group.

+
+

Commands common

+

This group provide means to execute common known commands in several machines in the group, such as: reboot, copy files to nodes, copy and execute shell scripts, among others. +Consider add instances to this group to quickly perform common commands in several nodes in a row.

+

No hosts are needed for this group.

+ + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
Common available actions

Name

Description

copy

Copy a file from the localhost to the remote nodes

fetch

Fetch files from the remote nodes to the localhost

reboot

Reboot a machine and waits it to become available

run-command

Execute a shell command in the remote hosts

run-script

Transfer a script from localhost to remote nodes and execute it in the remote hosts

update-packages

Update packages in the remote hosts

+

Variables and examples for each action is shown below

+
+

copy action variables

+

The following variables must be informed when running the copy action (via extra parameter)

+ + +++++ + + + + + + + + + + + + + + + + +
Common-commands copy action variables

Name

Type

Description

src

path

File to be copied to the remote hosts. If the path is not absolute (it is relative), it will search in the group’s files directory else the file indicated will be copied. +If the file is a directory, it will be recursive copied.

dest

path

Destination path where the files will be put into (remote nodes)

+

Examples of the group’s copy action is showed below:

+
clapp group action commands-common copy --extra src="/home/ubuntu/file" dest="~"
+
+
+

The above command copy the file at /home/ubuntu/file (localhost) the the ~ directory of the remote hosts

+

Or, you can use filters such as --nodes and --tag to the clapp group action command to selectively specify which nodes inside the group the action will be executed

+
clapp group action commands-common copy --nodes node-0  node-1 --extra src="/home/ubuntu/file" dest="~"
+clapp group action commands-common copy --tag 'x=y' --extra src="/home/ubuntu/file" dest="~"
+
+
+

The above (first one) command copy the file at /home/ubuntu/file (localhost) the the ~ directory of the nodes node-0 and node-1

+

The above (second one) command copy the file at /home/ubuntu/file (localhost) the the ~ directory of all nodes in the belonging to the commands-common group, tagged with x=y

+
+
+

fetch action variables

+

The following variables must be informed when running the fetch action (via extra parameter)

+ + +++++ + + + + + + + + + + + + + + + + +
Common-commands fetch action variables

Name

Type

Description

src

path

File to be copied from the remote hosts. +If the file is a directory, it will be recursive copied.

dest

path

Destination path where the files will be put into (localhost)

+

Examples of the group fetch action is showed below:

+
clapp group action commands-common fetch --extra src="~/file" dest="/home/ubuntu/fetched_files/"
+
+
+

The above command fetch a file at ~/file directory from the nodes and place at the /home/ubuntu/fetched_files/ directory of the localhost

+
+
+

reboot action variables

+

This action does not require any additional variable to be passed

+
clapp group action commands-common reboot
+clapp group action commands-common reboot --nodes node-0
+clapp group action commands-common reboot --tag 'x=y'
+
+
+

The first command reboot all machines belonging to the commands-common group.

+

The second one reboot the node-0 and the third one reboot the machines belonging to the group and tagged with 'x=y'

+
+
+

run-command action variables

+

The following variables must be informed when running the run-command action (via extra parameter)

+ + +++++ + + + + + + + + + + + + + + + + +
Common-commands run-command action variables

Name

Type

Description

cmd

string

String with the command to be executed in the nodes

workdir (optional)

path

Change into this directory before running the command. If none is passed, home directory of the remote node will be used

+

Examples of the group run-command action is showed below:

+
clapp group action commands-common run-command --extra cmd="ls"
+clapp group action commands-common run-command --extra cmd="ls" workdir="/bin"
+
+
+

The above command (first one) runs the command ls in the remote nodes

+

The above command (second one) runs the command ls in the remote nodes, after changing to the “/bin” directory

+
+
+

run-script action variables

+

The following variables must be informed when running the run-script action (via extra parameter).

+ + +++++ + + + + + + + + + + + + + + + + + + + + +
Common-commands run-script action variables

Name

Type

Description

src

string

Shell script file to be executed in the remote nodes. The file will be first copied (from localhost) to the nodes and after will be executed. Note: the script file must begin with the bash shebang (#!/bin/bash). Also the script filepath must be absolute else, if relative path is passed, Ansible seach in the group’s file directory. The script will be deleted from nodes after execution.

args (optional)

string

Command-line arguments to be passed to the script.

workdir (optional)

path

Change into this directory before running the command. If none is passed, home directory of the remote node will be used (Path must be absolute for Unix-aware nodes)

+

Examples of the group run-script action is showed below:

+
clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh"
+clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh" args="1 2 3"
+clapp group action commands-common run-script --extra src="/home/ubuntu/echo.sh" args="1 2 3" workdir="/home"
+
+
+

The above command (first one) will copy the /home/ubuntu/echo.sh script from localhost to the remote nodes and execute it (similar to run bash -c echo.sh in the hosts).

+

The above command (second one) will copy the /home/ubuntu/echo.sh script from localhost to the remote nodes and execute it using the arguments “1 2 3” (similar to run bash -c echo.sh 1 2 3 in the hosts).

+

The above command (third one) is similar to the second one but will execute the script in the /home directory.

+
+
+

update-packages action variables

+

This action does not require any additional variable to be passed

+
clapp group action commands-common update-packages
+
+
+

The above command will update the package list from remote hosts (similar to apt update command)

+
+
+
+

EC2 Common

+

This group provide means to interact with AWS EC2 instances, such as pausing and resuming nodes

+

The actions for the group is listed below (the setup action is automatically executed when the node is added to the group). +No hosts are needed for this group.

+ + ++++ + + + + + + + + + + + + + +
EC2 Common group actions

Name

Description

pause

Pause (stop) instances in the EC2 cloud

resume

Resume paused (stopped) instances in the EC2 cloud

+

Example of the command is showed below:

+
    +

  • Adding nodes to the group

    • +
+
clapp group add ec2-common node-0
+
+
+

The above command add node-0 to the EC2 Common group

+
    +

  • Pausing (stopping) intances

    • +
+
clapp group action ec2-common pause
+clapp group action ec2-common pause --nodes node-0 node-1
+
+
+

For the above commands, the first one pause (stop) all EC2 instances belonging tho the EC2 Common group +and the second one pause only the nodes node-0 and node-1.

+
+
+

EC2 EFS

+

This group setup and mount an network EFS filesystem on AWS provider.

+

The actions for the group is listed below (the setup action is automatically executed when the node is added to the group). +No hosts are needed for this group.

+ + ++++ + + + + + + + + + + + + + +
EC2 EFS group actions

Name

Description

setup

Install nfs client and mount EC2 file system

umount

Umount EC2 File System

+
+

Setup action variables

+

The following variables must be informed when running the setup action (via extra parameter)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EC2 EFS setup action variables

Name

Type

Description

efs_mount_point

path

Directory path where the filesystem will be mounted

user

string

Name of the user owner (e.g. ubuntu)

group

string

Name of the group owner (e.g. ubuntu)

mount_ip

string

Mount ip of the filesystem (see AWS EFS Documentation for more information)

mount_permissions

string

Permission used tomount the filesystem (e.g. 0644)

+

An example of the command would be:

+
clapp group add ec2-efs node-0 --extra efs_mount_point="/efs" user="ubuntu" group="ubuntu" mount_ip="192.168.0.1" mount_permissions="0644"
+
+
+

The above command will install and mount EC2 EFS filesystem on node-0

+
+
+

Umount action variables

+

The following variables must be informed when running the umount action (via extra parameter)

+ + +++++ + + + + + + + + + + + + +
EC2 EFS umount action variables

Name

Type

Description

efs_mount_point

path

Directory path where the filesystem will be unmounted

+

An example of the command would be:

+
clapp group action ec2-efs umount --nodes node-0 --extra efs_mount_point="/efs"
+
+
+

The above command will unmount EC2 EFS filesystem from node-0

+
+
+
+

Docker

+

This group installs docker-ce in debian and red-hat based systems

+

The actions for the group is listed below (the setup action is automatically executed when the node is added to the group). +No hosts are needed for this group.

+ + ++++ + + + + + + + + + + +
Docker group

Name

Description

setup

Install docker-ce and start the service

+

No additional variables is needed for the group

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/troubleshooting.html b/docs/source/_build/html/troubleshooting.html new file mode 100644 index 00000000..756300cd --- /dev/null +++ b/docs/source/_build/html/troubleshooting.html @@ -0,0 +1,219 @@ + + + + + + + + + + + Troubleshooting — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Troubleshooting

+

Sorry, to be written…

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/tutorials.html b/docs/source/_build/html/tutorials.html new file mode 100644 index 00000000..0d56ce77 --- /dev/null +++ b/docs/source/_build/html/tutorials.html @@ -0,0 +1,219 @@ + + + + + + + + + + + Tutorials — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Tutorials

+

Sorry, to be written…

+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/_build/html/usage.html b/docs/source/_build/html/usage.html new file mode 100644 index 00000000..4e286f0a --- /dev/null +++ b/docs/source/_build/html/usage.html @@ -0,0 +1,356 @@ + + + + + + + + + + + Usage — CLoud Application Platform 0.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + + + + +
+ + + + +
+
+
+
+ +
+

Usage

+

CLAP is a platform to start, stop and manage instances (nodes) in different cloud providers transparently. +CLAP also offer mechanisms to control what is installed in each node and to perform actions in a group of nodes in a row.

+

This section describes the common use commands to start, stop and manage instances.

+

To use clap, first activate the virtual environment running the following command (inside CLAP directory):

+
source clap-env/bin/activate
+
+
+

CLAP has several commands, you can use

+
clapp -v --show-all
+
+
+

command to get information about all available commands. +Alternatively you can use --help in each command to see the features. +The -v parameter can always be used, increasing he verbosity level of CLAP. -vv allows showing DEBUG messages.

+
+

List available instances

+

To list the nodes managed by CLAP, you can use the command:

+
clapp node list
+
+
+

If there is any node already instantiated, an example output is shown below:

+
*  Node(id=`node-1`, instance_type=`type-a`, status=`reachable`, provider_id: `aws-config-us-east-1`, connection_ip=`54.89.209.193`, groups=`spits/jobmanager`, tags=`spits=cluster-spits`)
+*  Node(id=`node-2`, instance_type=`type-a`, status=`reachable`, provider_id: `aws-config-us-east-1`, connection_ip=`54.157.8.46`, groups=`spits/taskmanager`, tags=`spits=cluster-spits`)
+Listed 2 nodes(s)
+
+
+

For several commands, CLAP uses the node id (e.g. node-1, node-2) to perform operation in the nodes, transparently. +Nodes may have tags (discussed lately) to easily perform selections and mey belong to groups, to perform group actions (discussed later).

+

You may want to see the troubleshooting page if any failure occurs when working with nodes.

+
+
+

Start Instances and Check Aliveness

+

To instantiate one node based on an instance template defined in the ~/.clap/configs/instances.yaml file, you can use the command:

+
clapp -v node start ubuntu-instance-aws
+
+
+

Where the ubuntu-instance-aws refers to the instance template ID defined in the ~/.clap/configs/instances.yaml file. +In this way, you need to configure the files only once and launch instances any time.

+

To launch more than one machine with the same instance template ID, you can put the desired number after the instance template ID preceded by an :. For instance, the command below:

+
clapp -v node start ubuntu-instance-aws:4
+
+
+

Instantiates 4 ubuntu-instance-aws virtual machines in a row! +Once the instance is started, CLAP will try to login (via SSH) with the login information provided. +The machine is considered instantiated when the SSH connection is performed successfully. Machines instantiated that cannot perform SSH in a timeout (600 seconds) are automatically stopped.

+

You can also instantiate different machines in a row using the same command, but just appending more instance template IDs to it:

+
clapp -v node start ubuntu-instance-aws:2 example-instance-aws:2
+
+
+

The above command instantiates 2 ubuntu-instance-aws machines and 2 example-instance-aws machines in a row!

+

Once instances are successfully started, CLAP will assign to each one an unique node ID used to perform other operations to it. +The clapp node list command can be used to show managed clap instances and a more detailed information of a specific node can be obtained with the command below:

+
clapp node show node-1
+
+
+

Replacing node-1 with the id of the node to be detailed.

+

NOTE

+
    +

  • If the message below appears, don’t worry, just ignore it.

    • +
+
[ERROR] Thread-XXX: Apparently, Amazon does not compute the RSA key fingerprint as we do! We cannot check if the uploaded keypair is correct!
+
+
+

After the node is started, you can check if it is alive using the command below:

+
clapp node alive node-1 ...
+
+
+

Where node-0 must be replaced with the node ID of interest. Also, more nodes can be checked, simple appending their node IDs to the command.

+

The node alive command also updates the node connection IP and can be very useful when the node IP changes (e.g. instance stopped comes alive, or when using floating ips) +Its recommended to run the command periodically to update nodes information.

+
+
+

Terminating Instances

+

The stop command can be used to terminate an running instance (in AWS, stop/resume instance is not supported yet, so the nodes are terminated). +The command is shown below

+
clapp -v node stop node-1 ...
+
+
+

Where node-0 must be replaced with the node ID of interest. Also, more nodes can be stopped, simple appending their node IDs to the command.

+

If an instance is stopped (not terminated) in the AWS EC2 console, it must be resumed from there. +After an instance is resumed it is prudent to run the node alive command to update instance information.

+
+
+

Executing and Connecting

+

CLAP provides three simple commands to interact directly with the nodes.

+
    +

  • The node connect command can be used to get an SSH shell to the desired node, as shown in the command below:

    • +
+
clapp node connect node-1
+
+
+
    +

  • The node execute command can be used to execute an shell script command in a node and print the respective stdout and stderr outputs. +An example is shown below, used to execute the command echo ola in the node node-0 and retrieve its outputs.

    • +
+
clapp node execute node-0 'echo ola'
+
+
+
    +

  • The node playbook command allows to execute an Ansible playbook in several nodes in a row. +An example is shown below, used to execute the playbook example.yml in three nodes (node-0, node-1 and node-2)

    +
    clapp node playbook example.yml node-0 node-1 node-2
+
    +
    +

    And if your playbook contains variables that must be passed from the command line, you can use the extra parameter. +The below example shows how to pass a keyworded value to a variable in the playbook.

    +
    clapp node playbook example.yml node-0 node-1 node-2 --extra variable1="any value" variable2="another value"
+
    +
    +

    Where the variable1 and variable2 are passed to the playbook in your execution.

    +

    NOTE

    +
      +

    • The extra parameter must be the last one in the node playbook command

      • +

    • You may want to set a higher verbosity level to see Ansible outputs (not just errors). For that, use the -v parameter, just after clapp command.

      • +
    +
    • +
+
+
+

Tagging Nodes

+

Tags is a (key, value) pair that can be associated to nodes aiming to easily select it when needed. +Almost every command that you must supply nodes as input may have options to select nodes by tag (will be shown later).

+

You can use the command below to added a tag to some nodes:

+
clapp tag add "key=value" node-0 node-1
+
+
+

Where the tag must be a string in the format ("key=value") and the nodes must be specified after.

+

To remove tags, you can use the tag remove command, similarly to the tag add command, as shown below:

+
clapp tag remove "key=value" node-0 node-1
+
+
+

Where the tag must be a string in the format ("key=value").

+

Finally, you can also start nodes and tag them right after its creation, by using the below command:

+
clapp -v node start ubuntu-instance-aws:4 --tag "key=value"
+
+
+

The above command instantiates 4 ubuntu-instance-aws machines and tags them with tag "key=value", after its creation.

+
+
+ + +
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..947e5361 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,68 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import sphinx_rtd_theme + +# -- Project information ----------------------------------------------------- + +project = 'CLoud Application Platform' +copyright = u'2020, Otávio Napoli' +author = u'Otávio Napoli' + +# The full version, including alpha/beta/rc tags +version = open('../../version.txt').read() +release = open('../../version.txt').read() +master_doc = 'index' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'autoapi.extension', + 'sphinx_rtd_theme', + 'sphinx.ext.viewcode' +] + +autoapi_type = 'python' +autoapi_dirs = ['../../clap'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +source_encoding = 'utf-8' + +htmlhelp_basename = 'clapdoc' diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst new file mode 100644 index 00000000..5ed7ba6a --- /dev/null +++ b/docs/source/configuration.rst @@ -0,0 +1,274 @@ +.. _configuration: + +============================ +Basic Configuration Setup +============================ + +In order to create compute nodes and interact with them you will need provide +some information about how to connect to the cloud provider +(:ref:`providers configuration `), how to the login into +the machines (:ref:`logins configuration `) and details +about the cloud's virtual machines that can be used (:ref:`instances configuration `). +The following sections will show how to configure these sections and the valid +values for each one. All configuration files use the +`YAML File Format `_ as default format. + + +.. note:: + + YAML use spaces instead of tabs. Be careful to do not messing up! + +.. _cloud configuration: + +Cloud Provider Configuration +------------------------------- + +The ``~/.clap/configs/providers.yaml`` file defines all properties needed to connect +to a specific cloud provider, such as the region, IAM access keys, among others. +In this file you can define multiple provider configurations that is used by +other configurations. An example ``providers.yaml`` file is shown below. + +.. code-block:: yaml + + aws-east-1-config: # Name of the provider configuration ID + provider: aws # Provider (currently only 'aws') + access_keyfile: ec2_access_key.pub # Name of the file in the ~/.clap/private/ directory containing the IAM AWS access key ID + secret_access_keyfile: ec2_access_key.pem # Name of the file in the ~/.clap/private directory containing the IAM AWS Secret Access Key (access ID) + region: us-east-1 # The availability zone you want to use + + my-cool-config-2: + provider: aws + access_keyfile: acesss.pub + secret_access_keyfile: private_access.pem + region: us-east-2 + + my-cool-config-3: + provider: aws + ... + +The YAML dictionary keys (``aws-east-1-config``, ``my-cool-config-2`` and +``my-cool-config-3`` in the above example) are the provider configuration names +(provider IDs) that can be referenced in other files. The values for each provider ID +are specific cloud provider information. You can define as many provider +configurations as you want just adding a new provider ID and the values for it. +Note that each provider ID must be unique. The valid values for a provider +configuration showed in the table below. + +.. list-table:: Valid cloud provider configuration key and values + :header-rows: 1 + + * - **Name** + - **Valid Values or Type** + - **Description** + + * - **provider** + - **valid values**: aws + - Name of the cloud provider to be used + + * - **access_keyfile** + - **type**: string + - **Name of the file** containing the AWS access key ID. The file must be placed at ``~/.clap/private`` and this field must be filled only with the name of file, not the whole path. + + * - **secret_access_keyfile** + - **type**: string + - **Name of the file** containing the AWS Secret Access Key (access ID). The file must be placed at ``~/.clap/private`` and this field must be filled only with the name of file, not the whole path. + + * - **region** + - **type**: string + - The availability zone you want to use (e.g. ``us-east-1``) + + * - **vpc (optional)** + - **type**: string + - Name or ID of the AWS Virtual Private Cloud to provision resources in. + + +.. note:: + For CLAP, **all keys** must be stored at ``~/.clap/private/`` directory with + 400 permission (use the ``chmod 400`` command to set the read-only permission). + + +Note for AWS provider +++++++++++++++++++++++++ + +IAM Access keys consist of two parts: an access key ID (for example, ``AKIAIOSFODNN7EXAMPLE``) +and a secret access key (for example, ``wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY``). +These keys are **required** and is used to connect to the aws provider via third-party +applications (see the `AWS Access Keys documentation `_ for more information). +So you must place your access key ID string inside a file in the ``~/.clap/private/``. +For instance, copy and paste access key ID in a file and save at ``~/.clap/private/ec2_access_key.pub``, +or other filename and the same for the secret access key. + + +.. _login configuration: + +Login Configuration +------------------------------- + +The ``~/.clap/configs/logins.yaml`` defines all properties needed to access a +started virtual machine via SSH, such as login user name, SSH key file used to +access, etc. In this file you can define multiple login information that is used +by other configurations. An example ``logins.yaml`` file is shown below. + +.. code-block:: yaml + + ubuntu-login: # Name of the login config (Login ID) + user: ubuntu # Login name used to SSH into the virtual machine + keypair_name: key_us_east_1 # Name of the keypair to use on the cloud provider + keypair_public_file: key_us_east_1.pub # Name of the file in the ~/.clap/private directory containing the RSA/DSA public key corresponding to the private key file + keypair_private_file: key_us_east_1.pem # Name of the file in the ~/.clap/private directory containing a valid SSH private key to be used to connect to the virtual machine. + sudo: true # True if the sudo_user can execute commands as root by running the sudo command + sudo_user: root # (OPTIONAL) Login name of the super user (default is root) + + example-centos: + user: centos + ... + + +The YAML dictionary keys (``ubuntu-login`` and ``example-centos`` in the above example) +are login's configuration name (also called login ID). The values are the specific +information about that configuration. You can define as many login configurations +as you want just adding a new login ID and the values for it. Note that each login +ID must be unique. The valid values for a login configuration are: + + +.. list-table:: Valid login configuration key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **user** + - **type**: string + - Name of the user used to perform SSH into the virtual machine. + + * - **keypair_name** + - **type**: string + - Name of the keypair used on the cloud provider. + + * - **keypair_public_file** + - **type**: string + - Name of the file in the ``~/.clap/private`` directory containing the RSA/DSA public key corresponding to the private key file. + + * - **keypair_private_file** + - **type**: string + - Name of the file in the ``~/.clap/private`` directory containing a valid SSH private key to be used to connect to the virtual machine. + + * - **sudo** + - **type**: boolean + - True if the sudo user can execute commands as root by running the sudo command. + + * - **sudo_user (optional)** + - **type**: string + - Optional login name of the super user (default is root) + +The keypair is used to login to the machine without password (and perform SSH). + +Note for AWS users +++++++++++++++++++++++++ + +For AWS users, the keypair can be generated in the menu: ``EC2 --> Network & Security --> Key Pairs``. +A keypair can be created using the ``create key pair`` button providing an unique +keypair name (this name is used in the ``keypair_name`` field of the login configuration). +When a keypair is created, a private key file is generated to download. This is +the **private key file** (used to login to the instances). + +For CLAP, all key files must be placed in the ``~/.clap/private/`` directory with +400 permission. In the **keypair_private_file** login configuration field, the name +of the private key file inside the ``~/.clap/private/`` must be inserted (e.g. +**only** the file name: ``key_us_east_1.pem.pem`` and not ``~/.clap/private/key_us_east_1.pem.pem``) + +If you have a private key, the public key can be obtained with the command +``ssh-keygen -y -f /path_to_key_pair/my-key-pair.pem`` (where ``my-key_pair.pem`` is +the private key file. See `AWS Keypair Documentation `_ for more details). +The generated public key must be saved to a file and placed at ``~/.clap/private/`` +directory with 400 permission. So, in the ``keypair_public_file`` field of the +login configuration, the name of the public key file must be inserted. + + +.. _instance configuration: + +Instance Templates Configuration +---------------------------------- + +To start virtual machines in a cloud, you must first setup some instance templates +in the ``~/.clap/configs/instances.yaml`` file. The template contains information +about the virtual machine to start, including its flavor (i.e. instance type, +for instance ``t2.micro`` on AWS clouds), security group information, AMI used, +the disk size and others. The instance template references the provider configuration +and login configuration by its ID. An example of ``instances.yaml`` file is shown below. + +.. code-block:: yaml + + ubuntu-instance-aws: # Name of the instance template (instance template ID) + provider: aws-east-1-config # Provider configuration ID + login: ubuntu-login # Login configuration ID + flavor: t2.medium # The VM "size" to use. Different cloud providers call it differently: could be "instance type", "instance size" or "flavor". + image_id: ami-07d0cf3af28718ef8 # Disk image ID to use in the VM. Amazon EC2 uses IDs like ami-123456 + security_group: xxx-secgroup # Name of security group to use when starting the instance + boot_disk_size: 10 # (OPTIONAL) Size of the instance’s root filesystem volume, in Gibibytes (GiB) + boot_disk_device: /dev/sda1 # (OPTIONAL) Device name of the instance’s root file system in the block device mapping + boot_disk_type: gp2 # (OPTIONAL) Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (the default). + placement_group: XXX # (OPTIONAL) Placement group to enable low-latency networking between compute nodes + image_userdata: '...' # (OPTIONAL) Shell script to be executed (as root) when the machine starts. + network_ids: subnet-abcdfefxx # (OPTIONAL) Subnet IDs the nodes will be connected to + + instance-t2small-us-east-1: + provider: aws-east-1-config + ... + + +The YAML dictionary keys (``ubuntu-instance-aws`` and ``instance-t2small-us-east-1`` +in the above example) are the name of the instance templates (also called instance +template ID) and the values are the specific information about that instance template. +You can define as many instance templates configurations as you want just adding +a new instance template ID and the values for it. Note that each instance template +ID must be unique. Commands will use the instance template ID to start instances +based on this information. The valid values for the instance templates are: + +.. list-table:: Valid instance template key and values + :header-rows: 1 + + * - **Name** + - **Values/Type** + - **Description** + + * - **provider** + - **type**: string + - The ID of the provider configuration to be used for this instance. The ID must match the provider ID at ``providers.yaml`` + + * - **login** + - **type**: string + - The ID of the login configuration to be used for this instance. The ID must match the login ID at ``logins.yaml`` + + * - **flavor** + - **type**: string + - The provider instance type to use (e.g. ``t2.micro``, ``c5.large``, etc) + + * - **image_id** + - **type**: string + - Disk image ID to use in the VM (basically the OS to be used). Amazon EC2 uses IDs like ``ami-123456``. Note that the image_id is dependent of the provider region and a error may be raised if an invalid AMI id is specified + + * - **security_group** + - **type**: string + - Name of security group to use when starting the instance + + * - **boot_disk_size (optional)** + - **type**: string + - Size of the instance’s root filesystem volume, in Gibibytes (GiB) + + * - **boot_disk_device (optional)** + - **type**: string + - Device name of the instance’s root file system in the block device mapping. For AWS, see `block device mapping docs `_ for more information + + * - **boot_disk_type (optional)** + - **type**: string + - Root filesystem volume storage type, one of gp2 (general purpose SSD), io1 (provisioned IOPS SSD), or standard (default). See `Root filesystem volume storage type `_ for more information + + * - **placement_group (optional)** + - **type**: string + - Placement group to enable low-latency networking between compute nodes. See `placement groups `_ for more information + + * - **network_ids (optional)** + - **type**: string + - Subnet ID that the nodes of the cluster will be connected to diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..e957671e --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,51 @@ +===================================================== +Welcome to CLoud Application Provider Documentation! +===================================================== + + +Introduction +--------------- + +CLoud Application Provider (CLAP) provides a user-friendly command line tool to +create, manage and interact with individual instances or a set of instances +hosted in public cloud providers (such as AWS, Google Cloud and Microsoft Azure), +as well as easily creates, manages, resizes and interacts with compute clusters +hosted in public cloud providers. +It was firstly inspired on `elasticluster `_ +project, a tool that allows automated setup of compute clusters (MPI, Spark/Hadoop, etc.) +and `Ansible `_, a framework used for +automation. + +Its main features includes: + +- | `YAML-Style `_ configuration files to define nodes, logins and cloud configurations. +- User-friendly interface to create, setup, manage, interact and stop multiple instances hosted different cloud providers at the same time, transparently. +- Easy and fast creation and configuration of multiple compute clusters hosted in public cloud providers at same time. +- Growing and shrinking running clusters. +- Role system to easily perform actions in different heterogeneous nodes via `Ansible `_. playbooks. +- Easy-to-use python API to bring nodes up and configure them (via ansible or SSH commands). + +Contents +--------------- + +.. toctree:: + :maxdepth: 2 + + introduction + configuration + usage + shared_roles +.. architecture +.. tutorials +.. troubleshooting + + autoapi/index + + + +Indices and tables +------------------- + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst new file mode 100644 index 00000000..39fab58f --- /dev/null +++ b/docs/source/introduction.rst @@ -0,0 +1,106 @@ +.. _installation: + +========================== +Introduction +========================== + +Installation Guide +--------------------- + + +To install CLAP in a linux-based system follow the instructions below. + +1. Install requirement packages + +.. code-block:: bash + + gcc g++ git libc6-dev libffi-dev libssl-dev virtualenv python3 python3-pip + +.. note:: + + CLAP requires Python 3.7 or higher. + + +2. Clone the git repository and enter inside clap's directory + +.. code-block:: bash + + git clone https://github.com/lmcad-unicamp/CLAP.git clap + cd clap + +3. Set execution flags of the install script using the ``chmod`` command. +Then just run the ``install.sh`` script! + +.. code-block:: bash + + chmod +x install.sh + ./install.sh + +4. To use CLAP, you will need to activate the ``virtual-env``, for each shell you are using it. + Inside the ``clap`` root directory, where the ``git`` repository was cloned use the following command: + +.. code-block:: bash + + source clap-env/bin/activate + +5. Finally, test CLAP, via the CLI interface. The ``clapp`` command should be +available to use at this point. + +.. code-block:: bash + + clapp --help + + clapp node list + +.. note:: + + As CLAP is at development stage, use the ``update.sh`` periodically to fetch updates! + + +Quickly CLAP usage description +------------------------------------ + +To use CLAP you will first need to provide some information about how to launch instances in the cloud. By default, CLAP holds all information about configurations in the ``~/.clap/configs`` directory. The ``~/.clap/configs/providers.yaml`` file describes how to connect to the cloud provider, the ``~/.clap/configs/logins.yaml`` file describes how to login into machines and the ``~/.clap/configs/instances.yaml`` describe the instances that can be used with CLAP. +The :ref:`configuration section ` will guide you to write all these configuration sections easily. + +Once configurations written, the :ref:`usage section ` will show you how to execute CLAP commands based on the configurations written. +CLAP can be used to start, configure and manage single or multiple cloud's instances using the :ref:`node module ` as well as entire compute clusters using the :ref:`cluster module `. + + +.. _clap directory archtecture: + +Quickly CLAP directory architecture description +----------------------------------------------- +By default, CLAP holds all of it information needed inside the ``~/.clap`` +directory (where ``~`` stands for the user home directory). The minimal structure +of ``~/.clap`` directory is shown below: + +.. code-block:: + + ~/ (home directory) + └── .clap/ + ├── configs/ + │   ├── clusters/ + │   ├── instances.yaml + │   ├── logins.yaml + │   └── providers.yaml + ├── roles/ + │   ├── actions.d/ + │   ├── group_vars/ + │   │   └── all.yml + │   └── roles/ + ├── private/ + └── storage/ + + +- The ``~/.clap/configs/providers.yaml`` `YAML `_ file inside the ``~/.clap/configs`` directory holds the information about the cloud provider and how to connect to it. + +- The ``~/.clap/configs/logins.yaml`` file holds information about how to connect to an instance (e.g. login user, keyfile, etc) + +- The ``~/.clap/configs/instances.yaml`` holds the information about the instances to launch, i.e. the instance templates. + +- The ``roles`` directory store role's files and actions, used to perform action in several nodes. For more detailed information about roles and actions refer to the :ref:`roles section ` + +- The ``private`` stores keys and passwords files used to connect to the cloud provider and to the instance itself. Every key/secret files needed in the configuration files must be placed inside this directory (usually with 0400 permissions). + +- The ``storage`` directory store metadata information used by CLAP. diff --git a/docs/source/shared_roles.rst b/docs/source/shared_roles.rst new file mode 100644 index 00000000..56847c9b --- /dev/null +++ b/docs/source/shared_roles.rst @@ -0,0 +1,694 @@ +.. _shared_roles: + +========================== +Roles shared with CLAP +========================== + +Here are some roles shared by default with CLAP. Setup action is **always** +executed when adding a node to a role. Also, variables needed by actions must be +passed via ``extra`` parameter, as keyword value. + + +Role ``commands-common`` +-------------------------- + +This role provide means to execute common known commands in several machines in +the role, such as: reboot, copy files to nodes, copy and execute shell scripts, +among others. Consider add nodes to this role to quickly perform common commands +in several nodes in a row. + +The following actions is provided by this role: + +- ``copy``: Copy a file from the localhost to the remote nodes +- ``fetch``: Fetch files from the remote nodes to the localhost +- ``reboot``: Reboot a machine and waits it to become available +- ``run-command``: Execute a shell command in the remote hosts +- ``run-script``: Transfer a script from localhost to remote nodes and execute it in the remote hosts +- ``update-packages``: Update packages in the remote hosts + +Hosts ++++++++++++++++++++ + +No host must be specified by this role. + + +Action ``commands-common copy`` +++++++++++++++++++++++++++++++++++ + +Copy a file from the localhost to the remote nodes + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-commands copy`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied to the remote hosts. If the path **is not absolute** (it is relative), it will search in the role's files directory else the file indicated will be copied. If the path is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into at remote nodes + +Examples +^^^^^^^^^^^^ + +:: + + clapp role action commands-common copy --extra src="/home/ubuntu/file" -e dest="~" + +The above command copy the file at ``/home/ubuntu/file`` (localhost) the the ``~`` directory of the nodes. + + +Action ``commands-common fetch`` ++++++++++++++++++++++++++++++++++ + +Fetch files from the remote nodes to the localhost + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common fetch`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - path + - File to be copied from the remote hosts. If the file is a directory, it will be recursive copied. + + * - ``dest`` + - path + - Destination path where the files will be put into (localhost) + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common fetch --extra src="~/file" --extra dest="/home/ubuntu/fetched_files/" + +The above command fetch a file at ``~/file`` directory from the nodes and place +at the ``/home/ubuntu/fetched_files/`` directory of the localhost. + + +Action ``commands-common install-packages`` +++++++++++++++++++++++++++++++++++++++++++++++ + +Install packages in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common install-packages`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``packages`` + - string + - Comma-separated list of packages to install. + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common install-packages --extra "packages=openmpi-bin,openmpi-common" + +The above command will install ``openmpi-bin`` and ``openmpi-common`` packages to remote hosts + + +Action ``commands-common reboot`` +++++++++++++++++++++++++++++++++++ + +Reboot a machine and waits it to become available + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed. + +Examples +^^^^^^^^^^^^^^^^^^^ + +:: + + clapp role action commands-common reboot + +The command reboot all machines belonging to the ``commands-common`` role. + +Action ``commands-common run-command`` ++++++++++++++++++++++++++++++++++++++++++ + +Execute a shell command in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common run-command`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``cmd`` + - string + - String with the command to be executed in the nodes + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common run-command --extra cmd="ls" + clapp role action commands-common run-command --extra cmd="ls" -e "workdir=/bin" + +In the above command (first one) runs the command ``ls`` in the remote nodes, +the second one runs the command ``ls`` in the remote nodes, after changing to the +"/bin" directory + + +Action ``commands-common run-script`` +++++++++++++++++++++++++++++++++++++++ + +Transfer a script from localhost to remote nodes and execute it in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``commands-common run-script`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``src`` + - string + - Shell script file to be executed in the remote nodes. The file will be first copied (from localhost) to the nodes and after will be executed. Note: the script file **must begin** with the bash shebang (``#!/bin/bash``). Also the script filepath must be **absolute** else, if relative path is passed, Ansible search in the role's file directory. The script will be deleted from nodes after execution. + + * - ``args`` (optional) + - string + - Command-line arguments to be passed to the script. + + * - ``workdir`` (optional) + - path + - Change into this directory before running the command. If none is passed, home directory of the remote node will be used (Path must be absolute for Unix-aware nodes) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3" + clapp role action commands-common run-script --extra src="/home/ubuntu/echo.sh" -e args="1 2 3" -e workdir="/home" + + +The above command (first one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it (similar to run ``bash -c echo.sh`` in the hosts). + +The above command (second one) will copy the ``/home/ubuntu/echo.sh`` script from localhost to the remote nodes and execute it using the arguments "1 2 3" (similar to run ``bash -c echo.sh 1 2 3`` in the hosts). + +The above command (third one) is similar to the second one but will execute the script in the ``/home`` directory. + + +Action ``commands-common update-packages`` +++++++++++++++++++++++++++++++++++++++++++++++ + +Update packages in the remote hosts + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action commands-common update-packages + +The above command will update the package list from remote hosts (similar to ``apt update`` command) + + + +.. Group ``docker`` +.. ----------------- + +.. This group installs docker-ce in debian and red-hat based systems. The following actions are provided by this group. + +.. - ``setup``: Install docker-ce and start the service + +.. Hosts +.. +++++++++++++++++++ + +.. No host must be specified by this group. + + + +Group ``ec2-efs`` +-------------------- + +This role setup and mount an network EFS filesystem on AWS provider. +The following actions are provided by the role. + +- ``setup``: Install nfs client +- ``mount``: Mount an EFS filesystem +- ``umount``: Unmount EC2 File System + +Hosts ++++++++++++++++++++ + +No hosts must be specified by this role. + +Action ``ec2-efs setup`` +++++++++++++++++++++++++++++ + +Install nfs client at remote host. This action is executed when nodes are added +to the role. + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed + +Action ``ec2-efs mount`` +++++++++++++++++++++++++++++ + +Mount an AWS EC2 EFS filesystem at remote host. + +Required Variables +^^^^^^^^^^^^^^^^^^^ +.. list-table:: ``ec2-efs mount`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_ip`` + - string + - Mount IP of the filesystem (see `AWS EFS Documentation `_ for more information) + + * - ``efs_mount_point`` (OPTIONAL) + - path + - Directory path where the filesystem will be mounted. Default path is: ``/efs`` + + * - ``efs_owner`` (OPTIONAL) + - string + - Name of the user owner (e.g. ubuntu). Default user is the currently logged user + + * - ``efs_group`` (OPTIONAL) + - string + - Name of the group owner (e.g. ubuntu). Default group is the currently logged user + + * - ``efs_mount_permissions`` (OPTIONAL) + - string + - Permission used to mount the filesystem (e.g. 0644). Default permission is ``0744`` + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action ec2-efs mount --extra "efs_mount_ip="192.168.0.1" -e "efs_mount_point=/tmp" + +The above command will mount the EFS Filesystem from ``192.168.0.1`` it at ``/tmp`` +with ``744`` permissions (read-write-execute for user and read-only for group and others). + +Action ``ec2-efs umount`` +++++++++++++++++++++++++++++ + +Unmount the EC2 File System + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``ec2-efs umount`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``efs_mount_point`` (OPTIONAL) + - path + - Directory path where the filesystem will be mounted. Default path is: ``/efs`` + + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action ec2-efs umount --nodes node-0 --extra efs_mount_point="/efs" + +The above command will unmount EC2 EFS filesystem at ``/efs`` directory from ``node-0`` + + + +Role ``spits`` +------------------- + +Install `spits runtime for the SPITS programming model `_ +in nodes, deploy SPITS applications and collect results from execution. The +following actions are provided by this role. + +- ``add-nodes``: This action informs to the job manager node, the public address of all task managers. +- ``job-copy``: Copy the results (job directory) from the job manager to the localhost. +- ``job-create``: Create a SPITS job in nodes +- ``job-status``: Query job manager nodes the status and the metrics of a running SPITS job +- ``setup``: Install SPITS runtime and its dependencies at nodes +- ``start``: Start a SPITS job at job manager and task manager nodes + +.. note:: + + For now, shared filesystem is **not supported** for SPITS runtime. + +.. warning:: + + SPITS application are started using random TCP ports. For now, your security group must allows the communication from/to random IP addresses and ports. So, set inbound and outbound rules from you security group to allow the communication from anywhere to anywhere at any port. + +Hosts ++++++++++++++++++++ + +This role defines two host types: + +- ``jobmanager``: Nodes where job manager will be executed for a job +- ``taskmanager``: Nodes where task manager will be executed for a job + +Typical Workflow ++++++++++++++++++++ + +The ``spits`` role is used to run SPITS applications. For each SPITS application to run, you must create a SPITS job, with an unique Job ID. One node can execute multiple SPITS jobs. + +Thus, a typical workflow for usage is: + +1. Add job manager desired nodes to ``spits/jobmanager`` role and task manager desired nodes to ``spits/taskmanager`` +2. Use ``job-create`` action the create a new SPITS job in all machines belonging to ``spits`` role (filter nodes if you want to create a job at selected nodes only). +3. Use ``start`` action to start the SPITS job manager and SPITS task manager at nodes to run the SPITS job +4. Use the ``add-nodes`` action to copy public addresses from task managers nodes to the job manager node. +5. Optionally, check the job status using the ``job-status`` action. +6. When job is finished, use ``job-copy`` action to get the results. + +Action ``spits add-nodes`` +++++++++++++++++++++++++++++ + +This action informs to the job manager node, the public address of all task managers. + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits add-nodes`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits add-nodes --extra "jobid=my-job-123" + +The above example will add all task manager addresses, from nodes belonging to +the ``spits/taskmanager`` role to the ``spits/jobmanager`` nodes at job ``my-job-123``. +At this point, the job manager nodes recognizes all task managers. + +.. note:: + + - This action is not needed if job manager and task managers are running at same node + + +Action ``spits job-copy`` +++++++++++++++++++++++++++++ + +Copy the results (job directory) from the job manager to the localhost + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-copy`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``outputdir`` + - path + - Path where job will be copied to + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits job-copy -e "jobid=my-job-123" -e "outputdir=/home/app-output" + +The above example will copy the entire job folder (including logs/results) to the +localhost and put at ``/home/app-output`` directory. + + +Action ``spits job-create`` +++++++++++++++++++++++++++++ + +Create a SPITS job in nodes to run an SPITS application. If you are using a shared +filesystem, use this action in only one node and set the ``SPITS_JOB_PATH`` +variable to the desired location. + + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-create`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job ID to identify the SPITS job. + + * - ``spits_binary`` + - path + - Absolute path to the SPITS binary (at localhost) that will be copied to nodes + + * - ``spits_args`` + - string + - Arguments that will be passed to the SPITS binary when executing the SPITS application + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits job-create --extra "jobid=my-job-123" -e "spits_binary=/home/xxx/spits-app" -e "spits_args=foo bar 10" + +The above example create the a job called ``my-job-123`` in all nodes belonging +to the ``spits`` role. The job will execute the SPITS runtime with the binary +``/home/xxx/spits-app`` (that will be copied from localhost to nodes) with +arguments ``foo bar 10``. + +Action ``spits job-status`` +++++++++++++++++++++++++++++ + +Query job manager nodes the status and the metrics of a running SPITS job + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits job-status`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + + +Examples +^^^^^^^^^^^^^^^^^^^ +.. code-block:: none + + clapp role action spits job-status --extra "jobid=my-job-123" + +The above example query the status of a SPITS job with ID ``my-job-123`` from +nodes belonging to ``spits/jobmanager`` role. The job status will be displayed +at the command output (in green). + + +Action ``spits setup`` +++++++++++++++++++++++++++++ + +Install SPITS runtime and its dependencies at nodes + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +This action does not require any additional variable to be passed. Optional +variables can be passed. + +.. list-table:: ``spits setup`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role add -n jobmanager:node-0 -n taskmanager:node-1,node-2 + +The above example install SPITS runtime at ``node-0``, ``node-1`` and ``node-2``. +``node-0`` is set as job manager host and nodes ``node-1`` and ``node-2`` are +set as task manager host. + + +Action ``spits start`` +++++++++++++++++++++++++++++ + +Start a SPITS job at job manager and task manager nodes + + +Required Variables +^^^^^^^^^^^^^^^^^^^ + +.. list-table:: ``spits start`` action variables + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``jobid`` + - string + - Unique job identifier (must match the job ID used in the ``job-create`` action) + + * - ``jm_args`` + - string + - Arguments to be passed to the job manager SPITS runtime + + * - ``tm_args`` + - string + - Arguments to be passed to the task manager SPITS runtime + + * - ``PYPITS_PATH`` (OPTIONAL) + - path + - Directory path where the pypits will be installed (default: ``${HOME}/pypits/``) + + * - ``SPITS_JOB_PATH`` (OPTIONAL) + - path + - Directory path where the spits jobs will be created (default: ``${HOME}/spits-jobs/``) + +Examples +^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + clapp role action spits start --extra "jobid=my-job-123" -e "jm_args=-vv" + +The above example starts job managers and task managers for job ``my-job-123`` in +nodes belonging to ``spits`` role. Also, job managers SPITS runtime are executed +passing the ``-vv`` parameter. + +.. note:: + + The ``job-create`` action must be used before to create the SPITS job at nodes belonging to ``spits`` role. + + +.. Group ``nfs-client`` +.. --------------------- + +.. This group setup and mount an network EFS filesystem on AWS provider. + +.. - ``setup``: Install nfs client and mount EC2 file system +.. - ``umount``: Unmount EC2 File System + +.. Hosts +.. +++++++++++++++++++ + +.. No host must be specified by this group. + +.. Action ``ec2-efs setup`` +.. ++++++++++++++++++++++++++++ + +.. Install nfs client and mount EC2 file system. This action is executed when nodes are added to the group. + +.. Required Variables +.. ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 00000000..40cd4e6f --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,1177 @@ +.. _usage: + +============= +Basic Usage +============= + +CLAP is a platform to start, stop and manage cloud's instances (called CLAP nodes +or simply, nodes) at different cloud providers transparently, based on configuration +files. Also, it offers mechanisms to perform actions via SSH commands or Ansible +playbooks in single nodes or in a set of nodes in a row. To provide this, in a modular +way, CLAP provides modules to allow performing several operations. +You can use ``clapp --help`` command to list the available modules. + +The most common modules are: ``node``, ``role`` and ``cluster``. + +.. _node section: + +Node Module +--------------------- + +The node module provides mechanisms to create, manage and interact with cloud's +instances. It provides the following features: + +* Start nodes based on the instance templates with the ``start`` command. +* Stop (terminate) already started nodes using the ``stop`` command. +* Pause or resume already instantiated nodes using the ``pause`` and ``resume`` commands, respectively. +* Check the status of a node (if its accessible by SSH) using the ``alive`` command. +* List started nodes using the ``list`` command. +* Execute a shell command via SSH, using the ``execute`` command. +* Execute an Ansible Playbook using the ``playbook`` command. +* Obtain a shell session (via SSH) using the ``connect`` command. +* Add and remove tags from nodes using ``add-tag`` and ``remove-tag`` commands. +* List all available instance templates configurations using the ``list-templates`` command. + +All these commands are detailed below. + + +Command ``node start`` ++++++++++++++++++++++++++++ + +To launch a cloud's instance based on an instance template, defined in the +``~/.clap/configs/instances.yaml`` file, you can use the command below, where the +``ubuntu-instance-aws`` refers to the instance template ID defined in the +``~/.clap/configs/instances.yaml`` file. In this way, you need to configure the +files only once and launch instances at any time. + +:: + + clapp node start ubuntu-instance-aws + +Once instances are successfully started, CLAP will assign an unique node ID to each +instance, used to perform other CLAP operation. Also, CLAP will try to login at +the instance with the login information provided, via SSH. + +To launch more than one instance with the same instance template ID, you can +put the desired number after the instance template ID preceded by an ``:`` character. +For instance, the command below, launches 4 ``ubuntu-instance-aws`` instances in a row. + +:: + + clapp node start ubuntu-instance-aws:4 + + +You can also launch different instances in a row using the same command, but just +appending more instance template IDs to it, as below. The above command launches +2 ``ubuntu-instance-aws`` VMs and 2 ``example-instance-aws`` VMs in a row. + +:: + + clapp node start ubuntu-instance-aws:2 example-instance-aws:2 + + +Command ``node list`` ++++++++++++++++++++++++++++ + +The ``clapp node list`` command can be used to show managed CLAP's nodes. +An example output of this command is shown below. + +:: + + * Node: ebcd658bacdf485487543cbcc721d1b3, config: type-a, nickname: MarjoryLang, status: reachable, ip: 3.87.87.154, tags: {}, roles: [], creation at: 21-05-21 14:11:55 + Listed 1 nodes + + +The node id (``ebcd658bacdf485487543cbcc721d1b3`` in the above example) is used +across all other modules and commands to perform commands in this node. + + +Command ``node alive`` ++++++++++++++++++++++++++++ + +This command updates several node's information (such as IP) and check if the +node is reachable (if a SSH connection can be established). + +The node's status can be: + +* **started**: when the VM is up. +* **reachable**: when the VM is up and a SSH connection was successfully established. +* **unreachable**: when the SHH connection was not successfully established. +* **paused**: when VM is paused. +* **stopped**: when VM is terminated. + +.. note:: + + CLAP does not check the status of VM periodically. Use this command to update node status and information. + + + +Command ``node stop`` ++++++++++++++++++++++++++++ + +The ``clapp node stop`` command can be used to **terminate** an running VM (destroying it). The syntax is shown below: + + +Command ``node pause`` ++++++++++++++++++++++++++++ + +The ``clapp node pause`` command can be used to **pause** an running instance. +When a node is paused, its status is changed to **paused** and its public IP is +changed to ``None``. + +.. note:: + + The command has no effect for nodes that already been paused. + + +Command ``node resume`` ++++++++++++++++++++++++++++ + +The ``clapp node resume`` command can be used to **resume** a paused instance. +When a node is resumed, it status is changed to **started**. Then, it checked if +it is alive, testing its connection and updating its public IP (and changing its +status to **reachable**). + +.. note:: + + The command has no effect at nodes that were not paused. It will only check for its aliveness. + + +Command ``node connect`` ++++++++++++++++++++++++++++ + +The ``clapp node connect`` command can be used to obtain a shell to a specific +node. + +.. note:: + + The connection may fail if node has an invalid public IP or a invalid login information. You may want to check if node is alive first to update node's information. + + +Command ``node execute`` ++++++++++++++++++++++++++++ + +The ``clapp node execute`` command can be used to execute a shell command on an +reachable node. The syntax is shown below: + +:: + + Usage: clapp node execute [OPTIONS] [NODE_ID]... + + Execute a shell command in nodes (via SSH) + + Options: + -t, --tags TEXT Filter nodes by tags. There are two formats: or + = + -cmd, --command TEXT Shell Command to be executed in nodes [required] + --timeout INTEGER Timeout to execute command in host (0 to no timeout) + [default: 0] + -a, --additional TEXT Additional arguments to connection. Format: + = + --help Show this message and exit. + +One or more nodes can be passed as argument, or can be selected based on their tags. +The ``--command`` parameter specify the command that will be executed in nodes. + +An example is shown below, executing a simple ``ls -lha`` command in the node +``ebcd658bacdf485487543cbcc721d1b3`` + +:: + + clapp node execute ebcd658bacdf485487543cbcc721d1b3 -cmd "ls -lha" + +And the result: + +:: + + ------------------------ ebcd658bacdf485487543cbcc721d1b3 ------------------------ + return code ebcd658b: 0 + stdout ebcd658b: drwxr-xr-x 5 ubuntu ubuntu 4.0K May 21 17:12 . + stdout ebcd658b: drwxr-xr-x 3 root root 4.0K May 21 17:12 .. + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 220 Apr 4 2018 .bash_logout + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 3.7K Apr 4 2018 .bashrc + stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .cache + stdout ebcd658b: drwx------ 3 ubuntu ubuntu 4.0K May 21 17:12 .gnupg + stdout ebcd658b: -rw-r--r-- 1 ubuntu ubuntu 807 Apr 4 2018 .profile + stdout ebcd658b: drwx------ 2 ubuntu ubuntu 4.0K May 21 17:12 .ssh + + +.. note:: + + You may want to check for nodes aliveness first. + + +Command ``node playbook`` ++++++++++++++++++++++++++++ + +The ``clapp node playbook`` command can be used to execute an Ansible playbook +in a set of reachable nodes. The syntax is shown below: + +:: + + clapp node playbook [OPTIONS] [NODE_ID]... + + Execute an Ansible playbook in a set of nodes. + + The NODE_ID argument is a list of strings (optional) and can filter nodes to + execute the playbook by their node ids + + Options: + -p, --playbook TEXT Path of the playbook to be executed [required] + -t, --tags TEXT Filter nodes by tags. There are two formats: or + = + -e, --extra TEXT Extra variables to be passed. Format: = + -nv, --node-vars TEXT Host variables to be passed. Format: + :=,=,... + --help Show this message and exit. + + +One or more nodes can be passed as argument, or can be selected based on their tags. + +The ``--playbook`` parameter specify the playbook to execute in nodes. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +An example is shown below. The playbook ``install_packages.yml`` is executed in node +``ebcd658bacdf485487543cbcc721d1b3``. +Extra playbook variables (in jinja format, e.g. "{{ var1 }}") will be replaced by +the extra variables informed. In the example below the playbook's variable +``packages`` will be replaced by ``gcc``. + +:: + + clapp node playbook ebcd658bacdf485487543cbcc721d1b3 -p install_packages.yml -e "packages=gcc" + + +.. _tags section: + +Command ``node add-tag`` ++++++++++++++++++++++++++ + +This ``clapp node add-tag`` command adds a tag to a set of nodes and has the +following syntax: + +:: + + Usage: clapp node add-tag [OPTIONS] NODE_ID... + + Add tags to a set of nodes. + + The NODE_ID argument is a list of node_ids to add tags. + + Options: + -t, --tags TEXT Tags to add. Format: = [required] + --help Show this message and exit. + + +One or more nodes can be passed as argument. The ``tags`` parameter must be a +keyword value in the format ``key=value``. You can add as many tags to a node as +you want. An example of adding tags is shown below: + +:: + + clapp node add-tag ebcd658bacdf485487543cbcc721d1b3 -t x=10 + +Where tag ``x=10`` is added to nodes ``ebcd658bacdf485487543cbcc721d1b3``. + +Command ``node remove-tag`` +++++++++++++++++++++++++++++ + +This ``clapp tag remove`` command removes a tag from a set of nodes and has the +following syntax: + +:: + + clapp node remove-tag [OPTIONS] NODE_ID... + + Remove tags from a set of nodes. + + The NODE_ID argument is a list of node_ids to remove tags. + + Options: + -t, --tags TEXT Tags to remove. Format: [required] + --help Show this message and exit. + +One or more nodes can be passed as argument. The ``tag`` parameter must be a string. +The tags from nodes that matches to the informed tag is removed (tag and value). + +.. _role section: + +Role Module +------------------- + +The role module allows to perform pre-defined actions to a set of nodes that +belongs to a role. When a node is added to a role, it is said that this node +is ready to perform tasks of this role. +Thus, each role defines their set of specific actions that can be performed to +nodes that belongs to that particular role. + +In this way, the role module consists of three steps: + +1. Add nodes to a role. +2. Perform role's action to nodes that belongs to a role. +3. Optionally, remove nodes from the group. + +The nodes of a role can also be logically divided in hosts. Thus, role actions +can be performed to all nodes of the role or to a subset of nodes of role (hosts). + +CLAP's roles and actions +++++++++++++++++++++++++++++++ + +Role's actions are `Ansible playbooks `_ that are +executed when an action is invoked (e.g. using ``role action`` command). By +default CLAP's roles are stored in the ``~/.clap/roles/`` directory and each +role consists in at minimum of two files: + +* A YAML description file describing the actions that can be performed (and informing the playbook that must be called) and, optionally, the hosts (subset of role's nodes to execute the playbook) +* The Ansible Playbook called when each action is invoked. + +You can see some roles shared with CLAP and their requirements at :ref:`shared_roles` section. + + +Role description file +^^^^^^^^^^^^^^^^^^^^^^^ + +The role's description files are python files placed at ``~/.clap/groups/actions.d`` +directory. The name of the YAML file defines the role's name. +Each role description file defines the key ``actions`` and, optionally, the ``hosts`` +key. Inside ``actions`` key, each dictionary defines a role action where the +key name is the action name and the values informs characteristic of that action. + +An example role description file is shown below, for a role named ``commands-common`` +(placed at ``~/.clap/roles/actions.d/commands-common.yaml``). + +.. code-block:: yaml + + --- + actions: # Defines the actions of this group + setup: # Action called setup + playbook: roles/commands-common_setup.yml # Playbook to be executed when this group action is invoked + + copy: # Action called copy + playbook: roles/commands-common_copy.yml # Playbook to be executed when this group action is invoked + description: Copy files from localhost to remote hosts # Optional action's description + vars: # Optional variables required + - name: src # src variable + description: Source files/directory to be copied # Optional variable's description + optional: no # Informs if this variable is optional + - name: dest # dest variable + description: Destination directory where files will be placed # Optional variable's description + + fetch: + playbook: roles/commands-common_fetch.yml + description: Fetch files from remote hosts to localhost + vars: + - name: src + description: Source files/directory to be fetched + - name: dest + description: Destination directory where files will be placed + + hosts: # (optional) List of hosts that are used in this role. The host name can be used in the playbooks. + - master + - slave + +.. note:: + + Action's playbook is relative to the ``~/.clap/roles/`` directory. + +For role's description files, ``actions`` dictionary is required, and ``hosts`` optional. +The keys inside ``actions`` dictionary are the action names and the possible +values for each action are described in table below. + +.. list-table:: Valid values for actions + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``playbook`` + - path + - Playbook to be executed when this action is invoked. The path is relative to ``~/.clap/roles/`` directory. + + * - ``description`` (optional) + - string + - Action's descriptive information + + * - ``vars`` (optional) + - List of variable dictionaries + - List informing variables needed for this action + +And optionally, the actions can define their variables to use. The possible +values are listed table below + +.. list-table:: Valid action's values + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``name`` + - string + - Name of the variable + + * - ``description`` (optional) + - string + - Variable's descriptive information + + * - ``optional`` (optional) + - boolean + - Inform if variable is optional (default is ``no``) + + +Finally the hosts specify the ``hosts`` used by role actions. It's optional and +when specified Ansible playbooks can segment their execution using the ``hosts`` +variable at each play. If no hosts are specified you must use ``hosts: all`` +to perform the action over all nodes that belong to the role. + + +Command ``role list`` ++++++++++++++++++++++++++++ + +The ``clapp role list`` command can be used to list all available role and their +respective actions and hosts. An example of output is shown below + +:: + + * name: commands-common + Has 7 actions and 2 hosts defined + actions: copy, fetch, install-packages, reboot, run-command, run-script, update-packages + hosts: h1, h2 + + * name: ec2-efs + Has 3 actions and 0 hosts defined + actions: mount, setup, unmount + hosts: + + * name: spits + Has 6 actions and 2 hosts defined + actions: add-nodes, job-copy, job-create, job-status, setup, start + hosts: jobmanager, taskmanager + + Listed 3 roles + + + +Command ``role add`` ++++++++++++++++++++++++++++ + +The ``clapp role add`` command can be used to add a node to a role. The syntax +is shown below: + +:: + + clapp role add [OPTIONS] ROLE + + Add a set of nodes to a role. + + The ROLE argument specify the role which the nodes will be added. + + Options: + -n, --node TEXT Nodes to be added. Can use multiple "-n" commands and + it can be a list of colon-separated nodes as + ",,..." or + ":,". The formats are + mutually exclusive [required] + -nv, --node-vars TEXT Node's arguments. Format + :=,= + -hv, --host-vars TEXT Role's host arguments. Format + :=,... + -e, --extra TEXT Extra arguments. Format = + --help Show this message and exit. + + +The nodes can be supplied with ``--node`` parameter using two formats (mutually +exclusive): with host or without host. + +If the role does not define any host, nodes must be informed supplying only their +node ids in the ``--node`` parameter. Multiple ``--node`` parameters can be used +to indicate multiple nodes ids. Besides that, multiple nodes ids can be passed to +``--node`` parameter by separating them with comma. +The both examples below add nodes ``ebcd658bacdf485487543cbcc721d1b3`` and +``455e9c5da5c4417abc757f587a31c105`` to role ``commands-common``. + +:: + + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3,455e9c5da5c4417abc757f587a31c105 + +If the role defines one or more hosts, the ``--node`` parameter can be supplied +with the ",,..." format (1) or with the ":," +format (2) (both are mutually exclusive). If the format (1) is used, the nodes +are added to all role's hosts defined . +Two examples are shown below, one for format (1) and other for format (2). + +:: + + clapp role add commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role add commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105 + +Supposing the role ``commands-common`` defines 2 hosts: ``masters`` and ``slaves``, +the first one adds nodes ``ebcd658bacdf485487543cbcc721d1b3`` and ``ebcd658bacdf485487543cbcc721d1b3`` +to both role's host. +The second one adds node ``ebcd658bacdf485487543cbcc721d1b3`` as commands-common +masters and node ``455e9c5da5c4417abc757f587a31c105`` as commands-common slaves host. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +The ``--host-vars`` parameter can be used to pass keyword arguments to a hosts. + +.. note:: + + If the role's setup action is defined this action is immediately executed + when adding a role to a node. If this action fails, the node is not added to + the role. + + +Command ``role action`` ++++++++++++++++++++++++++++ + +The ``clapp role action`` command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below: + +.. code-block:: none + + clapp role action [OPTIONS] ROLE + + Perform an group action at a set of nodes. + + The ROLE argument specify the role which the action will be performed. + + Options: + -a, --action TEXT Name of the group's action to perform [required] + -n, --node TEXT Nodes to perform the action. Can use multiple "-n" + commands and it can be a list of colon-separated node + as ",,..." or + ":,". The formats are + mutually exclusive. If not is passed, the action will + be performed in all nodes that belongs to the role. + -nv, --node-vars TEXT Node's arguments. Format + :=,= + -hv, --host-vars TEXT Role's host arguments. Format + :=,... + -e, --extra TEXT Extra arguments. Format = + --help Show this message and exit. + + +The ``--node`` parameter is optional and if is not supplied, the role action will +be executed in all nodes that belongs to the role. If ``--node`` parameter is +supplied it may be in two formats (mutually exclusive): with host or without host. + +If nodes are informed in format without host, the selected nodes will be automatically +placed in their correct hosts (if any). Otherwise, the nodes will be placed in +informed hosts. + +Examples are shown below: + +:: + + clapp role action commands-common -a install-packages -n ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc + clapp role action commands-common -a install-packages -n masters:ebcd658bacdf485487543cbcc721d1b3 -e packages=gcc + clapp role action commands-common -a install-packages -e packages=gcc + + +The first command perform ``install-packages`` action, from ``commands-common`` role +in nodes ``ebcd658bacdf485487543cbcc721d1b3``. The node's hosts are the same when +the nodes added. The second command perform ``install-packages`` action, from +``commands-common`` role in node ``ebcd658bacdf485487543cbcc721d1b3``. The node's hosts +acts only as ``masters``, additional hosts from this node are discarded. +The last command perform ``install-packages`` action, from ``commands-common`` role +at all nodes that belongs to ``commands-common``. +For all commands, the extra variable ``package`` with value ``gcc`` is passed. + +The ``--extra`` parameter can be used to pass keyword arguments to the playbook. + +The ``--node-vars`` parameter can be used to pass keyword arguments to a specific node +when building the inventory. + +The ``--host-vars`` parameter can be used to pass keyword arguments to a hosts. + +Command ``role remove`` ++++++++++++++++++++++++++++ + +The ``clapp role action`` command can be used to perform an action in all nodes +belonging to a particular role. The syntax is shown below: + +:: + + clapp role remove [OPTIONS] ROLE + + Perform an group action at a set of nodes. + + The ROLE argument specify the role which the action will be performed. + + Options: + -n, --node TEXT Nodes to perform the action. Can use multiple "-n" commands + and it can be a list of colon-separated node as + ",,..." or ":,". + The formats are mutually exclusive. If not is passed, the + action will be performed in all nodes that belongs to the + role. [required] + --help Show this message and exit. + +The ``--node`` parameter is used to inform the nodes to remove from a role. +The parameter can be supplied using two formats (mutually exclusive): with host +or without host. +If host is passed, the node is removed from the host's role else the node is removed +from all hosts in the role (if any). An example is shown below: + +:: + + clapp role remove commands-common -n ebcd658bacdf485487543cbcc721d1b3 -n 455e9c5da5c4417abc757f587a31c105 + clapp role remove commands-common -n masters:ebcd658bacdf485487543cbcc721d1b3 -n slaves:455e9c5da5c4417abc757f587a31c105 + +The first example remove nodes ``ebcd658bacdf485487543cbcc721d1b3`` and ``455e9c5da5c4417abc757f587a31c105`` +from role ``commands-common`` and from all ``commands-common`` role hosts (if any). +The second example removes node ``ebcd658bacdf485487543cbcc721d1b3`` from host +called ``masters`` from ``commands-common`` role and node ``455e9c5da5c4417abc757f587a31c105`` +from hosts called ``slaves`` from ``commands-common`` role. + + +.. _cluster module: + +Cluster Module +------------------- + +The cluster module allows CLAP to work with cluster, which is a set of CLAP's nodes +tagged with a specific tag. A CLAP's cluster is created taking as input configuration +files, in YAML format, which will create nodes and setup each of them properly. +After created, the cluster can be resized (adding or removing nodes), paused, +resumed, stopped, among other things. + +By default, the CLAP's cluster module will find configurations inside +``~/clap/configs/clusters`` directory. At next sections, we will assume that +files will be created inside this directory (in ``.yaml`` format). + +The next section will guide you to write a cluster configuration and then, +module's commands will be presented. + +Cluster Configuration +++++++++++++++++++++++++++ + +To create a CLAP's cluster you will need to write: + +- **Setup configuration sections**: which define a series of groups and actions that must be performed. +- **Cluster configuration sections**: which define a set of nodes that must be created and the setups that must be performed in each node. + +Setups and cluster section may be written in multiple different files (or at the +same file), as CLAP's cluster modules will read all files (and setups and clusters +configurations, respectively) inside the cluster's directory. + +Setup Configuration Sections ++++++++++++++++++++++++++++++ + +Setup configuration sections define a series of roles and/or actions that must be +performed at cluster's nodes. An example of a setup configuration section is +shown below. + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common + setup-common: + roles: + - name: commands-common # Add nodes to commands-common role + - name: another-role # Add nodes to another-role role + actions: + - role: commands-common + action: update-packages # Perform action update-packages from role commands-common + - command: "git init" # Perform shell command 'git init' + + # This is a setup configuration called setup-spits-jobmanager + setup-spits-jobmanager: + roles: + - name: spits/jobmanager # Add nodes to spits' role as jobmanager host + + # This is a setup configuration called setup-spits-taskmanager + setup-spits-taskmanager: + roles: + - name: spits/taskmanager # Add nodes to spits' role as taskmanager host + +Setup configurations must be written inside ``setups`` YAML-dictionary. You can +define as many setup configurations as you want, even at different files but each +one must have a unique name. Inside the ``setups`` section, each dictionary +represents a setup configuration. The dictionary key (``setup-common``, +``setup-spits-jobmanager`` and ``setup-spits-taskmanager`` in above example) +represent the setup configuration ID. + +Each setup configuration may contain two dictionaries: ``roles`` and ``actions`` +(both are optional). Both sections, for a setup configuration is described in the +next two subsections. + +Roles key at setups configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``role`` section inside a setup configuration tells to add nodes, whose perform +this setup, to the defined roles. The ``roles`` section contains a **list** describing +each role that the nodes must be added. Also, the role is always added in the order +defined in the list. + +Each element of the list must have a ``name`` key, which describe the name of the role +that the node must be added. For instance, the ``setup-common`` at above example, +defines two roles which nodes that perform this setup must be added: ``commands-common`` +and ``another-role`` (in this order). + +Optionally an ``extra`` key can be defined by each role, as a dictionary. The key +and values is passed as ``extra`` parameter similar to the ``role add`` module +command. For instance, the setup below, will add nodes that perform this setup +(``setup-common-2``) to role ``example-role`` passing variables, ``foo`` and +``another_var`` with values ``bar`` and ``10``, respectively. + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common + setup-common-2: + roles: + - name: example-group # Add nodes to example-role role + extra: + foo: bar + another_var: 10 + + +Actions key at an setups configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ``actions`` section inside a setup configuration tells to perform actions at +nodes which perform this setup. The ``actions`` section contains a **list** +describing each action that must be performed (in order). +There are three types of actions: + +- **role action**: will perform an role action. Thus, the ``role`` and ``action`` keys must be informed. The ``role`` key will tell the name of the role and the ``action`` key will tell which action from that role which will be performed. Optionally, an ``extra`` dictionary can be informed to pass keyword variables to the role's action. +- **playbook**: will execute an Ansible Playbook. Thus, the ``playbook`` key must be informed, telling the absolute path of the playbook that will be executed. Optionally an ``extra`` dictionary can be informed to pass keyword variables to the playbook. +- **command**: will execute a shell command. Thus, the ``command`` key must be informed, telling which shell command must be executed. + +Some action examples are briefly shown below: + +.. code-block:: yaml + + # Setup configurations must be declared inside setups key + setups: + + # This is a setup configuration called setup-common. The actions are executed sequentially + another-setup-example: + actions: + # Perform mount action from role nfs-client, passing the variable mount_path with value /mnt + - action: mount + role: nfs-client + extra: + mount_path: /mnt + # Execute the playbook /home/my-cool-ansible-playbook with an variable foo with value bar + - playbook: /home/my-cool-ansible-playbook + extra: + foo: bar + # Execute a shell command: hostname + - command: hostname + # Perform reboot action from commands-common role + - role: commands-common + action: reboot + +.. note:: + + If a setup configuration contains both ``roles`` and ``actions`` sections, + the ``roles`` section will **always** be executed before ``actions`` section. + + +Cluster Configuration Sections +++++++++++++++++++++++++++++++ + +The cluster configuration defines a set of nodes that must be created and setups +that must be executed. Clusters are written inside ``clusters`` YAML-dictionary +key and each dictionary inside ``clusters`` key denotes a cluster (where the +dictionary key is the cluster's name). +Above is an example of a cluster configuration: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + +Clusters must have the ``nodes`` section, which defines the nodes that must be +created when the cluster is instantiated. As example above, each cluster's node +have a type (``master-node`` and ``slave-node``) and values, that specify the +cluster's node characteristics. Each node may have the values listed in is table +below. + +.. list-table:: Cluster's nodes valid parameters + :header-rows: 1 + + * - **Name** + - **Type** + - **Description** + + * - ``type`` + - string + - Instance type that must to be created. The type must match the node name at ``instances.yaml`` file + + * - ``count`` + - Integer + - Number of instances of this type to be launched + + * - ``min_count`` (OPTIONAL) + - Positive integer (less then or equal ``count`` parameter) + - Minimum number of instances of this type that must effectively be launched. If this parameter is not supplied the value of ``count`` parameter is assumed + + * - ``setups`` + - List of strings + - List with the name of the setup configurations that must be executed after nodes are created + +When a cluster is created, the instance types specified in the each node section +is created with the desired ``count`` number. The cluster is considered created +when all nodes are effectively created. The ``min_count`` parameter at each node +specify the minimum number of instances of that type that must effectively be +launched. If some instances could not be instantiated (or created wwith less than +``min_count`` parameter) the cluster creation process fails and all nodes are terminated. + +After the cluster is created, i.e. the minimum number of nodes of each type is +successfully created, the ``setups`` for each node is executed, in order. If some +setup does not execute correctly, the cluster remains created and the ``setup`` +phase can be executed again. + +Controlling cluster's setups execution phases +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +CLAP's cluster module also offers some other facilities to configure the cluster. +By default the cluster module create nodes and run the setup from each node type. +You can control the flow of the setup execution using some optional keys at your +cluster configuration. The keys: ``before_all``, ``before``, ``after`` and +``after_all`` can be plugged into a cluster's configuration, in order to execute +setups in different set of nodes, before and after the nodes setups. These keys +takes a list of setups to execute. CLAP's setup phases are executed in the order, +as shown in table bellow. + + +.. list-table:: Cluster's setups execution phases (in order) + :header-rows: 1 + + * - **Phase name** + - **Description** + + * - ``before_all`` (#1) + - Setups inside this key are executed in all cluster's nodes before specific setup of the nodes (#3). + + * - ``before`` (#2) + - Setups inside this key are executed only in nodes that are currently being added to the cluster, before the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster. + + * - ``node`` (#3) + - The setup for each node is executed. The setup (inventory generated) is executed only at nodes of this type + + * - ``after`` (#4) + - Setups inside this key are executed only in nodes that are currently being added to the cluster, after the setup specific setup of the nodes (#3). Its useful when resizing cluster, i.e., adding more nodes. This phase is always executed at cluster creation, as all created nodes are being added to the cluster. + + * - ``after_all`` (#5) + - Setups inside this key are executed in all cluster's nodes after specific setup of the nodes (#3). + +.. note:: + + All setups are optional + + +An example is shown below: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # These setups are executed at all cluster's nodes, before setups at nodes section + before_all: + - my-custom-setup-1 + + # These setups are executed at nodes that are currently being added to cluster, before setups at nodes section + before: + - my-custom-setup-2 + + # These setups are executed at nodes that are currently being added to cluster, after setups at nodes section + after: + - my-custom-setup-3 + - my-custom-setup-4 + + # These setups are executed at all cluster's nodes, after setups at nodes section + after_all: + - final_setup + + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + + +In the above example, supposing you are creating a new cluster, after the creation +of nodes the following setups are executed (in order): + +- ``before_all`` setups: ``my-custom-setup-1`` at all nodes +- ``before`` setups: ``my-custom-setup-2`` at all nodes +- ``nodes`` setups (not necessary in order): ``another-example-setup`` and ``master-setup`` at ``master-nodes`` nodes and ``setup-slave-node`` at ``slave-nodes`` nodes. +- ``after`` setups: ``my-custom-setup-3`` and ``my-custom-setup-4`` at all nodes +- ``after_all`` setups: ``final_setup`` at all nodes + +Now supposing you are resizing the already created cluster (adding more +``slave-nodes`` to it), the ``before_all`` and ``after_all`` setups will be executed +in all cluster's nodes (including the new ones, that are being added) and +``before``, ``nodes`` and ``after`` phase setups will only be executed at nodes +that are being added to the the cluster. + +Other cluster's setups optional keys +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The ``options`` key can be plugged at a cluster configuration allowing some special +options to cluster. The ``options`` key may have the following parameters: + +.. list-table:: code-block:: none Cluster's options keys + :header-rows: 1 + + * - **Option name** + - **Description** + + * - ``ssh_to`` + - Connect to a specific node when performing the ``cluster connect`` command + +A example is shown below: + +.. code-block:: yaml + + # Clusters must be defined inside clusters key + clusters: + # This is the cluster name + my-cool-cluster-1: + # Additional cluster's options (optional) + options: + # When connecting to a cluster, connect to a master-node + ssh_to: master-node + + # Nodes that must be created when a cluster is instantiated + nodes: + # Node named master-node + master-node: + type: aws-instance-t2.large # Instance type that must be created (must match instances.yaml name) + count: 1 # Number of instances that must be created + setups: # Optionally, list of setups to be executed when the master-nodes is created (reference setup configuration names, at setups section) + - another-example-setup + - master-setup + + # Node named taskmanager + slave-nodes: + type: aws-instance-t2.small # Instance type that must be created (must match instances.yaml name) + count: 2 # Number of instances that must be created + min_count: 1 # Minimum desired number of instances that must effectively be created + setups: # Optionally, list of setups to be executed when the slave-nodes is created + - setup-slave-node + + +Command ``cluster start`` +++++++++++++++++++++++++++ + +Start a cluster given a cluster configuration name. The syntax of the command is +shown below + +:: + + clapp cluster start [OPTIONS] CLUSTER_TEMPLATE + + Start cluster based on a cluster template. + + The CLUSTER TEMPLATE is the ID of the cluster configuration at cluster + configuration files. + + Options: + -n, --no-setup Do not perform setup [default: False] + --help Show this message and exit. + + + +By default, the CLAP's cluster module search for configurations at all ``.yaml`` +files inside ``~/.clap/configs/clusters`` directory. After cluster is created, +the setups are automatically executed. You can omit this phase by using the +``--no-setup`` option. + +An example of the command is shown below, which starts a cluster called +``example-cluster``. + +:: + + clapp cluster start example-cluster + +.. note:: + - After the cluster's creation a new ``cluster_id`` will be assigned to it. Thus, multiple clusters with same cluster configuration can be launched Also, all commands will reference to ``cluster_id`` to perform their actions. + - When a cluster is started its initial configuration is copied to cluster metadata. If you update the cluster configuration while having already started clusters use the ``clapp cluster update`` command to update the cluster configuration. + + +Command ``cluster setup`` +++++++++++++++++++++++++++ + +Setup an existing cluster. The command has the following syntax: + +:: + + clapp cluster setup [OPTIONS] CLUSTER_ID + + Perform cluster setup operation at a cluster. + + The CLUSTER_ID argument is the id of the cluster to perform the setup + + Options: + -a, --at TEXT Stage to start the setup action [default: before_all] + --help Show this message and exit. + + +Given the ``cluster_id``, the command will execute all setup phases in all cluster +nodes. Some phases of the setup pipeline can be skipped informing at which phase +the setup must begin with the ``at`` parameter. +Examples are shown below: + +:: + + clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9 + clapp cluster setup cluster-faa4017e10094e698aed56bb1f3369f9 --at "before" + +In the above examples, the first one setups all cluster nodes from +``cluster-faa4017e10094e698aed56bb1f3369f9``, the second one setups all nodes, +but starting at ``before`` phase. + +.. note:: + + The ``before_all`` and ``after_all`` phases will be executed at all cluster's nodes, even if setting the ``nodes`` parameter. + + +Command ``cluster grow`` +++++++++++++++++++++++++++ + +Start and add a new node to cluster, based on its cluster's node name. The command +has the following syntax: + +:: + + clapp cluster grow [OPTIONS] CLUSTER_ID + + Start more nodes at a cluster by cluster node type. + + The CLUSTER_ID argument is the id of the cluster to add more nodes. + + Options: + -n, --node TEXT Type of node to start. Format: : + [required] + -n, --no-setup Do not perform setup [default: False] + --help Show this message and exit. + + +The ``--node`` parameter determines how much nodes will be added to cluster. +If ``--no-setup`` is provided no setup phase will be executed. + +Command ``cluster list`` +++++++++++++++++++++++++++ + +List all available CLAP's clusters. + +Command ``cluster alive`` +++++++++++++++++++++++++++ + +Check if all nodes of the cluster are alive. + +Command ``cluster resume`` +++++++++++++++++++++++++++ + +Resume all nodes of the cluster. + +Command ``cluster pause`` +++++++++++++++++++++++++++ + +Pause all nodes of the cluster. + +Command ``cluster stop`` +++++++++++++++++++++++++++ + +Stop all nodes of the cluster, terminating them (destroying). + +Command ``cluster list-templates`` ++++++++++++++++++++++++++++++++++++ + +List all available cluster templates at ``~/clap/configs/clusters`` directory. + +Command ``cluster update`` ++++++++++++++++++++++++++++++ + +Update a cluster configuration of an already created cluster. The command's +syntax is shown below. + +:: + + clapp cluster update [OPTIONS] CLUSTER_ID + + Perform cluster setup operation at a cluster. + + The CLUSTER_ID argument is the id of the cluster to perform the setup + + Options: + -c, --config TEXT New cluster config name + --help Show this message and exit. + +If ``--config`` option is provided, the cluster configuration will be replaced +with the informed configuration. Otherwise, the cluster will be updated with the +same configuration. + +.. note:: + + The configurations will be searched in ``~/clap/configs/clusters`` directory. + + +Command ``cluster connect`` ++++++++++++++++++++++++++++++ + +Get a SSH shell to a node of the cluster. Given a ``cluster_id`` it will try to +get an SSH shell to a node type specified in ``ssh_to`` cluster configuration +option. If no ``ssh_to`` option is informed at cluster's configuration the command +will try to connect to any other node that belongs to the cluster. + +Command ``cluster execute`` ++++++++++++++++++++++++++++++ + +Execute a shell command in nodes of the cluster. + +Command ``cluster playbook`` ++++++++++++++++++++++++++++++ + +Execute an Ansible Playbook in nodes of the cluster. \ No newline at end of file