/
DOORS Classic Rest API / DOORS Classic Connector

DOORS Classic Rest API / DOORS Classic Connector

Kubernetes

Configuration

The DOORS Classic Rest API is installed using the DOORS Classic Connector Helm Chart.

To configure the deployment create a new text file doors-classic-connector.yaml, which
will be used as Helm values.yaml file during the installation.

Setting up a connection to IBM DOORS Classic data

The DOORS Classic REST API accesses the data of DOORS Classic via file access to the data folder of DOORS Classic. Since DOORS Classic is installed on a Windows machine and the Rest API is run in a Kubernetes or OpenShift cluster, the acces must be granted.

A DOORS data folder can be connected in two ways:

  • via a Windows share (SMB)

  • via an NFS share

To connect data via a Windows share

To connect data via a Windows share add the following to your values.yaml:

doors-rest-api: dbShare: enabled: true type: smb smb: server: <SERVERNAME> share: <SHARENAME>

Furthermore a Secret “cifs” with share credentials has to be created in the DOORS connector namespace:

apiVersion: v1 data: mount_password: <SHAREUSERPASSWORD> mount_user: <SHAREUSER> kind: Secret metadata: name: cifs type: Opaque

To connect data via an NFS share

To connect data via a Windows share add the following to your values.yaml:

doors-rest-api: dbShare: enabled: true type: nfs nfs: server: <SERVERNAME> path: <PATHNAME> size: 1Gi # size doesn't matter here as the created persistent volume is only a "connector" to an NFS share mountOptions: [] # for using NFS mount options like rsize, timeo etc. (Link: https://linux.die.net/man/5/nfs)

Installation

You will need a username and password to download the helm chart and containers from MID's repository. You will receive username and password from your MID contact or from cops@mid.de.

helm repo add doors-classic-connector https://repo.secure.mid.de/chartrepo/doors-classic-connector --username <REPO_USERNAME> --password <REPO_PASSWORD> helm repo update helm upgrade --install doors-classic-connector doors-classic-connector/doors-classic-connector -f doors-classic-connector.yaml -n doors-classic-connector --create-namespace

Using the Doors Classic Rest API with the genoslc-connector for Doors Classic

Optionally, you can use the OSLC Connector for DOORS Classic with the REST API. To enable the OSLC Connector, activate it in the doors-classic-connector.yaml file:

genoslc-doors: enabled: true

Configure the OSLC Connector as shown in the section Deploying the OSLC Connector for IBM DOORS Classic.

Since the chart of the OSLC Connector is a subchart, all configuration must be done in side the “genoslc” section in your doors-classic-connector.yaml file.

genoslc-doors: enabled: true env: ...

Docker

Installation

docker pull registry.mid.de/smartfacts/oslc/doors-rest-api:<VERSION> docker run -d --name doors-rest-api -p 9000:9000 -v <LOKALER_DB_ORDNER>:/opt/doors-api/data-path/data registry.mid.de/smartfacts/oslc/doors-rest-api:<VERSION>