diff --git a/docs/configuration.md b/docs/configuration.md index 386f26dd..b855dc6b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -152,4 +152,39 @@ level = "info" # "debug", "info", "warning" # some functions took to execute performance_log = false performance_log_directory = "performance_logs" -``` \ No newline at end of file +``` + + +## Environment variables + +| Environment Variable | config section | config file entry | +| --------------------- | ---------------------- | -------------------------- | +| | main | backend | +| | main | import_ips | +| | main | import_prefixes | +| | main | import_intf_status | +| | main | import_vlans | +| | main | import_cabling | +| | main | excluded_platforms_cabling | +| | main | nbr_workers | +| | main | configs_directory | +| BATFISH_ADDRESS | batfish | address | +| BATFISH_NETWORK_NAME | batfish | network_name | +| BATFISH_SNAPSHOT_NAME | batfish | snapshot_name | +| BATFISH_API_KEY | batfish | api_key | +| BATFISH_PORT_V1 | batfish | port_v1 | +| BATFISH_PORT_V2 | batfish | port_v2 | +| BATFISH_USE_SSL | batfish | use_ssl | +| | drivers.mapping | | +| | inventory | supported_platforms | +| | inventory | backend (duplicate of main.backend?) | +| | inventory.settings | | +| | logs | level | +| | logs | performance_log | +| | logs | performance_log_directory | +| NETWORK_DEVICE_LOGIN | network | login | +| NETWORK_DEVICE_PWD | network | password | +| NETWORK_DEVICE_ENABLE | network | enable | +| | network | fqdns | +| | network.netmiko_extras | | +| | network.napalm_extras | | diff --git a/docs/getting_started.md b/docs/getting_started.md index cd7ff915..8f055d9c 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -145,6 +145,6 @@ network-importer apply [--update-configs] [--limit="site=nyc"] In addition to the supplied command you can also use `docker-compose` to bring up the required service stack. Like so: ``` sudo docker-compose up -d -sudo docker-compose exec network-importer bash +sudo docker-compose exec network_importer bash sudo docker-compose down ```