Commit Graph

75 Commits

Author SHA1 Message Date
Erno Kuvaja
e0c5440819 Add decompression import plugin
Supported compression formats initially are:
* zip
* gzip
* lha/lzh _if_ lhafile is installed

Change-Id: Id125ebb5e8a9b22a8797d3158e60451d80bfaa14
2020-03-26 15:44:59 +00:00
Zuul
2f91ae61d2 Merge "Multiple import fails if "all_stores" specified as "true"" 2020-02-24 17:27:16 +00:00
Russell Tweed
517ff4fbe4 Document os_admin_user in Useful Image Properties
Add documentation of the os_admin_user property to the Useful Image Properties guide.

Change-Id: I10e1e738aeacc708350993f05d373eaa1293fd27
Closes-Bug: 1850412
2020-02-21 11:22:44 +00:00
Abhishek Kekane
d7de7ccbd6 Multiple import fails if "all_stores" specified as "true"
Newly added multiple import fails if user passes "all_stores" as "true"
in the request. The reason is if all_stores is specified then we are getting
stores using CONF.enabled_backends and unfortunately we are injecting
reserved stores 'os_glance_staging_store' and 'os_glance_tasks_store'
runtime. As a result import job tries to import the image in the
'os_glance_staging_store' store as well where it fails as that image
is already staged in this staging store.

Made a provision to exclude available reserved stores if "all_stores"
is specified.

Change-Id: If2616c275a969cdad5649e2cb0851275e5d0c7d2
Closes-Bug: #1863879
2020-02-19 12:03:58 +00:00
Ian Wienand
0035ab2538 Revert "Remove all example configs for deprecated registry"
This reverts commit 2a28696de9.

Devstack still references a number of these files; revert until
devstack incorporates removal.

Change-Id: I1e90ceee1f87291668e447f180f37bb809763836
2020-02-14 14:30:44 +11:00
Erno Kuvaja
2a28696de9 Remove all example configs for deprecated registry
Including removal if the example conf in docs.

Change-Id: I00c77b8f7001d8fa0fde4083c2ee88c370c14a09
2020-02-13 15:33:50 +00:00
Abhishek Kekane
1754c9e2b0 Copy existing image in multiple stores
Added new import method 'copy-image' which will copy existing image into
specified list of stores. Introduced additional task which will serve
as internal plugin which will allow copying existing image into staging
area and then this data will be uploaded to specified stores via regula
import flow.

NOTE: This new import method 'copy-image' is only supported if multiple
stores are enabled in deployment.

APIImpact
Implements: blueprint copy-existing-image
Change-Id: I13eaab7ab013f44ce18465bdbdbe8052942570ff
2020-02-12 05:32:46 +00:00
Grégoire Unbekandt
92492cf504 Add ability to import image into multi-stores
The import image api now supports a list of stores to import data into.
This list can be specified through a new "stores" field that has been
added to the request body.
During import stage, Glance iterates overs this list and send the data
to each store one by one.
If an invalid backend is requested by the user, an exception is raised.
If an errors occurs during verify, already pushed data is removed and
image state is unchanged.

Change-Id: Id3ac19488c0a693d7042be4a3c83f3b9f12313d0
Implements: blueprint import-multi-stores
2020-02-10 09:39:01 +01:00
Akihiro Motoki
b6ceda28a4 doc: Clean up unnecessary left vertical lines
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
2019-12-23 13:58:32 +00:00
Zuul
4e8afee0be Merge "useful-image-properties: Update note on machine types" 2019-12-13 22:21:26 +00:00
Abhishek Kekane
6dba83ba3a Rethinking filesystem access
In Rocky multiple backend support is added as experimental feature. In
order to take advantage of this feature it is decided to deprecate
work_dir and node_staging_uri configuration options
and reserve two filesystem stores 'os_glance_tasks_store' and
'os_glance_staging_store', which can be used to get rid of initializing
store via internal functions.

These internal stores are considered "reserved stores" by Glance.
For the time being, these are hard-coded as filesystem stores.  The
store prefix 'os_glance_' is reserved for internal Glance use and
the glance-api service will refuse to start if a store with this
prefix is included in the enabled_backends config option in
glance-api.conf.

NOTE: Because there are no sensible default values for the location
of the datadir for each of these stores, the operator must define
'os_glance_tasks_store' and 'os_glance_staging_store' in
glance-api.conf configuration file as shown below.

