Skip to content

Upgrading ClusterControl

There are several ways to upgrade ClusterControl to the latest version. However, we recommend users to perform an Online Upgrade where the instructions are mostly up-to-date. For details on the latest release, see Release Notes.

Online Upgrade

This is the recommended way to upgrade ClusterControl. The following upgrade procedures require an internet connection on the ClusterControl node.

Red Hat/CentOS/Rocky Linux/AlmaLinux

  1. Clear the repository cache so it will retrieve the latest repository list and perform the upgrade:

    dnf clean all
dnf install clustercontrol2 \
clustercontrol-controller \
clustercontrol-ssh \
clustercontrol-notifications \
clustercontrol-cloud \
clustercontrol-clud \
s9s-tools

    yum clean all
yum install clustercontrol2 \
clustercontrol-controller \
clustercontrol-ssh \
clustercontrol-notifications \
clustercontrol-cloud \
clustercontrol-clud \
s9s-tools

  2. Restart the ClusterControl services:

    systemctl daemon-reload
systemctl restart cmon cmon-ssh cmon-events cmon-cloud

    service cmon restart
service cmon-ssh restart
service cmon-events restart
service cmon-cloud restart

The upgrade is now complete. Verify the new version from the GUI's footer or by using the command cmon -v. You should re-login if your ClusterControl UI session is active.

Attention

If you are upgrading to ClusterControl v1.9.8 (Feb 2024), there is an additional step to activate the web-based SSH feature. See [Activating Web-based SSH for ClusterControl GUI v2] further down.

Debian/Ubuntu

  1. Update the repository list and perform the upgrade:

    sudo apt update
sudo apt install clustercontrol2 \
    clustercontrol-controller \
    clustercontrol-ssh \
    clustercontrol-notifications \
    clustercontrol-cloud \
    clustercontrol-clud \
    s9s-tools

  2. Restart the ClusterControl services:

    systemctl daemon-reload
systemctl restart cmon cmon-ssh cmon-events cmon-cloud

    service cmon restart
service cmon-ssh restart
service cmon-events restart
service cmon-cloud restart

The upgrade is now complete. Verify the new version from the GUI's footer or by using the command cmon -v. You should re-login if your ClusterControl UI session is active.

Attention

If you are upgrading to ClusterControl v1.9.8 (Feb 2024), there is an additional step to activate the web-based SSH feature. See Activating Web-based SSH for ClusterControl GUI v2 further down.

Offline Upgrade

The following upgrade procedures can be performed without an internet connection on the ClusterControl node.

Red Hat/CentOS/Rocky Linux/AlmaLinux

  1. Download the latest version of ClusterControl-related RPM packages from Severalnines download site and the Severalnines Repository. There are some packages you need to download as explained below:

    • clustercontrol2 - ClusterControl GUI v2
    • clustercontrol-controller - ClusterControl Controller (CMON)
    • clustercontrol-notifications - ClusterControl event module
    • clustercontrol-ssh - ClusterControl web-ssh module
    • clustercontrol-cloud - ClusterControl cloud module
    • clustercontrol-clud - ClusterControl cloud's file manager module
    • s9s-tools - ClusterControl CLI (s9s)

  2. Install using yum or dnf to satisfy all dependencies:

    dnf localinstall clustercontrol*
dnf localinstall s9s-tools

    yum localinstall clustercontrol*
yum localinstall s9s-tools

  3. Restart the ClusterControl services:

    systemctl daemon-reload
systemctl restart cmon cmon-ssh cmon-events cmon-cloud

    service cmon restart
service cmon-ssh restart
service cmon-events restart
service cmon-cloud restart

The upgrade is now complete. Verify the new version from the GUI's footer or by using the command cmon -v. You should re-login if your ClusterControl UI session is active.

Attention

If you are upgrading to ClusterControl v1.9.8 (Feb 2024), there is an additional step to activate the web-based SSH feature. See Activating Web-based SSH for ClusterControl GUI v2 further down.

