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

Stand alone file watcher example agent #2959

Merged

Conversation

gwenkidd
Copy link
Contributor

@gwenkidd gwenkidd commented May 4, 2022

Description

Added a README with detailed setup instructions and updated comments within settings.py to use the more modern commands.

Type of change

This change is a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@gwenkidd gwenkidd requested a review from craig8 May 4, 2022 18:37
@@ -0,0 +1,50 @@
## Stand Alone File Watcher example agent

This python script will listen to the specified files and publish updates to specific topics on the remote instance.
Copy link
Contributor

Choose a reason for hiding this comment

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

a volttron instance

```
vctl auth keypair
```
Update settings.py with your public and secret keys
Copy link
Contributor

Choose a reason for hiding this comment

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

your == the generated

examples/StandAloneFileWatcher/README.md Show resolved Hide resolved
```
Update settings.py with this server key

5. Update the config section of settings.py with the files you want this agent to watch for and
Copy link
Contributor

Choose a reason for hiding this comment

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

remove you from this sentence. the agent. or the standalonewatcher agent.

vctl auth add
```
Provide the IP of the volttron instance when prompted for
address[]: and provide public key of standalone agent when prompted
Copy link
Contributor

Choose a reason for hiding this comment

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

the ip address should be where the agent is running from not the instance's vip address. they can leave it blank to accept all

Copy link
Contributor

Choose a reason for hiding this comment

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

credentials should be the publickey generated above in the keypair command

Copy link
Contributor

Choose a reason for hiding this comment

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

as a shortcut you could do vctl auth add --user_id identity_of_agent --credentials publickey_generated_above

examples/StandAloneFileWatcher/README.md Show resolved Hide resolved
examples/StandAloneFileWatcher/README.md Show resolved Hide resolved
examples/StandAloneFileWatcher/README.md Show resolved Hide resolved

4. Add this standalone agent to volttron auth entry using this command:
```
vctl auth add
Copy link
Contributor

Choose a reason for hiding this comment

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

a shortcut is vctl auth add --user_id identity --credentials generated_publickey

vctl auth add
```
Provide the IP of the volttron instance when prompted for
address[]: and provide public key of standalone agent when prompted
Copy link
Contributor

Choose a reason for hiding this comment

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

the ip address is that of the agent, not the instance. If they were on different machines, this would matter more. Can be blank

@gwenkidd
Copy link
Contributor Author

gwenkidd commented May 4, 2022

@craig8 updated the README

@craig8 craig8 merged commit 22dce63 into VOLTTRON:develop May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants