DataMasque Portal

Downgrading v3.x

Downgrading within v3.x

Note: These instructions are for DataMasque installed in a Docker or Podman environment. For specific instructions for downgrading on EKS or Cohesity, please contact support@datamasque.com.

It is not necessary to stop the DataMasque containers before downgrading these versions. To reach older versions, downgrade step-by-step through each version.

First, find your current version in the table below:

Current Version Migration Command Target Version
v3.26.18 migrate masque_entities 0142 v3.26.17
v3.26.17 None required (skip step 2) v3.26.16
v3.26.16 migrate masque_entities 0141 v3.26.15
v3.26.15 migrate file_masking 0008 v3.26.14
v3.26.14 migrate masque_entities 0133 then migrate file_masking 0006 v3.26.13
v3.26.13 migrate masque_entities 0130 then migrate file_masking 0005 v3.26.12
v3.26.12 migrate masque_entities 0127 v3.26.11
v3.26.11 migrate file_masking 0004 v3.26.10
v3.26.10 None required (skip step 2) v3.26.09
v3.26.09 migrate masque_entities 0126 v3.26.08
v3.26.08 migrate masque_entities 0124 v3.26.07
v3.26.07 migrate masque_entities 0122 v3.26.06
v3.26.06 None required (skip step 2) v3.26.05
v3.26.05 migrate masque_entities 0119 then migrate file_masking 0003 v3.26.04
v3.26.04 None required (skip step 2) v3.26.03
v3.26.03 migrate masque_entities 0118 v3.26.02
v3.26.02 None required (skip step 2) v3.26.01

To downgrade multiple versions: Run each migration command from the table in sequence (top to bottom), skipping any None required entries. Then install your final target version.

Before downgrading from v3.26.18: v3.26.18 removed the Microsoft SQL Server (Linked Server) database connection type and deleted all connections of this type. The downgrade does not restore these connections. To use this connection type again after downgrading, recreate the connections.

Before downgrading from v3.26.17: v3.26.17 introduced the Azure Cosmos DB database connection type. Delete any connections of this type via the DataMasque UI before you start — earlier versions cannot deserialize the saved configurations and will fail to load these connections. v3.26.17 also introduced the Foundation and Structured license types. If your instance uses one of these licenses, install a license of an earlier type before downgrading, because earlier versions reject these license types. Then follow the table above from your current version.

Before downgrading from v3.26.14: v3.26.14 split masking information out of discovery configurations into separate ruleset generation configurations. Earlier versions have no ruleset generation configurations, so the downgrade migration cannot restore the per-label masks. Instead, it marks every discovery configuration invalid. After downgrading, review and re-save (or recreate) your discovery configurations to make them valid again. The downgrade removes any ruleset generation configurations you created.

Before downgrading from v3.26.12: v3.26.12 introduced two new database connection types, Amazon DocumentDB and SAP HANA. Before running the migration command, delete any connections of these types via the DataMasque UI — earlier versions cannot deserialize the saved configurations and will fail to load these connections.

Before downgrading from v3.26.11: v3.26.11 introduced two new database connection types, Databricks and Informix. Before running the migration command, delete any connections of these types via the DataMasque UI — earlier versions cannot deserialize the saved configurations and will fail to load these connections.

Before downgrading from v3.26.09: v3.26.09 introduced two new database connection types, MongoDB and Databricks Lakebase. Before running the migration command, delete any connections of these types via the DataMasque UI — earlier versions cannot deserialize the saved configurations and will fail to load these connections.

Then follow these steps:

  1. Back up rulesets, connections, and seed files.

  2. Undo migrations using the command from the table above:

# Docker
$ sudo docker exec -it datamasque_admin-server_1 bash django_manage.sh <MIGRATION_COMMAND>

# Podman
$ sudo podman exec -it datamasque_admin-server_1 bash django_manage.sh <MIGRATION_COMMAND>
  1. Install the target version:
$ tar -xvzf datamasque-v<TARGET_VERSION>.pkg
$ cd datamasque/v<TARGET_VERSION>/
$ sudo ./install.sh --upgrade --force  # add --podman for Podman
  1. DataMasque should start within 5 minutes. If not, see Restarting containers.

Downgrading from v3.x to v2.x

Downgrading from DataMasque v3.x to any v2.x version is not supported. v3.x includes significant infrastructure changes that prevent reverting to a v2.x installation.

If you need to return to a v2.x version, you will need to restore from a backup taken prior to upgrading.

For further assistance, please contact the DataMasque support team at support@datamasque.com.

Restarting containers

If DataMasque doesn't start within 5 minutes, try forcing the containers to restart.

Note that these instructions assume DataMasque is installed in the default directory /usr/local/etc/datamasque. If you specified a different path during installation, update the path accordingly.

# Docker
$ sudo docker compose -f /usr/local/etc/datamasque/docker-compose.yml restart

# Podman
$ sudo docker-compose -f /usr/local/etc/datamasque/docker-compose.yml restart

Appendix: Migration reference

For advanced users or support reference, here are the database migrations that changed between versions:

Version Migration App Migration Target
v3.26.18 masque_entities 0146
v3.26.17 None N/A
v3.26.16 masque_entities 0142
v3.26.15 file_masking 0009
v3.26.14 masqueentities + filemasking 0141 + 0008
v3.26.13 masqueentities + filemasking 0133 + 0006
v3.26.12 masque_entities 0130
v3.26.11 file_masking 0005
v3.26.10 None N/A
v3.26.09 masque_entities 0127
v3.26.08 masque_entities 0126
v3.26.07 masque_entities 0124
v3.26.06 None N/A
v3.26.05 masqueentities + filemasking 0122 + 0004
v3.26.04 None N/A
v3.26.03 masque_entities 0119
v3.26.02 None N/A