Skip to content

Commit 97514d8

Browse files
craig8craig8
authored
Merge pull request #2807 from VOLTTRON/releases/8.1.1
8.1.1 to main
2 parents a5640dd + a91d9fc commit 97514d8

File tree

35 files changed

+818
-321
lines changed

35 files changed

+818
-321
lines changed

‎README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,46 @@ platform provides services for collecting and storing data from buildings and
88
devices and provides an environment for developing applications which interact
99
with that data.
1010

11+
## Upgrading to VOLTTRON 8.x
12+
13+
VOLTTRON 8 introduces three changes that require an explict upgrade step when upgrading from a earlier VOLTTRON version
14+
15+
1. Dynamic RPC authorization feature - This requires a modification to the auth file. If you have a pre-existing
16+
instance of VOLTTRON running on an older version, the auth file will need to be updated.
17+
2. Historian agents now store the cache database (backup.sqlite file) in
18+
<volttron home>/agents/<agent uuid>/<agentname-version>/<agentname-version>.agent-data directory instead of
19+
<volttron home>/agents/<agent uuid>/<agentname-version> directory. In future all core agents will write data only
20+
to the <agentname-version>.agent-data subdirectory. This is because vctl install --force backs up and restores
21+
only the contents of this directory.
22+
3. SQLHistorians (historian version 4.0.0 and above) now use a new database schema where metadata is stored in
23+
topics table instead of separate metadata table. SQLHistorians with version >= 4.0.0 can work with existing
24+
database with older schema however the historian agent code should be upgraded to newer version (>=4.0.0) to run
25+
with VOLTTRON 8 core.
26+
27+
To upgrade:
28+
29+
1. If upgrading historian, make sure historians are not in auto start mode. To remove any historian from auto start
30+
mode use the command 'vctl disable <uuid of historian that is currently enabled>. This is necessary so that the old
31+
sqlhistorian does not automatically start after step 5.
32+
2. Update volttron source code version to VOLTTRON 8
33+
3. activate the volttron environment, and run ```python bootstrap.py --force```. If you have
34+
any additional bootstrap options that you need (rabbitmq, web, drivers, etc.) include these in the above command.
35+
4. Run ```volttron-upgrade``` to update the auth file and move historian cache files into agent-data directory.
36+
Note that the upgrade script will only move the backup.sqlite file and will not move sqlite historian's db file
37+
if they are within the install directory. If using a SQLite historian, please backup the database file of
38+
sqlite historian before upgrading to the latest historian version.
39+
5. Start VOLTTRON
40+
6. Run ```vctl install --force --vip-identity <vip id of existing historian> --agent-config <config>``` to upgrade
41+
to the latest historian version. vctl install --force will backup the cache in <agent-version>.agent-data
42+
folder, installs the latest version of the historian and restore the contents of
43+
<agent-version>.agent-data folder.
44+
45+
### Upgrading aggregate historians
46+
47+
VOLTTRON 8 also comes with updated SQL aggregate historian schema. However, there is no automated upgrade path for
48+
aggregate historian. To upgrade an existing aggregate historian please refer to the CHANGELOG.md within
49+
SQLAggregateHistorian source directory
50+
1151
## Features
1252

