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 .. container:: paragraph
138 After every upgrade/downgrade ``db-migrator`` runs the report operation to show the
139 contents of the db-migrator log table.
143 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o report
145 Console output will also show the sql script command as in the example below:
149 upgrade 0100-jpapdpgroup_properties.sql
151 CREATE TABLE IF NOT EXISTS jpapdpgroup_properties (name VARCHAR(120) NULL, version VARCHAR(20) NULL,
152 PROPERTIES VARCHAR(255) NULL, PROPERTIES_KEY VARCHAR(255) NULL)
158 The migration schema contains two tables which belong to ``db-migrator``.
160 * schema_versions - table to store the schema version currently installed by ``db-migrator``
171 * policyadmin_schema_changelog - table which stores a record of each sql file that has been run
174 :widths: 10 40 10 10 10 20 10 20
186 - 0100-jpapdpgroup_properties.sql
192 - 2021-09-13 09:09:26
194 * ID: Sequence number of the operation
195 * script: name of the sql script which was run
196 * operation: operation type - upgrade/downgrade
197 * from_version: starting version
198 * to_version: target version
199 * tag: tag to identify operation batch
200 * success: 1 if script succeeded and 0 if it failed
201 * atTime: time script was run
204 Partial Upgrade/Downgrade
205 =========================
207 If an upgrade or downgrade ends with a failure status (success=0) the next time an upgrade
208 or downgrade is run it will start from the point of failure rather than re-run scripts
209 that succeeded. This allows the user to perform a partial upgrade or downgrade depending
210 on their requirements.
215 The script that runs ``db-migrator`` is part of the database configuration and is in the following directory:
219 oom/kubernetes/policy/resources/config/db_migrator_policy_init.sh
221 This script is mounted from the host file system to the policy-db-migrator container.
222 It is setup to run an upgrade by default.
226 /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
227 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
229 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
232 The following table describes what each line does:
240 * - /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
241 - prepare the upgrade scripts for the <SQL_DB> schema
242 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
245 - assign the return code from db-migrator to a variable
246 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
247 - run the db-migrator report for the <SQL_DB> schema
249 - exit with the return code from db-migrator
251 To alter how ``db-migrator`` is run the first two lines need to be modified.
252 The first line can be changed to call either ``prepare_upgrade.sh`` or ``prepare_downgrade.sh``.
253 The second line can be changed to use different input parameters for ``db-migrator`` :
269 - current version (e.g. 0800)
272 - target version (e.g. 0900)
275 This is an example of how a downgrade from version 0900 to version 0800 could be run:
279 /opt/app/policy/bin/prepare_downgrade.sh ${SQL_DB}
280 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o downgrade -f 0900 -t 0800
282 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
285 Additional Information
286 ======================
287 If the target version of your upgrade or downgrade is the same as the current version,
288 no sql files are run.
290 If an upgrade is run on a database where tables already exist in the policy schema, the
291 current schema version is set to 0800 and only sql scripts from later versions are run.
294 It is advisable to take a backup of your database prior to running this utility.
295 Please refer to the mariadb documentation on how to do this.