Updating navigation API services

You can update navigation services together with its data or without it. To download data only, you need to update the Navi-Castle service only. In other cases, update all required navigation services.

Update Navi-Castle service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command. Additionally you can specify the following flags:

      • To update only the service image, add the --only-apps flag after the pull command.
      • To update only data, add the --only-data flag after the pull command.
      • To update both service and data, run the command without the above flags.

      For more settings, see DGCLI command-line arguments.

2. Copy the path to a new manifest file from the command output and set it as a value to the dgctlStorage.manifest parameter in the values-castle.yaml configuration file. For more information, see the service installation instructions.

   Important

   You can configure the process of importing new data for Navi-Castle. Use the importer settings group of the configuration file. If during a regular update of the navigation services you do not want to import new data, specify the manifest used for the previous import. In other cases, using a new manifest is recommended.

3. Check out breaking changes. If necessary, update other settings in the values-castle.yaml configuration file.

4. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-castle.yaml navi-castle 2gis-on-premise/navi-castle

   In the --version parameter, set the api-platform component version:

   • To update only the service or both service and data, use the new version that you specified in the DGCLI configuration file.
   • To update only data, set the currently installed version.

5. Test if the update succeeded.

Update Navi-Attractor service

Do the following steps for each Navi-Attractor instance installed:

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-attractor-<transport>.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-attractor-<transport>.yaml navi-attractor-<transport> 2gis-on-premise/navi-attractor

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

Update Navi-Back service

Do the following steps for each Navi-Back instance installed:

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-back.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-back.yaml navi-back 2gis-on-premise/navi-back

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

4. Test if the update succeeded.

Update Navi-Splitter service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-splitter.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-splitter.yaml navi-splitter 2gis-on-premise/navi-splitter

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

4. Test if the update succeeded.

Update Navi-Router service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-router.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-router.yaml navi-router 2gis-on-premise/navi-router

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

4. Test if the update succeeded.

Update Navi-Front service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-front.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-front.yaml navi-front 2gis-on-premise/navi-front

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

4. Test if the update succeeded.

Update Distance Matrix Async API service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-navi-async-matrix.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-navi-async-matrix.yaml navi-async-matrix 2gis-on-premise/navi-async-matrix

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

4. Test if the update succeeded.

Update Navi Async gRPC proxy service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-navi-async-grpc-proxy.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-navi-async-grpc-proxy.yaml navi-async-grpc-proxy 2gis-on-premise/navi-async-grpc-proxy

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

Update VRP Solver service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-vrp-solver.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-vrp-solver.yaml navi-vrp-solver 2gis-on-premise/navi-vrp-solver

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

Update VRP Task Manager service

1. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

2. Check out breaking changes. If necessary, update settings in the values-vrp-task-manager.yaml configuration file. For more information, see the service installation instructions.

3. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-vrp-task-manager.yaml navi-vrp-task-manager 2gis-on-premise/navi-vrp-task-manager

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

Update Restrictions API service

1. (Recommended) Back up data used by the service.

2. Fetch new installation artifacts.

   1. In the DGCLI configuration file, specify:

      • New version of the api-platform component (see API Platform releases).
      • Version of core component required to install the new API-Platform version (see the Dependencies subsection in the API Platform releases description).

   2. Run the fetch command.

      For more settings, see DGCLI command-line arguments.

3. Check out breaking changes. If necessary, update settings in the values-restrictions.yaml configuration file. For more information, see the service installation instructions.

4. Run the command to update the service:

   helm upgrade --version=VERSION --atomic --values ./values-restrictions.yaml navi-restrictions 2gis-on-premise/navi-restrictions

   In the --version parameter, set the new api-platform component version that you specified in the DGCLI configuration file.

5. Test if the update succeeded.