25f2c5e079
As discussed in the Liberty Design Summit "Moving apps to Python 3" cross-project workshop, the way forward in the near future is to switch to the pure-python PyMySQL library as a default. https://etherpad.openstack.org/p/liberty-cross-project-python3 Also set the OS_TEST_DBAPI_ADMIN_CONNECTION override variable so that oslo.db opportunistic detection will know to use PyMySQL until I12b32dc097a121bd43991bc38dd4d289b65e86c1 makes it the default behavior. Change-Id: Icd91a065d3c4f62791ba0dca99a822e3a1a0ad44 Co-Authored-By: Victor Sergeyev <vsergeyev@mirantis.com>
5.1 KiB
ironic-dbsync
The ironic-dbsync utility is used to create the
database schema tables that the ironic services will use for storage. It
can also be used to upgrade (or downgrade) existing database tables when
migrating between different versions of ironic.
The Alembic library is used to perform the database migrations.
Options
This is a partial list of the most useful options. To see the full list, run the following:
ironic-dbsync --helpironic-dbsync
-h, --help
Show help message and exit.
--config-dir <DIR>
Path to a config directory with configuration files.
--config-file <PATH>
Path to a configuration file to use.
-d, --debug
Print debugging output.
-v, --verbose
Print more verbose output.
--version
Show the program's version number and exit.
upgrade, downgrade, stamp, revision, version, create_schema
The command <dbsync_cmds> to run.
Usage
Options for the various commands <dbsync_cmds> for ironic-dbsync are listed
when the -h or --help option is used
after the command.
For example:
ironic-dbsync create_schema --helpInformation about the database is read from the ironic configuration
file used by the API server and conductor services. This file must be
specified with the --config-file option:
ironic-dbsync --config-file /path/to/ironic.conf create_schemaThe configuration file defines the database backend to use with the connection database option:
[database]
connection=mysql+pymysql://root@localhost/ironicIf no configuration file is specified with the --config-file option,
ironic-dbsync
assumes an SQLite database.
Command Options
ironic-dbsync is
given a command that tells the utility what actions to perform. These
commands can take arguments. Several commands are available:
create_schema
create_schema
-h, --help
Show help for create_schema and exit.
This command will create database tables based on the most current version. It assumes that there are no existing tables.
An example of creating database tables with the most recent version:
ironic-dbsync --config-file=/etc/ironic/ironic.conf create_schemadowngrade
downgrade
-h, --help
Show help for downgrade and exit.
--revision <REVISION>
The revision number you want to downgrade to.
This command will revert existing database tables to a previous
version. The version can be specified with the --revision option.
An example of downgrading to table versions at revision 2581ebaf0cb2:
ironic-dbsync --config-file=/etc/ironic/ironic.conf downgrade --revision 2581ebaf0cb2revision
revision
-h, --help
Show help for revision and exit.
-m <MESSAGE>, --message <MESSAGE>
The message to use with the revision file.
--autogenerate
Compares table metadata in the application with the status of the database and generates migrations based on this comparison.
This command will create a new revision file. You can use the --message option to
comment the revision.
This is really only useful for ironic developers making changes that require database changes. This revision file is used during database migration and will specify the changes that need to be made to the database tables. Further discussion is beyond the scope of this document.
stamp
stamp
-h, --help
Show help for stamp and exit.
--revision <REVISION>
The revision number.
This command will 'stamp' the revision table with the version
specified with the --revision option. It will not run any
migrations.
upgrade
upgrade
-h, --help
Show help for upgrade and exit.
--revision <REVISION>
The revision number to upgrade to.
This command will upgrade existing database tables to the most recent
version, or to the version specified with the --revision option.
If there are no existing tables, then new tables are created,
beginning with the oldest known version, and successively upgraded using
all of the database migration files, until they are at the specified
version. Note that this behavior is different from the create_schema command that
creates the tables based on the most recent version.
An example of upgrading to the most recent table versions:
ironic-dbsync --config-file=/etc/ironic/ironic.conf upgradeNote
This command is the default if no command is given to ironic-dbsync.
Warning
The upgrade command is not compatible with SQLite databases since it uses ALTER TABLE commands to upgrade the database tables. SQLite supports only a limited subset of ALTER TABLE.
version
version
-h, --help
Show help for version and exit.
This command will output the current database version.