API Developer Portal DB Configuration when using Gateway 11 Debian Appliance as the Portal MySQL DB

Products

• CA API Developer Portal

Issue/Introduction

Some customer may choose to deploy a Gateway Appliance VM to use as the externalized MySQL DB for Portal 5.2.x

The out-of-the-box my.cnf configurating on the Gateway 11.x Appliance requires the following changes to be compatible with Portal 

Environment

Portal 5.2.x with Gateway 11.x Debian based Appliance as externalized Portal DB 

Cause

my.cnf configurations related to utf8mb4 Charset 

Resolution

1. Add the block of config from our techdoc,

 

[client]

 

default-character-set=utf8

 

[mysqld]

 

character-set-server=utf8mb4
innodb_log_buffer_size=32M
innodb_log_file_size=80M
max_allowed_packet=8M
sql_mode="STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"
group_concat_max_len=512000

 

2. Locate and comment out the following by adding a # infront of it,

 

# collation-server=utf8_general_ci

 

3. Restart mysql

Additional Information

Use utf8mb4 Charset for MySQL Server

 

https://techdocs.broadcom.com/us/en/ca-enterprise-software/layer7-api-management/api-gateway/11-0/install-configure-upgrade/using-mysql-8-0-with-gateway-10.html

 

 

Prior to Gateway version 11.0 CR1, both the MySQL server and database had to be configured to use the utf8mb3 character set. For Gateway version 11.0 CR1+, the MySQL database shall continue to use the utf8mb3 character set without needing to configure MySQL server to use the same character set. MySQL server can now use utf8mb4 as the default character set, provided that all Gateways connecting to the same MySQL server have  been upgraded to 11.0 CR1 or newer. 

 

To use the utf8mb4 character set as the default instead of the utf8mb3 character set for MySQL server, remove the following lines from the my.cnf file:

 

character-set-server=utf8 collation-server=utf8_general_ci

 

Note that this does not impact the character set used for the Gateway MySQL database, which shall continue to use the utf8mb3 character set.

 

The use of utf8mb4 in MySQL server allows both the Gateway and Portal to use the same MySQL server instance.