Administration guide¶
Schema Setup¶
For setting up the Monasca configuration database, we provide monasca_db,
an Alembic based database migration tool. Historically, the schema for the
configuration database was created by a SQL script. This SQL was changed a
couple of times, so monasca_db comes with a mechanism to detect the SQL
script revision being used to create it and stamp the database with the
matching Alembic revision.
Setting up a new database¶
If you are deploying Monasca from scratch, database setup is quite straightforward:
- Create a database and configure access credentials with
ALL PRIVILEGESpermission level on it in the Monasca API configuration file’s[database]section. - Run schema migrations:
monasca_db upgrade. It will run all migrations up to and including the most recent one (head) unless a revision to migrate to is explicitly specified.
Upgrading Existing Database from Legacy Schema¶
If you have been running an older version of Monasca, you can attempt to identify and stamp its database schema:
monasca_db stamp --from-fingerprint
This command will generate a unique fingerprint for the database schema in
question and match that fingerprint with an in-code map of fingerprints to
database schema revisions. This should work for all official (shipped as part
of the monasca-api repository) schema scripts. If you used a custom
third-party schema script to set up the database, it may not be listed and
you’ll get an error message similar to this one (the fingerprint hash will
vary):
Schema fingerprint 3d45493070e3b8e6fc492d2369e51423ca4cc1ac does not match any known legacy revision.
If this happens to you, please create a Storyboard story against the openstack/monasca-api project. Provide the following alongside the story:
- A copy of or pointer to the schema SQL script being used to set up the database.
- The fingerprint shown in the error message.
- The output of
monasca_db fingerprint --raw.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.