config/configutilities/configutilities/configutilities
Mingyuan Qi 611a68a96a Allow user specified registries for config_controller
Currently docker images were pulled from public registries during
config_controller. For some users, the connection to the public
docker registry may be slow such that installing the containerized
services images may timeout or the system simply does not have
access to the public internet.

This change allows users to specify alternative public/private
registries to replace k8s.gcr.io, gcr.io, quay.io and docker.io.
Insecure registry is supported if all default registries were
replaced by one unified registry. It lowers the complexity for
those who build his own registry without internet access.

Docker doesn't support ipv6 addr as registry name, instead
hostname or domain name in ipv6 network is allowed.

Test:
AIO-SX/AIO-DX/Standard(2+2):
  Alternative public registry (ipv4/domain) with proxy
    - config_controller pass
  Private registry (ipv4/ipv6/domain) without internet
    - config_controller pass
  Default registry with/without proxy
    - config_controller pass

Story: 2004711
Task: 28742

Change-Id: I4fee3f4e0637863b9b5ef4ef556082ac75f62a1d
Signed-off-by: Mingyuan Qi <mingyuan.qi@intel.com>
2019-02-23 10:10:07 +08:00
..
common Allow user specified registries for config_controller 2019-02-23 10:10:07 +08:00
LICENSE StarlingX open source release updates 2018-05-31 07:35:52 -07:00
README Update configutilities version 2019-01-11 13:46:22 +00:00
__init__.py Add docker proxy configuration for kubernetes 2019-01-30 17:23:17 +08:00
config_validator.py Fix: "import" issue for Python 2/3 compatible code 2018-12-25 08:58:03 +08:00
configfiletool.py Fix: "import" issue for Python 2/3 compatible code 2018-12-25 08:58:03 +08:00
configgui.py Fix: "import" issue for Python 2/3 compatible code 2018-12-25 08:58:03 +08:00
hostfiletool.py Fix: "import" issue for Python 2/3 compatible code 2018-12-25 08:58:03 +08:00
setup.py Update configutilities version 2019-01-11 13:46:22 +00:00

README

Copyright © 2017 Wind River Systems, Inc.

SPDX-License-Identifier: Apache-2.0
-----------------------------------------------------------------------


Titanium Cloud Configuration Utilities
---------------------------------------

To facilitate various aspects of Titanium Cloud installation and
configuration, utilities have been created to generate and validate
configuration and setup files which are utilized by the system.


Installing the Configuration Utilities
--------------------------------------

This tarball includes several utilities which can be used to aid in the
configuration of Titanium Cloud.  Note that these are optional tools which are run prior
to installation, and not run on the target system.

To install the utilities on a Linux machine follow these steps:

1.  Ensure you have the tools necessary to install new python packages (pip and setuptools)
    If you do not, you must install them using the appropriate commands for
    your version of linux, such as:
        sudo apt-get install python-pip  # e.g. for Ubuntu or Debian

2.  The config_gui tool makes use of external tools which must be
    installed as follows:

        if using Ubuntu/Debian:
            sudo apt-get install python-wxtools

        if using Fedora:
            sudo yum install wxPython python-setuptools

        if using CentOS/RedHat, the appropriate rpm can be obtained from EPEL
            sudo yum install epel-release
            sudo yum install wxPython

            Note, if epel-release is not available, it can be obtained as such (specific to
            your version)
                wget http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
                sudo rpm -Uvh epel-release-6*.rpm
                sudo yum install wxPython python-pip

3.  Copy wrs-configutilities-3.1.0.tgz to the python install directory
    (i.e. /usr/lib/python2.7/dist-packages or /usr/lib/python2.7/site-packages)

4.  Cd to this python install directory

5.  Untar the file: 
        sudo tar xfv wrs-configutilities-3.1.0.tgz

6.  Cd configutilities

7.  Run setup:  
        sudo python setup.py install


Using the Configuration Utilities
---------------------------------

There are two tools installed: config_validator and config_gui.

config_validator is a commandline tool which takes a 'controller configuration
input' file of the INI type and does preliminary analysis to ensure its validity.
It can be called as follows: 
    config_validator --system-config <filename>

config_gui is a GUI-based tool which provides tools for creating a 'controller 
configuration input' INI file and/or a 'bulk host' XML file.  It can be launched 
by calling 'config_gui' from the command line and will walk you through the process
of generating the desired configuration files.