manila/doc/source/man/manila-manage.rst
Julia Varlamova f8408e2720 Use Alembic instead of Sqlalchemy-migrate in Manila
Alembic offers the following functionality:
- Can emit ALTER statements to a database in order to change
  the structure of tables and other constructs
- Provides a system whereby "migration scripts" may be constructed;
  each script indicates a particular series of steps that can "upgrade"
  a target database to a new version, and optionally a series of steps
  that can "downgrade" similarly, doing the same steps in reverse.
- Allows the scripts to execute in some sequential manner.

1. Add Alembic migrations support.
2. Move 001_manila_init.py migration to
manila/db/sqlalchemy/alembic/versions/162a3e673105_manila_init.py.
3. Remove manila/db/sqlalchemy/migrate_repo directory.
4. Fix unit tests.
5. Add ability to runtime updrade/downgrade db.

Implements bp alembic-instead-of-sqlalchemy-migrate

Change-Id: Iadc0d9596e826323ba19bd25be741c401b90b688
2014-08-26 17:12:57 +04:00

141 lines
2.7 KiB
ReStructuredText

=============
manila-manage
=============
-------------------------------------
control and manage shared filesystems
-------------------------------------
:Author: openstack@lists.launchpad.net
:Date: 2014-06-11
:Copyright: OpenStack LLC
:Version: 2014.2
:Manual section: 1
:Manual group: shared filesystems
SYNOPSIS
========
manila-manage <category> <action> [<args>]
DESCRIPTION
===========
manila-manage controls shared filesystems service.
More information about OpenStack Manila is at https://wiki.openstack.org/wiki/Manila
OPTIONS
=======
The standard pattern for executing a manila-manage command is:
``manila-manage <category> <command> [<args>]``
For example, to obtain a list of all hosts:
``manila-manage host list``
Run without arguments to see a list of available command categories:
``manila-manage``
Categories are shell, logs, service, db, host, version and config. Detailed descriptions are below.
These sections describe the available categories and arguments for manila-manage.
Manila Db
~~~~~~~~~
``manila-manage db version``
Print the current database version.
``manila-manage db sync``
Sync the database up to the most recent version. This is the standard way to create the db as well.
``manila-manage db downgrade <version>``
Downgrade database to given version.
``manila-manage db stamp <version>``
Stamp database with given revision.
``manila-manage db revision <message> <authogenerate>``
Generate new migration.
Manila Logs
~~~~~~~~~~~
``manila-manage logs errors``
Displays manila errors from log files.
``manila-manage logs syslog <number>``
Displays manila alerts from syslog.
Manila Shell
~~~~~~~~~~~~
``manila-manage shell bpython``
Starts a new bpython shell.
``manila-manage shell ipython``
Starts a new ipython shell.
``manila-manage shell python``
Starts a new python shell.
``manila-manage shell run``
Starts a new shell using python.
``manila-manage shell script <path/scriptname>``
Runs the named script from the specified path with flags set.
Manila Host
~~~~~~~~~~~
``manila-manage host list``
Returns list of running manila hosts.
Manila Config
~~~~~~~~~~~~~
``manila-manage config list``
Returns list of currently set config options and its values.
Manila Service
~~~~~~~~~~~~~~
``manila-manage service list``
Returns list of manila services.
Manila Version
~~~~~~~~~~~~~~
``manila-manage version list``
Returns list of versions.
FILES
=====
The manila-manage.conf file contains configuration information in the form of python-gflags.
BUGS
====
* Manila is sourced in Launchpad so you can view current bugs at `OpenStack Manila <https://bugs.launchpad.net/manila>`__