From df78d323c0643fa5c7f04e20de2ff55776218df4 Mon Sep 17 00:00:00 2001
From: Troy Dawson <tdawson@redhat.com>
Date: Mon, 26 Oct 2015 10:12:09 -0500
Subject: Add atomic-openshift-utils add atomic-openshift-utils to
 openshift-ansible.spec file

no need for redundent spec file

remove dependencies that are not needed
---
 utils/src/DESCRIPTION.rst                          |  13 +
 utils/src/MANIFEST.in                              |   9 +
 utils/src/data/data_file                           |   1 +
 utils/src/ooinstall/__init__.py                    |   1 +
 .../ooinstall/ansible_plugins/facts_callback.py    |  81 ++++
 utils/src/ooinstall/cli_installer.py               | 482 +++++++++++++++++++++
 utils/src/ooinstall/install_transactions.py        | 124 ++++++
 utils/src/ooinstall/oo_config.py                   | 190 ++++++++
 utils/src/ooinstall/variants.py                    |  70 +++
 9 files changed, 971 insertions(+)
 create mode 100644 utils/src/DESCRIPTION.rst
 create mode 100644 utils/src/MANIFEST.in
 create mode 100644 utils/src/data/data_file
 create mode 100644 utils/src/ooinstall/__init__.py
 create mode 100644 utils/src/ooinstall/ansible_plugins/facts_callback.py
 create mode 100644 utils/src/ooinstall/cli_installer.py
 create mode 100644 utils/src/ooinstall/install_transactions.py
 create mode 100644 utils/src/ooinstall/oo_config.py
 create mode 100644 utils/src/ooinstall/variants.py

(limited to 'utils/src')

