1 .. This work is licensed under a Creative Commons Attribution
2 .. 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
5 Using Policy DB Migrator
6 ########################
8 Policy DB Migrator is a set of shell scripts used to
9 install the database tables required to run ONAP Policy Framework.
12 Currently the Istanbul versions of the PAP and API components require
13 ``db-migrator`` to run prior to initialization.
18 Policy DB Migrator is run as a docker container and consists of the following scripts:
28 ``prepare_upgrade.sh`` is included as part of the docker image and is used
29 to copy the upgrade sql files to the run directory.
30 This script takes one parameter: <SCHEMA NAME>.
32 ``prepare_downgrade.sh`` is included as part of the docker image and is used
33 to copy the downgrade sql files to the run directory.
34 This script takes one parameter: <SCHEMA NAME>.
36 ``db-migrator`` is included as part of the docker image and is used
37 to run either the upgrade or downgrade operation depending on user requirements.
38 This script can take up to four parameters:
49 - upgrade/downgrade/report
60 The container also consists of several sql files which are used to upgrade/downgrade
63 The following environment variables need to be set to enable ``db-migrator``
64 to run and connect to the database.
86 Prior to upgrading the following script is run:
90 /opt/app/policy/bin/prepare_upgrade.sh <SCHEMA NAME>
92 This will copy the upgrade files from ``/home/policy/sql`` to ``$POLICY_HOME/etc/db/migration/<SCHEMA NAME>/sql/``
94 Each individual sql file that makes up that release will be run as part of the upgrade.
100 Prior to downgrading the following script is run:
103 /opt/app/policy/bin/prepare_downgrade.sh <SCHEMA NAME>
105 This will copy the downgrade files from ``/home/policy/sql`` to ``$POLICY_HOME/etc/db/migration/<SCHEMA NAME>/sql/``
107 Each individual sql file that makes up that release will be run as part of the downgrade.
114 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o upgrade -f 0800 -t 0900
116 If the ``-f`` and ``-t`` flags are not specified, the script will attempt to run all available
117 sql files greater than the current version.
119 The script will return either 1 or 0 depending on successful completion.
126 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o downgrade -f 0900 -t 0800
128 If the ``-f`` and ``-t`` flags are not specified, the script will attempt to run all available
129 sql files less than the current version.
131 The script will return either 1 or 0 depending on successful completion.
136 After every upgrade/downgrade ``db-migrator`` runs the report operation to show the
137 contents of the db-migrator log table.
141 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o report
143 Console output will also show the sql script command as in the example below:
147 upgrade 0100-jpapdpgroup_properties.sql
149 CREATE TABLE IF NOT EXISTS jpapdpgroup_properties (name VARCHAR(120) NULL, version VARCHAR(20) NULL,
150 PROPERTIES VARCHAR(255) NULL, PROPERTIES_KEY VARCHAR(255) NULL)
156 The migration schema contains two tables which belong to ``db-migrator``.
158 * schema_versions - table to store the schema version currently installed by ``db-migrator``
169 * policyadmin_schema_changelog - table which stores a record of each sql file that has been run
172 :widths: 10 40 10 10 10 20 10 20
184 - 0100-jpapdpgroup_properties.sql
190 - 2021-09-13 09:09:26
192 * ID: Sequence number of the operation
193 * script: name of the sql script which was run
194 * operation: operation type - upgrade/downgrade
195 * from_version: starting version
196 * to_version: target version
197 * tag: tag to identify operation batch
198 * success: 1 if script succeeded and 0 if it failed
199 * atTime: time script was run
202 Partial Upgrade/Downgrade
203 =========================
205 If an upgrade or downgrade ends with a failure status (success=0) the next time an upgrade
206 or downgrade is run it will start from the point of failure rather than re-run scripts
207 that succeeded. This allows the user to perform a partial upgrade or downgrade depending
208 on their requirements.
213 The script that runs ``db-migrator`` is part of the database configuration and is in the following directory:
217 oom/kubernetes/policy/resources/config/db_migrator_policy_init.sh
219 This script is mounted from the host file system to the policy-db-migrator container.
220 It is setup to run an upgrade by default.
224 /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
225 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
227 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
230 The following table describes what each line does:
238 * - /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
239 - prepare the upgrade scripts for the <SQL_DB> schema
240 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
243 - assign the return code from db-migrator to a variable
244 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
245 - run the db-migrator report for the <SQL_DB> schema
247 - exit with the return code from db-migrator
249 To alter how ``db-migrator`` is run the first two lines need to be modified.
250 The first line can be changed to call either ``prepare_upgrade.sh`` or ``prepare_downgrade.sh``.
251 The second line can be changed to use different input parameters for ``db-migrator`` :
267 - current version (e.g. 0800)
270 - target version (e.g. 0900)
273 This is an example of how a downgrade from version 0900 to version 0800 could be run:
277 /opt/app/policy/bin/prepare_downgrade.sh ${SQL_DB}
278 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o downgrade -f 0900 -t 0800
280 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
283 Additional Information
284 ======================
285 If the target version of your upgrade or downgrade is the same as the current version,
286 no sql files are run.
288 If an upgrade is run on a database where tables already exist in the policy schema, the
289 current schema version is set to 0800 and only sql scripts from later versions are run.
292 It is advisable to take a backup of your database prior to running this utility.
293 Please refer to the mariadb documentation on how to do this.