Upgrading to Inventory service V2 APIs and events

If you are using V1 of the Availability, Reservation, and Events APIs for your inventory, you must upgrade to the corresponding V2 APIs and events for the Inventory service.

1. Review the new V2 URL and event identifiers that replace the V1 URL and event identifiers. For more information, see V1 and V2 API URLs and event identifiers.
2. If you are using V1 events, complete one of the following steps in your environment:
   • Create IBM Cloud® Storage Object buckets to hold the V2 events. For more information, see Publishing events from the Inventory service to IBM Cloud Object Storage.
   • Add the webhooks. For more information, see Publishing events from the Inventory service to webhooks.
   • For more information about format differences and webhooks, see New event delivery format.
3. Update the client-side implementation to use the V2 APIs and start the new event consumers to listen for V2 events.
   Note:

   • The client must enable the node priority behavior for network reservation. For more information, see Reservations by using node priority behavior.
   • For more information about updating the API, see Update settings API and set the value of placeNodeLevelReservationForDg to true.
   • After you enable the node priority behavior, recreate V1 network reservation using V2 network reservation APIs. This ensures all network reservation are prioritized by node and eliminates inventory overbooking. V2 reservation API expects to throw exception if placeNodeLevelReservationForDg is not set or false.
     For more information, see Reservations by date (V2). After the changes are completed, you can start using V2 reservation for network.
   • To ensure minimal disruption to the systems, it is recommended that you plan for downtime when you are switching from the V1 to the V2 API URLs.
4. Open a support ticket to start the upgrade process. For more information, see IBM® Support.
5. Provide the new event endpoints - IBM Cloud Object Storage and webhooks in your support ticket.
   Note:

   • Specify all the v2 events that need to be enabled.
   • Specify whether any failed events are being consumed or not.
   • If you are using the COS endpoints, you can share the API key(s) and public endpoint URL details.
6. If your non-production environment is deployed in a V1 data center and need to migrate to V2, IBM configures to a new data center with V2 functionalities. Please check with IBM Software Support if this applies to any of your non-production environments.
   In case of migration, IBM migrates all the configuration data to the new data center. However, the transaction data does not get migrated.
   • All configuration data is migrated over a three-day period. Do not access your environments during this time.
   • Transaction data, which includes supply, demand, and reservation data, is reset upon completion.
     Attention: This environment upgrade applies only to nonproduction and pre-production environments and has no impact on production environments.
7. IBM Support contacts you when the V2 upgrade is ready.
   Meanwhile, you can continue to work with the V1 APIs and events.
   Note: When the V2 upgrade is ready, you should already have access to V2 reservation APIs. The environment forks new data into two pipeline - old V1 and new V2 that is true during the V2 upgrade procedure.
8. Cut over to V2 APIs and events for all client applications, depending on the client-side implementation update that you completed in Step 3. Once IBM completes the upgradation, you can cut over to V2 APIs. When the upgradation is completed, IBM turns the V1 feature off.
   Attention: Once IBM completes the upgrade activity, you have 7 days of grace period to cut over to V2. During this period, both V1 and V2 availability APIs will be accessible however V1 API response will be stale. Hence it is strongly recommended to cut over as soon as possible.
9. Notify IBM that the client side V2 cutover has completed.
   Note: When you confirm the V2 cutover as completed, V1 is decommissioned for the account and there is no access to old APIs. At this point, the V1 pipeline is turned off by IBM.

For Order Management System Software on-premises environments only, complete step 10.

10. To set up your environment on the Order Management System Software instance to work with the V2 APIs and events, complete the following steps:
    1. Stop the application and agent servers.
    2. In the customer.overrides.properties file, update the IVApiVersion and URL paths.
    3. Restart the application and agent servers.
    4. Notify IBM after you complete the environment setup.

    For more information, see Enabling the integration adapter (phase 2) to use Availability by date breakup.

    Note: This step is applicable for adapter phase 2 only. If you are on phase 1 and calling IV V1 availability and reservation APIs via custom implementation, you need to review and replace the V2 API URLs for the V1 URLs.