TIBCO BusinessConnect™ Container Edition

(1)

TIBCO BusinessConnect™

Container Edition

Installation and Deployment

Version 1.1.0 January 2021

(2)

2 | Contents

Contents 2

TIBCO Documentation and Support Services 3

Introduction 5

Installation Requirements 6

Docker Files 10

Deploying TIBCO BusinessConnect™ Container Edition Application 12 Building BusinessConnect Container Edition Component's Docker Images 12 Deploying BusinessConnect Container Edition Component's Docker Images 13

Post-installation Task 18

Viewing Container Logs 19

Uninstalling TIBCO BusinessConnect™ Container Edition 20

Legal and Third-Party Notices 21

(3)

3 | TIBCO Documentation and Support Services

TIBCO Documentation and Support Services

For information about this product, you can read the documentation, contact TIBCO Support, and join TIBCO Community.

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly in HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any other documentation included with the product. To access the latest

documentation, visit

https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO BusinessConnect™ Container Edition is available on the

TIBCO BusinessConnect™ Container Edition page.

The following documents for this product can be found in the TIBCO Documentation site:

l

TIBCO BusinessConnect™ Container Edition Release Notes

l

TIBCO BusinessConnect™ Container Edition Installation and Deployment

l

TIBCO BusinessConnect™ Container Edition Concepts

l

TIBCO BusinessConnect™ Container Edition Trading Partner Management

l

TIBCO BusinessConnect™ Container Edition Administration

l

TIBCO BusinessConnect™ Container Edition Security Guidelines

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

l

For an overview of TIBCO Support, visit

http://www.tibco.com/services/support.

l

For accessing the Support Knowledge Base and getting personalized content about products you are interested in, visit the TIBCO Support portal at

https://support.tibco.com.

(4)

4 | TIBCO Documentation and Support Services

contract with TIBCO. You also need a user name and password to log in to

https://support.tibco.com. If you do not have a user name, you can request one by

clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matter experts to share and access their collective experience. TIBCO

Community offers access to Q&A forums, product wikis, and best practices. It also offers

access to extensions, adapters, solution accelerators, and tools that extend and enable

customers to gain full value from TIBCO products. In addition, users can submit and

vote on feature requests from within the

TIBCO Ideas Portal. For a free registration, go

to

https://community.tibco.com.

(5)

5 | Introduction

Introduction

TIBCO BusinessConnect™ Container Edition is the containerized edition of TIBCO BusinessConnect, TIBCO's leading enterprise B2B gateway. BusinessConnect™

Container Edition enables an enterprise organization to host a trading community and

facilitate the secure exchange of industry-standard business documents with their

suppliers and customers, thereby automating cross-company processes.

(6)

6 | Installation Requirements

Installation Requirements

This section describes supported platforms and disk space, system memory, and software requirements for this product.

Before proceeding with the installation, see the product

readme

file. The readme files are found in the following locations:

Installation

bcce-1.1.0 > scripts > Readme

Deployment

bcce-deployment-1.1.0 > scripts > Readme

Disk Space Requirements

The minimum disk space requirement is 10 GB.

System Memory Requirements

The minimum system memory requirement is 8 GB.

Supported Platforms

The supported platforms are as follows:

l

CentOS 7.7 64-bit on x86-64

l

Ubuntu Server 18.04 64-bit on x86-64 Software Requirements

Before you install and deploy TIBCO BusinessConnect™ Container Edition, ensure that you have the following software installed or deployed.

Software Description

TIBCO^® AuditSafe TIBCO^® AuditSafe allows you to securely post and store audit events generated by your business processes, and to retrieve those events later.

Software Requirements

(7)

TIBCO^® AuditSafe is required to be deployed and running to post the audit logs from BusinessConnect Container Edition.

TIBCO Enterprise Message Service™

(EMS)

TIBCO Enterprise Message Service™ is used as the notification and messaging backbone for BusinessConnect Container Edition. It is also used for internal communication between the Interior server and Poller server, and Interior server and Gateway server

BusinessConnect Container Edition is not necessarily installed on the machine on which TIBCO Enterprise Message Service™ is installed.

BusinessConnect Container Edition license does not cover this usage of the included TIBCO Enterprise Message Service™ software. You must separately license TIBCO Enterprise Message Service™ or another supported JMS product for this usage.

