Create a Kubernetes Deployment

Create a Kubernetes Deployment (a .yaml configuration file), which describes how to deploy the Docker image of the TIBCO BPM Enterprise application to the Kubernetes cluster. A sample deployment file is included in the TIBCO BPM Enterprise installation.

The following table describes the parameters in the deployment file.

Parameter Description
name: The name to be used to identify the TIBCO BPM Enterprise container.
image: The name of the Docker image of the TIBCO BPM Enterprise application.

(Default: tibco/bpm/runtime:5.6.1)
livenessProbe: Kubernetes livenessProbe is used to ensure that the container is healthy and responsive. This must be defined using an httpGetAction, with:
  • path defined as /bpm/adapter/v1/liveness.
  • port defined with the same value as containerPort.
readinessProbe: Kubernetes readinessProbe is used to determine the container's readiness to accept work. This must be defined using an httpGetAction, with:
  • path defined as /bpm/adapter/v1/readiness.
  • port defined with the same value as containerPort.
ports: Port numbers to be exposed:
  • containerPort: Number of the port to expose on the pod's IP address.

    (Default: 8181)

  • hostPort: Number of the port to expose on the host.

    (Default: 8181)
env: This section must contain the following environment variables, which are used to inject configuration data required by TIBCO BPM Enterprise into the pod:
  • JDBC_DRIVERCLASS - The JDBC_DRIVERCLASS is optional, and defaults to PostgreSQL. The default JDBC_DRIVERCLASS is org.postgresql.Driver. However, it can be set to Oracle or Microsoft SQL Server driver name based on the target database to connect. If the database is Oracle, set the JDBC_DRIVERCLASS to oracle.jdbc.OracleDriver. If the database is Microsoft SQL Server, set the JDBC_DRIVERCLASS to com.microsoft.sqlserver.jdbc.SQLServerDriver. If the database is IBM DB2, set the JDBC_DRIVERCLASS to com.ibm.db2.jcc.DB2Driver
  • JDBC_URL - The JDBC connection string to connect to the TIBCO BPM Enterprise database.
  • LDAP_NAME_ALIAS - Identifies the LDAP directory.
  • LDAP_NAME_URL - Used to connect to the LDAP directory.
  • JDBC_SSL_CONFIG - This is the SSL configuration for the JDBC connection.
  • LDAP_<GROUP_NAME>_SSLCERT - This is used to configure LDAP SSL.

Use of the following environment variable is optional, but recommended:

  • ADMIN_CRYPTO_KEY - Defines the key used to encrypt and decrypt sensitive data held in the BPM database definition of shared resources (HTTP Clients, Keystore Providers, SSL Client Providers, SMTP Connections, SAML Connections, and OpenID Connections).
    Note: If ADMIN_CRYPTO_KEY is not specified, this data is stored in the BPM database in unencrypted format.

For more information, see Configure Environment Variables.

Configure Environment Variables

You can set the variable INSTALLATION_TYPE to Production. This enables you to only deploy artifacts that have been locked for production in TIBCO Business Studio - BPM Edition.

If you do not configure this variable, it is by default set to Development. In this case, you can deploy any type of project.

If set to Production, the variable INSTALLATION_TYPE is configured as follows:

For Docker:

environment:
- INSTALLATION_TYPE= Production

For Kubernetes: 

- name: INSTALLATION_TYPE
      value: Production

For more general information about Docker deployment, see Deployment.