satori/doc/source/openstack_resources.rst

OpenStack Control Plane Discovery

Satori supports control plane <terminology_control_plane> discovery of resources that belong to an OpenStack tenant. To discover OpenStack specific information for a resource, provide credentials to Satori for the tenant that owns the resource.

OpenStack Credentials

OpenStack credentials can be provided on the command line or injected into shell environment variables. Satori reuses the OpenStack Nova conventions for environment variables since many Satori users also use the nova program.

Use the export command to store the credentials in the shell environment:

::

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

Alternatively, the credentials can be passed on the command line:

::

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

Discovered Host

If the domain name or IP address provided belongs to the authenticated tenant, the OpenStack resource data (Server ID, IPs, etc) will be returned. In this example, the OpenStack credentials were provided via environment variables. The "Host" section is only available because the control plane discovery was possible using the OpenStack credentials.

$ satori www.foo.com
Domain: foo.com
  Registered at TUCOWS DOMAINS INC.
  Expires in 475 days.
  Name servers:
      DNS1.STABLETRANSIT.COM
      DNS2.STABLETRANSIT.COM
Address:
  www.foo.com resolves to IPv4 address 192.0.2.10
Host:
  192.0.2.10 (www.foo.com) is hosted on a Nova Instance
  Instance Information:
      URI: https://nova.api.somecloud.com/v2/111222/servers/d9119040-f767-414
           1-95a4-d4dbf452363a
      Name: sampleserver01.foo.com
      ID: d9119040-f767-4141-95a4-d4dbf452363a
  ip-addresses:
      public:
          ::ffff:404:404
          192.0.2.10
      private:
          10.1.1.156