openstack/glance
Code Issues Proposed changes

doc: Clean up unnecessary left vertical lines

Browse Source 
In HTML documents with openstackdocstheme, vertical lines are shown
at the left side for literal blocks. Indented blocks are considered
as literal blocks in ReST text.
Unnecessary indented blocks are found in the glance document and
it leads to blocks with unexpected vertical left lines and
sometimes with unexpected fonts like [1].
Unexpected literal blocks are cleanup.

This commit also converts Definition lists in user/formats.rst and
user/common-image-properties.rst into the proper way in ReST text.

[1] https://docs.openstack.org/glance/latest/user/formats.html#container-format

Change-Id: I1b026f919bb22a59d23e3bb93bb7919d202a62fc
This commit is contained in:
Akihiro Motoki 2019-09-18 14:21:31 +09:00
parent 0eacf2da18
commit b6ceda28a4
15 changed files with 126 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/admin/interoperable-image-import.rst
View File

@ -421,13 +421,13 @@ required.
You will need to configure 'glance-image-import.conf' file as shown below:
.. code-block:: ini
.. code-block:: ini
[image_import_opts]
image_import_plugins = ['image_conversion']
[image_import_opts]
image_import_plugins = ['image_conversion']
[image_conversion]
output_format = raw
[image_conversion]
output_format = raw
.. note::

4
doc/source/admin/policies.rst
View File

