bpd-docker-compose for BPD and CAM Design Template

Using Docker Compose file to launch Blueprint Designer

Requirement:

• Docker Compose 1.2
• Docker Engine 17.x
• Docker account (Your docker account will be used to subscribe to CAM's docker store)

Pull BPD/CAM Template Designer from Docker Store

1. Create a Docker account - https://store.docker.com
2. Login to Docker Store
3. Search for IBM Cloud Automation Manager
4. Subscribe to the product
5. On your system, you can use one of the following commands to pull down the image:

docker pull store/ibmcorp/icam-bpd-ui:2.1.0.2-x86_64

or

docker-compose -f cam-bpd-docker-compose.yaml pull

Start Up Blueprint Designer/CAM Design Template Services

1. Use a text editor to modify the provided docker-compose.yaml

2. Run docker-compose up -d or docker-compose -f cam-bpd-docker-compose.yaml up -d or docker-compose -f cam-bpd-docker-compose-docker-store.yaml up -d
3. Run docker ps -a to ensure that all services are healthy.

Note: You need to have access to ucdp-docker.artifactory.swg-devops.com docker registry. Please contact bpd development team .

Test CAM-Blueprint Designer/Blueprint Designer (BPD) Container

1. Get a web browser and visit http://:8080 or with the port that you specified in your docker-compose.yaml file.
2. Login to BPD with BPD's default authentication: ucdpadmin/ucdpadmin

Setup Persist Volume for MariaDB and BPD

designerdb
    ...
    volumes:
    - "/my/own/datadir:/var/lib/mysql"
designer
    ...
    volumes:
    - "/<PATH>/workspace:/opt/ibm-ucd-patterns/workspace"
    - "/<PATH>/repositories:/opt/ibm-ucd-patterns/repositories"

Use external Database

By default, bpd/cam-bpd is packaged with MariaDB JDBC driver. In order to use bpd with others DB, you need to add your DB's JDBC driver to BPD's container /opt/ibm-ucd-patterns/ext_lib directory .

Here are the steps:

1. Open your docker-compose.yaml with a text editor
2. Add your JDBC folder which containers JDBC jars to the docker-compose's volumes section

designer
    ...
    volumes:
    - <JDBC_PATH>:/opt/ibm-ucd-patterns/ext_lib
    ...

3. Update the following environment variables

   DB_NAME: ""

   DB_USER: ""

   DB_PASSWORD: ""

   DB_TCP_PORT: ""

   DB_TCP_URL: ""

   DB_TYPE: db2|oracle|sqlserver|mysql|mariadb

Upgrade the BPD Container

You can upgrade/change your BPD container version by using the docker-compose's up command.

Assuming that your BPD container is running.

1. Use your text editor to update the docker-compose.yaml with the newest image version/tag. image: ucdp-docker.artifactory.swg-devops.com/designer:devel

2. Run docker-compose up -d designer

Note: BPD doest not support rollback; in some cases rollback may work with different verions of BPD images. However, this practice is not supported. If you need to use a older version for BPD for some reasons, please back up your DB before doing so.

Add Changes to the BPD container without Creating a New Container.

In some cases, you may need to access to BPD running containers to add files or do some configuration. You can use the following steps to access to BPD running container.

1. docker-compose exec -f cam-bpd-docker-compose.yaml designer bash
2. Add your changes to the container
3. docker-compose restart -f cam-bpd-docker-compose.yaml designer

Remove/Delete BPD Containers service

To delete BPD services and its network, you can run the following command:

docker-compose -f <docker-compose file> down

Example:

docker-compose -f cam-bpd-docker-compose.yaml down