[os_glance_tasks_store]
filesystem_store_datadir = /var/lib/glance/tasks_work_dir/

[os_glance_staging_store]
filesystem_store_datadir = /var/lib/glance/staging/

Each filesystem store must have a unique datadir.

Depends-On: https://review.openstack.org/#/c/639765/
Implements: blueprint rethinking-filesystem-access
Change-Id: I86ec513c5fc653dbb97b79d953d8430f014e684f
2019-10-01 09:53:48 +00:00
Erno Kuvaja
82697983c0 Use glance as example in docs instead of osc
This patch also removes casual suggestion to turn on show multiple
locations. This feature has been idetified as vulnerability and
we should not advise turning it on without explaining the specific
use cases where it might be necessary.

Co-authored-by: Erno Kuvaja <jokke@usr.fi>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: I65952f70f0216d227ca14d1098d264208913e4e5
2019-09-27 19:21:09 +02:00
Kashyap Chamarthy
52127a692a useful-image-properties: Update note on machine types
For ARMv7 and AArch64, Nova uses the 'virt' machine type as the default.
Update the docs to reflect that.

Refer to this commit in Nova:

    https://opendev.org/openstack/nova/commit/e155baefb0
    (libvirt: Use 'virt' as the default machine type for ARMv7,
    2018-09-14)

Change-Id: I13793dded976fdf872ca0ea779a7f6cbee98118f
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2019-09-13 10:12:30 +02:00
Adam Spiers
3a281b9bc6 Add SEV-related extra spec and image properties
The AMD SEV support recently introduced to nova[0] depends on certain
metadata properties for flavors and images which were either missing
or only partially covered by existing glance metadata, so fill the
missing gaps:

- Add the hw:mem_encryption flavor extra spec and corresponding
  hw_mem_encryption image property.

- hw_firmware_type has been supported by nova for quite a while,
  so register it as an official metadata property.

- Add hw_cdrom_bus which was missing as per
  https://bugs.launchpad.net/glance/+bug/1808868.  This shares
  values with hw_disk_bus, so document that too.

[0] https://docs.openstack.org/nova/latest/admin/configuration/hypervisor-kvm.html#amd-sev-secure-encrypted-virtualization

Closes-Bug: 1808868
Change-Id: I8116565ad0326d0125b320d840d787edcb086aa9
2019-09-12 19:58:27 +01:00
Abhishek Kekane
73fefddd96 Add periodic job to prefetch images into cache
Added new periodic job which will run as per interval set using
'cache_prefetcher_interval' configuration option and fetch images
which are queued for caching in cache directory.

DocImpact
Change-Id: If2875f7a215aca10a6ed2febc89b02219f90a10d
2019-09-10 15:01:58 +00:00
Zuul
ca00b48e59 Merge "add metadef vlaues for new video models" 2019-09-06 12:03:03 +00:00
Zuul
1b6ae384af Merge "add hw_pmu metadef" 2019-09-06 03:13:48 +00:00
Zuul
d105390c62 Merge "Update hw_rng_model image property doc" 2019-09-04 14:34:45 +00:00
Sean Mooney
5bdefff5cd add metadef vlaues for new video models
- This change adds the newly supported libvirt
  video models, virtio, gop and none.
- This change updates the train metadefs changes
  release note.

Change-Id: I440a038b53825b5f92fc977566edcf3cabfba673
2019-08-21 01:18:07 +01:00
Sean Mooney
2998c795ed add hw_pmu metadef
This change adds a new hw_pmu metadef property to the
OS::Compute::LibvirtImage namespace and extends the train
metadef changes releasenote.

Depends-on: https://review.opendev.org/#/c/671338/
Change-Id: I2f4e7ef4f816afbd0524a6265d5605afa1da5f86
2019-08-21 01:06:04 +01:00
Andreas Jaeger
15609a11bd Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I17c97cb7655bdedc3927f4883b45ba4dcfc55516
2019-07-22 19:15:05 +02:00
Brian Rosmaita
90bffdc361 Update hw_rng_model image property doc
This property requires configuration on the Nova side for it
to have an effect; make that clear in the documentation.

