Upgrading AEN (AEN 4.2.0)#
CAUTION: These instructions are for upgrading AEN to the current version 4.2.0 from 4.1.3 ONLY. Each version must be upgraded iteratively from the previous version. Do not skip versions.
Upgrade instructions for previous versions:
- AEN 4.1.3 upgrade instructions
- AEN 4.1.2 upgrade instructions
- AEN 4.1.1 upgrade instructions.
- AEN 4.1.0 upgrade instructions.
- AEN 4.0.0 upgrade instructions.
For upgrades from versions before those listed above, please contact your enterprise support representative.
NOTE: Named Service Account functionality is available with AEN 4.0.0+ for new installations only. It is not available for upgraded installations. Contact your enterprise support representative for more information.
An AEN platform update requires that each instance of the 3 node types be upgraded individually:
- AEN Server
- AEN Gateway
- AEN Compute
The upgrade process requires that all AEN service instances be stopped, upgraded, and then restarted.
NOTE: Any commands that call for the root user can also be done using sudo.
If you encounter any difficulty during the upgrade process, see Troubleshooting which provides guidance on:
- configuration files
- log files
If you are unable to resolve an installation or upgrade problem, please contact your enterprise support representative.
CAUTION: Make a tested backup of your installation before starting the upgrade. Upgrading to a higher version of AEN is not reversible. Any errors during the upgrade procedure may result in partial or complete data loss and require restoring data from backups.
CAUTION: Terminate all AEN applications and stop all projects before starting the upgrade process.
Before upgrading each service on each host:
Suspend the services on each of the nodes:
sudo service wakari-server stop sudo service wakari-gateway stop sudo service wakari-compute stop
Set the AEN Functional ID (“NFI”) and AEN Functional Group (“NFG”) to the NFI and NFG of the current installation:
export AEN_SRVC_ACCT="wakari" export AEN_SRVC_GRP="wakari"
NOTE: The default NFI is
aen_adminor any other name may be used instead.
For more information on NFI and NFG, see the installation instructions.
yum install wget
NOTE: If you are using LDAP-based authentication, back up the
configuration file. After the server has been upgraded, copy that
file back into the same location as before the upgrade.
Complete the following steps on the server host:
Stop the Elasticsearch service:
sudo service elasticsearch stop
Remove any previous index:
sudo rm -rf /var/lib/elasticsearch/*
NOTE: You can choose to keep the old index, but if you detect any issues with the search capabilities after the upgrade, you will need to run the following to start with a clean index:
sudo service wakari-server stop sudo service elasticsearch stop sudo rm -rf /var/lib/elasticsearch/* sudo service elasticsearch start sudo service wakari-server start
Upgrade the server:
pushd /tmp wget http://j.mp/aen-server-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/miniconda/bin/conda install \ -p /opt/wakari/wakari-server \ --file aen-server-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/miniconda/bin/conda install \ -p /opt/wakari/wakari-server \ --no-deps \ wakari-enterprise-server-conf-update=2.0.6 popd
sudo service elasticsearch start
Or, if you do not want to use the search features, edit your server’s
/opt/wakari/wakari-server/etc/wakari/config.jsonfile by adding the line
Remove previous Unix socket:
AEN server version >= 4.1.3 uses Unix sockets for communication with NGINX. Version 4.1.3 uses a Unix socket at
/tmp. Version 4.2.0 uses a unix socket at the location
unix:/opt/wakari/wakari-server/var/run/wakari-server.sock. Remove the leftover socket with:
sudo rm /tmp/wakari-server.sock
Restart the NGINX server:
AEN server version >= 4.1.3 uses Unix sockets for communication with NGINX. Restart NGINX to load this new configuration:
sudo service nginx restart
Alternatively, you can restart NGINX with:
sudo nginx -s stop sudo nginx
Start the server:
sudo service wakari-server start
Check that the server is running properly:
sudo service wakari-server status
If you see NGINX errors, please check the configuration at
Connect to AEN server using your web browser with the correct protocol (http or https), hostname and port number.
Complete the following steps on each gateway host:
Upgrade the gateway:
pushd /tmp wget http://j.mp/aen-gateway-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/miniconda/bin/conda install \ -p /opt/wakari/wakari-gateway \ --file aen-gateway-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/miniconda/bin/conda install \ -p /opt/wakari/wakari-gateway \ --no-deps \ wakari-enterprise-gateway-conf-update=2.0.6 popd
Start the gateway:
sudo service wakari-gateway start
Check that the gateway is running properly:
sudo service wakari-gateway status
Connect to the gateway using your web browser with the correct http/https, hostname and port number.
Complete the following steps on each host where an AEN compute service is running:
Check for any
ps aux | grep wakari-indexer
NOTE: If you stopped all the projects, you will not see any wakari-indexer processes running.
Terminate any remaining
sudo killall wakari-indexer
NOTE: The processes killed with
killallare run by the $AEN_SRVC_ACCT user, so they can be killed as root with
sudo killallor killed as the $AEN_SRVC_ACCT user with
sudo -u $AEN_SRVC_ACCT killall. Example commands show the
Check for any AEN applications processes running—Workbench, Viewer, Terminal or Notebook:
ps aux | grep wk-app-gateone ps aux | grep wk-app-workbench ps aux | grep wk-app-viewer ps aux | grep wk-app-terminal ps aux | grep jupyter-notebook
NOTE: If you stopped all the projects, you will not see any AEN app processes running.
Terminate any remaining AEN application processes by running one or more of the following:
sudo killall wk-app-gateone sudo killall wk-app-workbench sudo killall wk-app-viewer sudo killall wk-app-terminal sudo killall jupyter-notebook
Verify the contents of
/opt/wakari/anaconda/.condarc. Modify it to contain the following entries, and possibly others if you customized the
NOTE: Modify the file as the AEN_SRVC_ACCT user (or be sure to keep the same ownership).
channels: - https://conda.anaconda.org/t/<TOKEN>/anaconda-nb-extensions - r - https://conda.anaconda.org/wakari - defaults create_default_packages: - anaconda-client - ipykernel
NOTE: Contact your enterprise support representative to get your token for the Anaconda channel referenced above. Replace
<TOKEN>with the actual token from your enterprise support representative.
Upgrade each compute service:
pushd /tmp wget http://j.mp/aen-compute-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/anaconda/bin/conda install \ -p /opt/wakari/wakari-compute \ --file aen-compute-update-4_2_0 sudo -E -u $AEN_SRVC_ACCT /opt/wakari/anaconda/bin/conda install \ --no-deps \ -p /opt/wakari/wakari-compute \ wakari-enterprise-compute-conf-update=2.0.11 popd
NOTE: When upgrading the wakari-compute environment, you may see ImportError warnings with some nbextensions. As long as the Validating message is OK, the ImportError warnings are harmless—a consequence of the post-link presence on those packages.
Run the upgrade_420.sh script to make your 4.1.3 projects compatible with the 4.2.0 codebase:
pushd /tmp wget -O upgrade_420.sh http://j.mp/upgrade_420 chmod a+x upgrade_420.sh ./upgrade_420.sh popd
Initialize the root environment to prime the package cache:
sudo -E -u $AEN_SRVC_ACCT /opt/wakari/anaconda/bin/conda create \ -p /opt/wakari/testenv \ --clone root
Test the offline cloning step:
sudo -E -u $AEN_SRVC_ACCT /opt/wakari/anaconda/bin/conda create \ -p /opt/wakari/testenvoffline \ --clone root --offline
Remove the test environments:
sudo rm -rf /opt/wakari/testenv sudo rm -rf /opt/wakari/testenvoffline
Install necessary dependencies:
NOTE: Skip this step if you already have these dependencies installed from previous installations.
sudo yum groupinstall "X Window System" -y sudo yum install git -y
NOTE: If you don’t want to install the whole X Window System, you must install the following packages to have R plotting support:
sudo yum install -y libXrender libXext libXdmcp libSM libICE libXt \ dejavu-sans-fonts dejavu-serif-fonts dejavu-fonts-common \ fontpackages-filesystem
Start the compute service:
sudo service wakari-compute start
Verify the compute service is running properly:
sudo service wakari-compute status
Restart the AEN Server with:
sudo service wakari-server restart
Repeat this upgrade procedure for all compute nodes in your Data Center.
Restart the projects and start using AEN applications.
If you have a customized default environment, you may choose to upgrade it depending on the needs of your users.
NOTE: Upgrading the default environment at
/opt/wakari/anaconda/envs/defaultdoes NOT automatically upgrade the default environment in the users pre-existing projects. For pre-existing projects, the upgrade, if requested, should be done on a per-user basis.
If you did not stop all your projects before upgrading, then the first time you start an application you will see an error page requesting that you restart the application.
Restart the application to complete the upgrade.
If you still see old applications or icons after restart, reload the page to reset the browser cache.