Upgrade from Archivematica 1.6.x to 1.7.0¶
On this page:
- Create a backup
- Upgrade Ubuntu package install
- Upgrade CentOS/Red Hat package install
- Upgrade search indices
- Upgrade in indexless mode
- Upgrade with output capturing disabled
While it is possible to upgrade a GitHub-based source install using ansible, these instructions do not cover that scenario.
Create a backup¶
Before starting any upgrade procedure on a production system, we strongly recommend backing up your system. If you are using a virtual machine, take a snapshot of it before making any changes. Alternatively, back up the file systems being used by your system. Exact procedures for updating will depend on your local installation. At a minimum you should make backups of:
- The Storage Service SQLite (or MySQL) database
- The dashboard MySQL database
This is a simple example of backing up these two databases:
sudo cp /var/archivematica/storage-service/storage.db ~/storage_db_backup.db mysqldump -u root -p MCP > ~/am_backup.sql
If you do not have a password set for the root user in MySQL, you can take out the ‘-p’ portion of that command. If there is a problem during the upgrade process, you can restore your MySQL database from this backup and try the upgrade again.
Upgrade on Ubuntu¶
Before you start: Archivematica 1.7 stopped using
/usr/share/python as the
home for our Python virtual environments. We did this because it was causing
Ubuntu Xenial to break when attempting to upgrade a system package called
python-minimal. If you’re running Ubuntu Xenial the following commands are
going to be necessary to continue the upgrade:
sudo rm -rf /usr/share/python/archivematica-dashboard sudo rm -rf /usr/share/python/archivematica-mcp-server sudo rm -rf /usr/share/python/archivematica-mcp-client
Update the operating system.
sudo apt-get update && sudo apt-get upgrade
Update Python Setuptools. This is used to install Python dependencies for both the Storage Service and the dashboard. There is a known issue with pip on Ubuntu 14.04 which makes this step necessary.
sudo pip install -U setuptools
Update package sources.
In Ubuntu 14.04:
sudo add-apt-repository --remove ppa:archivematica/externals echo 'deb [arch=amd64] http://packages.archivematica.org/1.7.x/ubuntu trusty main' >> /etc/apt/sources.list echo 'deb [arch=amd64] http://packages.archivematica.org/1.7.x/ubuntu-externals trusty main' >> /etc/apt/sources.list
In Ubuntu 16.04:
sudo add-apt-repository --remove ppa:archivematica/externals echo 'deb [arch=amd64] http://packages.archivematica.org/1.7.x/ubuntu xenial main' >> /etc/apt/sources.list echo 'deb [arch=amd64] http://packages.archivematica.org/1.7.x/ubuntu-externals xenial main' >> /etc/apt/sources.list
Optionally you can remove the lines referencing packages.archivematica.org/1.6.x from /etc/apt/sources.list.
Update the Storage Service.
sudo apt-get update sudo apt-get install archivematica-storage-service
Update the Application Container. As of Storage Service version 0.10.0, the Storage Service uses Gunicorn as WSGI server. This means that the old uwsgi server needs to be stopped and disabled after performing the upgrade.
sudo service uwsgi stop sudo update-rc.d uwsgi disable
Update Archivematica. During the update process you may be asked about updating configuration files. Choose to accept the maintainers versions. You will also be asked about updating the database - say ‘ok’ to each of those steps. If you have set a password for the root MySQL database user, enter it when prompted. It is better to update the dashboard before updating the mcp components.
sudo apt-get upgrade
Disable unused services. Archivematica 1.7.0 uses Nginx as HTTP server, and Gunicorn as WSGI server. This means that some services used in Archivematica 1.6.1 should be stopped and disabled before performing the upgrade.
sudo service apache2 stop sudo update-rc.d apache2 disable
sudo service nginx restart sudo restart archivematica-storage-service sudo ln -s /etc/nginx/sites-available/dashboard.conf /etc/nginx/sites-enabled/dashboard.conf sudo service gearman-job-server restart sudo restart archivematica-mcp-server sudo restart archivematica-mcp-client sudo start archivematica-dashboard sudo restart fits sudo freshclam sudo service clamav-daemon restart sudo service nginx restart
Depending on which service manager (init system) you are using (e.g., systemd, Upstart, or init), the above
restartcommands may not work. Please refer to the documentation for your operating system’s service manager for more details.
Depending on how your Ubuntu system is set up, you may have trouble restarting gearman with the command in the block above. If that is the case, try this command instead:
sudo restart gearman-job-server
Remove unused services.
sudo apt-get remove --purge python-pip apache2 uwsgi
Upgrade on CentOS/Red Hat¶
Upgrade the repositories for 1.7:
sudo sed -i 's/1.6.x/1.7.x/g' /etc/yum.repos.d/archivematica*
Upgrade the packages:
sudo yum update
Once the new packages are installed, upgrade the databases for both Archivematica and the Storage Service. This can be done with:
sudo -u archivematica bash -c " \ set -a -e -x source /etc/default/archivematica-dashboard || \ source /etc/sysconfig/archivematica-dashboard \ || (echo 'Environment file not found'; exit 1) cd /usr/share/archivematica/dashboard /usr/share/archivematica/virtualenvs/archivematica-dashboard/bin/python manage.py migrate "; sudo -u archivematica bash -c " \ set -a -e -x source /etc/default/archivematica-storage-service || \ source /etc/sysconfig/archivematica-storage-service \ || (echo 'Environment file not found'; exit 1) cd /usr/lib/archivematica/storage-service /usr/share/archivematica/virtualenvs/archivematica-storage-service/bin/python manage.py migrate ";
Restart the Archivematica related services, and continue using the system:
sudo systemctl restart archivematica-storage-service sudo systemctl restart archivematica-dashboard sudo systemctl restart archivematica-mcp-client sudo systemctl restart archivematica-mcp-server
Depending on your browser settings, you may need to clear your browser cache to make the dashboard pages load properly. For example in Firefox or Chrome you should be able to clear the cache with control-shift-R or command-shift-F5.
Upgrade search indices¶
Ignore this section if you are planning to run Archivematica without a search index. Instead, follow the instructions on how to upgrade Archivematica in indexless mode.
To complete these instructions you need to know the paths of your transfer backlog and AIP storage locations. Respectively, these usually are:
You can confirm the paths of your installation in the Location tab of the Storage Service.
This process has two steps:
Rebuild transfer index:
Run the following command passing the path of the transfer backlog location you confirmed above:
sudo -u archivematica bash -c " \ set -a -e -x source /etc/default/archivematica-dashboard || \ source /etc/sysconfig/archivematica-dashboard \ || (echo 'Environment file not found'; exit 1) cd /usr/share/archivematica/dashboard /usr/share/archivematica/virtualenvs/archivematica-dashboard/bin/python manage.py \ rebuild_transfer_backlog \ --transfer-backlog-dir=/var/archivematica/sharedDirectory/www/AIPsStore/transferBacklog ";
This may take a while if you have a large backlog. Once it completes, you should be able to see your Transfer Backlog in the Appraisal tab and in the Backlog tab.
Depending on your browser settings, you may need to clear your browser cache to make the dashboard pages load properly. For example in Firefox or Chrome yo should be able to clear the cache with
Rebuild the AIP index:
Run the following command passing the path of the AIP storage location you confirmed above:
sudo -u archivematica bash -c " \ set -a -e -x source /etc/default/archivematica-dashboard || \ source /etc/sysconfig/archivematica-dashboard \ || (echo 'Environment file not found'; exit 1) cd /usr/share/archivematica/dashboard /usr/share/archivematica/virtualenvs/archivematica-dashboard/bin/python manage.py \ rebuild_elasticsearch_aip_index_from_files \ /var/archivematica/sharedDirectory/www/AIPsStore ";
This may take a while if you have many AIPs stored.
Upgrade in indexless mode¶
As of Archivematica 1.7, Archivematica can be run in indexless mode; that is, without Elasticsearch. Installing Archivematica without Elasticsearch means reduced consumption of compute resources and lower operational complexity. Disabling Elasticsearch means that the Backlog, Appraisal, and Archival Storage tabs do not appear and their functionality is not available.
Upgrade your existing Archivematica pipeline following the instructions above.
Modify the relevant systemd EnvironmentFile files by adding lines that set the relevant environment variables to
If you are using Ubuntu, run the following commands.
sudo sh -c 'echo "ARCHIVEMATICA_DASHBOARD_DASHBOARD_SEARCH_ENABLED=false" >> /etc/default/archivematica-dashboard' sudo sh -c 'echo "ARCHIVEMATICA_MCPSERVER_MCPSERVER_SEARCH_ENABLED=false" >> /etc/default/archivematica-mcp-server' sudo sh -c 'echo "ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_SEARCH_ENABLED=false" >> /etc/default/archivematica-mcp-client'
If you are using CentOS, run the following commands.
sudo sh -c 'echo "ARCHIVEMATICA_DASHBOARD_DASHBOARD_SEARCH_ENABLED=false" >> /etc/sysconfig/archivematica-dashboard' sudo sh -c 'echo "ARCHIVEMATICA_MCPSERVER_MCPSERVER_SEARCH_ENABLED=false" >> /etc/sysconfig/archivematica-mcp-server' sudo sh -c 'echo "ARCHIVEMATICA_MCPCLIENT_MCPCLIENT_SEARCH_ENABLED=false" >> /etc/sysconfig/archivematica-mcp-client'
If you are using Ubuntu, run the following commands.
sudo service archivematica-dashboard restart sudo service archivematica-mcp-client restart sudo service archivematica-mcp-server restart
If you are using CentOS, run the following commands.
sudo -u root systemctl restart archivematica-dashboard sudo -u root systemctl restart archivematica-mcp-client sudo -u root systemctl restart archivematica-mcp-server
If you had previously installed and started the Elasticsearch service, you can turn it off now.
If you are using Ubuntu 14.04, run the following commands.
sudo service elasticsearch stop sudo update-rc.d elasticsearch disable
If you are using Ubuntu 16.04 or CentOS/Red Hat, run the following commands.
sudo -u root systemctl stop elasticsearch sudo -u root systemctl disable elasticsearch
Upgrade with output capturing disabled¶
As of Archivematica 1.7.1, output capturing can be disabled at upgrade or at
any other time. This means the stdout and stderr from preservation tasks are
not captured, which can result in a performane improvement. See the
Task output capturing configuration <task-output-capturing-admin> page for
more details. In order to disable output capturing, set the
false and restart the MCP Client process(es). Consult the
installation instructions for your deployment method for more details on how to
set environment variables and restart Archivematica processes.