Change-Id: I9a1902eefcb3a2ed1334f24a5d3335e17ab0aad2
Closes-bug: #1805679
2019-06-06 09:39:46 -04:00
Abhishek Kekane
f930288120 Mark http store read-only in discovery call
Made changes to discovery store to show 'http'
store as 'read-only' if it is configured under
'enabled_backends' cofiguration option.

Change-Id: If5d292bbb4cef1bd21a7e6cd4ef343a767eb91a4
2019-05-29 05:12:44 +00:00
ZhongShengping
8e16e3a857 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: Ibe48a4ea537915bc6ce142812354b1d3b3ab1cf7
2019-04-28 09:26:48 +08:00
Zuul
f9a568f235 Merge "Document os_shutdown_timeout image property" 2019-04-09 17:25:06 +00:00
Abhishek Kekane
8e957bff59 Update cache-manage documentation
During Stein cycle glance has added support to use cache-manage
utility using V2 API. Now it has support for keystone v3
authentication as well.

Change-Id: I698bdb84f6dcb964d7cf5e907f61c35e9beb36f0
Closes-Bug: #1823124
2019-04-04 07:46:52 +00:00
Jack Ding
59a5994a18 Add definition for hw_time_hpet image property
Depends-On: https://review.openstack.org/605902
Change-Id: Ia7358ce658878d1341026af3dc1459f450557cac
Signed-off-by: Jack Ding <jack.ding@windriver.com>
2018-11-20 22:45:51 +00:00
imacdonn
2f498770e8 [doc] Fix options group for default_backend
Fix the option group in the example config snippet for the
default_backend option.

Change-Id: I484ebf0685fe0e9a5b06daf96728f71089673668
Closes-Bug: #1804075
2018-11-19 23:13:23 +00:00
Matt Riedemann
3f18940d80 Document os_shutdown_timeout image property
This adds an entry to the "Useful image properties" docs for
the os_shutdown_timeout property. The description is copied
from the metadata definition.

Change-Id: I96be4b908f929361c201a8369d2e140bf711c923
Closes-Bug: #1784953
2018-10-24 10:16:27 -04:00
Zuul
070179948b Merge "Rename async package to async_" 2018-09-20 15:18:32 +00:00
Zuul
e4ecf7c0ea Merge "Document hw_cpu_policy and hw_cpu_thread_policy image properties" 2018-08-08 20:01:05 +00:00
Corey Bryant
c58e5e02af Rename async package to async_
In Python 3.7, "async" is a keyword. To prevent it from
conflicting, rename the async package to async_.

Change-Id: I1eaf87eedb86679d9ca9323aac05f0770c33efea
Closes-Bug: #1781617
2018-08-07 14:42:14 -04:00
Abhishek Kekane
d6ac7460ca Doc:Multiple stores support
Added documentation and modified api-ref documents to
reflect multiple stores support changes.

Related to blueprint multi-store
Change-Id: I932297df8149968d31a5367a9ca71a5629045445
2018-08-03 11:17:59 +00:00
Matt Riedemann
d2a5c52680 Document hw_cpu_policy and hw_cpu_thread_policy image properties
These were found in the nova flavor extra specs docs [1] but not
the image properties docs, so they are added here.

[1] https://docs.openstack.org/nova/latest/user/flavors.html

Change-Id: I2225821f859d43b1458174b8b7baa05c50cd0cd7
Closes-Bug: #1784462
2018-07-30 15:26:07 -04:00
Arvind Nadendla
b30ed486ae Update glance documentation for trait support
Required traits on the image allow specifying a server to be
built only on compute nodes which express those traits. The
Nova Scheduler has been updated to look at the image trait
properties when selecting compute nodes.

Updating the documentation for glance to explain the same.

Documentation is similar to flavor required traits documentation available
here: https://docs.openstack.org/nova/latest/user/flavors.html#extra-specs

Change-Id: I716821abf44238eecc9c4a1d198d8a31b87dedce
Implements: blueprint glance-image-traits
2018-07-13 11:09:37 -07:00
Brian Rosmaita
23d4e0e9c0 Documentation for OSSN-0075 mitigation
Updates the Glance Administration Guide and adds a release note.

