Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docker docs #237

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update docker docs #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e3f495
Update getting_started.md
dmcken Nov 12, 2021
0e508fc
List currently defined env variables
dmcken Nov 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,4 +152,39 @@ level = "info" # "debug", "info", "warning"
# some functions took to execute
performance_log = false
performance_log_directory = "performance_logs"
```
```


## 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 | <should this be made into ENV variables?> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure how we could fit everything into an environment variable ... probably best to keep it as it for now

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| | drivers.mapping | <should this be made into ENV variables?> |
| | drivers | mapping |

| | inventory | supported_platforms |
| | inventory | backend (duplicate of main.backend?) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes the doc is not correct, this setting doesn't exist.
please could you remove it from this table and update the doc as well ?

| | inventory.settings | <TODO> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| | inventory.settings | <TODO> |
| | inventory.settings | Backend specific |

| | 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 | <TODO> |
| | network.napalm_extras | <TODO> |
2 changes: 1 addition & 1 deletion docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```