diff --git a/utils/src/DESCRIPTION.rst b/utils/src/DESCRIPTION.rst
new file mode 100644
index 000000000..68b3a57f2
--- /dev/null
+++ b/utils/src/DESCRIPTION.rst
@@ -0,0 +1,13 @@
+A sample Python project
+=======================
+
+This is the description file for the project.
+
+The file should use UTF-8 encoding and be written using ReStructured Text. It
+will be used to generate the project webpage on PyPI, and should be written for
+that purpose.
+
+Typical contents for this file would include an overview of the project, basic
+usage examples, etc. Generally, including the project changelog in here is not
+a good idea, although a simple "What's New" section for the most recent version
+may be appropriate.
diff --git a/utils/src/MANIFEST.in b/utils/src/MANIFEST.in
new file mode 100644
index 000000000..d4153e738
--- /dev/null
+++ b/utils/src/MANIFEST.in
@@ -0,0 +1,9 @@
+include DESCRIPTION.rst
+
+# Include the test suite (FIXME: does not work yet)
+# recursive-include tests *
+
+# If using Python 2.6 or less, then have to include package data, even though
+# it's already declared in setup.py
+include ooinstall/*
+include ansible.cfg
diff --git a/utils/src/data/data_file b/utils/src/data/data_file
new file mode 100644
index 000000000..7c0646bfd
--- /dev/null
+++ b/utils/src/data/data_file
@@ -0,0 +1 @@
+some data
\ No newline at end of file
diff --git a/utils/src/ooinstall/__init__.py b/utils/src/ooinstall/__init__.py
new file mode 100644
index 000000000..acaac8d85
--- /dev/null
+++ b/utils/src/ooinstall/__init__.py
@@ -0,0 +1 @@
+from .oo_config import OOConfig
diff --git a/utils/src/ooinstall/ansible_plugins/facts_callback.py b/utils/src/ooinstall/ansible_plugins/facts_callback.py
new file mode 100644
index 000000000..b19e6848e
--- /dev/null
+++ b/utils/src/ooinstall/ansible_plugins/facts_callback.py
@@ -0,0 +1,81 @@
+import os
+import yaml
+from tempfile import mkstemp
+
+class CallbackModule(object):
+    """
+    """
+
+    def __init__(self):
+        ######################
+        # This is ugly stoopid. This should be updated in the following ways:
+        # 1) it should probably only be used for the openshift_facts.yml playbook, so maybe there's some way to check a variable that's set when that playbook is run?
+        try:
+            self.hosts_yaml_name = os.environ['OO_INSTALL_CALLBACK_FACTS_YAML']
+        except KeyError:
+            raise ValueError('The OO_INSTALL_CALLBACK_FACTS_YAML environment variable must be set.')
+        self.hosts_yaml = os.open(self.hosts_yaml_name, os.O_CREAT | os.O_WRONLY)
+
+    def on_any(self, *args, **kwargs):
+        pass
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        pass
+
+    def runner_on_ok(self, host, res):
+        if res['invocation']['module_args'] == 'var=result':
+            facts = res['var']['result']['ansible_facts']['openshift']
+            hosts_yaml = {}
+            hosts_yaml[host] = facts
+            os.write(self.hosts_yaml, yaml.safe_dump(hosts_yaml))
+
+    def runner_on_skipped(self, host, item=None):
+        pass
+
+    def runner_on_unreachable(self, host, res):
+        pass
+
+    def runner_on_no_hosts(self):
+        pass
+
+    def runner_on_async_poll(self, host, res):
+        pass
+
+    def runner_on_async_ok(self, host, res):
+        pass
+
+    def runner_on_async_failed(self, host, res):
+        pass
+
+    def playbook_on_start(self):
+        pass
+
+    def playbook_on_notify(self, host, handler):
+        pass
+
+    def playbook_on_no_hosts_matched(self):
+        pass
+
+    def playbook_on_no_hosts_remaining(self):
+        pass
+
+    def playbook_on_task_start(self, name, is_conditional):
+        pass
+
+    def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
+        pass
+
+    def playbook_on_setup(self):
+        pass
+
+    def playbook_on_import_for_host(self, host, imported_file):
+        pass
+
+    def playbook_on_not_import_for_host(self, host, missing_file):
+        pass
+
+    def playbook_on_play_start(self, name):
+        pass
+
+    def playbook_on_stats(self, stats):
+        pass
diff --git a/utils/src/ooinstall/cli_installer.py b/utils/src/ooinstall/cli_installer.py
new file mode 100644
index 000000000..a23dc0d53
--- /dev/null
+++ b/utils/src/ooinstall/cli_installer.py
@@ -0,0 +1,482 @@
+import click
+import os
+import re
+import sys
+from ooinstall import install_transactions
+from ooinstall import OOConfig
+from ooinstall.oo_config import Host
+from variants import find_variant, get_variant_version_combos
+
+DEFAULT_ANSIBLE_CONFIG = '/usr/share/atomic-openshift-util/ansible.cfg'
+
+def validate_ansible_dir(ctx, param, path):
+    if not path:
+        raise click.BadParameter('An ansible path must be provided')
+    return path
+    # if not os.path.exists(path)):
+    #     raise click.BadParameter("Path \"{}\" doesn't exist".format(path))
+
+def is_valid_hostname(hostname):
+    if not hostname or len(hostname) > 255:
+        return False
+    if hostname[-1] == ".":
+        hostname = hostname[:-1] # strip exactly one dot from the right, if present
+    allowed = re.compile("(?!-)[A-Z\d-]{1,63}(?<!-)$", re.IGNORECASE)
+    return all(allowed.match(x) for x in hostname.split("."))
+
+def validate_hostname(ctx, param, hosts):
+    # if '' == hostname or is_valid_hostname(hostname):
+    for hostname in hosts:
+        if not is_valid_hostname(hostname):
+            raise click.BadParameter('"{}" appears to be an invalid hostname. ' \
+                                     'Please double-check this value ' \
+                                     'and re-enter it.'.format(hostname))
+    return hosts
+
+def validate_prompt_hostname(hostname):
+    if '' == hostname or is_valid_hostname(hostname):
+        return hostname
+    raise click.BadParameter('"{}" appears to be an invalid hostname. ' \
+                             'Please double-check this value i' \
+                             'and re-enter it.'.format(hostname))
+
+def get_ansible_ssh_user():
+    click.clear()
+    message = """
+This installation process will involve connecting to remote hosts via ssh.  Any
+account may be used however if a non-root account is used it must have
+passwordless sudo access.
+"""
+    click.echo(message)
+    return click.prompt('User for ssh access', default='root')
+
+def list_hosts(hosts):
+    hosts_idx = range(len(hosts))
+    for idx in hosts_idx:
+        click.echo('   {}: {}'.format(idx, hosts[idx]))
+
+def delete_hosts(hosts):
+    while True:
+        list_hosts(hosts)
+        del_idx = click.prompt('Select host to delete, y/Y to confirm, ' \
+                               'or n/N to add more hosts', default='n')
+        try:
+            del_idx = int(del_idx)
+            hosts.remove(hosts[del_idx])
+        except IndexError:
+            click.echo("\"{}\" doesn't match any hosts listed.".format(del_idx))
+        except ValueError:
+            try:
+                response = del_idx.lower()
+                if response in ['y', 'n']:
+                    return hosts, response
+                click.echo("\"{}\" doesn't coorespond to any valid input.".format(del_idx))
+            except AttributeError:
+                click.echo("\"{}\" doesn't coorespond to any valid input.".format(del_idx))
+    return hosts, None
+
+def collect_hosts():
+    """
+        Collect host information from user. This will later be filled in using
+        ansible.
+
+        Returns: a list of host information collected from the user
+    """
+    click.clear()
+    click.echo('***Host Configuration***')
+    message = """
+The OpenShift Master serves the API and web console.  It also coordinates the
+jobs that have to run across the environment.  It can even run the datastore.
+For wizard based installations the database will be embedded.  It's possible to
+change this later using etcd from Red Hat Enterprise Linux 7.
+
+Any Masters configured as part of this installation process will also be
+configured as Nodes.  This is so that the Master will be able to proxy to Pods
+from the API.  By default this Node will be unscheduleable but this can be changed
+after installation with 'oadm manage-node'.
+
+The OpenShift Node provides the runtime environments for containers.  It will
+host the required services to be managed by the Master.
+
+http://docs.openshift.com/enterprise/latest/architecture/infrastructure_components/kubernetes_infrastructure.html#master
+http://docs.openshift.com/enterprise/3.0/architecture/infrastructure_components/kubernetes_infrastructure.html#node
+    """
+    click.echo(message)
+
+    hosts = []
+    more_hosts = True
+    ip_regex = re.compile(r'^\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}$')
+
+    while more_hosts:
+        host_props = {}
+        hostname_or_ip = click.prompt('Enter hostname or IP address:',
+                                      default='',
+                                      value_proc=validate_prompt_hostname)
+
+        if ip_regex.match(hostname_or_ip):
+            host_props['ip'] = hostname_or_ip
+        else:
+            host_props['hostname'] = hostname_or_ip
+
+        host_props['master'] = click.confirm('Will this host be an OpenShift Master?')
+        host_props['node'] = True
+
+        rpm_or_container = click.prompt('Will this host be RPM or Container based (rpm/container)?',
+                                        type=click.Choice(['rpm', 'container']),
+                                        default='rpm')
+        if rpm_or_container == 'container':
+            host_props['containerized'] = True
+        else:
+            host_props['containerized'] = False
+
+        host = Host(**host_props)
+
+        hosts.append(host)
+
+        more_hosts = click.confirm('Do you want to add additional hosts?')
+    return hosts
+
+def confirm_hosts_facts(oo_cfg, callback_facts):
+    hosts = oo_cfg.hosts
+    click.clear()
+    message = """
+A list of the facts gathered from the provided hosts follows. Because it is
+often the case that the hostname for a system inside the cluster is different
+from the hostname that is resolveable from command line or web clients
+these settings cannot be validated automatically.
+
+For some cloud providers the installer is able to gather metadata exposed in
+the instance so reasonable defaults will be provided.
+
+Plese confirm that they are correct before moving forward.
+
+"""
+    notes = """
+Format:
+
+IP,public IP,hostname,public hostname
+
+Notes:
+ * The installation host is the hostname from the installer's perspective.
+ * The IP of the host should be the internal IP of the instance.
+ * The public IP should be the externally accessible IP associated with the instance
+ * The hostname should resolve to the internal IP from the instances
+   themselves.
+ * The public hostname should resolve to the external ip from hosts outside of
+   the cloud.
+"""
+
+    # For testing purposes we need to click.echo only once, so build up
+    # the message:
+    output = message
+
+    default_facts_lines = []
+    default_facts = {}
+    validated_facts = {}
+    for h in hosts:
+        default_facts[h] = {}
+        h.ip = callback_facts[str(h)]["common"]["ip"]
+        h.public_ip = callback_facts[str(h)]["common"]["public_ip"]
+        h.hostname = callback_facts[str(h)]["common"]["hostname"]
+        h.public_hostname = callback_facts[str(h)]["common"]["public_hostname"]
+
+        validated_facts[h] = {}
+        default_facts_lines.append(",".join([h.ip,
+                                             h.public_ip,
+                                             h.hostname,
+                                             h.public_hostname]))
+        output = "%s\n%s" % (output, ",".join([h.ip,
+                             h.public_ip,
+                             h.hostname,
+                             h.public_hostname]))
+
+    output = "%s\n%s" % (output, notes)
+    click.echo(output)
+    facts_confirmed = click.confirm("Do the above facts look correct?")
+    if not facts_confirmed:
+        message = """
+Edit %s with the desired values and rerun oo-install with --unattended .
+""" % oo_cfg.config_path
+        click.echo(message)
+        # Make sure we actually write out the config file.
+        oo_cfg.save_to_disk()
+        sys.exit(0)
+    return default_facts
+
+def get_variant_and_version():
+    message = "\nWhich variant would you like to install?\n\n"
+
+    i = 1
+    combos = get_variant_version_combos()
+    for (variant, version) in combos:
+        message = "%s\n(%s) %s %s" % (message, i, variant.description,
+            version.name)
+        i = i + 1
+
+    click.echo(message)
+    response = click.prompt("Choose a variant from above: ", default=1)
+    product, version = combos[response - 1]
+
+    return product, version
+
+def confirm_continue(message):
+    click.echo(message)
+    click.confirm("Are you ready to continue?", default=False, abort=True)
+    return
+
+def error_if_missing_info(oo_cfg):
+    missing_info = False
+    if not oo_cfg.hosts:
+        missing_info = True
+        click.echo('For unattended installs, hosts must be specified on the '
+                   'command line or in the config file: %s' % oo_cfg.config_path)
+        sys.exit(1)
+
+    if 'ansible_ssh_user' not in oo_cfg.settings:
+        click.echo("Must specify ansible_ssh_user in configuration file.")
+        sys.exit(1)
+
+    # Lookup a variant based on the key we were given:
+    if not oo_cfg.settings['variant']:
+        click.echo("No variant specified in configuration file.")
+        sys.exit(1)
+
+    ver = None
+    if 'variant_version' in oo_cfg.settings:
+        ver = oo_cfg.settings['variant_version']
+    variant, version = find_variant(oo_cfg.settings['variant'], version=ver)
+    if variant is None or version is None:
+        err_variant_name = oo_cfg.settings['variant']
+        if ver:
+            err_variant_name = "%s %s" % (err_variant_name, ver)
+        click.echo("%s is not an installable variant." % err_variant_name)
+        sys.exit(1)
+    oo_cfg.settings['variant_version'] = version.name
+
+    missing_facts = oo_cfg.calc_missing_facts()
+    if len(missing_facts) > 0:
+        missing_info = True
+        click.echo('For unattended installs, facts must be provided for all masters/nodes:')
+        for host in missing_facts:
+            click.echo('Host "%s" missing facts: %s' % (host, ", ".join(missing_facts[host])))
+
+    if missing_info:
+        sys.exit(1)
+
+
+def get_missing_info_from_user(oo_cfg):
+    """ Prompts the user for any information missing from the given configuration. """
+    click.clear()
+
+    message = """
+Welcome to the OpenShift Enterprise 3 installation.
+
+Please confirm that following prerequisites have been met:
+
+* All systems where OpenShift will be installed are running Red Hat Enterprise
+  Linux 7.
+* All systems are properly subscribed to the required OpenShift Enterprise 3
+  repositories.
+* All systems have run docker-storage-setup (part of the Red Hat docker RPM).
+* All systems have working DNS that resolves not only from the perspective of
+  the installer but also from within the cluster.
+
+When the process completes you will have a default configuration for Masters
+and Nodes.  For ongoing environment maintenance it's recommended that the
+official Ansible playbooks be used.
+
+For more information on installation prerequisites please see:
+https://docs.openshift.com/enterprise/latest/admin_guide/install/prerequisites.html
+"""
+    confirm_continue(message)
+    click.clear()
+
+    if oo_cfg.settings.get('ansible_ssh_user', '') == '':
+        oo_cfg.settings['ansible_ssh_user'] = get_ansible_ssh_user()
+        click.clear()
+
+    if not oo_cfg.hosts:
+        oo_cfg.hosts = collect_hosts()
+        click.clear()
+
+    if oo_cfg.settings.get('variant', '') == '':
+        variant, version = get_variant_and_version()
+        oo_cfg.settings['variant'] = variant.name
+        oo_cfg.settings['variant_version'] = version.name
+        click.clear()
+
+    return oo_cfg
+
+
+def collect_new_nodes():
+    click.clear()
+    click.echo('***New Node Configuration***')
+    message = """
+Add new nodes here
+    """
+    click.echo(message)
+    return collect_hosts()
+
+def get_installed_hosts(hosts, callback_facts):
+    installed_hosts = []
+    for host in hosts:
+        if(host.name in callback_facts.keys()
+           and 'common' in callback_facts[host.name].keys()
+           and callback_facts[host.name]['common'].get('version', '')
+           and callback_facts[host.name]['common'].get('version', '') != 'None'):
+            installed_hosts.append(host)
+    return installed_hosts
+
+def get_hosts_to_run_on(oo_cfg, callback_facts, unattended, force):
+
+    # Copy the list of existing hosts so we can remove any already installed nodes.
+    hosts_to_run_on = list(oo_cfg.hosts)
+
+    # Check if master or nodes already have something installed
+    installed_hosts = get_installed_hosts(oo_cfg.hosts, callback_facts)
+    if len(installed_hosts) > 0:
+        # present a message listing already installed hosts
+        for host in installed_hosts:
+            if host.master:
+                click.echo("{} is already an OpenShift Master".format(host))
+                # Masters stay in the list, we need to run against them when adding
+                # new nodes.
+            elif host.node:
+                click.echo("{} is already an OpenShift Node".format(host))
+                hosts_to_run_on.remove(host)
+        # for unattended either continue if they force install or exit if they didn't
+        if unattended:
+            if not force:
+                click.echo('Installed environment detected and no additional nodes specified: ' \
+                           'aborting. If you want a fresh install, use --force')
+                sys.exit(1)
+        # for attended ask the user what to do
+        else:
+            click.echo('Installed environment detected and no additional nodes specified. ')
+            response = click.prompt('Do you want to (1) add more nodes or ' \
+                                    '(2) perform a clean install?', type=int)
+            if response == 1: # add more nodes
+                new_nodes = collect_new_nodes()
+
+                hosts_to_run_on.extend(new_nodes)
+                oo_cfg.hosts.extend(new_nodes)
+
+                install_transactions.set_config(oo_cfg)
+                callback_facts, error = install_transactions.default_facts(oo_cfg.hosts)
+                if error:
+                    click.echo("There was a problem fetching the required information. " \
+                               "See {} for details.".format(oo_cfg.settings['ansible_log_path']))
+                    sys.exit(1)
+            else:
+                pass # proceeding as normal should do a clean install
+
+    return hosts_to_run_on, callback_facts
+
+@click.command()
+@click.option('--configuration', '-c',
+              type=click.Path(file_okay=True,
+                              dir_okay=False,
+                              writable=True,
+                              readable=True),
+              default=None)
+@click.option('--ansible-playbook-directory',
+              '-a',
+              type=click.Path(exists=True,
+                              file_okay=False,
+                              dir_okay=True,
+                              writable=True,
+                              readable=True),
+              # callback=validate_ansible_dir,
+              envvar='OO_ANSIBLE_PLAYBOOK_DIRECTORY')
+@click.option('--ansible-config',
+              type=click.Path(file_okay=True,
+                              dir_okay=False,
+                              writable=True,
+                              readable=True),
+              default=None)
+@click.option('--ansible-log-path',
+              type=click.Path(file_okay=True,
+                              dir_okay=False,
+                              writable=True,
+                              readable=True),
+              default="/tmp/ansible.log")
+@click.option('--unattended', '-u', is_flag=True, default=False)
+@click.option('--force', '-f', is_flag=True, default=False)
+def main(configuration, ansible_playbook_directory, ansible_config, ansible_log_path, unattended, force):
+    oo_cfg = OOConfig(configuration)
+
+    if not ansible_playbook_directory:
+        ansible_playbook_directory = oo_cfg.settings.get('ansible_playbook_directory', '')
+
+    if ansible_config:
+        oo_cfg.settings['ansible_config'] = ansible_config
+    elif os.path.exists(DEFAULT_ANSIBLE_CONFIG):
+        # If we're installed by RPM this file should exist and we can use it as our default:
+        oo_cfg.settings['ansible_config'] = DEFAULT_ANSIBLE_CONFIG
+
+    validate_ansible_dir(None, None, ansible_playbook_directory)
+    oo_cfg.settings['ansible_playbook_directory'] = ansible_playbook_directory
+    oo_cfg.ansible_playbook_directory = ansible_playbook_directory
+
+    oo_cfg.settings['ansible_log_path'] = ansible_log_path
+    install_transactions.set_config(oo_cfg)
+
+    if unattended:
+        error_if_missing_info(oo_cfg)
+    else:
+        oo_cfg = get_missing_info_from_user(oo_cfg)
+
+    click.echo('Gathering information from hosts...')
+    callback_facts, error = install_transactions.default_facts(oo_cfg.hosts)
+    if error:
+        click.echo("There was a problem fetching the required information. " \
+                   "Please see {} for details.".format(oo_cfg.settings['ansible_log_path']))
+        sys.exit(1)
+
+    hosts_to_run_on, callback_facts = get_hosts_to_run_on(oo_cfg, callback_facts, unattended, force)
+
+
+    click.echo('Writing config to: %s' % oo_cfg.config_path)
+
+    # We already verified this is not the case for unattended installs, so this can
+    # only trigger for live CLI users:
+    # TODO: if there are *new* nodes and this is a live install, we may need the  user
+    # to confirm the settings for new nodes. Look into this once we're distinguishing
+    # between new and pre-existing nodes.
+    if len(oo_cfg.calc_missing_facts()) > 0:
+        validated_hosts = confirm_hosts_facts(oo_cfg, callback_facts)
+
+    oo_cfg.save_to_disk()
+
+    click.echo('Ready to run installation process.')
+    message = """
+If changes are needed to the values recorded by the installer please update {}.
+""".format(oo_cfg.config_path)
+    if not unattended:
+        confirm_continue(message)
+
+    error = install_transactions.run_main_playbook(oo_cfg.hosts,
+                                                   hosts_to_run_on)
+    if error:
+        # The bootstrap script will print out the log location.
+        message = """
+An error was detected.  After resolving the problem please relaunch the
+installation process.
+"""
+        click.echo(message)
+        sys.exit(1)
+    else:
+        message = """
+The installation was successful!
+
+If this is your first time installing please take a look at the Administrator
+Guide for advanced options related to routing, storage, authentication and much
+more:
+
+http://docs.openshift.com/enterprise/latest/admin_guide/overview.html
+"""
+        click.echo(message)
+        click.pause()
+
+if __name__ == '__main__':
+    main()
diff --git a/utils/src/ooinstall/install_transactions.py b/utils/src/ooinstall/install_transactions.py
new file mode 100644
index 000000000..ac69bb4b8
--- /dev/null
+++ b/utils/src/ooinstall/install_transactions.py
@@ -0,0 +1,124 @@
+import subprocess
+import os
+import yaml
+from variants import find_variant
+
+CFG = None
+
+def set_config(cfg):
+    global CFG
+    CFG = cfg
+
+def generate_inventory(hosts):
+    print hosts
+    global CFG
+    base_inventory_path = CFG.settings['ansible_inventory_path']
+    base_inventory = open(base_inventory_path, 'w')
+    base_inventory.write('\n[OSEv3:children]\nmasters\nnodes\n')
+    base_inventory.write('\n[OSEv3:vars]\n')
+    base_inventory.write('ansible_ssh_user={}\n'.format(CFG.settings['ansible_ssh_user']))
+    if CFG.settings['ansible_ssh_user'] != 'root':
+        base_inventory.write('ansible_sudo=true\n')
+
+    # Find the correct deployment type for ansible:
+    variant, ver = find_variant(CFG.settings['variant'],
+        version=CFG.settings.get('variant_version', None))
+    base_inventory.write('deployment_type={}\n'.format(ver.ansible_key))
+
+    if 'OO_INSTALL_DEVEL_REGISTRY' in os.environ:
+        base_inventory.write('oreg_url=rcm-img-docker01.build.eng.bos.redhat.com:5001/openshift3/ose-${component}:${version}\n')
+    if 'OO_INSTALL_PUDDLE_REPO_ENABLE' in os.environ:
+        base_inventory.write("openshift_additional_repos=[{'id': 'ose-devel', 'name': 'ose-devel', 'baseurl': 'http://buildvm-devops.usersys.redhat.com/puddle/build/AtomicOpenShift/3.1/latest/RH7-RHAOS-3.1/$basearch/os', 'enabled': 1, 'gpgcheck': 0}]\n")
+    if 'OO_INSTALL_STAGE_REGISTRY' in os.environ:
+        base_inventory.write('oreg_url=registry.access.stage.redhat.com/openshift3/ose-${component}:${version}\n')
+
+    base_inventory.write('\n[masters]\n')
+    masters = (host for host in hosts if host.master)
+    for master in masters:
+        write_host(master, base_inventory)
+    base_inventory.write('\n[nodes]\n')
+    nodes = (host for host in hosts if host.node)
+    for node in nodes:
+        # TODO: Until the Master can run the SDN itself we have to configure the Masters
+        # as Nodes too.
+        scheduleable = True
+        # If there's only one Node and it's also a Master we want it to be scheduleable:
+        if node in masters and len(masters) != 1:
+            scheduleable = False
+        write_host(node, base_inventory, scheduleable)
+    base_inventory.close()
+    return base_inventory_path
+
+
+def write_host(host, inventory, scheduleable=True):
+    global CFG
+    facts = ''
+    if host.ip:
+        facts += ' openshift_ip={}'.format(host.ip)
+    if host.public_ip:
+        facts += ' openshift_public_ip={}'.format(host.public_ip)
+    if host.hostname:
+        facts += ' openshift_hostname={}'.format(host.hostname)
+    if host.public_hostname:
+        facts += ' openshift_public_hostname={}'.format(host.public_hostname)
+    # TODO: For not write_host is handles both master and nodes.
+    # Technically only nodes will ever need this.
+    if not scheduleable:
+        facts += ' openshift_scheduleable=False'
+    inventory.write('{} {}\n'.format(host, facts))
+
+
+def load_system_facts(inventory_file, os_facts_path, env_vars):
+    """
+    Retrieves system facts from the remote systems.
+    """
+    FNULL = open(os.devnull, 'w')
+    status = subprocess.call(['ansible-playbook',
+                     '--inventory-file={}'.format(inventory_file),
+                     os_facts_path],
+                     env=env_vars)
+                         #                     stdout=FNULL)
+    if not status == 0:
+        return [], 1
+    callback_facts_file = open(CFG.settings['ansible_callback_facts_yaml'], 'r')
+    callback_facts = yaml.load(callback_facts_file)
+    callback_facts_file.close()
+    return callback_facts, 0
+
+
+def default_facts(hosts):
+    global CFG
+    inventory_file = generate_inventory(hosts)
+    os_facts_path = '{}/playbooks/byo/openshift_facts.yml'.format(CFG.ansible_playbook_directory)
+
+    facts_env = os.environ.copy()
+    facts_env["OO_INSTALL_CALLBACK_FACTS_YAML"] = CFG.settings['ansible_callback_facts_yaml']
+    facts_env["ANSIBLE_CALLBACK_PLUGINS"] = CFG.settings['ansible_plugins_directory']
+    if 'ansible_log_path' in CFG.settings:
+        facts_env["ANSIBLE_LOG_PATH"] = CFG.settings['ansible_log_path']
+    if 'ansible_config' in CFG.settings:
+        facts_env['ANSIBLE_CONFIG'] = CFG.settings['ansible_config']
+    return load_system_facts(inventory_file, os_facts_path, facts_env)
+
+
+def run_main_playbook(hosts, hosts_to_run_on):
+    global CFG
+    inventory_file = generate_inventory(hosts)
+    if len(hosts_to_run_on) != len(hosts):
+        main_playbook_path = os.path.join(CFG.ansible_playbook_directory,
+                                          'playbooks/common/openshift-cluster/scaleup.yml')
+    else:
+        main_playbook_path = os.path.join(CFG.ansible_playbook_directory,
+                                          'playbooks/byo/config.yml')
+    facts_env = os.environ.copy()
+    if 'ansible_log_path' in CFG.settings:
+        facts_env['ANSIBLE_LOG_PATH'] = CFG.settings['ansible_log_path']
+    if 'ansible_config' in CFG.settings:
+        facts_env['ANSIBLE_CONFIG'] = CFG.settings['ansible_config']
+    return run_ansible(main_playbook_path, inventory_file, facts_env)
+
+def run_ansible(playbook, inventory, env_vars):
+    return subprocess.call(['ansible-playbook',
+                             '--inventory-file={}'.format(inventory),
+                             playbook],
+                             env=env_vars)
diff --git a/utils/src/ooinstall/oo_config.py b/utils/src/ooinstall/oo_config.py
new file mode 100644
index 000000000..ea9638fe9
--- /dev/null
+++ b/utils/src/ooinstall/oo_config.py
@@ -0,0 +1,190 @@
+import os
+import yaml
+from pkg_resources import resource_filename
+
+PERSIST_SETTINGS = [
+    'ansible_ssh_user',
+    'ansible_config',
+    'ansible_log_path',
+    'variant',
+    'variant_version',
+    ]
+REQUIRED_FACTS = ['ip', 'public_ip', 'hostname', 'public_hostname']
+
+
+class OOConfigFileError(Exception):
+    """The provided config file path can't be read/written
+    """
+    pass
+
+
+class OOConfigInvalidHostError(Exception):
+    """ Host in config is missing both ip and hostname. """
+    pass
+
+
+class Host(object):
+    """ A system we will or have installed OpenShift on. """
+    def __init__(self, **kwargs):
+        self.ip = kwargs.get('ip', None)
+        self.hostname = kwargs.get('hostname', None)
+        self.public_ip = kwargs.get('public_ip', None)
+        self.public_hostname = kwargs.get('public_hostname', None)
+
+        # Should this host run as an OpenShift master:
+        self.master = kwargs.get('master', False)
+
+        # Should this host run as an OpenShift node:
+        self.node = kwargs.get('node', False)
+        self.containerized = kwargs.get('containerized', False)
+
+        if self.ip is None and self.hostname is None:
+            raise OOConfigInvalidHostError("You must specify either 'ip' or 'hostname'")
+
+        if self.master is False and self.node is False:
+            raise OOConfigInvalidHostError(
+                "You must specify each host as either a master or a node.")
+
+        # Hosts can be specified with an ip, hostname, or both. However we need
+        # something authoritative we can connect to and refer to the host by.
+        # Preference given to the IP if specified as this is more specific.
+        # We know one must be set by this point.
+        self.name = self.ip if self.ip is not None else self.hostname
+
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.name
+
+    def to_dict(self):
+        """ Used when exporting to yaml. """
+        d = {}
+        for prop in ['ip', 'hostname', 'public_ip', 'public_hostname',
+                     'master', 'node', 'containerized']:
+            # If the property is defined (not None or False), export it:
+            if getattr(self, prop):
+                d[prop] = getattr(self, prop)
+        return d
+
+
+class OOConfig(object):
+    new_config = True
+    default_dir = os.path.normpath(
+        os.environ.get('XDG_CONFIG_HOME',
+                       os.environ['HOME'] + '/.config/') + '/openshift/')
+    default_file = '/installer.cfg.yml'
+
+    def __init__(self, config_path):
+        if config_path:
+            self.config_path = os.path.normpath(config_path)
+        else:
+            self.config_path = os.path.normpath(self.default_dir +
+                                                self.default_file)
+        self.settings = {}
+        self.read_config()
+        self.set_defaults()
+
+    def read_config(self, is_new=False):
+        self.hosts = []
+        try:
+            new_settings = None
+            if os.path.exists(self.config_path):
+                cfgfile = open(self.config_path, 'r')
+                new_settings = yaml.safe_load(cfgfile.read())
+                cfgfile.close()
+            if new_settings:
+                self.settings = new_settings
+                # Parse the hosts into DTO objects:
+                if 'hosts' in self.settings:
+                    for host in self.settings['hosts']:
+                        self.hosts.append(Host(**host))
+
+                # Watchout for the variant_version coming in as a float:
+                if 'variant_version' in self.settings:
+                    self.settings['variant_version'] = \
+                        str(self.settings['variant_version'])
+
+        except IOError, ferr:
+            raise OOConfigFileError('Cannot open config file "{}": {}'.format(ferr.filename,
+                                                                              ferr.strerror))
+        except yaml.scanner.ScannerError:
+            raise OOConfigFileError('Config file "{}" is not a valid YAML document'.format(self.config_path))
+        self.new_config = is_new
+
+    def set_defaults(self):
+
+        if 'ansible_inventory_directory' not in self.settings:
+            self.settings['ansible_inventory_directory'] = \
+                self._default_ansible_inv_dir()
+        if not os.path.exists(self.settings['ansible_inventory_directory']):
+            os.makedirs(self.settings['ansible_inventory_directory'])
+        if 'ansible_plugins_directory' not in self.settings:
+            self.settings['ansible_plugins_directory'] = resource_filename(__name__, 'ansible_plugins')
+
+        if 'ansible_callback_facts_yaml' not in self.settings:
+            self.settings['ansible_callback_facts_yaml'] = '{}/callback_facts.yaml'.format(self.settings['ansible_inventory_directory'])
+
+        if 'ansible_ssh_user' not in self.settings:
+            self.settings['ansible_ssh_user'] = ''
+
+        self.settings['ansible_inventory_path'] = '{}/hosts'.format(self.settings['ansible_inventory_directory'])
+
+        # clean up any empty sets
+        for setting in self.settings.keys():
+            if not self.settings[setting]:
+                self.settings.pop(setting)
+
+    def _default_ansible_inv_dir(self):
+        return os.path.normpath(
+            os.path.dirname(self.config_path) + "/.ansible")
+
+    def calc_missing_facts(self):
+        """
+        Determine which host facts are not defined in the config.
+
+        Returns a hash of host to a list of the missing facts.
+        """
+        result = {}
+
+        for host in self.hosts:
+            missing_facts = []
+            for required_fact in REQUIRED_FACTS:
+                if not getattr(host, required_fact):
+                    missing_facts.append(required_fact)
+            if len(missing_facts) > 0:
+                result[host.name] = missing_facts
+        return result
+
+    def save_to_disk(self):
+        out_file = open(self.config_path, 'w')
+        out_file.write(self.yaml())
+        out_file.close()
+
+    def persist_settings(self):
+        p_settings = {}
+        for setting in PERSIST_SETTINGS:
+            if setting in self.settings and self.settings[setting]:
+                p_settings[setting] = self.settings[setting]
+        p_settings['hosts'] = []
+        for host in self.hosts:
+            p_settings['hosts'].append(host.to_dict())
+
+        if self.settings['ansible_inventory_directory'] != \
+                self._default_ansible_inv_dir():
+            p_settings['ansible_inventory_directory'] = \
+                self.settings['ansible_inventory_directory']
+
+        return p_settings
+
+    def yaml(self):
+        return yaml.safe_dump(self.persist_settings(), default_flow_style=False)
+
+    def __str__(self):
+        return self.yaml()
+
+    def get_host(self, name):
+        for host in self.hosts:
+            if host.name == name:
+                return host
+        return None
diff --git a/utils/src/ooinstall/variants.py b/utils/src/ooinstall/variants.py
new file mode 100644
index 000000000..a5159f857
--- /dev/null
+++ b/utils/src/ooinstall/variants.py
@@ -0,0 +1,70 @@
+"""
+Defines the supported variants and versions the installer supports, and metadata
+required to run Ansible correctly.
+
+This module needs to be updated for each major release to allow the new version
+to be specified by the user, and to point the generic variants to the latest
+version.
+"""
+
+
+class Version(object):
+    def __init__(self, name, ansible_key):
+        self.name = name  # i.e. 3.0, 3.1
+
+        self.ansible_key = ansible_key
+
+
+class Variant(object):
+    def __init__(self, name, description, versions):
+        # Supported variant name:
+        self.name = name
+
+        # Friendly name for the variant:
+        self.description = description
+
+        self.versions = versions
+
+
+# WARNING: Keep the versions ordered, most recent last:
+OSE = Variant('openshift-enterprise', 'OpenShift Enterprise',
+    [
+        Version('3.0', 'enterprise'),
+        Version('3.1', 'openshift-enterprise')
+    ]
+)
+
+AEP = Variant('atomic-enterprise', 'Atomic OpenShift Enterprise',
+    [
+        Version('3.1', 'atomic-enterprise')
+    ]
+)
+
+# Ordered list of variants we can install, first is the default.
+SUPPORTED_VARIANTS = (OSE, AEP)
+
+
+def find_variant(name, version=None):
+    """
+    Locate the variant object for the variant given in config file, and
+    the correct version to use for it.
+    Return (None, None) if we can't find a match.
+    """
+    prod = None
+    for prod in SUPPORTED_VARIANTS:
+        if prod.name == name:
+            if version is None:
+                return (prod, prod.versions[-1])
+            for v in prod.versions:
+                if v.name == version:
+                    return (prod, v)
+
+    return (None, None)
+
+def get_variant_version_combos():
+    combos = []
+    for variant in SUPPORTED_VARIANTS:
+        for ver in variant.versions:
+            combos.append((variant, ver))
+    return combos
+
-- 
cgit v1.2.3