satori 0.1.3

OpenStack Configuration Discovery

Satori provides configuration discovery for existing infrastructure. It is a related OpenStack project.

The charter for the project is to focus narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which resources (load balancer and servers) the URL is hosted on and what software is running on those servers.

Configuration discovery output could be used for:

• Configuration analysis (ex. compared against a library of best practices)

• Configuration monitoring (ex. has the configuration changed?)

• Troubleshooting

• Heat Template generation

• Solum Application creation/import

• Creation of Chef recipes/cookbooks, Puppet modules, Ansible playbooks, setup scripts, etc..

Getting Started

Run:

$ pip install satori
$ satori foo.com
Address:
  foo.com resolves to IPv4 address 4.4.4.4

Deeper discovery is available if the network location (IP or hostname) is hosted on an OpenStack cloud tenant that Satori can access. Cloud settings can be passed in on the command line or via OpenStack tenant environment variables:

$ satori foo.com --os-username yourname --os-password yadayadayada --os-tenant-name myproject --os-auth-url http://...

Or:

$ export OS_USERNAME=yourname
$ export OS_PASSWORD=yadayadayada
$ export OS_TENANT_NAME=myproject
$ export OS_AUTH_URL=http://...
$ satori foo.com

Notice the discovery result now contains a Host section:

Address:
    www.foo.com resolves to IPv4 address 4.4.4.4
Host:
    4.4.4.4 (www.foo.com) is hosted on a Nova Instance
    Instance Information:
        URI: https://nova.api.somecloud.com/v2/111222/servers/d9119040-f767-
             4141-95a4-d4dbf452363a
        Name: sampleserver01.foo.com
        ID: d9119040-f767-4141-95a4-d4dbf452363a
    ip-addresses:
        public:
            ::ffff:404:404
            4.4.4.4
        private:
            10.1.1.156

Documentation

Additional documentation is located in the doc/ directory and is hosted at http://satori.readthedocs.org/.

Start Hacking

We recommend using a virtualenv to install the client. This description uses the install virtualenv script to create the virtualenv:

$ python tools/install_venv.py
$ source .venv/bin/activate
$ python setup.py develop

Unit tests can be ran simply by running:

$ run_tests.sh

Links

• OpenStack Wiki

• Launchpad Project