@ -177,7 +177,7 @@ Examples
Example 1. (The default policy configuration)
::
::
{
"default": ""
@ -188,7 +188,7 @@ Glance API are callable by anyone.
Example 2. Disallow modification calls to non-admins
::
::
{
"default": "",

10
doc/source/admin/property-protections.rst
View File

@ -66,7 +66,7 @@ will not start**
The path to the file should be specified in the ``[DEFAULT]`` section of
``glance-api.conf`` as follows.
::
::
property_protection_file=/path/to/file
@ -77,7 +77,7 @@ The file may use either roles or policies to describe the property protections.
The config value should be specified in the ``[DEFAULT]`` section of
``glance-api.conf`` as follows.
::
::
property_protection_rule_format=<roles|policies>
@ -116,7 +116,7 @@ Examples
**Example 1**. Limit all property interactions to admin only.
::
::
[.*]
create = admin
@ -128,7 +128,7 @@ Examples
and modify properties prefixed with ``x_billing_code_``. Allow admins to
read and modify any properties.
::
::
[^x_billing_code_.*]
create = admin,billing
@ -145,7 +145,7 @@ read and modify any properties.
**Example 3**. Limit all property interactions to admin only using policy
rule context_is_admin defined in policy.json.
::
::
[.*]
create = context_is_admin

4
doc/source/cli/glancescrubber.rst
View File

@ -121,8 +121,8 @@ OPTIONS
The inverse of --daemon. Runs the scrub operation once and
then exits. This is the default.
**--restore <IMAGE_ID>**
Restore the specified image status from 'pending_delete' to 'active'.
**--restore <IMAGE_ID>**
Restore the specified image status from 'pending_delete' to 'active'.
FILES
=====

6
doc/source/configuration/configuring.rst
View File

@ -1343,9 +1343,7 @@ this registry server operates. These configuration options are specified in the
with the glance-api service when clients are using the v1 REST API. See
`Configuring Glance APIs`_ for more info.
``sql_connection=CONNECTION_STRING`` (``--sql-connection`` when specified
on command line)
``sql_connection=CONNECTION_STRING``
Optional. Default: ``None``
Can be specified in configuration files. Can also be specified on the
@ -1356,6 +1354,8 @@ on command line)
`SQLAlchemy connection strings <http://docs.sqlalchemy.org/en/latest/core/connections.html>`_
online. You must urlencode any special characters in CONNECTION_STRING.
Use ``--sql-connection`` when specified on command line.
``sql_timeout=SECONDS``
Optional. Default: ``3600``

52
doc/source/contributor/database_architecture.rst
View File

@ -50,12 +50,13 @@ Image basic methods
*image_id* with the values listed in the *values* dictionary. Returns a
dictionary representation of the updated *Image* object.
Optional parameters are:
- ``purge_props`` — a flag indicating that all the existing
properties not listed in the *values['properties']* should be
deleted;
- ``from_state`` — a string filter indicating that the updated
image must be in the specified state.
Optional parameters are:
- ``purge_props`` — a flag indicating that all the existing
properties not listed in the *values['properties']* should be
deleted;
- ``from_state`` — a string filter indicating that the updated
image must be in the specified state.
#. ``image_destroy(context, image_id)`` — deletes all database
records of an image with the identifier *image_id* (like tags,
@ -71,25 +72,26 @@ Image basic methods
is_public=None, admin_as_user=False, return_tag=False)`` — gets
all the images that match zero or more filters.
Optional parameters are:
- ``filters`` — dictionary of filter keys and values. If a 'properties'
key is present, it is treated as a dictionary of key/value filters in
the attribute of the image properties.
- ``marker`` — image id after which a page should start.
- ``limit`` — maximum number of images to return.
- ``sort_key`` — list of image attributes by which results should
be sorted.
- ``sort_dir`` — direction in which results should be sorted
(asc, desc).
- ``member_status`` — only returns shared images that have this
membership status.
- ``is_public`` — if true, returns only public images. If false,
returns only private and shared images.
- ``admin_as_user`` — for backwards compatibility. If true, an admin
sees the same set of images that would be seen by a regular user.
- ``return_tag`` — indicates whether an image entry in the result
includes its relevant tag entries. This can improve upper-layer
query performance and avoid using separate calls.
Optional parameters are:
- ``filters`` — dictionary of filter keys and values. If a 'properties'
key is present, it is treated as a dictionary of key/value filters in
the attribute of the image properties.
- ``marker`` — image id after which a page should start.
- ``limit`` — maximum number of images to return.
- ``sort_key`` — list of image attributes by which results should
be sorted.
- ``sort_dir`` — direction in which results should be sorted
(asc, desc).
- ``member_status`` — only returns shared images that have this
membership status.
- ``is_public`` — if true, returns only public images. If false,
returns only private and shared images.
- ``admin_as_user`` — for backwards compatibility. If true, an admin
sees the same set of images that would be seen by a regular user.
- ``return_tag`` — indicates whether an image entry in the result
includes its relevant tag entries. This can improve upper-layer
query performance and avoid using separate calls.
Image location methods
----------------------

2
doc/source/contributor/database_migrations.rst
View File

@ -334,7 +334,7 @@ NOTES
pass
A no-op migrate script:
A no-op migrate script:
.. code::

55
doc/source/user/common-image-properties.rst
View File

@ -25,44 +25,29 @@ This document explains the names of these properties and the expected values.
The common image properties are also described in a JSON schema, found in
/etc/glance/schema-image.json in the Glance source code.
**architecture**
----------------
architecture
Operating system architecture as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
Operating system architecture as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
instance_uuid
Metadata which can be used to record which instance this image is associated
with. (Informational only, does not create an instance snapshot.)
kernel_id
The ID of image stored in Glance that should be used as the kernel when
booting an AMI-style image.
**instance_uuid**
-----------------
ramdisk_id
The ID of image stored in Glance that should be used as the ramdisk when
booting an AMI-style image.
Metadata which can be used to record which instance this image is associated
with. (Informational only, does not create an instance snapshot.)
os_distro
The common name of the operating system distribution as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
**kernel_id**
-------------
os_version
The operating system version as specified by the distributor.
The ID of image stored in Glance that should be used as the kernel when booting
an AMI-style image.
**ramdisk_id**
--------------
The ID of image stored in Glance that should be used as the ramdisk when
booting an AMI-style image.
**os_distro**
-------------
The common name of the operating system distribution as specified in
https://docs.openstack.org/python-glanceclient/latest/cli/property-keys.html
**os_version**
--------------
The operating system version as specified by the distributor.
**description**
---------------
A brief human-readable string, suitable for display in a user interface,
describing the image.
description
A brief human-readable string, suitable for display in a user interface,
describing the image.

75
doc/source/user/formats.rst
View File

@ -34,8 +34,7 @@ the information contained in a virtual machine disk image.
You can set your image's disk format to one of the following:
* **raw**
raw
This is an unstructured disk image format.
The ``raw`` image format is the simplest one, and is natively supported by
@ -43,44 +42,37 @@ You can set your image's disk format to one of the following:
bit-equivalent of a block device file, created as if somebody had copied,
say, ``/dev/sda`` to a file using the :command:`dd` command.
* **vhd**
vhd
This is the VHD (Virtual Hard Disk) disk format, a common disk format used by
virtual machine monitors from VMware, Xen, Microsoft, VirtualBox, and others.
* **vhdx**
vhdx
This is the `VHDX
<http://technet.microsoft.com/en-us/library/hh831446.aspx>`_ format, an
enhanced version of the ``vhd`` format. It has support for larger disk sizes
and protection against data corruption during power failures.
* **vmdk**
vmdk
The
`VMDK <https://developercenter.vmware.com/web/sdk/60/vddk>`_
(Virtual Machine Disk) format is supported by many common virtual machine
monitors, for example the VMware ESXi hypervisor.
* **vdi**
vdi
The `VDI <https://forums.virtualbox.org/viewtopic.php?t=8046>`_
(Virtual Disk Image) format for image files is supported by the VirtualBox
virtual machine monitor and the QEMU emulator.
* **iso**
iso
The `ISO
<http://www.ecma-international.org/publications/standards/Ecma-119.htm>`_
format is a disk image formatted with the read-only ISO 9660 (also known
as ECMA-119) filesystem commonly used for CDs and DVDs.
* **ploop**
ploop
A disk format supported and used by Virtuozzo to run OS Containers.
* **qcow2**
qcow2
The `QCOW2 <http://en.wikibooks.org/wiki/QEMU/Images>`_
(QEMU copy-on-write version 2) format is commonly used with the
KVM hypervisor. It uses a sparse representation, so the image size
@ -93,20 +85,17 @@ format was the initial image format supported by Amazon EC2.
The image consists of three files, each of which has its own specific
``disk_format`` identifier:
* **aki**
aki
This indicates what is stored in Glance is an Amazon Kernel Image (AKI).
It is a kernel file that the hypervisor will load initially to boot the
image. For a Linux machine, this would be a ``vmlinuz`` file.
* **ari**
ari
This indicates what is stored in Glance is an Amazon Ramdisk Image (ARI).
It is an optional ramdisk file mounted at boot time.
For a Linux machine, this would be an ``initrd`` file.
* **ami**
ami
This indicates what is stored in Glance is an Amazon Machine Image (AMI).
It is a virtual machine image in raw format.
@ -129,47 +118,39 @@ Note the following:
You can set your image's container format to one of the following:
* **bare**
bare
This indicates there is no container or metadata envelope for the image.
* **ovf**
ovf
`OVF <http://dmtf.org/sites/default/files/OVF_Overview_Document_2010.pdf>`_
(Open Virtualization Format) is a packaging format for virtual machines,
defined by the Distributed Management Task Force (DMTF) standards group.
An OVF package contains one or more image files, a ``.ovf`` XML metadata file
that contains information about the virtual machine, and possibly other
files as well.
`OVF <http://dmtf.org/sites/default/files/OVF_Overview_Document_2010.pdf>`_
(Open Virtualization Format) is a packaging format for virtual machines,
defined by the Distributed Management Task Force (DMTF) standards group.
An OVF package contains one or more image files, a ``.ovf`` XML metadata file
that contains information about the virtual machine, and possibly other
files as well.
An OVF package can be distributed in different ways. For example,
it could be distributed as a set of discrete files, or as a tar archive
file with an ``.ova`` (open virtual appliance/application) extension.
* **aki**
An OVF package can be distributed in different ways. For example,
it could be distributed as a set of discrete files, or as a tar archive
file with an ``.ova`` (open virtual appliance/application) extension.
aki
This indicates what is stored in Glance is an Amazon kernel image.
* **ari**
ari
This indicates what is stored in Glance is an Amazon ramdisk image.
* **ami**
ami
This indicates what is stored in Glance is an Amazon machine image.
* **ova**
ova
This indicates what is stored in Glance is an OVA tar archive file,
that is, an OVF package contained in a single tar archive file.
* **docker**
docker
This indicates what is stored in Glance is a Docker tar archive of
the container filesystem.
* **compressed**
compressed
The exact format of the compressed file is not specified. It is the
responsibility of the consuming service to analyze the data payload
and determine the specific compression format. A particular

4
doc/source/user/glanceapi.rst
View File

@ -432,8 +432,8 @@ We have created a new virtual machine image in some way (created a
"golden image" or snapshotted/backed up an existing image) and we
wish to do two things:
* Store the disk image data in Glance
* Store metadata about this image in Glance
* Store the disk image data in Glance
* Store metadata about this image in Glance
We can do the above two activities in a single call to the Glance API.
Assuming, like in the examples above, that a Glance API server is running

12
doc/source/user/signature.rst
View File

@ -103,12 +103,12 @@ Current ones you can use are:
* DSA
* ECC-CURVES
* SECT571K1
* SECT409K1
* SECT571R1
* SECT409R1
* SECP521R1
* SECP384R1
* SECT571K1
* SECT409K1
* SECT571R1
* SECT409R1
* SECP521R1
* SECP384R1
.. Note:: ECC curves - Only keysizes above 384 are included.
Not all ECC curves may be supported by the back end.

13
glance/common/auth.py
View File

@ -18,15 +18,18 @@ This auth module is intended to allow OpenStack client-tools to select from a
variety of authentication strategies, including NoAuth (the default), and
Keystone (an identity management system).
> auth_plugin = AuthPlugin(creds)
::
> auth_plugin.authenticate()
> auth_plugin = AuthPlugin(creds)
> auth_plugin.auth_token
> auth_plugin.authenticate()
> auth_plugin.auth_token
abcdefg
> auth_plugin.management_url
http://service_endpoint/
> auth_plugin.management_url
http://service_endpoint/
"""
import httplib2
from keystoneauth1.access import service_catalog as ks_service_catalog

2
glance/common/client.py
View File

@ -291,7 +291,7 @@ class BaseClient(object):
"""
Setups the connection based on the given url.
The form is:
The form is::
<http|https>://<host>:port/doc_root
"""

11
glance/image_cache/__init__.py
View File

@ -50,11 +50,12 @@ The essential functions of a driver are defined in the base class
and prospective) must implement this interface. Currently available drivers
are ``sqlite`` and ``xattr``. These drivers primarily differ in the way they
store the information about cached images:
* The ``sqlite`` driver uses a sqlite database (which sits on every glance
node locally) to track the usage of cached images.
* The ``xattr`` driver uses the extended attributes of files to store this
information. It also requires a filesystem that sets ``atime`` on the files
when accessed.
* The ``sqlite`` driver uses a sqlite database (which sits on every glance
node locally) to track the usage of cached images.
* The ``xattr`` driver uses the extended attributes of files to store this
information. It also requires a filesystem that sets ``atime`` on the files
when accessed.
Possible values:
* sqlite

18
glance/notifier.py
View File

@ -61,14 +61,16 @@ prefix to disable all event notifications within a group.
Possible values:
A comma-separated list of individual notification types or
notification groups to be disabled. Currently supported groups:
* image
* image.member
* task
* metadef_namespace
* metadef_object
* metadef_property
* metadef_resource_type
* metadef_tag
* image
* image.member
* task
* metadef_namespace
* metadef_object
* metadef_property
* metadef_resource_type
* metadef_tag
For a complete listing and description of each event refer to:
http://docs.openstack.org/developer/glance/notifications.html