Debian/Ubuntu

  1. Download the latest version of ClusterControl-related DEB packages from Severalnines download site and Severalnines Repository. There are some packages you need to download as explained below:

    • clustercontrol2 - ClusterControl GUI v2
    • clustercontrol-controller - ClusterControl Controller (CMON)
    • clustercontrol-notifications - ClusterControl event module
    • clustercontrol-ssh - ClusterControl web-ssh module
    • clustercontrol-cloud - ClusterControl cloud module
    • clustercontrol-clud - ClusterControl cloud's file manager module
    • s9s-tools - ClusterControl CLI (s9s) - Download it from here.
    • s9s-tools-lib - ClusterControl CLI (s9s) library - Download it from here.

  2. Upload the packages to the server and install them using dpkg command:

    sudo dpkg -i clustercontrol*.deb
sudo dpkg -i libs9s0*.deb
sudo dpkg -i s9s*.deb

  3. Restart the ClusterControl services:

    systemctl daemon-reload
systemctl restart cmon cmon-ssh cmon-events cmon-cloud

    service cmon restart
service cmon-ssh restart
service cmon-events restart
service cmon-cloud restart

The upgrade is now complete. Verify the new version from the GUI's footer or by using the command cmon -v. You should re-login if your ClusterControl UI session is active..

Attention

If you are upgrading to ClusterControl v1.9.8 (Feb 2024), there is an additional step to activate the web-based SSH feature. See Activating Web-based SSH for ClusterControl GUI v2 further down.

Activating Web-based SSH for ClusterControl GUI v2

Starting from ClusterControl 1.9.8, ClusterControl GUI v2 is now able to perform a web-based SSH using a web socket. ClusterControl will use the operating system user as configured during the cluster deployment/import and pop up a new browser window to access the SSH terminal via ClusterControl.

Note

The ClusterControl GUI user must have "Manage" privilege to the cluster to use this feature.

