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.

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

Update docs #33

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ ansible-galaxy collection install git+https://github.com/eclipse-volttron/volttr
The collection provides a number of playbooks and roles that can be used to install VOLTTRON, configure it, and manage its operation. The documentation provided below will go into more detail on the seteps of using these playbooks. The general process for using this collection is as follows:

- Install the collection
- Create an inventory file that describes the hosts you want to manage
- Create an inventory file that describes the hosts you want to manage (examples in the
`examples/vagrant-vms` directory)
- Create the configuration structure for each host that describes the platform and agents to be installed, and contains the configuration for those agents.
- Run the playbooks in order
- host_config
Expand Down
14 changes: 14 additions & 0 deletions examples/vagrant-vms/recipe-inventory.additional_options.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
ansible_test:
hosts:
collector1:
ansible_host: collector1 # may use IP or hostname. Use localhost for local installation
ansible_connection: ssh # If using local installation, use local
# Explicitly set the python interpreter. Unless specified, this will also be the interpreter
# used for the volttron virtual environment.
ansible_python_interpreter: "python3.10"
http_proxy: "http://localhost:1234" # Set the http and https proxy environment variables if the host does not route to the internet
https_proxy: "http://localhost:1234"
volttron_home: "~/.volttron_test" # The location of the volttron home directory on the managed node
## host_configs_dir is the location on the managed node where the platform's agent configuration files are placed by ansible
host_configs_dir: "~/.volttron_configs"
verbose_debug_tasks: true # Set to true to enable verbose debugging of ansible tasks