Upgrade

Important

This information refers to the previous helm install method for the Obcerv Platform. If you are looking to install using the more streamlined Kubernetes Off-the-Shelf (KOTS) method, see the updated installation overview.

Before upgrading Obcerv components, you must ensure you have the latest helm charts and docker images. If you have chosen to maintain your own docker repository you must first ensure it is up to date with the ITRS repository, to do this follow the steps in Docker images.

When a new version of Obcerv is released, a new version of the Operator typically comes with it. The Operator must be upgraded first before upgrading any Obcerv instances in the cluster.

Before upgrading Obcerv, carefully review the release notes for important information about changes, enhancements, bug fixes, and known issues that may impact the upgrade process or software functionality.

Breaking changes for version 2.6.1 release Copied

Before upgrading, if you have set any of the following parameters in your config prior to Obcerv Platform version 2.6.1, you must remove them or rename them to the new parameter names.

Removed config parameters Copied

Renamed config parameters Copied

The following parameters were renamed from:

  downsampledMetricsStream:
    maxPollRecords: 5000

  dpd:
    kafkaConsumerMaxPollRecords: 5000
  
  sinkd:
    metrics:
      maxPollRecords: 5000
    dsMetrics:
      maxPollRecords: 5000
    loki:
      maxPollRecords: 2000
    entities:
      maxPollRecords: 5000
    signals:
      maxPollRecords: 5000
    traces:
      maxPollRecords: 1000

To:

  downsampledMetricsStream:
    consumerProperties:
      max.poll.records: 5000
    bucketedConsumerProperties:
      max.poll.records: 5000
    
  dpd:
    consumerProperties:
      max.poll.records: 5000  
    
  sinkd:
    metrics:
      consumerProperties:
        max.poll.records: 5000
    dsMetrics:
      consumerProperties:
        max.poll.records: 5000
    loki:
      consumerProperties:
        max.poll.records: 2000
    entities:
      consumerProperties:
        max.poll.records: 5000
    signals:
      consumerProperties:
        max.poll.records: 5000
    traces:
      consumerProperties:
        max.poll.records: 1000

Upgrade Copied

  1. Update the Helm repository to get the new charts:

    helm repo update itrs

  2. Upgrade the operator:

    helm upgrade obcerv-operator itrs/obcerv-operator -n <namespace> --version 2.6.1 --wait

  3. Upgrade an Obcerv instance using the same configuration file used during installation:

    helm upgrade -f config.yaml <instance> itrs/obcerv -n <namespace> --version 2.6.1

    The Operator will stop, upgrade, and restart the workloads in the correct order. To monitor the progress, run:

    kubectl describe obcerv <instance> -n <namespace>

While the upgrade is in progress, the Obcerv status shows as DEPLOYING. Once completed, the status is set to DEPLOYED.

Note

You cannot downgrade an instance that has already been upgraded.

Note

When reinstalling the Obcerv Platform after a restore, you need to supply the exact same configuration values used in the restored snapshot. After modifying the configuration of the installed Platform, it is recommended to create a new snapshot and store a copy of the configuration.
["Obcerv"] ["User Guide", "Technical Reference"]

Was this topic helpful?