Depends-on: https://review.openstack.org/#/c/579507/
Change-Id: I87343b67614da8dea3a09b10456f4bfc0042ed0e
2018-07-06 15:04:18 -04:00
Kashyap Chamarthy
9a893e80c2 useful-image-properties.rst: Update default RNG source
Nova's libvirt driver has changed[*] the default source from /dev/random
to /dev/urandom:

    "Since libvirt 1.3.4, any RNG (Random Number Generator) device path
    (that returns random numbers when read!) is accepted. However, the
    recommended source of entropy is `/dev/urandom` (it is non-blocking;
    and doesn't have the same limitations of `dev/random`, which is a
    legacy interface)."

Update the relevant Glance documentation to reflect that.

[*] https://git.openstack.org/cgit/openstack/nova/commit/?id=814bfd93

Change-Id: I656b5c244b98202f3c8d019d0bbeddc4e7c0314a
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2018-07-02 14:41:10 +02:00
Erno Kuvaja
c6a663ea6d Add image conversion plugin
This change adds image conversion plugin for Interoperable
Image Import workflow.

Change-Id: Icd4f4f30b12f6dd073dcdbf7f842e933c75ae249
2018-06-11 21:23:50 +01:00
Zuul
b19dd14878 Merge "Update pypi url to new url" 2018-06-05 02:08:48 +00:00
inspurericzhang
1370b15f01 Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I22b323065448425acad5c7052e2ccb7da419af28
2018-05-21 09:57:58 +08:00
wu.chunyang
ad4b87c5ca update "auth_url" in document
As of the Queens release,keystone has removed identity API v2.0
for more information.see [0]

[0]https://docs.openstack.org/keystone/latest/contributor/http-api.html

Change-Id: I275742b991ef6677dc38620e2d38e7e2e911e779
2018-05-12 11:59:08 +08:00
Brian Rosmaita
d3ccab6435 Add 'useful image properties' document
Move the list of useful image properties from the glanceclient
docs to the Glance Admin Guide.  It makes more sense in the Glance
docs as the only connection they have with the glanceclient is that
you can use the client CLI to set these properties

The table of property keys/values is unchanged; the introductory
section is new.

Change-Id: I0c307a067490c06728b5adf70c91586254e337da
Needed-by: https://review.openstack.org/565782
2018-05-02 10:48:06 -04:00
Brian Rosmaita
b13987cd41 Update Glance landing pages
Currently https://docs.openstack.org/glance/latest/ is a long
unorganized list of documentation links.  This patch revises that
page and the 'Glance Contribution Guidelines' page to make it
easier to locate content.  Also updates the main heading on other
index pages.

Change-Id: Ieea44dd05f8d164ed4c27f1205fb29b6e66d9660
2018-03-20 16:04:49 -04:00
chenpengzi
eef715ddde Delete the superfluous symbol of the command line
Change-Id: Ib6cbed6d6a5f3eb8d6f24f6646e7a13e5ca93ef1
2018-03-09 03:05:46 +00:00
Zuul
00f74962b6 Merge "Fix format cache.rst" 2018-03-08 15:43:31 +00:00
Zuul
9df90bd538 Merge "[doc] Modify the description for the command" 2018-03-01 15:39:34 +00:00
Abhishek Kekane
d500b3f883 Revise database rolling upgrade documentation
- mark zero-downtime-db-upgrade as EXPERIMENTAL for queens
- clarify the relation between the E-M-C strategy and
  zero-downtime db upgrades
- add note that for MySQL, using the glance-manage expand or
  glance-manage contract command requires that the glance
  is granted SUPER privileges
- add note to contributor docs about checking the trigger
  flag in expand and contract scripts

Co-authored-by: Abhishek Kekane <akekane@redhat.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: I5af4a1428b89ecb05a1be9c420c5f0afc05b9a95
Closes-Bug: #1750555
2018-02-20 15:47:58 -05:00
Zuul
7416aa989f Merge "Revise interoperable image import documentation" 2018-02-19 16:34:01 +00:00
Brian Rosmaita
3d5f33f2b3 Update Queens info about Glance and uWSGI
Adds a "Known Issues" releasenote and updates the "running glance
under httpd" documentation.

Change-Id: Ifc315b40cea23af95fc969a9c3a9479e8692792c
2018-02-16 09:42:43 -05:00
Brian Rosmaita
90815cc7fb Revise interoperable image import documentation
Updated to include the changes introduced in the Queens release.
Closes-bug: #1749762

Change-Id: I1df60db5826ff1e4491134f943d5eb0f29b0b072
2018-02-15 20:57:46 -05:00