Open NathanDotTo opened 8 months ago
Probably the best "documentation" on how to run the code of this repo as an end user could be the CircleCI pipeline definition (which I run daily in my personal CircleCI account, and is usually working end-to-end): .circleci/config.yml
. The caveat being that CircleCI has a UI to define environment variables, which in the case of a CLI run is done by editing bin/minimal_env.sh
.
So yes, roughly one defines the expected outcome in the config/config.yaml
file, then switches to the bin
directory, sources an edited/adapted minimal_env.sh
file, and then runs bin/config_build.sh
(the sdwan_config_builder
code is included in the container image). After that, Ansible playbooks can be run normally.
Thanks for looking at this, good user facing documentation is very important, looking forward to a PR!
Hi, I am working through how to run the code in this repo. I am given to understand that the starting point is in
sdwan_config_builder
. In that directory, theREADME
says:By default sdwan_config_build looks for a 'metadata.yaml' file in the directory where it is run.
The only
metadata.yaml
file that is in the repo is in theconfig
dir, alongside aconfig.example.yaml
.The
minimal_env.sh
has:export CONFIG_BUILDER_METADATA="../config/metadata.yaml"
This implies, then, that the overall starting point must be to run the
minimal_env.sh
from the bin directory first. I think that step should be documented in the top levelREADME
then.The
metadata.yaml
refers to:top_level_config: "../config/config.yaml"
Whereas we have a
config.example.yaml
in the repo. I think, then, that theconfig.example.yaml
should be copied to aconfig.yaml
and suitably edited.If this is correct so far, then I can add suitable documentation updates and submit a PR.
Thanks
Nathan