How to install docker

Please visit the official page (Mac, Windows, Ubuntu, CentOS) for instruction.

How to install docker-compose

Please visit the official page for instruction.

Requirements of docker

System requirements for Windows

• Windows 10 64-bit: Pro, Enterprise, or Education (Build 15063 or later).
• Hyper-V and Containers Windows features must be enabled.
• The following hardware prerequisites are required to successfully run Client Hyper-V on Windows 10:
  • 64 bit processor with Second Level Address Translation (SLAT)
  • 4GB system RAM
  • BIOS-level hardware virtualization support must be enabled in the BIOS settings. For more information, see Virtualization.

System requirements for Mac

Your Mac must meet the following requirements to successfully install Docker Desktop:

• Mac hardware must be a 2010 or newer model, with Intel’s hardware support for memory management unit (MMU) virtualization, including Extended Page Tables (EPT) and Unrestricted Mode. You can check to see if your machine has this support by running the following command in a terminal:
  

  sysctl kern.hv_support

• macOS must be version 10.13 or newer. We recommend upgrading to the latest version of macOS.
  If you experience any issues after upgrading your macOS to version 10.15, you must install the latest version of Docker Desktop to be compatible with this version of macOS.
  Note: Docker supports Docker Desktop on the most recent versions of macOS. That is, the current release of macOS and the previous two releases. As new major versions of macOS are made generally available, Docker will stop supporting the oldest version and support the newest version of macOS (in addition to the previous two releases).
• At least 4 GB of RAM.
• VirtualBox prior to version 4.3.30 must not be installed as it is not compatible with Docker Desktop.

Note: If your system does not satisfy these requirements, you can install Docker Toolbox, which uses Oracle VirtualBox instead of HyperKit.

System requirements for Linux

• At least 4 GB of RAM.

Requirements of codebeamer-x for evaluation

• At least 2 CPU (min. 2Ghz)
• At least 8 GB of RAM.
• 3G free disk space

How to start a codebeamer-x application with docker-compose

1. Create a new docker-compose.yml file with the content below
2. Add your host-id in retina-app/environment section! (e.g. - CB_MAC_ADDRESS=06:51:89:23:B6:20)
   Important! Ensure to separate the two hexadecimal digits with colons (:) instead of hyphens (-)
3. Open a shell (command prompt on windows) in directory where the file is located
4. Run the following command below to start docker container:
   $ docker-compose up -d
5. codeBeamer will be available on http://localhost:8080/x
   1. Default user is bond / 007
6. Open a shell and run the command below to stop container:
   $ docker-compose down

docker-compose.yml

Create a docker-compose.yml file with the following content

# Copyright by Intland Software, https://www.intland.com
#
# All rights reserved.
#
# Please note that if you change this docker file, we do not take any responsibility and we are not liable for
# any damage caused through use of this image, be it indirect, special, incidental
# or consequential damages (including but not limited to damages for loss of business, loss of profits, interruption or the like).


version: '2.1'


services:
  retina-db:
    image: intland/mysql:5.7.24
    environment:
      - MYSQL_USER=user
      - MYSQL_PASSWORD=pass
      - MYSQL_DATABASE=retina
      - MYSQL_MAX_ALLOWED_PACKET=1024M
      - MYSQL_INNODB_BUFFER_POOL_SIZE=1G
      - MYSQL_INNODB_LOG_FILE_SIZE=256M
      - MYSQL_INNODB_LOG_BUFFER_SIZE=256M
    volumes:
      - retina-db-data:/var/lib/mysql/data


  retina-app:
    image: intland/codebeamer-x:4.1
    ports:
      - 8080:8080
    environment:
      - WAIT_HOSTS=container-mysql:3306
      - WAIT_HOSTS_TIMEOUT=120
      - CB_REDIRECT_TO=/x
      - CB_CONTEXT_PATH=cb
      - CB_database_JDBC_Username=user
      - CB_database_JDBC_Password=pass
      - CB_database_JDBC_Driver=com.mysql.jdbc.Driver
      - CB_database_JDBC_ConnectionURL=jdbc:mysql://container-mysql:3306/retina?autoReconnect=true&zeroDateTimeBehavior=convertToNull&emulateLocators=true&characterEncoding=UTF-8&useSSL=false
      - CB_MAC_ADDRESS=<<your mac-address>>
    volumes:
      - retina-app-repository-docs:/home/appuser/codebeamer/repository/docs
      - retina-app-repository-search:/home/appuser/codebeamer/repository/search
      - retina-app-logs:/home/appuser/codebeamer/logs
    links:
      - retina-db:container-mysql


volumes:
  retina-db-data:
  retina-app-repository-docs:
  retina-app-repository-search:
  retina-app-logs:

How to upgrade a codebeamer-x application with docker-compose

Stop current version of codebeamer-x instance

If you started without -d press ctrl +c

If you started with -d run the following command in the directory where your docker-compose.yml is

docker-compose down

Start the newer version of codebeamer-x instance

Change the version in docker-compose.yml from the previous section, in this example the upgrade happens to 3.3 from version 3.2
In this line

image: intland/retina:3.2 --> image: intland/codebeamer-x:3.3

and here change the redirect from /retina to /x:

- CB_REDIRECT_TO=/x

Then run the following command in the directory where your docker-compose.yml is.

docker-compose up

You will see the logs.

Alternatively you can start in in the background with

docker-compose up -d

The update is successful when the following criteria are met:

• No exceptions in the log
• Previously created project, repository found and works in the new container (3.2 in the example)
• Uploaded document available in the new container (3.2 in the example)