Update docker docs#237
Open
dmcken wants to merge 2 commits intonetworktocode:developfrom
dmcken:update-docker-docs
Open
Update docker docs#237dmcken wants to merge 2 commits intonetworktocode:developfrom dmcken:update-docker-docs
dmcken wants to merge 2 commits intonetworktocode:developfrom
dmcken:update-docker-docs
Conversation
dmcken
commented
Nov 12, 2021
dmcken
commented
- Fixed docker-compose command documentation to use network_importer (not network-importer) as defined in docker-compose.yml
- Added table of all currently defined environment variables to docs/configuration.md based on what I found in network_importer/config.py. I hope to work on this to fill in the missing entries as I would prefer to work with this project using docker.
Fixed docker-compose service name in example commands.
List all the currently defined environment variables. The empty values can be used as a focus on what to fix next so the service can be better dockerized.
dgarros
reviewed
Nov 30, 2021
Contributor
dgarros
left a comment
dgarros
left a comment
There was a problem hiding this comment.
Thank you for this PR, I added few comments and suggestions inline
| | 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?> | |
Contributor
There was a problem hiding this comment.
not sure how we could fit everything into an environment variable ... probably best to keep it as it for now
Contributor
There was a problem hiding this comment.
Suggested change
| | | drivers.mapping | <should this be made into ENV variables?> | | |
| | | drivers | mapping | |
| | | drivers.mapping | <should this be made into ENV variables?> | | ||
| | | inventory | supported_platforms | | ||
| | | inventory | backend (duplicate of main.backend?) | | ||
| | | inventory.settings | <TODO> | |
Contributor
There was a problem hiding this comment.
Suggested change
| | | inventory.settings | <TODO> | | |
| | | inventory.settings | Backend specific | |
| | BATFISH_USE_SSL | batfish | use_ssl | | ||
| | | drivers.mapping | <should this be made into ENV variables?> | | ||
| | | inventory | supported_platforms | | ||
| | | inventory | backend (duplicate of main.backend?) | |
Contributor
There was a problem hiding this comment.
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 ?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.