3cd2ebd375
On offline upgrades, due to the rolling upgrade mechanism we need to restart the cinder services twice to complete the upgrade, just like in the rolling upgrade case. The current offline upgrade process is: - Stop cinder services - Upgrade the cinder nodes - Sync your DB - Start the cinder services - Restart all the cinder services This second restart creates a bad user experience and it should not be necessary on an offline upgrade, so this patch adds a new optional parameter -called "--bump-versions"- to the cinder-manage db sync command that allows us to skip the restart of the services. Closes-Bug: #1756321 Change-Id: I1b58c637f6b2187a78c9c00a6c4933335439ad6f
185 lines
5.0 KiB
ReStructuredText
185 lines
5.0 KiB
ReStructuredText
=============
|
|
cinder-manage
|
|
=============
|
|
|
|
------------------------------------------
|
|
Control and manage OpenStack block storage
|
|
------------------------------------------
|
|
|
|
:Author: openstack@lists.openstack.org
|
|
:Copyright: OpenStack Foundation
|
|
:Manual section: 1
|
|
:Manual group: cloud computing
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
cinder-manage <category> <action> [<args>]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
:command:`cinder-manage` provides control of cinder database migration,
|
|
and provides an interface to get information about the current state
|
|
of cinder.
|
|
More information about OpenStack Cinder is available at `OpenStack Cinder <https://docs.openstack.org/cinder/latest/>`_.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
The standard pattern for executing a cinder-manage command is:
|
|
``cinder-manage <category> <command> [<args>]``
|
|
|
|
For example, to obtain a list of the cinder services currently running:
|
|
``cinder-manage service list``
|
|
|
|
Run without arguments to see a list of available command categories:
|
|
``cinder-manage``
|
|
|
|
Categories are shell, logs, migrate, db, volume, host, service, backup, version, and config. Detailed descriptions are below.
|
|
|
|
You can also run with a category argument such as 'db' to see a list of all commands in that category:
|
|
``cinder-manage db``
|
|
|
|
These sections describe the available categories and arguments for cinder-manage.
|
|
|
|
Cinder Db
|
|
~~~~~~~~~
|
|
|
|
``cinder-manage db version``
|
|
|
|
Print the current database version.
|
|
|
|
``cinder-manage db sync [--bump-versions] [version]``
|
|
|
|
Sync the database up to the most recent version. This is the standard way to create the db as well.
|
|
|
|
This command interprets the following options when it is invoked:
|
|
|
|
version Database version
|
|
|
|
--bump-versions Update RPC and Objects versions when doing offline
|
|
upgrades, with this we no longer need to restart the
|
|
services twice after the upgrade to prevent ServiceTooOld
|
|
exceptions.
|
|
|
|
``cinder-manage db purge [<number of days>]``
|
|
|
|
Purge database entries that are marked as deleted, that are older than the number of days specified.
|
|
|
|
``cinder-manage db online_data_migrations``
|
|
|
|
Perform online data migrations for database upgrade between releases in batches.
|
|
|
|
This command interprets the following options when it is invoked:
|
|
|
|
--max_count Maximum number of objects to consider.
|
|
--ignore_state Force records to migrate even if another operation is
|
|
performed on them. This may be dangerous, please refer to
|
|
release notes for more information.
|
|
|
|
Cinder Logs
|
|
~~~~~~~~~~~
|
|
|
|
``cinder-manage logs errors``
|
|
|
|
Displays cinder errors from log files.
|
|
|
|
``cinder-manage logs syslog [<number>]``
|
|
|
|
Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10).
|
|
|
|
Cinder Shell
|
|
~~~~~~~~~~~~
|
|
|
|
``cinder-manage shell bpython``
|
|
|
|
Starts a new bpython shell.
|
|
|
|
``cinder-manage shell ipython``
|
|
|
|
Starts a new ipython shell.
|
|
|
|
``cinder-manage shell python``
|
|
|
|
Starts a new python shell.
|
|
|
|
``cinder-manage shell run``
|
|
|
|
Starts a new shell using python.
|
|
|
|
``cinder-manage shell script <path/scriptname>``
|
|
|
|
Runs the named script from the specified path with flags set.
|
|
|
|
Cinder Volume
|
|
~~~~~~~~~~~~~
|
|
|
|
``cinder-manage volume delete <volume_id>``
|
|
|
|
Delete a volume without first checking that the volume is available.
|
|
|
|
``cinder-manage volume update_host --currenthost <current host> --newhost <new host>``
|
|
|
|
Updates the host name of all volumes currently associated with a specified host.
|
|
|
|
Cinder Host
|
|
~~~~~~~~~~~
|
|
|
|
``cinder-manage host list [<zone>]``
|
|
|
|
Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone.
|
|
|
|
Cinder Service
|
|
~~~~~~~~~~~~~~
|
|
|
|
``cinder-manage service list``
|
|
|
|
Displays a list of all cinder services and their host, zone, status, state and when the information was last updated.
|
|
|
|
``cinder-manage service remove <service> <host>``
|
|
|
|
Removes a specified cinder service from a specified host.
|
|
|
|
Cinder Backup
|
|
~~~~~~~~~~~~~
|
|
|
|
``cinder-manage backup list``
|
|
|
|
Displays a list of all backups (including ones in progress) and the host on which the backup operation is running.
|
|
|
|
``cinder-manage backup update_backup_host --currenthost <current host> --newhost <new host>``
|
|
|
|
Updates the host name of all backups currently associated with a specified host.
|
|
|
|
Cinder Version
|
|
~~~~~~~~~~~~~~
|
|
|
|
``cinder-manage version list``
|
|
|
|
Displays the codebase version cinder is running upon.
|
|
|
|
Cinder Config
|
|
~~~~~~~~~~~~~
|
|
|
|
``cinder-manage config list [<param>]``
|
|
|
|
Displays the current configuration parameters (options) for Cinder. The optional flag parameter may be used to display the configuration of one parameter.
|
|
|
|
FILES
|
|
=====
|
|
|
|
The cinder.conf file contains configuration information in the form of python-gflags.
|
|
|
|
The cinder-manage.log file logs output from cinder-manage.
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
* `OpenStack Cinder <https://docs.openstack.org/cinder/latest/>`__
|
|
|
|
BUGS
|
|
====
|
|
|
|
* Cinder is hosted on Launchpad so you can view current bugs at `Bugs : Cinder <https://bugs.launchpad.net/cinder/>`__
|