Skip to main content

Upgrade Requirements

Carefully read this information before upgrading AtScale to the corresponding release.

C2024.9.0​

Update the atscale-api and atscale-engine clients​

When you upgrade to AtScale C2024.9.0, you need to update the atscale-api and atscale-engine clients with additional service account roles.

  1. In the Identity Broker, click Clients in the left-hand navigation, then click the atscale-engine client.

  2. On the Settings tab, in the Capability config section, locate the Authentication flow field and enable Service accounts roles.

  3. Click Save.

  4. Go to the Service accounts roles tab.

  5. Click Assign role, then assign the atscale-engine client following roles:

    • admin realm role
    • uma_protection client role

  6. Click Clients in the left-hand navigation and select the atscale-api client.

  7. On the Settings tab, in the Capability config section, locate the Authentication flow field and enable Service accounts roles.

  8. Click Save.

  9. Go to the Service accounts roles tab.

  10. Click Assign role and assign the atscale-api client the admin realm role.

DOC-1446

Update semi-additive metrics​

C2024.9.0 introduced updates to the semi_additive property in SML metric files. After upgrading to this release, you must update any semi-additive metrics in your models to use the new syntax. For the full reference for the new properties, refer to the AtScale SML Object Documentation on GitHub.

Update atscale.yml files​

In C2024.9.0, the atscale.yml file was renamed to catalog.yml, and its as_version property was renamed to version. After upgrading to this release, AtScale recommends making the following changes to the atscale.yml files in any existing models you have:

  1. Rename the files to catalog.yml.
  2. Rename their as_version properties to version.

C2024.8.0​

Resize the PostgresSQL and MinIO PVCs​

In C2024.8.0, the default sizes required for the MinIO and PostgresSQL PVCs included with AtScale increased from 16Gi to 64Gi. You must manually resize these as part of the upgrade procedure.

Note

The following procedure uses the default names for the PVCs and StatefulSets. Be sure to use the names specific to your cluster when performing these steps.

  1. Before upgrading AtScale:

    1. Ensure resizing is enabled for the PVCs:

      1. Find the PVC storage class:

        kubectl get pvc -n <namespace>

      2. Enable resizing:

        kubectl patch sc <storage_class_name> -p '{"allowVolumeExpansion": true}'

    2. Resize the PostgreSQL PVCs:

      KUBE_EDITOR="sed -i s/16Gi/64Gi/g" kubectl edit pvc -n <namespace> data-postgres-postgresql-0
      KUBE_EDITOR="sed -i s/16Gi/64Gi/g" kubectl edit pvc -n <namespace> data-postgres-postgresql-1
      KUBE_EDITOR="sed -i s/16Gi/64Gi/g" kubectl edit pvc -n <namespace> data-postgres-postgresql-2

    3. Resize the MinIO PVCs:

      KUBE_EDITOR="sed -i s/16Gi/64Gi/g" kubectl edit pvc -n <namespace> minio

    4. Delete the PostgreSQL StatefulSet:

      kubectl delete sts -n <namespace> --cascade=orphan postgres-postgresql

      PostgresSQL is a High Availability cluster and is therefore deployed as a StatefulSet. Because these don't support changes, you must delete them. Note that --cascade=orphan leaves all pods running, so you should not experience any downtime.

  2. Upgrade the AtScale chart:

    helm upgrade atscale oci://docker.io/atscaleinc/atscale --version <version> -n <namespace> -f <override_file>

    Where:

    • <version> is the version of AtScale you want to upgrade to.
    • <namespace> is the namespace in which AtScale is installed.
    • <override_file> is your values override file.

  3. Restart the pods in order to resize the mounted volume:

    kubectl rollout restart sts -n <namespace> postgres-postgresql

C2024.7.0​

Aggregate Rebuild on Upgrade Warning for IRIS Data Warehouses​

If you use InterSystems IRIS, aggregate tables will be rebuilt when you upgrade from C2024.1.1 to C2024.7.0 or later. You should plan your upgrade so that the system has time to rebuild the affected aggregates outside of business operations.

If you want to perform the upgrade without immediately rebuilding the aggregates, do the following:

  1. Before upgrading, set the custom engine setting aggregate.maintenance.job.invalid-physical-plans.enabled = False and restart the engine.
  2. Perform the upgrade.
  3. When you are ready to rebuild aggregates after the upgrade, set aggregate.maintenance.job.invalid-physical-plans.enabled = True and restart the engine.

ATSCALE-21956