Use of local toml files, cargo make and possible config clarifications

[data-sync-user]

Currently, we provide a pretty bare-bones example config file. Configuration is particularly challenging with syncstorage-rs given that it houses the code for both syncstorage and tokenserver, and that there are multiple mix and match options for databases.

It is not obvious what needs to be set in order to run the service. Publicly-accessible code docs docs a la https://mozilla-hub.atlassian.net/browse/SYNC-3341 will help a lot (users will be able to see all of the settings in the Settings structs along with their doc comments), but it would be useful to give comprehensive examples of how to build and configure the following:

• Syncstorage with Postgres
• Tokenserver with Postgres

Tasks:

• Add more example config files to support running different server configurations out of the box.
  • Ex. a local.postgres.toml
• Expand upon the Makefile to add more support for running different server configurations out of the box
• Explore using cargo make to make building and running the app easier
• Make using Docker locally easier (build caching?)

┆Issue is synchronized with this Jira Task

[data-sync-user]

➤ Barry Chen commented:

I don’t understand why this is in the Postgres deploy pipeline epic.

[data-sync-user]

➤ Taddes Korris commented:

We decided to move this from the docs epic to this one in our team meeting a while back. It was broadly satisfying “robust build pipeline” part. It can be in this epic or another, but I think the general goal is that this simplifies and standardizes the way we address setup & config.

[data-sync-user]

➤ Taddes Korris commented:

Given the other PRs that have landed that clarified the Docker setups, as well as bootstrapping for Postgres, I think we can close this issue. There were some useful ideas here for the future like using cargo make and some other server config options, but we can evaluate those down the road.