Deployment

Production¶

Make sure to set METAXY_STORE to "prod" in your production environment. This will make it the default Metaxy metadata store without any code changes.
Add the following step to your production deployment pipeline:
```
mx push --store prod
```
This will persist feature definitions in the metadata store, enabling feature history tracking and multi-project setups.

Tip

We strongly recommend setting METAXY_LOCKED to true in production when using external features.

Branch Deployments¶

Branch Deployments, also known as Preview (1) Deployments, are ephemeral environments typically created to test changes in a production-like setting. They are usually created by CI/CD for Pull Requests. Some tooling like Dagster has built-in support for Branch Deployments, and so does Metaxy.

or Review Environments, or Feature Branches, or whatever

In order to benefit from Branch Deployments, it is recommended to configure a separate store, templated by some kind of a deployment identifier. For example:

metaxy.toml

[stores.branch]
type = "metaxy.ext.metadata_stores.delta.DeltaMetadataStore"
root_path = "s3://branch-bucket/${PULL_REQUEST_ID}"
fallback_stores = ["prod"]

[stores.prod] title="metaxy.toml"
type = "metaxy.ext.metadata_stores.delta.DeltaMetadataStore"
root_path = "s3://my-prod-bucket/metaxy"

It is beneficial to have it fallback to prod store to avoid having to materialize all upstream features to a given one of interest (that's being tested).

Of course, the Branch Deployment CD needs to do:

mx push --store branch

And make sure to set METAXY_STORE to "branch" in the branch deployment environment.