-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Improved illegal set and delete call detection. Improved docs. * Fixed indentation * Make load_config more configstore friendly. * Add config store support to actuator. * Callback for config called "config" are always processed first. * Improvements to Actuator Agent config store support. * Fixed get_utc_seconds_from_epoch to stop rounding to the nearest second. * Master driver config store support. * Fixed tests for master driver config store support. * Added more config store example configs. * Fixed tests. * Add warning for rejected old style configuration. * Added script to convert old style master driver scripts to config store version. * change wording for main_configuration argument. * Reliable case handling in config store utils. * Keep name case when reporting config name. * Changed default config type to json. * Moved and fixed obsolete driver configruations. * Updated example configurations. * Update config store spec for name case. * Fixed config case name change preventing drivers from being shut down properly. * Updated driver configuration docs for configuration store. * Removed unused starting method. * Fixed example reference. * Fixed spec * Config store agent docs and cheatsheet. * Add config store command line docs. * Removed real building references from examples and docs. * Changed config get to return json
- Loading branch information
Showing
9 changed files
with
306 additions
and
211 deletions.
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
docs/source/core_services/config_store/Commandline-Interface.rst
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
Configuration Store Command Line Tools | ||
====================================== | ||
|
||
Command line management of the Configuration Store is done with the `volttron-ctl config` sub-commands. | ||
|
||
Store Configuration | ||
------------------- | ||
|
||
To store a configuration in the Configuration Store use the `store` sub-command: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config store <agent vip identity> <configuration name> <infile> | ||
- **agent vip identity** - The agent store to add the configuration to. | ||
- **configuration name** - The name to give the configuration in the store. | ||
- **infile** - The file to ingest into the store. | ||
|
||
Optionally you may specify the file type of the file. Defaults to ``--json``. | ||
|
||
- ``--json`` - Interpret the file as JSON. | ||
- ``--csv`` - Interpret the file as CSV. | ||
- ``--raw`` - Interpret the file as raw data. | ||
|
||
Delete Configuration | ||
-------------------- | ||
|
||
To delete a configuration in the Configuration Store use the `delete` sub-command: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config delete <agent vip identity> <configuration name> | ||
- **agent vip identity** - The agent store to delete the configuration from. | ||
- **configuration name** - The name of the configuration to delete. | ||
|
||
To delete all configurations for an agent in the Configuration Store use ``--all`` | ||
switch in place of the configuration name: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config delete <agent vip identity> --all | ||
Get Configuration | ||
----------------- | ||
|
||
To get the current contents of a configuration in the Configuration Store use the `get` sub-command: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config get <agent vip identity> <configuration name> | ||
- **agent vip identity** - The agent store to retrieve the configuration from. | ||
- **configuration name** - The name of the configuration to get. | ||
|
||
By default this command will return the json representation of what is stored. | ||
|
||
- ``--raw`` - Return the raw version of the file. | ||
|
||
List Configurations | ||
------------------- | ||
|
||
To get the current list of agents with configurations in the Configuration Store use the `list` sub-command: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config list | ||
To get the current list of configurations for an agent include the Agent's VIP IDENTITY: | ||
|
||
.. code-block:: bash | ||
volttron-ctl config list <agent vip identity> | ||
- **agent vip identity** - The agent store to retrieve the configuration from. | ||
|
||
|
||
|
||
|
||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.. _VOLTTRON-Configuration-Store: | ||
============================ | ||
VOLTTRON Configuration Store | ||
============================ | ||
|
||
The configuration store provides storage for agent configurations and an agent interface to facilitate dynamic agent configuration. | ||
|
||
.. toctree:: | ||
:glob: | ||
:maxdepth: 2 | ||
|
||
* |
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,4 +14,5 @@ VOLTTRON Core Services | |
service_agents/index | ||
security/index | ||
restricted/index | ||
config_store/index | ||
|
Oops, something went wrong.