Building a Docker Image for Codebeamer
 |
PTC has moved away from providing Docker images and provides a script to create your own Docker images. Read this topic for more information.
|
This topic contains information about the necessary files and instructions for building a Docker image for Codebeamer.
Prerequisites
Before you begin, ensure you meet the following prerequisites:
• Docker is installed on your system. For more information, see , Getting Started with Docker.
• Codebeamer Linux installer compatible with the builder is available at: (https://support.ptc.com/appserver/auth/it/esd/product.jsp?prodFamily=CBM).
Downloading the Docker Image Builder and Installing Codebeamer
1. Log in to the PTC Support portal and go to the PTC Software Download page.
2. Download the following files from this page:
◦ The docker-image-builder-<codebeamer_version>.zip file which contains the Docker script.
◦ The Linux installer. For example, download the MED-61402-CD-330_2-0-0-2_Linux.bin installer.
Place this installer in the directory that contains the extracted Docker Image Builder. This directory also contains the README.md file, the docker-compose.yml file, and the Dockerfile.
Using custom context path
Modify the following section in the docker-compose.yml file to customize the application context path:
build:
context: .
args:
CB_CONTEXT_PATH: ${CUSTOM}
context: .
args:
CB_CONTEXT_PATH: ${CUSTOM}
Building the Docker Image
Enter the following command to build and start the Docker container in the directory where the docker-compose.yaml file is located:
docker-compose up -d --build
This builds the Codebeamer Docker image, creates the container, and starts the Codebeamer application.
|
|
The docker-compose.yaml file is not a production compose file. It is not recommended to use this file in production environment. The file uses only one database and does not meet the requirements of production.
|
Creating a Docker image using Git
Modify the following section in the docker-compose.yaml to create an image using Git,. The true and false options are available when creating the image using Git. The default option is false.
build:
context: .
args:
GIT_IMAGE:true|false
context: .
args:
GIT_IMAGE:true|false
Accessing Codebeamer
Once the Codebeamer container is running, you can access Codebeamer by navigating to http://localhost:portnumber in a web browser, where portnumber in the URL is the number of the appropriate port.
The default port number is 8080, and hence the default address is http://localhost:8080.
Logging in to Codebeamer
You can log in to Codebeamer with the default credentials.
Configuration
You can customize the Docker Compose configuration in docker-compose.yaml file to match your specific requirements, such as ports, environment variables, and volumes.
Known Issues
During the build process, you may encounter the following error message:
=> ERROR [codebeamer] https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2
failed to solve: failed to load cache key: invalid response status 429
failed to solve: failed to load cache key: invalid response status 429
According to the BitBucket documentation, if you encounter this error, you may need to wait for about one minute and then restart the build process.