Browse Source
This patch adds a new command ironic-inspector-dbsync which can be used to sync the ironic inspector database using alembic migrations. It adds a migration to match the current required db schema. Change-Id: I21188b3f5003c8ab43d82903473e2a6ef7f755a0 Closes-Bug: #1495620changes/65/223665/8
Sam Betts
7 years ago
12 changed files with 447 additions and 3 deletions
@ -0,0 +1,38 @@
|
||||
[alembic] |
||||
# path to migration scripts |
||||
script_location = %(here)s/migrations |
||||
|
||||
# Logging configuration |
||||
[loggers] |
||||
keys = root,sqlalchemy,alembic |
||||
|
||||
[handlers] |
||||
keys = console |
||||
|
||||
[formatters] |
||||
keys = generic |
||||
|
||||
[logger_root] |
||||
level = WARN |
||||
handlers = console |
||||
qualname = |
||||
|
||||
[logger_sqlalchemy] |
||||
level = WARN |
||||
handlers = |
||||
qualname = sqlalchemy.engine |
||||
|
||||
[logger_alembic] |
||||
level = INFO |
||||
handlers = |
||||
qualname = alembic |
||||
|
||||
[handler_console] |
||||
class = StreamHandler |
||||
args = (sys.stderr,) |
||||
level = NOTSET |
||||
formatter = generic |
||||
|
||||
[formatter_generic] |
||||
format = %(levelname)-5.5s [%(name)s] %(message)s |
||||
datefmt = %H:%M:%S |
||||
@ -0,0 +1,90 @@
|
||||
# Copyright 2015 Cisco Systems |
||||
# All Rights Reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
import os |
||||
import six |
||||
import sys |
||||
|
||||
from alembic import command as alembic_command |
||||
from alembic import config as alembic_config |
||||
from alembic import util as alembic_util |
||||
|
||||
from oslo_config import cfg |
||||
from oslo_db import options as db_opts |
||||
from oslo_log import log |
||||
|
||||
from ironic_inspector import conf # noqa |
||||
|
||||
CONF = cfg.CONF |
||||
db_opts.set_defaults(CONF) |
||||
|
||||
|
||||
def add_alembic_command(subparsers, name): |
||||
return subparsers.add_parser( |
||||
name, help=getattr(alembic_command, name).__doc__) |
||||
|
||||
|
||||
def add_command_parsers(subparsers): |
||||
for name in ['current', 'history', 'branches', 'heads']: |
||||
parser = add_alembic_command(subparsers, name) |
||||
parser.set_defaults(func=do_alembic_command) |
||||
|
||||
for name in ['downgrade', 'stamp', 'show', 'edit']: |
||||
parser = add_alembic_command(subparsers, name) |
||||
parser.set_defaults(func=with_revision) |
||||
parser.add_argument('--revision', nargs='?', required=True) |
||||
|
||||
parser = add_alembic_command(subparsers, 'upgrade') |
||||
parser.set_defaults(func=with_revision) |
||||
parser.add_argument('--revision', nargs='?') |
||||
|
||||
parser = add_alembic_command(subparsers, 'revision') |
||||
parser.set_defaults(func=do_revision) |
||||
parser.add_argument('-m', '--message') |
||||
|
||||
|
||||
command_opt = cfg.SubCommandOpt('command', |
||||
title='Command', |
||||
help='Available commands', |
||||
handler=add_command_parsers) |
||||
|
||||
CONF.register_cli_opt(command_opt) |
||||
|
||||
|
||||
def do_revision(config, cmd, *args, **kwargs): |
||||
do_alembic_command(config, cmd, message=CONF.command.message) |
||||
|
||||
|
||||
def with_revision(config, cmd, *args, **kwargs): |
||||
revision = CONF.command.revision or 'head' |
||||
do_alembic_command(config, cmd, revision) |
||||
|
||||
|
||||
def do_alembic_command(config, cmd, *args, **kwargs): |
||||
try: |
||||
getattr(alembic_command, cmd)(config, *args, **kwargs) |
||||
except alembic_util.CommandError as e: |
||||
alembic_util.err(six.text_type(e)) |
||||
|
||||
|
||||
def main(args=sys.argv[1:]): |
||||
log.register_options(CONF) |
||||
CONF(args, project='ironic-inspector') |
||||
config = alembic_config.Config(os.path.join(os.path.dirname(__file__), |
||||
'alembic.ini')) |
||||
config.set_main_option('script_location', "ironic_inspector:migrations") |
||||
config.ironic_inspector_config = CONF |
||||
|
||||
CONF.command.func(config, CONF.command.name) |
||||
@ -0,0 +1,82 @@
|
||||
# Copyright 2015 Cisco Systems |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
from alembic import context |
||||
from logging.config import fileConfig |
||||
from sqlalchemy import create_engine |
||||
|
||||
# this is the Alembic Config object, which provides |
||||
# access to the values within the .ini file in use. |
||||
config = context.config |
||||
ironic_inspector_config = config.ironic_inspector_config |
||||
|
||||
# Interpret the config file for Python logging. |
||||
# This line sets up loggers basically. |
||||
fileConfig(config.config_file_name) |
||||
|
||||
# add your model's MetaData object here |
||||
# for 'autogenerate' support |
||||
# from myapp import mymodel |
||||
# target_metadata = mymodel.Base.metadata |
||||
from ironic_inspector import db |
||||
target_metadata = db.Base.metadata |
||||
|
||||
# other values from the config, defined by the needs of env.py, |
||||
# can be acquired: |
||||
# my_important_option = config.get_main_option("my_important_option") |
||||
# ... etc. |
||||
|
||||
|
||||
def run_migrations_offline(): |
||||
"""Run migrations in 'offline' mode. |
||||
|
||||
This configures the context with just a URL |
||||
and not an Engine, though an Engine is acceptable |
||||
here as well. By skipping the Engine creation |
||||
we don't even need a DBAPI to be available. |
||||
|
||||
Calls to context.execute() here emit the given string to the |
||||
script output. |
||||
|
||||
""" |
||||
url = ironic_inspector_config.database.connection |
||||
context.configure( |
||||
url=url, target_metadata=target_metadata, literal_binds=True) |
||||
|
||||
with context.begin_transaction(): |
||||
context.run_migrations() |
||||
|
||||
|
||||
def run_migrations_online(): |
||||
"""Run migrations in 'online' mode. |
||||
|
||||
In this scenario we need to create an Engine |
||||
and associate a connection with the context. |
||||
|
||||
""" |
||||
connectable = create_engine(ironic_inspector_config.database.connection) |
||||
|
||||
with connectable.connect() as connection: |
||||
context.configure( |
||||
connection=connection, |
||||
target_metadata=target_metadata |
||||
) |
||||
|
||||
with context.begin_transaction(): |
||||
context.run_migrations() |
||||
|
||||
if context.is_offline_mode(): |
||||
run_migrations_offline() |
||||
else: |
||||
run_migrations_online() |
||||
@ -0,0 +1,36 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
"""${message} |
||||
|
||||
Revision ID: ${up_revision} |
||||
Revises: ${down_revision | comma,n} |
||||
Create Date: ${create_date} |
||||
|
||||
""" |
||||
|
||||
# revision identifiers, used by Alembic. |
||||
revision = ${repr(up_revision)} |
||||
down_revision = ${repr(down_revision)} |
||||
branch_labels = ${repr(branch_labels)} |
||||
depends_on = ${repr(depends_on)} |
||||
|
||||
from alembic import op |
||||
import sqlalchemy as sa |
||||
${imports if imports else ""} |
||||
|
||||
def upgrade(): |
||||
${upgrades if upgrades else "pass"} |
||||
|
||||
|
||||
def downgrade(): |
||||
${downgrades if downgrades else "pass"} |
||||
@ -0,0 +1,63 @@
|
||||
# Copyright 2015 Cisco Systems, Inc. |
||||
# All rights reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
# |
||||
|
||||
"""inital_db_schema |
||||
|
||||
Revision ID: 578f84f38d |
||||
Revises: |
||||
Create Date: 2015-09-15 14:52:22.448944 |
||||
|
||||
""" |
||||
|
||||
# revision identifiers, used by Alembic. |
||||
revision = '578f84f38d' |
||||
down_revision = None |
||||
branch_labels = None |
||||
depends_on = None |
||||
|
||||
from alembic import op |
||||
import sqlalchemy as sa |
||||
|
||||
|
||||
def upgrade(): |
||||
op.create_table( |
||||
'nodes', |
||||
sa.Column('uuid', sa.String(36), primary_key=True), |
||||
sa.Column('started_at', sa.Float, nullable=True), |
||||
sa.Column('finished_at', sa.Float, nullable=True), |
||||
sa.Column('error', sa.Text, nullable=True) |
||||
) |
||||
|
||||
op.create_table( |
||||
'attributes', |
||||
sa.Column('name', sa.Text, primary_key=True), |
||||
sa.Column('value', sa.Text, primary_key=True), |
||||
sa.Column('uuid', sa.String(36), sa.ForeignKey('nodes.uuid')) |
||||
) |
||||
|
||||
op.create_table( |
||||
'options', |
||||
sa.Column('uuid', sa.String(36), sa.ForeignKey('nodes.uuid'), |
||||
primary_key=True), |
||||
sa.Column('name', sa.Text, primary_key=True), |
||||
sa.Column('value', sa.Text) |
||||
) |
||||
|
||||
|
||||
def downgrade(): |
||||
op.drop_table('nodes') |
||||
op.drop_table('attributes') |
||||
op.drop_table('options') |
||||
@ -0,0 +1,64 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
"""Add Rules |
||||
|
||||
Revision ID: d588418040d |
||||
Revises: 578f84f38d |
||||
Create Date: 2015-09-21 14:31:03.048455 |
||||
|
||||
""" |
||||
|
||||
# revision identifiers, used by Alembic. |
||||
revision = 'd588418040d' |
||||
down_revision = '578f84f38d' |
||||
branch_labels = None |
||||
depends_on = None |
||||
|
||||
from alembic import op |
||||
import sqlalchemy as sa |
||||
|
||||
from oslo_db.sqlalchemy import types |
||||
|
||||
|
||||
def upgrade(): |
||||
op.create_table( |
||||
'rules', |
||||
sa.Column('uuid', sa.String(36), primary_key=True), |
||||
sa.Column('created_at', sa.DateTime, nullable=False), |
||||
sa.Column('description', sa.Text), |
||||
sa.Column('disabled', sa.Boolean, default=False), |
||||
) |
||||
|
||||
op.create_table( |
||||
'rule_conditions', |
||||
sa.Column('id', sa.Integer, primary_key=True), |
||||
sa.Column('rule', sa.String(36), sa.ForeignKey('rules.uuid')), |
||||
sa.Column('op', sa.String(255), nullable=False), |
||||
sa.Column('multiple', sa.String(255), nullable=False), |
||||
sa.Column('field', sa.Text), |
||||
sa.Column('params', types.JsonEncodedDict) |
||||
) |
||||
|
||||
op.create_table( |
||||
'rule_actions', |
||||
sa.Column('id', sa.Integer, primary_key=True), |
||||
sa.Column('rule', sa.String(36), sa.ForeignKey('rules.uuid')), |
||||
sa.Column('action', sa.String(255), nullable=False), |
||||
sa.Column('params', types.JsonEncodedDict) |
||||
) |
||||
|
||||
|
||||
def downgrade(): |
||||
op.drop_table('rules') |
||||
op.drop_table('rule_conditions') |
||||
op.drop_table('rule_actions') |
||||
Loading…
Reference in new issue