Metadata-Version: 2.0
Name: spiro-network
Version: 0.1
Summary: Salt modules for discovering and exposing minion's IP addresses
Home-page: https://gitlab.com/spirostack/spiro-network
Author: Jamie Bliss
Author-email: jamie@ivyleav.es
License: UNKNOWN
Project-URL: Source, https://gitlab.com/spirostack/spiro-network/
Project-URL: Bug Reports, https://gitlab.com/spirostack/spiro-network/issues
Project-URL: Tip Jar, https://ko-fi.com/astraluma
Keywords: salt saltstack
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Environment :: Other Environment
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Systems Administration
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: setuptools

spiro-network
=============

A variety of network utilities.

This is meant to be installed on minions.

Full docs available [online](https://spirostack.com/spiro-net.html).

Installation
============

On minions, install the `spiro-network` PyPI package.


Interface
=========

A number of things are provided:

Modules
-------

* `ipaddr.external_four`, `ipaddr.external_six`: Queries external services for
  your IP, useful if the minion is behind a NAT or other complex network

* `ipaddr.four`, `ipaddr.six`: Collates information about a minion's IP address
  from several sources. 

    * `network.ipaddrs` / `network.ipaddrs6`
    * AWS metadata if the [metadata grain](https://docs.saltstack.com/en/latest/ref/grains/all/salt.grains.metadata.html) is available
    * `ipaddr.external_four` / `ipaddr.external_six` (above)

States
------

* `hostname.is`: Sets the hostname, takes no arguments. (Note: See hostname(1)
  for information on FQDNs and other hostname variants.)


Configuration
=============

spiro-network requires no configuration to function.


