This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches
This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The man pages listed version and dates that are out of date. This
patch bumps the dates and version to Pike specific values. It also
moves the common metadata of each man page to a header file.
Change-Id: I5e0c57d893b8e93a0a25d1809f81ad28eca401e3
Partially reverts I6d67e7a40e16468bb7bf4ac742361fb44eec4e28 to
restore the source files for the man pages. These are used by
some packagers (confirmed that this is the case for Ubuntu) to
generate the man pages included in their distributions.
Does not add the man pages back to the HTML index, so these will
be orphans for now. A follow up patch will either add a man build
to tox, or add the HTML generation back so we can review generated
content.
Long term fix will be to merge the content of the --help text
in the cmd files with the content of the man pages and figure
out how to generate the man pages from the --help text. Right
now, the --help text is better in some regards, and the man pages
are better in others.
Change-Id: I2aa85b63a196c75224630981b322fecbf36f1b7c
1. Deletes man pages
2. Deletes indices section
3. Moves the contributor section up to the top
Change-Id: I6d67e7a40e16468bb7bf4ac742361fb44eec4e28
Implements: blueprint overhaul-glance-docs
The parent of this patch introduced the change to Alembic-based
migrations. This commit builds on top of that by adding expand,
migrate and contract commands to the glance-manage tool.
Appropriate documentation is updated and failing tests are adjusted
to accomodate the new database versioning schema.
Data migrations are expected to be run in the background with older
Glance services being active during the upgrade process.
Partially-Implements: blueprint database-strategy-for-rolling-upgrades
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
Change-Id: Ie839e0f240436dce7b151de5b464373516ff5a64
Depends-On: I77921366a05ba6f9841143af89c1f4059d8454c6
This change proposes the use of Alembic to manage Glance migrations.
* Introduce new directory ``alembic_migrations`` under
``glance/db/sqlalchemy``. This directory is the home for all glance
migrations henceforth. All the migration scripts reside under
``versions`` directory.
* All the migrations up to Liberty are consolidated into one migration
called ``liberty_initial`` as those migrations are not supported
any more. Mitaka migrations are retained but under a different naming
convention.
* All the glance manage db commands are changed appropriately. They now
use alembic to perform operations such as ``version``, ``upgrade``,
``sync`` and ``version_control``.
* The database versions are not numerical any more. They are the revision
ID of the last migration applied on the database. Since we don't
support migrations before Mitaka, the Liberty version ``42`` will now
appear as ``liberty``. Migration ``43`` and ``44`` in Mitaka appear as
``mitaka01`` and ``mitaka02`` respectively.
* When one performs a ``sync`` or ``upgrade`` command, the database is
first stamped with an equivalent alembic version before upgrading.
* The older migration scripts are retained so that users can correlate
with the new migrations. Also, it is probably safe to retain them until
the alembic migrations become stable. Similarly, the ``migrate_version``
table is not removed yet.
Partially-Implements: blueprint alembic-migrations
Change-Id: Ie8594ff339a13bf190aefa308f54e97ee20ecfa2
Co-Authored-By: Alexander Bashmakov <alexander.bashmakov@intel.com>
Depends-On: I1596499529af249bc48dfe859bbd31e90c48a5e0
The bug in [1] proposed to always require a directory option for
glance-manage db_export_metadefs command. The rationale being that
silently overwriting the default path /etc/glance/metadefs can
be undesired. However, the feedback was that this command should
stay silent in case it's called from cron jobs or automated tasks,
and that it's better to simply log a warning and proceed, as well
as update the documentation with a cautionary note. This patch
addresses that request.
[1] https://bugs.launchpad.net/glance/+bug/1367011
Change-Id: Ie8cc4bb3769a6347fd25e2235a72c6358af70d42
Closes-Bug: #1367011
As downgrade are not supported after Kilo, we should remove them now.
Roll backs can be performed as mentioned in the below link:
http://docs.openstack.org/ops-guide/ops-upgrades.html#rolling-back-a-failed-upgrade
The DB downgrades were deprecated in Glance Mitaka release by commit
e3366afdfb.
Change-Id: I937d15d93f16a3e44a50e6ff1a469098eab67c79
Implements: blueprint remove-db-downgrade
The man pages listed version and dates that are out of date. This
patch bumps the dates and version to Newton specific values.
Change-Id: If5da432cbd21a1940ee960d5def5a26fc18d31ad
Use oslo_config.sphinxext to automatically document the available
configuration options in the sphinx documentation.
See https://etherpad.openstack.org/p/automating-oslo-config-documentation
for work to implement this to each project. Glance is one of the first
six projects for a consolidated operators configuration reference.
Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b
Indenting the include directives for the snippet files means the
headings in those files are "under" or "inside" the sections defined by
the headings in the parent file, but that's not something rst supports.
Change-Id: I70cb5b7f4d5051595a8e057ecf3b23a372ee21ca
Currently the documentation of glance-manage is missing the commands
to handle the glance metadata defnition. This patch provides details
on following commands:
db_load_metadefs
db_unload_metadefs
db_export_metadefs
Closes-Bug: #1414725
Change-Id: I90865831d38478f76e7379ca447ed99c17387710
As specified in the blueprint, we are only going to set log_file in the
configuration file for now, and we read it last in glance.cmd.manage.
This allows glance-manage to use the appropriate log-file and still
retain the settings it needs in glance-api.conf and glance-registry.conf
DocImpact
Change-Id: I87595a29634e6ffda4e1581d42a92dfe6f84044b
Implements: blueprint create-glance-manage-conf
Closes-bug: #1391211
Finish updating the glance manpages:
- Update and modernize all files and references
- Add a new manpage for glance-replicator
- Move the common configuration options to common files for
easier maintenance and less redundancy
Change-Id: If2cbcc30f2761b187038f39324c7698de4eb2ab9
Closes-Bug: #1238366
nova-manage supports subcommands of db, for nova-manage,
eg) 'nova-manage db sync',
glance manage however has individual commands like db_sync, db_version
etc. This patch aims at adding the db operations as subcommands to db in
glance-manage similar to nova and refactoring this bit of code in
cmd/manage.py
Fixes: bug 1213197
Change-Id: I6fad31766bc1cec2a666a7ebc8df5c732007c5f1
These are some text fixes in document, scripts and functions,
including variable usage, text aligning, adding new store class in
document
Change-Id: I98e226969d86698972870a7b3a042cb00c2206e9
The usage message for glance-cache-manage lists "clean" as an available
command, but this functionality is part of a separate tool,
glance-cache-cleaner.
Remove any references to this to avoid confusion.
DocImpact
Fixes bug 1189451
Change-Id: I2aba8164ab9ef0c3bef31870cb3771233a722d27
* bin/glance-cache-queue-image duplicates functionality provided by
bin/ glance-cache-manage, and it is currently broken. Let's just remove it.
Change-Id: Ib18be2116055154047df6ca9b4c335323c8b2dde
* Rewords how we refer to to our 'reference' implementation of the registry
API. glance-registry is an implementation detail of the main glance API, not
an example of a community-driven API spec
* Remove duplicate 'gettingstarted' information
* Fixes bug 954554
Change-Id: I889f61a399c398897f2146b756b2c3c310847718
Fix for bug 936798. Allow a client to select which
region endpoint they want from the service catalogue.
The region can be set via the environment variable
OS_REGION_NAME or via the '-R/--region' command line
option.
If a single image endpoint is returned from keystone,
the client will use that even if no region was specified
(the default). Where multiple endpoints exist a region
must be provided.
Change-Id: I6797f8ddf88d5875caf194913082c3fe24c86585
Fix for bug 929591.
Change glance to require server certificate validation
by default when using https. The standard system
CA file will be used if available (and an alternative was not
provided).
The --insecure option can be used by clients to skip server
certificate validation if appropriate.
* This change will impact Nova clients accessing glance over https.
If the standard CA file is not suitable they will need to provide
a CA file or else create an 'insecure' glance client.
* Accesses to a https registry server must now perform server
certificate validation.
* If the package which provides the standard
system CA file is installed then that file will be used by default.
It probably makes sense for the glance package to have a
dependency on whichever package provides the default CA bundle.
(In Ubuntu this is 'ca-certificates')
Change-Id: I7c83361ba0881559ec77d4baf10dfeb5b8e32185
A few man pages were already in place. This patch uses the --help
output from each executable to seed a man page for the rest of the
executables, which include:
- glance
- glance-cache-cleaner
- glance-cache-manage
- glance-cache-prefetcher
- glance-cache-pruner
- glance-cache-queue-image
- glance-control
- glance-scrubber
Fixes bug 911291.
Change-Id: Ie0de990ff6617e7eb953f270a089c99bc340b4fe
Doug Hellmann