1 .. This work is licensed under a Creative Commons Attribution
2 .. 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
5 .. _policy-db-migrator-label:
7 Using Policy DB Migrator
8 ########################
10 Policy DB Migrator is a set of shell scripts used to
11 install the database tables required to run ONAP Policy Framework.
14 Currently the Istanbul versions of the PAP and API components require
15 ``db-migrator`` to run prior to initialization.
20 Policy DB Migrator is run as a docker container and consists of the following scripts:
31 ``prepare_upgrade.sh`` is included as part of the docker image and is used
32 to copy the upgrade sql files to the run directory.
33 This script takes one parameter: <SCHEMA NAME>.
35 ``prepare_downgrade.sh`` is included as part of the docker image and is used
36 to copy the downgrade sql files to the run directory.
37 This script takes one parameter: <SCHEMA NAME>.
39 ``db-migrator`` and ``db-migrator-pg`` are included as part of the docker image
40 and are used to run either the upgrade or downgrade operation for MariaDB or
41 PostgresSQL depending on user requirements.
42 These script can take up to four parameters:
53 - upgrade/downgrade/report
64 The container also consists of several sql files which are used to upgrade/downgrade
67 The following environment variables need to be set to enable ``db-migrator``
68 to run and connect to the database.
89 The following environment variables need to be set to enable ``db-migrator-pg``
90 to run and connect to the database.
116 Prior to upgrading the following script is run:
120 /opt/app/policy/bin/prepare_upgrade.sh <SCHEMA NAME>
122 This will copy the upgrade files from ``/home/policy/${SCRIPT_DIRECTORY}`` to ``$POLICY_HOME/etc/db/migration/<SCHEMA NAME>/${SCRIPT_DIRECTORY}/``
124 Each individual sql file that makes up that release will be run as part of the upgrade.
130 Prior to downgrading the following script is run:
133 /opt/app/policy/bin/prepare_downgrade.sh <SCHEMA NAME>
135 This will copy the downgrade files from ``/home/policy/${SCRIPT_DIRECTORY}`` to ``$POLICY_HOME/etc/db/migration/<SCHEMA NAME>/${SCRIPT_DIRECTORY}/``
137 Each individual sql file that makes up that release will be run as part of the downgrade.
144 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o upgrade -f 0800 -t 0900
150 /opt/app/policy/bin/db-migrator-pg -s <SCHEMA NAME> -o upgrade -f 0800 -t 0900
152 If the ``-f`` and ``-t`` flags are not specified, the script will attempt to run all available
153 sql files greater than the current version.
155 The script will return either 1 or 0 depending on successful completion.
162 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o downgrade -f 0900 -t 0800
168 /opt/app/policy/bin/db-migrator-pg -s <SCHEMA NAME> -o downgrade -f 0900 -t 0800
170 If the ``-f`` and ``-t`` flags are not specified, the script will attempt to run all available
171 sql files less than the current version.
173 The script will return either 1 or 0 depending on successful completion.
178 After every upgrade/downgrade ``db-migrator`` or ``db-migrator-pg`` runs the report operation
179 to show the contents of the db-migrator log table.
183 /opt/app/policy/bin/db-migrator -s <SCHEMA NAME> -o report
187 /opt/app/policy/bin/db-migrator-pg -s <SCHEMA NAME> -o report
189 Console output will also show the sql script command as in the example below:
193 upgrade 0100-jpapdpgroup_properties.sql
195 CREATE TABLE IF NOT EXISTS jpapdpgroup_properties (name VARCHAR(120) NULL, version VARCHAR(20) NULL,
196 PROPERTIES VARCHAR(255) NULL, PROPERTIES_KEY VARCHAR(255) NULL)
202 The migration schema contains two tables which belong to ``db-migrator``.
204 * schema_versions - table to store the schema version currently installed by ``db-migrator``
215 * policyadmin_schema_changelog - table which stores a record of each sql file that has been run
218 :widths: 10 40 10 10 10 20 10 20
230 - 0100-jpapdpgroup_properties.sql
236 - 2021-09-13 09:09:26
238 * ID: Sequence number of the operation
239 * script: name of the sql script which was run
240 * operation: operation type - upgrade/downgrade
241 * from_version: starting version
242 * to_version: target version
243 * tag: tag to identify operation batch
244 * success: 1 if script succeeded and 0 if it failed
245 * atTime: time script was run
248 Partial Upgrade/Downgrade
249 =========================
251 If an upgrade or downgrade ends with a failure status (success=0) the next time an upgrade
252 or downgrade is run it will start from the point of failure rather than re-run scripts
253 that succeeded. This allows the user to perform a partial upgrade or downgrade depending
254 on their requirements.
259 The script that runs ``db-migrator`` is part of the database configuration and is in the following directory:
263 oom/kubernetes/policy/resources/config/db_migrator_policy_init.sh
265 This script is mounted from the host file system to the policy-db-migrator container.
266 It is setup to run an upgrade by default.
270 /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
271 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
273 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
278 /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
279 /opt/app/policy/bin/db-migrator-pg -s ${SQL_DB} -o upgrade
281 /opt/app/policy/bin/db-migrator-pg -s ${SQL_DB} -o report
284 The following table describes what each line does:
292 * - /opt/app/policy/bin/prepare_upgrade.sh ${SQL_DB}
293 - prepare the upgrade scripts for the <SQL_DB> schema
294 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o upgrade
297 - assign the return code from db-migrator to a variable
298 * - /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
299 - run the db-migrator report for the <SQL_DB> schema
301 - exit with the return code from db-migrator
303 To alter how ``db-migrator`` is run the first two lines need to be modified.
304 The first line can be changed to call either ``prepare_upgrade.sh`` or ``prepare_downgrade.sh``.
305 The second line can be changed to use different input parameters for ``db-migrator`` :
321 - current version (e.g. 0800)
324 - target version (e.g. 0900)
327 This is an example of how a downgrade from version 0900 to version 0800 could be run:
331 /opt/app/policy/bin/prepare_downgrade.sh ${SQL_DB}
332 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o downgrade -f 0900 -t 0800
334 /opt/app/policy/bin/db-migrator -s ${SQL_DB} -o report
337 Additional Information
338 ======================
339 If the target version of your upgrade or downgrade is the same as the current version,
340 no sql files are run.
342 If an upgrade is run on a database where tables already exist in the policy schema, the
343 current schema version is set to 0800 and only sql scripts from later versions are run.
346 It is advisable to take a backup of your database prior to running this utility.
347 Please refer to the mariadb documentation on how to do this.