To activate the web-based SSH on ClusterControl GUI v2, a modification is required to be performed to the Apache configuration file, to ensure the feature is secure and ClusterControl can exchange HTTP token authentication properly.

  1. Ensure you have upgraded to the latest version of the ClusterControl GUI v2 package. The package name and version should be at least clustercontrol2.x86_64 2.1.0-1203.

  2. Edit /etc/httpd/conf.d/cc-frontend.conf (RedHat-based) or /etc/apache2/conf.d/sites-available/cc-frontend.conf (Debian-based) and make sure the following lines exist inside the <VirtualHost *:9443> section.

            # Proxy settings
        SSLProxyEngine on
        SSLProxyVerify none
        SSLProxyCheckPeerCN off
        SSLProxyCheckPeerExpire off
        SSLProxyCheckPeerName off
        SSLProxyCACertificateFile /var/lib/cmon/ca/cmon/rpc_tls.crt

        <LocationMatch /cc-license>
            ProxyPass https://severalnines.com/service/lic.php
            ProxyPassReverse https://severalnines.com/service/lic.php
        </LocationMatch>

        <LocationMatch /api/v2/>
            ProxyPass https://127.0.0.1:9501/v2/
            ProxyPassReverse https://127.0.0.1:9501/v2/
            Header edit Set-Cookie ^(.*)$ "$1; Path=/"
        </LocationMatch>

        <LocationMatch /api/events-test/>
            ProxyPass http://127.0.0.1:9510/test/
            ProxyPassReverse http://127.0.0.1:9510/test/
        </LocationMatch>


        <Location /cmon-ssh/cmon/ws/>
            RewriteEngine On
            RewriteCond %{REQUEST_URI} ^/cmon-ssh/cmon/ws/(.*)$
            RewriteRule ^(.*)$ ws://127.0.0.1:9511/cmon/ws/%1 [P,L]
        </Location>

        <LocationMatch /cmon-ssh/>
            ProxyPass http://127.0.0.1:9511/
            ProxyPassReverse http://127.0.0.1:9511/
        </LocationMatch>

    This is an example after we have updated the configuration file on a Rocky Linux 8 system, /etc/httpd/conf.d/cc-frontend.conf:

    <VirtualHost *:9443>
        ServerName 157.230.37.193
        ServerAlias *.severalnines.local

        DocumentRoot /var/www/html/clustercontrol2
        #ErrorLog /var/log/httpd/cc-frontend-error.log
        #CustomLog /var/log/httpd/cc-frontend-access.log combined
        #ErrorLog ${APACHE_LOG_DIR}/cc-frontend-error.log
        #CustomLog ${APACHE_LOG_DIR}/cc-frontend-access.log combined

        # HTTP Strict Transport Security (mod_headers is required) (63072000 seconds)
        Header always set Strict-Transport-Security "max-age=63072000"

        SSLEngine on
        SSLCertificateFile /etc/ssl/certs/s9server.crt
        SSLCertificateKeyFile /etc/ssl/private/s9server.key

        <Directory />
                Options +FollowSymLinks
                AllowOverride All
                Require all granted
        </Directory>

        <Directory /var/www/html/clustercontrol2>
                Options +Indexes +Includes +FollowSymLinks -MultiViews
                AllowOverride All

                RewriteEngine On
                # If an existing asset or directory is requested go to it as it is
                RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -f [OR]
                RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} -d
                RewriteRule ^ - [L]
                # If the requested resource doesn't exist, use index.html
                RewriteRule ^ /index.html
        </Directory>

        # Proxy settings
        SSLProxyEngine on
        SSLProxyVerify none
        SSLProxyCheckPeerCN off
        SSLProxyCheckPeerExpire off
        SSLProxyCheckPeerName off
        SSLProxyCACertificateFile /var/lib/cmon/ca/cmon/rpc_tls.crt

        <LocationMatch /cc-license>
            ProxyPass https://severalnines.com/service/lic.php
            ProxyPassReverse https://severalnines.com/service/lic.php
        </LocationMatch>

        <LocationMatch /api/v2/>
            ProxyPass https://127.0.0.1:9501/v2/
            ProxyPassReverse https://127.0.0.1:9501/v2/
            Header edit Set-Cookie ^(.*)$ "$1; Path=/"
        </LocationMatch>

        <LocationMatch /api/events-test/>
            ProxyPass http://127.0.0.1:9510/test/
            ProxyPassReverse http://127.0.0.1:9510/test/
        </LocationMatch>


        <Location /cmon-ssh/cmon/ws/>
            RewriteEngine On
            RewriteCond %{REQUEST_URI} ^/cmon-ssh/cmon/ws/(.*)$
            RewriteRule ^(.*)$ ws://127.0.0.1:9511/cmon/ws/%1 [P,L]
        </Location>

        <LocationMatch /cmon-ssh/>
            ProxyPass http://127.0.0.1:9511/
            ProxyPassReverse http://127.0.0.1:9511/
        </LocationMatch>



</VirtualHost>
# intermediate configuration
SSLProtocol             all -SSLv3 -TLSv1 -TLSv1.1
SSLCipherSuite          ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384
SSLHonorCipherOrder     off
SSLSessionTickets       off

# SSLUseStapling On
# SSLStaplingCache "shmcb:logs/ssl_stapling(32768)"

  3. Restart the Apache service:

    systemctl restart httpd

    systemctl restart apache2

  4. Finally, you must log out from the ClusterControl GUI v2 and re-login again, to activate the new cookie settings for HTTP token authentication.

You can now use the web SSH feature accessible under Nodes → Actions → SSH Console.

Copyright © 2014-2025 Severalnines AB. All rights reserved.

Severalnines and ClusterControl are registered trademarks in the US, UK, and EU. The 3rd-party trademarks on this site are property of their respective owners and are used for referential purposes only.

Made with Material for MkDocs