Vera 2024.1 Upgrade Tasks

Owned by HB Farris
Last updated: Jun 28, 2024 by Mark Purdy
5 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 2024.1. If the two step process is not followed, then the connections will not be properly imported from the Synchronization Policy.

Web Portal Client Secrets

To improve security, the Web Portal has been updated to store a sensitive Client Secret in a separate file. The instructions for loading the file are below.

New Timeout Configuration Settings

The Vera Web Portal will not warn users of an inactivity timeout. The default timeout setting is 10 minutes with a warning at 8 minutes of inactivity. If you would like to change these defaults, see Configure Inactivity Timeout Settings.

New Identity Provider Settings and Login Options

Identity Provider Names

The Vera Web Portal now supports naming Identity Providers configured in the identity-providers.yaml file. This Name is only a user friendly descriptor and does not have an affect on the system, but will be displayed in the Web Portal to end users. You can configured the IdP Names, follow the instructions here: Setup a SAML 2.0 SSO Identity Provider

Identity Provider Initiated Login

The Vera Web Portal now supports logging in directly from a configured Identity Provider. More information on logging in can be found here: Logging into the Vera Web Portal

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 2024.1. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  4. Update the vera.api.audithistory service in the docker-compose file with the JWT information. Following environment variables needs to be copied from the vera.server service.

    1. VERA_SERVER_JWT_CERT_NAME

    2. VERA_SERVER_JWT_CERT_PASSWORD

Values of these variables need to be exactly same as in the vera.server service.

  1. Set the client secret for the vera.web.portal container. See here for more information on setting the client secret: Vera Deployment with Docker | Configure Docker Orchestration (Docker Compose)

  2. 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-worker-qtest

      1. Collection: webhook.subscriptions

    2. New Database: vera-api-gateway

      1. Collection: endpoints

    3. New Database: vera-audit-history

      1. Collection: audit-entries

    4. New Database: tx3-vera-connections:

      1. Collection: connections

    5. New Database: tx3-vera-webhooks

      1. Collection: webhook-callbacks

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

      1. Collection: job-attempts

      2. Collection: job-types

      3. Collection: jobs

    7. New Database: tx3-vera-jira

      1. Collection: webhook-calls

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

      1. Collection: job-attempts

      2. Collection: job-types

      3. Collection: jobs

  3. Pull the images.

  4. 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 2024.1. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  3. Update the vera.api.audithistory service in the docker-compose file with the JWT information. Following environment variables needs to be copied from the vera.server service.

    1. VERA_SERVER_JWT_CERT_NAME

    2. VERA_SERVER_JWT_CERT_PASSWORD

Values of these variables need to be exactly same as in the vera.server service.

  1. Set the client secret for the vera.web.portal container. See here for more information on setting the client secret: Vera Deployment with Docker | Configure Docker Orchestration (Docker Compose)

  2. 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-worker-qtest

      1. Collection: webhook.subscriptions

    2. New Database: vera-api-gateway

      1. Collection: endpoints

    3. New Database: vera-audit-history

      1. Collection: audit-entries

    4. New Database: tx3-vera-jira

      1. Collection: webhook-calls

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

      1. Collection: job-attempts

      2. Collection: job-types

      3. Collection: jobs

  3. Pull the images.

  4. 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 2024.1. See here for more information on setting the image tags: Upgrade the Vera Server Applications

  3. Update the vera.api.audithistory service in the docker-compose file with the JWT information. Following environment variables needs to be copied from the vera.server service.

    1. VERA_SERVER_JWT_CERT_NAME

    2. VERA_SERVER_JWT_CERT_PASSWORD

Values of these variables need to be exactly same as in the vera.server service.

  1. Set the client secret for the vera.web.portal container. See here for more information on setting the client secret: Vera Deployment with Docker | Configure Docker Orchestration (Docker Compose)

  2. 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-worker-qtest

      1. Collection: webhook.subscriptions

    2. New Database: vera-api-gateway

      1. Collection: endpoints

    3. New Database: vera-audit-history

      1. Collection: audit-entries

  3. Pull the images.

  4. Restart the containers.

Upgrading from 2023.4

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

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

  2. Update the vera.api.audithistory service in the docker-compose file with the JWT information. Following environment variables needs to be copied from the vera.server service.

    1. VERA_SERVER_JWT_CERT_NAME

    2. VERA_SERVER_JWT_CERT_PASSWORD

Values of these variables need to be exactly same as in the vera.server service.

  1. Set the client secret for the vera.web.portal container. See here for more information on setting the client secret: Vera Deployment with Docker | Configure Docker Orchestration (Docker Compose)

  2. 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-worker-qtest

      1. Collection: webhook.subscriptions

  3. Pull the images.

  4. 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.