Patching the Platform

Caution:

Ensure that all preparation steps for system patching have been completed. For instructions, see Prepare for Patching.

The platform patching covers both the internal services of the platform layer, and the administrative and user-level services exposed through the infrastructure services layer.

The containerized microservices have their own separate patching mechanism. A service is patched if a new Helm deployment chart and container image are found in the pca302_containers ULN channel. When a new deployment chart is detected during the patching process, the pods running the services are restarted with the new container image.

Note:

In software version 3.0.2-b892153 and later all patch operations are based on the upgrade plan, which is generated when the pre-upgrade command is executed. For more information, see Prepare for Patching. When a component is already at the required version, the patch operation is skipped. However, patching with the same version can be forced using the Service Web UI or Service CLI command option (force=True), if necessary.

Using the Service Web UI

  1. In the navigation menu, click Upgrade & Patching.

  2. In the top-right corner of the Upgrade Jobs page, click Create Upgrade or Patch.

    The Create Request window appears. Choose Patch as the Request Type.

  3. Select the appropriate patch request type: Patch Platform.

  4. If required, fill out the patch parameters:

    • ULN: Enter the fully qualified domain name of the ULN mirror in your data center. This parameter is deprecated in software version 3.0.2-b892153 and later.

    • Advanced Options JSON: Not available.

    • Log Level: Optionally, select a specific log level for the upgrade log file. The default log level is "Information". For maximum detail, select "Debug".

  5. Click Create Request.

    The new patch request appears in the Upgrade Jobs table.

Using the Service CLI

  1. Enter the patch command.

    PCA-ADMIN> patchPlatform
    Command: patchPlatform
    Status: Success
    Time: 2022-12-08 17:26:12,217 UTC
    Data:
      Service request has been submitted. Upgrade Job Id = 1638984971208-platform-79257 \
    Upgrade Request Id = UWS-39f3f08f-b2d1-4804-8185-2dd3af60dd41
  2. Use the request ID and the job ID to check the status of the upgrade process.

    PCA-ADMIN> getupgradejobs
    Command: getupgradejobs
    Status: Success
    Time: 2022-12-08 17:36:34,657 UTC
    Data:
      id                               upgradeRequestId                           commandName   result
      --                               ----------------                           -----------   ------
      1638984971208-platform-79257     UWS-39f3f08f-b2d1-4804-8185-2dd3af60dd41   platform      None
    
    PCA-ADMIN> getupgradejob upgradeJobId=1638984971208-platform-79257
    Command: getupgradejob upgradeJobId=1638984971208-platform-79257
    Status: Success
    Time: 2022-12-08 17:38:19,385 UTC
    Data:
      Upgrade Request Id = UWS-39f3f08f-b2d1-4804-8185-2dd3af60dd41
      Name = platform
      Start Time = 2022-12-08T17:26:11
      Pid = 79257
      Host = pcamn02
      Log File = /nfs/shared_storage/pca_upgrader/log/pca-upgrader_platform_services_2022_12_08-17.26.11.log
      Arguments = {"component_names":null,"diagnostics":false,"display_task_plan":false,"dry_run_tasks":false, \
      "expected_iso_checksum":null,"fail_halt":false,"fail_upgrade":null,"image_location":null, \
    [...]
      Process = alive
      Tasks 1 - Name = Validate ULN Channel URL
      Tasks 1 - Description = Verify that the ULN channel URL is accessible
      Tasks 1 - Time = 2022-12-08T17:26:12
    [...]