Docker You must install Docker for building the Docker images.

Docker provides a way to run applications securely isolated in a container, packaged with all its dependencies and libraries. Your application can run in any environment as all the dependencies are already present in the image of the application.

For more information, see

Docker Documentation

.

Elasticsearch Elasticsearch is a distributed, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured. The Elasticsearch REST APIs support structured queries, full text queries, and complex queries that combine the two.

TIBCO recommends Elasticsearch 7.6 as the minimum version required.

ElasticSearch Documentation.

kubectl You must install Kubectl for the deployment on the Kubernetes cluster.

Kubernetes Documentation.

Kubernetes cluster You must install Kubernetes cluster for deploying and running the BusinessConnect Container Edition services.

(8)

If you are running the application in a Kubernetes cluster on a cloud platform, ensure that you have an active account on that cloud platform.

MySQL You need a database to run BusinessConnect Container Edition. Install MySQL database.

TIBCO recommends MySQL 5.7 as the minimum version required.

MySQL Documentation.

You need to read one database for

BusinessConnect Container Edition and one for AUS.

If the AUS database is already created while installing TASEE, only create one database for BusinessConnect Container Edition.

TIBCO

BusinessConnect™

Container Edition Services Plug-in (optional)

TIBCO BusinessConnect™ Container Edition Services Plug-in is an easy- to-use data transfer protocol, which allows you to securely exchange data over the Internet.

Trading partners managed by BusinessConnect Container Edition can quickly and efficiently be configured to exchange documents securely with the BusinessConnect Container Edition host over the Internet using this plug-in, without understanding or interpreting the document contents.

TIBCO

BusinessConnect™

Container Edition EDI Protocol powered by Instream®

(optional)

TIBCO BusinessConnect™ Container Edition EDI Protocol powered by Instream® is the TIBCO B2B solution for transferring Electronic Data Interchange (EDI) documents between trading partners. It can be used for all EDI integration scenarios, including connecting directly to trading partners and connecting to value added networks (VANs).

TIBCO TIBCO BusinessConnect™ Container Edition RosettaNet Protocol is the

(9)

BusinessConnect™

Container Edition RosettaNet

Protocol (optional)

TIBCO implementation of RosettaNet. It acts as a plug-in to

BusinessConnect Container Edition and uses business process models that conform to the RosettaNet Partner Interface Process standard, which enables you to conduct e-business transactions with your trading partners using RosettaNet.

TIBCO BusinessConnect Container Edition RosettaNet Protocol implements the RNIF 1.1 and RNIF 2.0 standards. It supports all PIPs listed as approved standards on the

Rosetta Net website.

Note: When you obtain third-party software or services, it is your

responsibility to ensure you understand the license terms associated with

such third-party software or services and comply with such terms.

(10)

10 | Docker Files

Docker Files

TIBCO BusinessConnect™ Container Edition provides Docker files for installing and deploying the components of BusinessConnect Container Edition.

Docker file is a script, which contains various commands to automatically perform actions on a base image.

BusinessConnect Container Edition Docker Files

TIBCO BusinessConnect™ Container Edition provides the following Docker files and scripts.

File Description

configuration.properties Contains all the properties that user has to set before building the BusinessConnect Container Edition's Docker images and deploying to the Kubernetes cluster.

build-images.sh Creates the BusinessConnect Container Edition Docker images and pushes the images to the Docker repository.

deployment.properties Contains all the properties that user has to set before deploying BusinessConnect Container Edition's Docker images to the Kubernetes cluster.

deploy-bcce.sh Deploys the BusinessConnect Container Edition services onto the Kubernetes cluster.

remove_bcce_

services.sh

Deletes all the BusinessConnect Container Edition services and deployments.

apply_secret_cert.sh Creates the Kubernetes secret bcce-gs-config for two key/cert files.

apply_secret_docker_

login.sh

Creates the Kubernetes secret Docker-registry for Docker login.

apply_secret_log4j2.sh Creates the Kubernetes secret log4j2 with the log4j2.xml.

(11)

11 | Docker Files

File Description

log4j2.xml Default xml file for creating the Kubernetes log4j2 secret.

(12)

12 | Deploying TIBCO BusinessConnect™ Container Edition Application

Deploying TIBCO BusinessConnect™ Container Edition Application

Before you can run BusinessConnect Container Edition components, you must build and deploy Docker images for those components. For the list of supporting software, see

