Upgrading Tenant Projects
  • 11 Apr 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Upgrading Tenant Projects

  • Dark
    Light
  • PDF

Article summary

Greymatter provides a convenient process for upgrading projects using the greymatter upgrade command. Upgrades typically involve re-deploying Greymatter core service infrastructure to include sync and the edge.

Before upgrading the project, you must download the version of the CLI shipped with your Greymatter version. Otherwise, the CLI will not have the latest set of migrations.

Upgrade GSL Projects

Navigate to your GSL project directory and run the upgrade command:

greymatter upgrade 

This command will automatically upgrade the GSL schemas.

Upgrade Greymatter Platform Services

It is required that you manually update all associated Greymatter Platform Kubernetes manifests related to a tenant, including but not limited to, the sync service and edge proxies.

In the Sync manifest file inside k8s, change the image version to match the CLI version shipped with your Greymatter release. Re-deploy the service using kubectl.

In the edge manifest file instead the k8s directory, change the image version to match the proxy version shipped with your Greymatter release.

Once those changes have been made, apply them with kubectl:

kubectl apply -f ./k8s

Upgrade Flags

The Greymatter CLI upgrade command allows for specific flags.

Flag

Description

--migrate-import-paths

Modify pre-v1.8.4 GSL to reference new import path scheme.

--add-service-info

Automatically adds the service info listener into each service during upgrade for full Greymatter metrics captures. Accepted values are true/false. Default: true

--safe

Guarantees your previous GSL module installation will be restored if the upgrade fails.

--dir

The root of an existing greymatter GSL project. Default: current working directory


Was this article helpful?