Skip to content

Commit 2d7f36b

Browse files
authored
Merge pull request #2805 from schandrika/historian_upgrade_8.x
README update for 8.x upgrade
2 parents 99cb1c2 + dc05eed commit 2d7f36b

File tree

2 files changed

+34
-26
lines changed

2 files changed

+34
-26
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,23 @@ VOLTTRON 8 introduces three changes that require an explict upgrade step when up
2424
database with older schema however the historian agent code should be upgraded to newer version (>=4.0.0) to run
2525
with VOLTTRON 8 core.
2626

27-
To begin the upgrade process, activate the volttron environment, and run ```python bootstrap.py --force```. If you have
28-
any additional bootstrap options that you need (rabbitmq, web, drivers, etc.) include these in the above command.
29-
30-
After the bootstrap process is completed, run ```volttron-upgrade``` to update the auth file and move historian
31-
cache files into agent-data directory. Note that the upgrade script will only move the backup.sqlite file and will not
32-
move sqlite historian's db file if they are within the install directory. If using a SQLite historian, please backup
33-
the database file of sqlite historian before upgrading to the latest historian version.
34-
35-
Once the volttron-upgrade script is complete, you can do a vctl install --force command to upgrade to the latest
36-
historian version. vctl install --force will backup the cache in <agent-version>.agent-data folder, install the latest
37-
version of the historian and restore the contents of <agent-version>.agent-data folder.
38-
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.
3944

4045
### Upgrading aggregate historians
4146

docs/source/volttron-topics/VOLTTRON-releases/upgrading-versions.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,24 @@ VOLTTRON 8 introduces three changes that require an explict upgrade step when up
2525
database with older schema however the historian agent code should be upgraded to newer version (>=4.0.0) to run
2626
with VOLTTRON 8 core.
2727

28-
To begin the upgrade process, activate the volttron environment, and run ```python bootstrap.py --force```.
2928

30-
.. note::
31-
32-
If you have any additional bootstrap options that you need (rabbitmq, web, drivers, etc.)
33-
include these in the above command.
34-
35-
After the bootstrap process is completed, run ```volttron-upgrade``` to update the auth file and move historian
36-
cache files into agent-data directory. Note that the upgrade script will only move the backup.sqlite file and will not
37-
move sqlite historian's db file if they are within the install directory. If using a SQLite historian, please backup
38-
the database file of sqlite historian before upgrading to the latest historian version.
39-
40-
Once the volttron-upgrade script is complete, you can do a vctl install --force command to upgrade to the latest
41-
historian version. vctl install --force will backup the cache in <agent-version>.agent-data folder, install the latest
42-
version of the historian and restore the contents of <agent-version>.agent-data folder.
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.
4346

4447
Upgrading aggregate historians
4548
------------------------------

0 commit comments

Comments
 (0)