Installation Requirements.

Building BusinessConnect Container Edition Component's Docker Images

Perform the following procedure to build BusinessConnect Container Edition component's Docker images.

1. Download TIBCO BusinessConnect™ Container Edition package

TIB_bcce_

<version>.tar.gz

from the TIBCO Software product download site (https://edelivery.tibco.com/).

To download the installation package, a user name and password are required. If you do not have a user name and password, contact TIBCO Technical Support.

2. Extract the content of the package to a folder.

3. Install the required protocols, such as, EZComm, RosettaNet, EDI (X12 and Gateway). Any number of protocols can be installed.

4. Navigate to

<folder>/bcce-1.1.0/config

folder.

5. Open the

configuration.properties

file and configure the following properties:

Property Description

docker_

repository=

<docker_

registry_ip>

:

<docker_

registry_port>

<docker_registry_ip>

is the IP address and

<docker_

registry_port>

is the port of the machine in which you want to push the Docker images.

Configuration Properties

(13)

docker_username Specify the user name of the Docker login.

download_

dir=

<download_dir>

is the directory path where you want to download the JAR files.

6. Save and close the

configuration.properties

file.

7. Navigate to

<folder>/bcce-1.1.0/scripts

folder.

8. Run the following command:

./build-images.sh

A message -

You must accept the License agreement before proceeding. Press ENTER key to read the License. Press q to finish reading.

is displayed.

9. Press ENTER key to read the license agreement. Press q to finish reading.

10. Enter y to accept the license agreement.

A message -

Do you want to push the BCCE docker images to <docker_registry_ip>:<docker_

registry_port>?

If not, the BCCE docker images will still be built at local.

(y/n)

is displayed.

11. Enter y.

The BusinessConnect Container Edition Docker images are built and pushed to Docker repository.

Deploying BusinessConnect Container Edition Component's Docker Images

Perform the following procedure to deploy BusinessConnect Container Edition Docker images.

1. Download the deployment package

TIB_bcce-deployment_<version>.tar.gz

from the public github repository.

2. Extract the content of the package to a folder.

(14)

4. Open the

deployment.properties

file and configure the following properties:

docker_repository=

<docker_

registry_ip>

:

<docker_

registry_port>

<docker_registry_ip>

is the IP address and

<docker_registry_port>

is the port of the machine in which you want to push the Docker images.

docker_username Specify the user name of the Docker login.

host_ip=

<host_ip> <host_ip>

is the IP address of the host machine.

database_

url=jdbc:mysql://<database_

machine_ip>:3306/<database_

name>

<database_machine_ip>

is the IP address of the machine where the database resides.

<database_name>

is the name of database.

Specify the CMS database details under the database properties in the deployment.properties file.

database_

username=<username>

<username> is the name of the user accessing the database.

database_

password=<password>

<password> is the password to access the database.

aus_database_

url=jdbc:mysql://<database_

machine_ip>:3306/<aus_

database_name>

<database_machine_ip>

is the IP address of the machine where the AUS database resides.

<aus_database_name>

is the name of AUS database.

aus_database_

username=<database_username>

<database_username> is the name of the user accessing the AUS database.

aus_database_

password=<database_password>

<database_password> is the password to access the AUS database.

Deployment Properties

(15)

gstoken_unzip=<gstoken_

unzip>

<gstoken_unzip> is the directory path where you should extract the contents of GSToken.zip.

5. Save and close the

file.

Note: Before you deploy Docker images, if you are using MySQL 5.7.x or above versions, then in the

my.ini

file under [mysqld] section, add skip_ssl and set max_allowed_packet to 500M.

6. Do one of the following:

l

For Kubernetes - Navigate to

<folder>/bcce-deployment-<version>/scripts

and run the following command:

./deploy-bcce.sh

l

For Docker - Navigate to

<folder>/bcce-deployment-<version>/samples/docker- scripts

and run the following command:

./docker-run-bcce-all.sh

A message -

You must accept the License agreement before proceeding. Press ENTER key to read the License. Press q to finish reading.

is displayed.

7. Press ENTER key to read the license agreement. Press q to finish reading.

8. Enter y to accept the license agreement.

Two messages are displayed:

Do you want to deploy TIBCO Auth Server service?

(y/n)

Do you want to deploy TIBCO BCCE Server services?

1. ConfigStore Management Server

(16)

2. Admin Server

9. Enter y to deploy Auth Server, ConfigStore Management Server, and Admin Server.

10. Before you deploy Poller Server and Interior Server, you must set the JMS server settings by performing the following procedure:

a. Log in to BusinessConnect Container Edition using the following URL:

http://<host_ip>:<as_port>

.

Note: Use the <host_ip> and <as_port> that you have set in the

file.

b. Navigate to System Settings tile > General, click Internal Messaging (JMS).

c. Click Private Process JMS and enter all the mandatory fields and click Save.

d. Click Intercomponent JMS and enter all the mandatory fields and click Save.

e. Optional: To use different JMS between Gateway Server and Interior Server, click Intercomponent DMZ-JMS (Optional) and enter all the mandatory fields and click Save.

For more information, see TIBCO BusinessConnect™ Container Edition Administration Guide, Configuring JMS Settings.

11. A message -

Do you want to deploy TIBCO BCCE Server services?

3. Poller Server 4. Interior Server (y/n)

is displayed.

12. Enter y to deploy Poller Server and Interior Server.

13. Before you deploy Gateway Server, you must perform the following procedure:

a. On System Settings tile > General, click Installation Properties.

b. Click Export GS configuration to download

GSToken.zip

, which contains

intercomProps

,

hostKey

and

peerCert

files that are required to deploy Gateway

Server.

(17)

c. Extract the contents of

GSToken.zip

to

<gstoken_unzip>

.

Note: Use the

<gstoken_unzip>

that you have set in the

file.

d. On System Settings tile > Transport Protocols, click Inbound Protocols.

e. Select HTTP check box and click Save.

f. Click Configure Service of HTTP, click add icon and enter all the mandatory fields then click Save.

Note: Default Gateway Service Name is set as http in the

file. To use another Gateway Service Name, set <service name> for gs_services=HTTP:<service name> in the

file.

g. Enable the http gateway service.

For more information, see TIBCO BusinessConnect™ Container Edition Administration Guide, Configuring Gateway Services (HTTP).

14. A message -

Do you want to deploy TIBCO BCCE Gateway Server services?

Please make sure that you have downloaded the GSToken.zip from Admin UI, extracted it in a folder and set the property gstoken_unzip in the deployment.properties file.

Otherwise, the Gateway Server won't work.

(y/n)

is displayed.

15. Enter y to deploy Gateway Server.

(18)

18 | Post-installation Task

Post-installation Task

Configure the Outbound Email poller to receive an email in the event of a forgotten password.

You can import a .csx file if required. For more information, refer to the migration

document.

(19)

19 | Viewing Container Logs

Viewing Container Logs

All component containers of TIBCO BusinessConnect™ Container Edition publish their logs on the standard output device.

Procedure

1. To view logs of a particular container, run the following command:

l

For Kubernetes:

kubectl logs <container_id> -n <name_space>

Tip: Use "--follow" to follow the logs.

Note: Use the <name_space> that you have set in the

file.

l

For Docker:

docker logs <container_id>

(20)

20 | Uninstalling TIBCO BusinessConnect™ Container Edition

Uninstalling TIBCO BusinessConnect™ Container Edition

Perform the following procedure to uninstall TIBCO BusinessConnect™ Container Edition.

Procedure

1. To remove all the BusinessConnect Container Edition services/deployments, do one of the following:

l

For Kubernetes - Navigate to

<folder>/bcce-deployment-<version>/scripts

and run the following command:

./remove_bcce_services.sh

l

For Docker - Navigate to

<folder>/bcce-deployment-<version>/samples/docker- scripts

and run the following command:

./stop_bcce_containers.sh

2. Delete all the Docker images.

3. Log in to MySQL to delete the database which you have set up for

BusinessConnect Container Edition.

(21)

21 | Legal and Third-Party Notices

Legal and Third-Party Notices

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR

CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE

“LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, TIB, and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle Corporation and/or its affiliates.

This document includes fonts that are licensed under the SIL Open Font License, Version 1.1, which is available at: https://scripts.sil.org/OFL

Copyright (c) Paul D. Hunt, with Reserved Font Name Source Sans Pro and Source Code Pro.

All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. See the readme file for the availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER

(22)

22 | Legal and Third-Party Notices

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer to TIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.