Upgrade to 2024.3

If you are upgrading from 2024.1, follow these steps to ensure your upgrade is successful:

1. Add the following containers to the docker-compose.yml file. For more information on setting the image tags, see Upgrade the Vera Server Applications.

   • vera.api.documents

   • vera.worker.documents

   • vera.worker.carbone

   • vera.query.engine

   • vera.api.qtest

   • vera.api.traceability

   • vera.worker.traceability

2. Remove the following container from the docker-compose.yml file.

   • vera.api.qtest.routeactions

3. Add the following environment variable to the vera.worker.qtest container in the docker-compose.yml file. Be sure to replace the your.vera.url with your actual Vera FQDN and port, if needed.

   • Vera.Worker.QTest.WebhookUrl=http://your.vera.url/api/qtest/webhook

4. Add the following logging settings definitions to the logging-settings.json file.

   • API Documents

   • Worker Documents

   • API qTest

   • API Traceability

   • Worker Traceability

5. Ensure the database user has the correct permissions to create the following databases and collections (or manually create them as needed):

   New database	Collection
   vera-documents	document-definitions document-template-revisions document-templates document-types
   vera-documents-templates-messagedata	fs.chunks fs.files
   vera-documents-template-files	fs.chunks fs.files
   vera-qtest	fs.chunks fs.files qtest-active-linkage-detections qtest-record-imports qtest-record-link-syncs qtest-record-syncs qtest-release-syncs webhook-subscriptions
   vera-traceability	project-releases vera-record-links vera-releases

6. Add the Jira-qTest Requirement record type to your Records Management Policies that will use the traceability feature from qTest.

If you are upgrading from 2023.4, follow these steps to ensure your upgrade is successful:

1. Set the image tags to the highest patch available for 2024.1. For more information on setting the image tags, see Upgrade the Vera Server Applications.

2. Update the vera.api.audithistory service in the docker-compose.yml file with the JWT information.

   The following environment variables needs to be copied from the vera.server service:

   • VERA_SERVER_JWT_CERT_NAME

   • VERA_SERVER_JWT_CERT_PASSWORD

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

3. Set the client secret for the vera.web.portal container. For more information on setting the client secret, see Configure Docker Orchestration (Docker Compose).

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:

   New database	Collection
   vera-worker-qtest	webhook.subscriptions

5. Pull the images.

6. Restart the containers.

If you are upgrading from 2023.3, 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.

   • vera.api.audithistory

   • vera.worker.audithistory

2. Set the image tags to the highest patch available for 2024.1. For more information on setting the image tags, see Upgrade the Vera Server Applications.

3. Update the vera.api.audithistory service in the docker-compose.yml file with the JWT information.

   The following environment variables needs to be copied from the vera.server service:

   • VERA_SERVER_JWT_CERT_NAME

   • VERA_SERVER_JWT_CERT_PASSWORD

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

4. Set the client secret for the vera.web.portal container. For more information on setting the client secret, see Configure Docker Orchestration (Docker Compose).

5. 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:

   New database	Collection
   vera-worker-qtest	webhook.subscriptions
   vera-api-gateway	endpoints
   vera-audithistory	audit-entries

6. Pull the images.

7. Restart the containers.

If you are upgrading from 2023.2, 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.

   • vera.api.audithistory

   • vera.api.jira.routeactions

   • vera.worker.audithistory

   • vera.worker.jobservice

   • vera.worker.jira

2. Set the image tags to the highest patch available for 2024.1. For more information on setting the image tags, see Upgrade the Vera Server Applications.

3. Update the vera.api.audithistory service in the docker-compose.yml file with the JWT information.

   The following environment variables needs to be copied from the vera.server service:

   • VERA_SERVER_JWT_CERT_NAME

   • VERA_SERVER_JWT_CERT_PASSWORD

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

4. Set the client secret for the vera.web.portal container. For more information on setting the client secret, see Configure Docker Orchestration (Docker Compose).

5. 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:

   New database	Collection
   vera-worker-qtest	webhook.subscriptions
   vera-api-gateway	endpoints
   vera-audithistory	audit-entries
   tx3-vera-jira	webhook-calls

6. Pull the images.

7. Restart the containers.

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

1. Upgrade MongoDB, if needed.

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

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

   • rabbitmq

   • vera.api.audithistory

   • vera.api.connections.testconnection

   • vera.api.jira.routeactions

   • vera.api.qtest.routeactions

   • vera.api.routes.routeevents

   • vera.worker.audithistory

   • vera.worker.jobservice

   • vera.worker.jira

   • 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.yml file with the JWT information.

   The following environment variables needs to be copied from the vera.server service:

   • VERA_SERVER_JWT_CERT_NAME

   • VERA_SERVER_JWT_CERT_PASSWORD

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

5. Set the client secret for the vera.web.portal container. For more information on setting the client secret, see Configure Docker Orchestration (Docker Compose).

6. 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:

   New database	Collection
   vera-worker-qtest	webhook.subscriptions
   vera-api-gateway	endpoints
   vera-audithistory	audit-entries
   tx3-vera-connections	connections
   tx3-vera-webhooks	webhook-callbacks
   vera-qtest-routeactions-sagas	job-attempts job-types jobs
   tx3-vera-jira	webhook-calls
   vera-worker-jobservice-sagas	job-attempts job-types jobs

7. Pull the images.

8. Restart the containers.

If you are upgrading from any version prior to 2023.1, please follow these steps for a successful upgrade:

1. Upgrade MongoDB according to the “MongoDB compatibility update” table.

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

3. Perform the upgrade to 2023.1:

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

   • Pull the images.

   • Restart the docker containers.

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