Codebeamer installation

This document describes how to install the codebeamer extension to communicate with the Raiqon.ai platform.

The platform installation guide can be found here.

The installation process is somewhat different on different operating systems, you can find the details below.

Linux

New installation instructions

1. Download and extract raiqon installer zip file on the codeBeamer host server

2. Navigate to raiqon-installer folder

3. Set CB_INSTALL_DIR environment variable to point to CodeBeamer installation and execute raiqon_install.sh

   export CB_INSTALL_DIR=<installation folder>
   ./raiqon_install.sh

4. The executable displays all the new and modified files and creates backup

⚠️ Please do NOT delete raiqon-installer folder in order to keep backup files

Rollback instructions

1. Navigate to raiqon-installer folder

2. Set CB_INSTALL_DIR environment variable to point to CodeBeamer installation and execute raiqon_rollback.sh

   export CB_INSTALL_DIR=<installation folder>
   ./raiqon_rollback.sh

Update instructions

1. Follow rollback instructions

2. Follow new installation instructions

Windows

New installation instructions

1. Download and extract raiqon installer zip file on the codeBeamer host server

2. Navigate to raiqon-installer folder

3. Set CB_INSTALL_DIR environment variable to point to CodeBeamer installation and execute raiqon_install.bat

   set CB_INSTALL_DIR=<installation folder>
   ./raiqon_install.bat

4. The executable displays all the new and modified files and creates backup

⚠️ Please do NOT delete raiqon-installer folder in order to keep backup files

Rollback instructions

1. Navigate to raiqon-installer folder

2. Set CB_INSTALL_DIR environment variable to point to CodeBeamer installation and execute raiqon_rollback.sh

   set CB_INSTALL_DIR=<installation folder>
   ./raiqon_rollback.bat

Update instructions

1. Follow rollback instructions

2. Follow new installation instructions

Docker

New installation instructions

1. Download raiqon installer zip file

2. Use code the following example Dockerfile:  

   # Codebeamer
   FROM intland/codebeamer:2.1.0.3 as codebeamer
   
   COPY --chown=1001:1001 build/raiqon-installer.zip /tmp/
   RUN unzip /tmp/raiqon-installer.zip -d /tmp/
   RUN chmod +x /tmp/raiqon_install_docker.sh
   RUN cd /tmp && ./raiqon_install_docker.sh

Rollback instructions

1. Remove the installation steps from your docker build

Update instructions

1. Use the new version of the raiqon installer zip file

Post-installation steps

⚠️ Requires a working Raiqon.ai platform

Setup environment variables for codeBeamer

The following environment variables are needed to be set to properly establish the connection between codeBeamer and the Raiqon services:

• CB_raiqon_url: The accessible URL to the Raiqon connector service.

• CB_raiqon_api_key: The API key to authenticate to the connector service.

• CB_raiqon_api_token_secret: A shared secret between Raiqon and codeBeamer to acquire the API tokens.

• CB_raiqon_sync_frequency_seconds: The frequency for new item notifications sent to Raiqon.

• CB_CORS_ALLOWED_ORIGINS: The URL of the Raiqon widget service. Needed to render images or additional attachments of work items.

Add the external widget to application configuration

To see the analysis results we need to add the Raqion service as an external widget to codeBeamer:

• Login as a System Admin

• Go to Application Configuration

• Add the following entry with the correct url:

"externalWidgetExtensions" : {
    "uri" : "https://{cb-connector url}/codebeamer/extension.json"
}

• Now a new sidebar should appear in a tracker document view.
  

See the official codeBeamer documentation for further details