1353
- [Message Bus](https://volttron.readthedocs.io/en/latest/platform-features/message-bus/index.html) allows agents to subscribe to data sources and publish results and messages.
@@ -295,6 +335,7 @@ There are several walkthroughs to explore additional aspects of the platform:
295335
- [RabbitMQ setup with Federation and Shovel plugins](https://volttron.readthedocs.io/en/latest/deploying-volttron/multi-platform/multi-platform-rabbitmq-deployment.html)
296336
- [Backward compatibility with the RabbitMQ message bus](https://volttron.readthedocs.io/en/latest/deploying-volttron/multi-platform/multi-platform-multi-bus.html)
297337
338+
298339
## Acquiring Third Party Agent Code
299340
300341
Third party agents are available under the volttron-applications repository. In

‎bootstrap.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def update(operation, verbose=None, upgrade=False, offline=False, optional_requi
133133
# We must install wheel first to eliminate a bunch of scary looking
134134
# errors at first install.
135135
# TODO Look towards fixing the packaging so that it works with 0.31
136-
pip('install', ['wheel==0.30'], verbose, True, offline=offline)
136+
# option_requirements contains wheel as first entry
137137

138138
# Build option_requirements separately to pass install options
139139
build_option = '--build-option' if wheeling else '--install-option'

‎docs/source/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ def __getattr__(cls, name):
4343
author = 'The VOLTTRON Community'
4444

4545
# The short X.Y version
46-
version = '8.1'
46+
version = '8.1.1'
4747
# The full version, including alpha/beta/rc tags
48-
release = '8.1'
48+
release = '8.1.1'
4949

5050

5151
# -- General configuration ---------------------------------------------------

docs/source/volttron-topics/change-log/scalability/scalability-improvements.rst renamed to docs/source/deploying-volttron/scalability/scalability-improvements.rst

File renamed without changes.

docs/source/volttron-topics/change-log/scalability/scalability.rst renamed to docs/source/deploying-volttron/scalability/scalability.rst

File renamed without changes.

docs/source/volttron-topics/change-log/scalability/testing-driver-scalability.rst renamed to docs/source/deploying-volttron/scalability/testing-driver-scalability.rst

File renamed without changes.

‎docs/source/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla
137137
platform-features/config-store/configuration-store
138138
platform-features/security/volttron-security
139139

140+
140141
.. toctree::
141142
:caption: VOLTTRON Core Service Agents
142143
:hidden:
@@ -146,6 +147,7 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla
146147

147148
volttron-api/services/*/modules
148149

150+
149151
.. toctree::
150152
:caption: VOLTTRON Core Operations Agents
151153
:hidden:
@@ -155,16 +157,16 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla
155157

156158
volttron-api/ops/*/modules
157159

160+
158161
.. toctree::
159162
:caption: VOLTTRON Topics
160163
:hidden:
161164
:titlesonly:
162165
:maxdepth: 1
163166

167+
Releases <volttron-topics/VOLTTRON-releases/index>
164168
volttron-topics/troubleshooting/index
165169
volttron-topics/volttron-applications/index
166-
volttron-topics/change-log/index
167-
168170

169171

170172
Indices and tables

‎docs/source/volttron-topics/VOLTTRON-releases/index.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _VOLTTRON-Releases:
2+
3+
==========
4+
VOLTTRON Releases
5+
==========
6+
7+
This section includes individual documents describing important changes to platform components. For information on specific release, please refer to the corresponding document.
8+
9+
10+
.. toctree::
11+
12+
release-history
13+
upgrading-versions

‎docs/source/volttron-topics/VOLTTRON-releases/release-history.rst‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
.. _Release-History:
2+
3+
===============
4+
Release History
5+
===============
6+
7+
VOLTTRON Release Documentation for version 5.1.0 and above is found on GitHub.
8+
`https://github.com/VOLTTRON/volttron/releases <https://github.com/VOLTTRON/volttron/releases>`_
9+
10+
11+
VOLTTRON 8.1.1 Maintenance Release
12+
==================================
13+
14+
`https://github.com/VOLTTRON/volttron/releases/tag/8.1.1 <https://github.com/VOLTTRON/volttron/releases/tag/8.1.1>`_
15+
16+
17+
VOLTTRON 8.1 Release
18+
====================
19+
20+
`https://github.com/VOLTTRON/volttron/releases/tag/8.1 <https://github.com/VOLTTRON/volttron/releases/tag/8.1>`_
21+
22+
23+
VOLTTRON 8.0 Full Release
24+
=========================
25+
26+
`https://github.com/VOLTTRON/volttron/releases/tag/8.0.0 <https://github.com/VOLTTRON/volttron/releases/tag/8.0.0>`_
27+
28+
29+
VOLTTRON 7.0.1 Update
30+
=====================
31+
32+
`https://github.com/VOLTTRON/volttron/releases/tag/7.0.1 <https://github.com/VOLTTRON/volttron/releases/tag/7.0.1>`_
33+
34+
35+
VOLTTRON 8.0 Release Candidate
36+
==============================
37+
38+
`https://github.com/VOLTTRON/volttron/releases/tag/8.0rc1 <https://github.com/VOLTTRON/volttron/releases/tag/8.0rc1>`_
39+
40+
41+
VOLTTRON 7.0 Release
42+
====================
43+
44+
`https://github.com/VOLTTRON/volttron/releases/tag/7.0 <https://github.com/VOLTTRON/volttron/releases/tag/7.0>`_
45+
46+
47+
VOLTTRON 7.0 Release Candidate
48+
==============================
49+
50+
`https://github.com/VOLTTRON/volttron/releases/tag/7.0rc1 <https://github.com/VOLTTRON/volttron/releases/tag/7.0rc1>`_
51+
52+
53+
VOLTTRON 6.0 Release
54+
====================
55+
56+
`https://github.com/VOLTTRON/volttron/releases/tag/6.0 <https://github.com/VOLTTRON/volttron/releases/tag/6.0>`_
57+
58+
59+
VOLTTRON 6.0 Release Candidate
60+
==============================
61+
62+
`https://github.com/VOLTTRON/volttron/releases/tag/6.0rc1 <https://github.com/VOLTTRON/volttron/releases/tag/6.0rc1>`_
63+
64+
65+
VOLTTRON 5.1.0 Release
66+
======================
67+
68+
`https://github.com/VOLTTRON/volttron/releases/tag/5.1.0 <https://github.com/VOLTTRON/volttron/releases/tag/5.1.0>`_
69+
70+
71+
VOLTTRON 5.0 Release
72+
====================
73+
74+
- Tagging service for attaching metadata to topics for simpler retrieval
75+
- Message bus performance improvement
76+
- Multi-platform publish/subscribe for simpler coordination across platforms
77+
- Drivers contributed back for SEP 2.0 and ChargePoint EV
78+
79+
80+
VOLTTRON 4.0 Release
81+
====================
82+
83+
- Documentation moved to ReadTheDocs
84+
- VOLTTRON Configuration Wizard
85+
- Configuration store to dynamically configure agents
86+
- Aggregator agent for aggregating topics
87+
- More reliable remote install mechanism
88+
- UI for device configuration
89+
- Automatic registration of VOLTTRON instances with management agent
90+
91+
92+
VOLTTRON 3.0 Release
93+
====================
94+
95+
- Modularize Data Historian
96+
- Modularize Device Drivers
97+
- Secure and accountable communication using the VIP
98+
- Web Console for Monitoring and Administering VOLTTRON Deployments
99+
100+
101+
VOLTTRON 2.0 Release
102+
====================
103+
104+
- Advanced Security Features
105+
- Guaranteed resource allocation to agents using execution contracts
106+
- Signing and verification of agent packaging
107+
- Agent mobility
108+
- Admin can send agents to another platform
109+
- Agent can request to move
110+
- Enhanced command framework
111+
112+
113+
VOLTTRON 1.0 – 1.2
114+
==================
115+
116+
- Agent execution platform
117+
- Message bus
118+
- Modbus and BACnet drivers
119+
- Historian
120+
- Data logger
121+
- Device scheduling
122+
- Device actuation
123+
- Multi-node communication
124+
- Weather service

docs/source/volttron-topics/change-log/upgrading-versions.rst renamed to docs/source/volttron-topics/VOLTTRON-releases/upgrading-versions.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,48 @@ It is often recommended that users upgrade to the latest stable release of VOLTT
88
releases include helpful new features, bug fixes, and other improvements. Please see the guides below for upgrading
99
your existing deployment to the latest version.
1010

11+
VOLTTRON 8
12+
==========
13+
14+
VOLTTRON 8 introduces three changes that require an explict upgrade step when upgrading from a earlier VOLTTRON version
15+
16+
1. Dynamic RPC authorization feature - This requires a modification to the auth file. If you have a pre-existing
17+
instance of VOLTTRON running on an older version, the auth file will need to be updated.
18+
2. Historian agents now store the cache database (backup.sqlite file) in
19+
<volttron home>/agents/<agent uuid>/<agentname-version>/<agentname-version>.agent-data directory instead of
20+
<volttron home>/agents/<agent uuid>/<agentname-version> directory. In future all core agents will write data only
21+
to the <agentname-version>.agent-data subdirectory. This is because vctl install --force backs up and restores
22+
only the contents of this directory.
23+
3. SQLHistorians (historian version 4.0.0 and above) now use a new database schema where metadata is stored in
24+
topics table instead of separate metadata table. SQLHistorians with version >= 4.0.0 can work with existing
25+
database with older schema however the historian agent code should be upgraded to newer version (>=4.0.0) to run
26+
with VOLTTRON 8 core.
27+
28+
29+
To upgrade:
30+
31+
1. If upgrading historian, make sure historians are not in auto start mode. To remove any historian from auto start
32+
mode use the command 'vctl disable <uuid of historian that is currently enabled>. This is necessary so that the old
33+
sqlhistorian does not automatically start after step 5.
34+
2. Update volttron source code version to VOLTTRON 8
35+
3. activate the volttron environment, and run ```python bootstrap.py --force```. If you have
36+
any additional bootstrap options that you need (rabbitmq, web, drivers, etc.) include these in the above command.
37+
4. Run ```volttron-upgrade``` to update the auth file and move historian cache files into agent-data directory.
38+
Note that the upgrade script will only move the backup.sqlite file and will not move sqlite historian's db file
39+
if they are within the install directory. If using a SQLite historian, please backup the database file of
40+
sqlite historian before upgrading to the latest historian version.
41+
5. Start VOLTTRON
42+
6. Run ```vctl install --force --vip-identity <vip id of existing historian> --agent-config <config>``` to upgrade
43+
to the latest historian version. vctl install --force will backup the cache in <agent-version>.agent-data
44+
folder, installs the latest version of the historian and restore the contents of
45+
<agent-version>.agent-data folder.
46+
47+
Upgrading aggregate historians
48+
------------------------------
49+
50+
VOLTTRON 8 also comes with updated SQL aggregate historian schema. However, there is no automated upgrade path for
51+
aggregate historian. To upgrade an existing aggregate historian please refer to the CHANGELOG.md within
52+
SQLAggregateHistorian source directory
1153

1254
VOLTTRON 7
1355
==========

0 commit comments

Comments
 (0)