Vera 2023.4 Upgrade Tasks

Owned by HB Farris
Last updated: Jan 19, 2024 by John Berek
4 min read

For upgrades from versions prior to 2023.1: a two step upgrade process must be followed. Please upgrade to 2023.1 first, then upgrade to 2023.4. If the two step process is not followed, then the connections will not be properly imported from the Synchronization Policy.

Starting with 2023.2.3, older SSL certificates used by the Web Portal for HTTPS may no longer work with Vera. This is due to Node.js no longer supporting certificates using the RC2 ciphers. When upgrading, make sure to create a new certificate PFX file with a supported cipher.

In this version, we have introduced two new containers to improve performance. Your deployment script (e.q. docker-compose-yml) needs to be updated to include the new images. Please see Upgrade the Vera Server Applications for more information.

  1. tricentis/vera-worker-audithistory- Worker to handle Audit History actions.

  2. tricentis/vera-api-audithistory - Public API for Audit History

There is a sample docker-compose file on the Vera Deployment with Docker page

Vera 2023.4 introduced new features. Vera will automatically make the following updates when you upgrade to Vera 2023.4 to support these new features.

  1. Users can now configure their e-mail notification by domain. Upon upgrade, all users will be set with notifications enabled for their associated domains.

  2. Users can now be deactivated via the User Management area. All current users will be marked as Active until they are manually deactivated. More information can be found here: Deactivating/Activating User Accounts

  3. Vera Local Users (eg. service accounts and non-SSO users) will now be allowed up to 5 incorrect login attempts within a 10 minute period before their accounts are temporarily locked. More information can be found here: Automatic Locking of Users

  4. The system will add the following databases and collections:

    1. New Database: vera-audithistory:

      1. Collection: audit-entries

    2. New Database: vera-api-gateway:

      1. Collection: endpoints

Network Communication Changes

With the introduction of microservices for the Audit History module, various network changes will need to be implemented to ensure connectivity. See this page for more information on the ports that will be required after the upgrade: Required Ports

Additional Logging Options

The following logging options are now now available to be added to the logging-settings.yml file.

  • API Audit History

  • Worker Audit History

For more information on logging settings, see Configuring Logging for Vera Server and Microservices

Follow the steps below for your current Vera version:

Upgrading from a version prior to 2023.1

If you are upgrading from any version prior to 2023.1, please follow these step to ensure your upgrade is successful.

  1. Upgrade MongoDB, if needed. See the “MongoDB Compatibility Update” section below.

  2. Follow the steps to upgrade to 2022.3, if needed: Vera 2022.3 Upgrade Tasks

  3. Perform the upgrade to 2023.1:

    1. Set the docker container tags to the latest patch for 2023.1: Vera 2023.1

    2. Pull the images

    3. Restart the docker containers

  4. Once the server has successfully started up, follow the steps below to upgrade from 2023.1.

Upgrading from 2023.1

If you are upgrading from 2023.1, please follow these steps to ensure your upgrade is successful.

  1. Upgrade MongoDB, if needed. See the “MongoDB Compatibility Update” section below.

  2. Add the following containers to the docker-compose.yml (or similar) file. A sample file is located here: Vera Deployment with Docker

    1. vera.server: replace the tx3/vera-server image with the tricentis/vera-server-legacy image

    2. rabbitmq

    3. vera.api.audithistory

    4. vera.api.connections.testconnection

    5. vera.api.jira.routeactions

    6. vera.api.qtest.routeactions

    7. vera.api.routes.routeevents

    8. vera.worker.audithistory

    9. vera.worker.jobservice

    10. vera.worker.jira

    11. vera.worker.qtest

  3. Set the image tags to the highest patch available for 2023.3. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  4. Vera will create the following databases and collections. Ensure the MongoDB user has the appropriate permissions to create the collections, or create them manually if needed:

    1. New Database: vera-api-gateway

      1. Collection: endpoints

    2. New Database: vera-audithistory

      1. Collection: audit-entries

    3. New Database: tx3-vera-connections:

      1. Collection: connections

    4. New Database: tx3-vera-webhooks

      1. Collection: webhook-callbacks

    5. New Database: vera-qtest-routeactions-sagas

      1. Collection: job-attempts

      2. Collection: job-types

      3. Collection: jobs

    6. New Database: tx3-vera-jira

      1. Collection: webhook-calls

    7. New Database: vera-worker-jobservice-sagas

      1. Collection: job-attempts

      2. Collection: job-types

      3. Collection: jobs

  5. Pull the images.

  6. Restart the containers.

Upgrading from 2023.2

If you are upgrading from 2023.2, please follow these steps to ensure your upgrade is successful.

  1. Add the following containers to the docker-compose.yml (or similar) file. A sample file is located here: Vera Deployment with Docker

    1. vera.api.audithistory

    2. vera.api.jira.routeactions

    3. vera.worker.audithistory

    4. vera.worker.jobservice

    5. vera.worker.jira

  2. Set the image tags to the highest patch available for 2023.3. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  3. Vera will create the following databases and collections. Ensure the MongoDB user has the appropriate permissions to create the collections, or create them manually if needed:

    1. New Database: vera-api-gateway

      1. Collection: endpoints

    2. New Database: vera-audithistory

      1. Collection: audit-entries

    3. New Database: tx3-vera-jira

      1. Collection: webhook-calls

  4. Pull the images.

  5. Restart the containers.

Upgrading from 2023.3

If you are upgrading from 2023.3, please follow these steps to ensure your upgrade is successful.

  1. Add the following containers to the docker-compose.yml (or similar) file. A sample file is located here: Vera Deployment with Docker

    1. vera.api.audithistory

    2. vera.worker.audithistory

  2. Set the image tags to the highest patch available for 2023.3. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  3. Vera will create the following databases and collections. Ensure the MongoDB user has the appropriate permissions to create the collections, or create them manually if needed:

    1. New Database: vera-api-gateway

      1. Collection: endpoints

    2. New Database: vera-audithistory

      1. Collection: audit-entries

  4. Pull the images.

  5. Restart the containers.

MongoDB Compatibility Update

Vera now requires a minimum MongoDB version of 5.0. Please ensure your MongoDB is updated prior to upgrading Vera to the latest version.

Current MongoDB Version

Upgrade Path

Current MongoDB Version

Upgrade Path

4.2.x

  1. Upgrade to MongoDB 4.4:  https://www.mongodb.com/docs/v5.0/release-notes/4.4-upgrade-standalone/

  2. Upgrade to MongoDB 5.x: https://www.mongodb.com/docs/manual/release-notes/5.0-upgrade-standalone/

  3. (Optional) Upgrade to MongoDB 6.x: https://www.mongodb.com/docs/manual/release-notes/6.0-upgrade-standalone/

4.4.x

  1. Upgrade to MongoDB 5.x: https://www.mongodb.com/docs/manual/release-notes/5.0-upgrade-standalone/

  2. (Optional) Upgrade to MongoDB 6.x: https://www.mongodb.com/docs/manual/release-notes/6.0-upgrade-standalone/

5.x

  1. (Optional) Upgrade to MongoDB 6.x: https://www.mongodb.com/docs/manual/release-notes/6.0-upgrade-standalone/

6.x

No upgrade necessary.