Skip to content

Update to the newest version

If you are using a version of the Codex Catalog that is older than the latest release available, you may need to update your Codex Catalog Version.

On your Codex Catalog home page, you will see a section showing your current version.

Directly below, a card will display the latest available version along with a “SELECT FOR UPDATE” button.

Select the update

To begin, click Select for update on the Latest Version Available card.

Select the update

This will open the Settings modal.

Settings modal

Choose your settings

The Settings modal walks you through several steps where you can configure the Codex Catalog update. Examples of configurable options include:

  • Compute SKU for the App Service Plan.
  • Storage size for the PostgreSQL server.

To proceed, step by step:

  1. Select your preferred settings from the dropdown menus.
  2. Click Next to move to the following step.

Settings modal options

  1. Continue through the steps until you reach Finish, where you can review all your choices.

To change any settings, you can use the Previous and Next arrows, or click directly on the step you want to revisit.

Settings modal navigation

  1. When you are ready, click on the button Save Settings. The Installer will save your configuration in Azure.

Update the Codex Catalog

After saving your settings, you will be asked to confirm if you would like to start installing the version you have selected.

Update version confirmation

Click the blue Update button to begin the installation.

Once started, you will see the status and progress of the installation directly on screen.

Update version: status and progress

Update Steps and Statuses

When an update starts, the installer runs through three main steps:

  1. DeployUpdateApiResources – Azure prepares the infrastructure resources required for the update (such as networking, storage, and service dependencies).
  2. DeployUpdateApiApplication – The application components are deployed into the prepared resources.
  3. TriggerUpdateApi – The update process is triggered and executed, applying the new version of the Codex Catalog.

Status Indicators

Each step displays a status so you can follow the progress of the installation:

  • Not started – The step has not yet begun.
  • In progress – The step is currently running.
  • Failed – An error occurred and the step did not complete.
  • Completed – The step finished successfully.

End of installation

When the update completes, the installer will confirm that your Codex Catalog is ready to use.

Update version: end of installation

After the update, you will see the option to roll back to the last version you had previous to the update, if needed.