Upgrading from 6.1.0 to 6.2.0 (introduced in v6.2.0)

Steps to upgrade

note

Before you begin, ensure the Boomi Cloud API Management - Local Edition 6.1.0 cluster is up and running.

Procedure

1. Build new images.

   Refer to Building Images for more information.

2. Upgrade the database schema for the member_role_audit_log table from apim/apim-le-toolkit.

   important

   This table needs an update for successful migration from Boomi Cloud API Management - Local Edition 4.x, 5.x, and future upgrades.

   [ec2-user@ip-10-0-0-174 ~]$ docker ps
   CONTAINER ID   IMAGE                         COMMAND       CREATED      STATUS      PORTS     NAMES
   dca78a3d66e3   apim/apim-le-toolkit:v6.1.0   "/bin/bash"   6 days ago   Up 6 days             eloquent_davinci
   [ec2-user@ip-10-0-0-174 ~]$ docker exec -it dca78a3d66e3 bash
   I have no name!@dca78a3d66e3:/$ cd /opt/apim/db
   I have no name!@dca78a3d66e3:/opt/apim/db$ ls -lart
   total 156
   -rw-rw-r--. 1 root  root    133 Oct 24 19:08 upgrade-schema-6.0.0_6.1.0.sql
   -rw-rw-r--. 1 root  root    133 Oct 24 19:08 rollback-schema-6.1.0_6.0.0.sql
   -rw-rw-r--. 1 root  root   1646 Oct 24 19:08 apim-le-db-token-purger-schema_6.0.0.sql
   -rw-rw-r--. 1 root  root 136174 Oct 24 19:08 apim-le-db-schema_6.1.0.sql
   -rw-rw-r--. 1 root  root   1227 Oct 24 19:08 apim-le-db-counter-purger-schema_6.1.0.sql
   -rw-rw-r--. 1 root  root   1239 Oct 24 19:08 apim-le-db-audit-purger-schema_6.1.0.sql
   drwxr-xr-x. 1 root  root     16 Nov 12 04:28 ..
   drwxr-xr-x. 1 65532 root     45 Nov 12 04:28 .
   I have no name!@dca78a3d66e3:/opt/apim/db$ MYSQL_PWD=<Password> mysql -h <Host-ip>  -umasheryonprem --database=name masherysolar < upgrade-schema-6.0.0_6.1.0.sql
   
   -------------------------
   Check in the mysql instance
   
   MySQL [masherysolar]> desc member_role_audit_log;
   +---------------+--------------+------+-----+---------+----------------+
   | Field         | Type         | Null | Key | Default | Extra          |
   +---------------+--------------+------+-----+---------+----------------+
   | handle        | varchar(255) | NO   |     | NULL    |                |
   | role_id       | int unsigned | NO   |     | NULL    |                |
   | area_id       | int unsigned | NO   | MUL | NULL    |                |
   | changed_by    | varchar(255) | NO   |     | NULL    |                |
   | changed_on    | datetime     | YES  |     | NULL    |                |
   | change_type   | char(1)      | YES  |     | NULL    |                |
   | delta         | longtext     | YES  |     | NULL    |                |
   | auto_id       | int          | NO   | PRI | NULL    | auto_increment |
   | is_anonymized | tinyint(1)   | YES  |     | 0       |                |
   | id            | int          | YES  |     | NULL    |                |
   +---------------+--------------+------+-----+---------+----------------+
   10 rows in set (0.032 sec)
   
   MySQL [masherysolar]> select  * from member_role_audit_log;
   +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
   | handle         | role_id | area_id | changed_by | changed_on          | change_type | delta                                                    | auto_id | is_anonymized | id   |
   +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
   | AutoBOTUser333 | 4000003 |    2222 | admin      | 2024-10-23 16:47:21 | U           | {"role_id":{"+":"567dbc68-d9d1-48b9-b039-52d6f10477f2"}} |       1 |             0 | NULL |
   +----------------+---------+---------+------------+---------------------+-------------+----------------------------------------------------------+---------+---------------+------+
   1 row in set (0.026 sec)

3. Log in to MySQL using MySQL CLI. Run the following queries at the MySQL prompt:

   1. Update the content_objects table to replace admin user name with the <new username> provided during the Helm installation.

      note

      Updating the content_objects table is required to ensure a successful migration from Boomi Cloud API Management – Local Edition 6.x and for future upgrades.

      UPDATE content_objects 
          SET created_by = CASE WHEN created_by = 'admin' THEN '<new username>' ELSE created_by END, 
              edited_by = CASE WHEN edited_by = 'admin' THEN '<new username>' ELSE edited_by END
          WHERE created_by = 'admin' OR edited_by = 'admin';

   2. Update the portal navigation table to to replace admin user name with the <new username> provided during the Helm installation.

      UPDATE portal_nav
          SET created_by = CASE WHEN created_by = 'admin' THEN '<new username>' ELSE created_by END,
              edited_by = CASE WHEN edited_by = 'admin' THEN '<new username>' ELSE edited_by END
          WHERE created_by = 'admin' OR edited_by = 'admin';

4. Upgrade cluster using Helm. Run the following command:

   $ cd helm install apim deploy \ --namespace \ 
   --set preInstallDBPrep.initDBUserPassword= \ 
   --set preInstallDBPrep.localDevAdminPassword=
   
   The expected sample output is as follows:
   
   NAME: apim
   LAST DEPLOYED: Fri Oct 13 08:01:54 2023
   NAMESPACE: <namespace_name>
   STATUS: deployed
   REVISION: 1
   TEST SUITE: None

tip

If you are facing any issues when upgrading to Boomi Cloud API Management – Local Edition 6.1.0, consider rolling back to the previous 6.1.0 version.

Refer to Rollback from 6.1.0 and 6.2.0 to Previous 6.x Versions for more information.