Upgrade¶

Warning

No other operation (such as disk replacement) must be performed during the upgrade.

A minor version is released each quarter to deliver new features. A patch version is released whenever it is needed to deliver bug or CVE fixes, and improvements. Refer to Product Lifecycle for more information.

Upgrades are strongly recommended at least once every three months. You can upgrade ARTESCA from any patch version of the previous minor version to any patch version of the current minor version.

To check your running ARTESCA version, follow the Check your ARTESCA version using the UI procedure.

Important

You can upgrade to 4.3.1 from 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.2.4 and from 4.3.0.

The upgrade downtime depends on the platform architecture:

On a single-node ARTESCA, there will be a service downtime during all the upgrade duration. Other platforms will not have any service downtime.
On a multi-node ARTESCA, there will be no service downtime during the upgrade.

The upgrade process follows this workflow:

Find the bootstrap node if you are running a multi-node ARTESCA.
Download the upgrade artifacts.
Run the OS Update.
Run the ARTESCA Upgrade.

Upgrade Notifications¶

Important

If your browser does not have Internet access, it will not detect or receive notifications for new versions.

When logged in as a Platform Admin, if a new ARTESCA version is available, the UI displays a pop-up notification that provides information about the latest version and a link to the release notes.

From there, you can:

Click Ignore until next release to disable update notifications for this specific version. However, notifications will re-display if a new update becomes available.
Click Remind me tomorrow to skip the notification until the next day.
Click Download to start the Download Artifacts process.

When a new version is detected, the platform displays a notification in the notification center on the top bar menu. Click the notification to view details about the new version.

Find the Bootstrap Node¶

On a multi-node ARTESCA architecture, the OS and ARTESCA upgrade operations must be run from the bootstrap node.

Select the Platform tab.
Select Nodes from the sub-menu.
Identify the node with the bootstrap role as shown in the screenshot below.

Download Artifacts¶

You can download artifacts:

Using the ARTESCA UI, when logged in with a Platform Admin role. In this case, the browser downloads all the resources from the packages server and uploads them to the ARTESCA instance.

Important

The UI download artifacts process is available only if you upgrade from version 3.0.0 or higher.
Using the CLI, either with Internet access or without Internet access, depending on the ARTESCA that you are running the installation or upgrade from.

Using the UI

On the version notification pop-up displayed with the latest version information, click Download.

Tip

The new version information is also available from the notification center and by clicking About from the user dropdown menu.
Enter your Scality credentials to authenticate to the upgrade service and click Log-in and Continue.

Note

Go to your OneLogin Scality profile to access your credentials. They are found next to your email address, for example: holly.day@email.com | holly.day.
The download process starts. As it takes a few minutes depending on the network connection, you can let it run in the background while performing other operations on the UI. The download status is available in the notification center.
(Optional) You can pause or abort the download at any time by clicking the respective buttons.

Pause the download

You can resume the download by clicking the corresponding button.

The download status is also available on the notification center.

Abort the download

You must confirm the action by clicking Abort.
Once the download is complete, continue the upgrade process by running the OS update and ARTESCA upgrade commands displayed on the dialog box.

(Optional) Forget this version

Click Forget this version if you want to abort the upgrade process and remain on your current version.

You must confirm the action by clicking Forget.

Using the CLI With Internet Access

Download the ARTESCA installer to the /home/artesca-os directory.

[artesca-os@bootstrap ~]$

rm -rf artesca-installer SHA256SUM \
   && curl -s --fail -Lo artesca-installer \
   https://downloads.scality.com/artesca-installer/Artesca-4.3.1/artesca-installer \
   && curl -s --fail -Lo SHA256SUM \
   https://downloads.scality.com/artesca-installer/Artesca-4.3.1/SHA256SUM \
   && sha256sum -c SHA256SUM \
   && chmod +x artesca-installer

artesca-installer: OK

Download the component artifacts using your Scality credentials (username and password).
[artesca-os@bootstrap ~]$
sudo ./artesca-installer get --ask-password --username <username>
If you are based in the Asia-Pacific region, you may want to use this command instead to download them.
[artesca-os@bootstrap ~]$
sudo ./artesca-installer get --ask-password --username <username> --url https://apac.packages.scality.com/Artesca/4.3.1/artifacts
Note

Go to your OneLogin Scality profile to access your credentials. They are found next to your email address, for example: holly.day@email.com | holly.day.

Using the CLI Without Internet Access

On a machine with an Internet access, download all the resources from https://packages.scality.com/Artesca/4.3.1/artifacts. (If you are based in the Asia-Pacific region, you may want to use this link instead to download them).
Copy all these files to the /home/artesca-os/ directory on your target machine.

Note

Overwrite any existing copies of the files.

Tip

scp is the recommended tool for this task.

From this step forward, run all commands on the target machine.

Check that the installer was correctly copied.

[artesca-os@bootstrap ~]$

sha256sum -c SHA256SUM

Make the ARTESCA installer executable.

[artesca-os@bootstrap ~]$

chmod +x artesca-installer

Provide the component artifacts to the ARTESCA installer.
[artesca-os@bootstrap ~]$
sudo ./artesca-installer get --url .
Note

You can provide any local path or HTTP(s) URL to the installer if the resources are not located in the installer directory.

Delete the installation artifacts from the /home/artesca-os directory.

[artesca-os@bootstrap ~]$

rm -f artesca-base-repo.iso artesca-base.iso metalk8s.iso xcore.iso zenko-base.iso zenko.iso

OS Update¶

Note

The OS upgrade takes between 10 minutes and 1 hour.

Run the ARTESCA installer which will update the operating system on all cluster nodes using the ARTESCA offline repository.

[artesca-os@bootstrap ~]$

sudo ./artesca-installer os-update

Important

Nodes may restart during the OS update.

This does not cause any service interruption for 3-node and 6-node clusters.

If the node where ARTESCA installer is executed needs to restart, you will lose connection to this node. Wait for it to complete its reboot, then log back in to the node.

Once you have logged back in, you can immediately launch the upgrade as described in the next step.

The os-update log is located here: /var/log/artesca/os-update.log. After the os-update and reboot, the post-os-update log is located here: /var/log/artesca/post-os-update.log.

ARTESCA Upgrade¶

Note

The ARTESCA upgrade takes between 1 and 2 hours.

[artesca-os@bootstrap ~]$

sudo ./artesca-installer upgrade

Important

The upgrade is divided into five high-level steps: platform > base > data > storage > post.
If the upgrade fails, you can retry and resume the upgrade from the step where it failed.

The upgrade log is located here: /var/log/artesca/upgrade.log.

Note

If you encounter issues while browsing the UI, refer to the troubleshooting page Post-Upgrade Issue While Browsing the ARTESCA UI.