Preparing the 2018 deployment for upgrade

Prepare your 2018 deployment for upgrade to 10.0.5.x.

1. Review the upgrade considerations. See Upgrade considerations on native Kubernetes.
2. Configure external logging prior to upgrade.

   This step is not mandatory but is recommended. For example, you could use https://logdna.com/.

3. Be sure you know the name of each subsystem on your 2018 deployment.

   The 2018 subsystem names are carried over to version 10 installations. To view the names:

   apicup subsys list

   These subsystem names are the values used in the spec.subsystemName field for each custom resource (CR) when upgrading.

4. On 2018, check the health of each subsystem before upgrade:

   apicup subsys health-check <subsystem_name>

5. On the 2018 system, back up the original apicup project directory to a location from which it can always be retrieved.
   Note: The original project directory created with the apicup installer during the initial 2018 product installation (for example, myProject) is required if you need to restore the database and to run disaster recovery back to v2018. You cannot restore the database or perform a disaster recovery without the initial project directory because it contains pertinent information about the 2018 cluster.
6. Complete a full backup for the API Connect 2018 Management, Portal, and Analytics subsystems. Verify that you can successfully restore from the backups.
   Note: The Analytics subsystem cannot be upgraded due to changes in v10.0.5.0, and you cannot restore it into v10 but you should back it up in case a rollback is needed.

   Make sure you have current and correct configuration for backup and restore for all of the 2018 subsystems. See Backing up and restoring.

7. If you want to retain your analytics data, then you must export it before running the upgrade.

   For instructions on exporting data from v2018, see the v2018 documentation: https://www.ibm.com/docs/en/api-connect/2018.x?topic=analytics-exporting-api-event-data. Also, you can set up analytics offload so that all new analytics data is sent to a third-party system for storage: https://www.ibm.com/docs/en/api-connect/2018.x?topic=cloud-configuring-analytics-offload-api-connect.

8. Disassociate and delete your Analytics services.
   Note: If you want your v2018 deployment to continue gathering analytics data up to the last possible moment, this step can instead be done just before the Management subsystem upgrade: 5.

   1. In Cloud Manager, click Topology.
   2. In the section for the Availability Zone that contains the Analytics service, locate the Gateway service that the Analytics service is associated with.
   3. Click the actions menu, and select Unassociate analytics service. Remember to disassociate each Analytics service from all Gateways.
   4. In the section for the Availability Zone that contains the Analytics services, locate each Analytics service and click Delete.
9. On the 2018 deployment, use the apicops utility to resolve any known inconsistencies and synchronization problems with the database:

   The apicops preupgrade command must be run in fix mode just prior to starting the management upgrade. The fix mode fixes any inconsistencies and synchronization problems in the database.

   Important: Upgrade will fail if the apicops command is not successfully completed within 2 hours of starting the management upgrade. If the management upgrade must be run more than once, you must run the command in fix mode each time within 2 hours of starting the management upgrade.

   1. Obtain the latest 2018 release of apicops from https://github.com/ibm-apiconnect/apicops#latest-v2018-release.
   2. Set up the environment. See https://github.com/ibm-apiconnect/apicops#requirements.
   3. Run the command:

      apicops preupgrade -m fix --upgrade_to v10 -l <outputLogFileName>

      • The -m option runs the utility in fix mode. Running the utility in fix mode resolves most problems. If the utility identifies a problem it cannot resolve, contact IBM Support.
      • Set the -l option to send output to a log file.
10. Next, install the upgrade files. Continue with Obtaining files for upgrade from 2018.