Commit Graph

24 Commits

Author SHA1 Message Date
Cyril Roelandt dd9b3156cd inject_image_metadata plugin: Fix documentation
The properties and values given to the "inject" option must not be
quoted, otherwise the quotes become part of the values themselves.

Change-Id: Ibcb8b8488253f459f40e6d34f4221832b7ff3839
Closes-Bug: #2028895
2024-02-15 02:31:36 +01:00
Erno Kuvaja e4fd087a84 Minor fix on Interoperable Image Import admin doc
The III admin doc has grown quite a bit and multiple sections
misleadingly referred that all above options needed to be
configured as if different import-methods depended on
eachother.

Also correcting the statement of default enabled methods.

Change-Id: I19485c1d6bb22e81a8496ddab312e9458ae3cbee
2022-08-30 13:35:51 +01:00
Abhishek Kekane f09c338035 Add documentation for glance-download plugin
This patch adds documentation and API reference support for
glance download plugin.

Related blueprint glance-download-import
Co-Authored-By: Victor Coutellier <victor.coutellier@gmail.com>

Change-Id: Ie36232f3474d398a913025c8d408f08f879874d8
2022-08-26 05:46:12 +00:00
Dan Smith d8a6309893 Add administrator docs for distributed-import
This adds some text to the documentation about configuring the import
mechanism, including details about shared vs. local staging
directories. It also clarifies that *all* import methods require the
staging directory to be configured, as well as cleans up some
single-store-specific wording in this area.

Related to blueprint distributed-image-import

Change-Id: I726abe5d1104510e8da0e94f90f2b36d43b82cbe
2021-03-03 06:37:29 -08:00
Ghanshyam Mann c107629f90 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also convert the ./glance/tests/etc/policy.json to policy.yaml
file. Replace policy.json to policy.yaml ref from doc and tests.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Depends-On: https://review.opendev.org/c/openstack/nova/+/773192
Change-Id: I17d0374dd4223688e5f95253802a4ae87377953a
2021-01-29 15:31:47 -08:00
Abhishek Kekane 52eaa56e40 [Doc] Policy support to copy unowned images
Change-Id: If0fd74d9f2eecb21153493457c58d767f12ffdeb
2020-07-27 16:54:01 +00:00
Abhishek Kekane f7b1631190 Exclude http store if --all-stores specified for import/copy operation
If operator has configured read-only 'http' store in multiple stores and while
importing or copying existing image in multiple stores if user has specified
--all-stores true then depending on `allow-failure`; if it is True then image
is imported/copied to other stores than http or if it is false then image can
not be imported/copied to other stores as well. Aslo, new image property
`os_glance_failed_imports` shows `http` as failed store.

Excluded `http` store from the list of stores for import/copying workflow
if user specifies --all-stores as True.

Change-Id: I2ad41022aa709491881e78129708da0ccc25f4f6
Closes-Bug: #1881958
2020-06-03 23:21:19 +00:00
Zuul fa18f745df Merge "Revise admin interoperable image import docs" 2020-04-14 14:45:47 +00:00
Erno Kuvaja a2e0fb61e9 Do not decompress 'compressed' containers
Do not decompress the image if container_format is compressed

Change-Id: I913d9bf11479d2519f7887e42626e9e386d83d7a
2020-04-07 10:46:30 +01:00
khashf 30f821c624 Revise admin interoperable image import docs
This patch revises the documentation of the interoperable image import
feature available to admin operators to concisely describe Stein and
later releases.

Changes include:
- Remove enable_image_import option because it is no longer available
  since the release of Stein
- Simplify the language of the v1 API being deprecated

Change-Id: Ic155afd6de5b37a25743457e9a7ddd5a45dac4e8
Closes-Bug: #1808814
2020-04-06 15:43:21 -07:00
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
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
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
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
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
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
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
Brian Rosmaita 10b9490969 Update admin docs for web-download import method
Change-Id: I8a9ffe2ca8a5b83374ac0b0e9d564e696f286930
Closes-bug: #1749478
2018-02-15 20:34:11 +00:00
Brian Rosmaita 49a1a0a02b Revise import property injection plugin releasenote
Revise the releasenote from I98be97c42f23b60a72d520aad5f6078a96372c59
by reducing the release note to a summary and moving the details to
the documentation (Glance Admin Guide).

Co-authored-by: Bhagyashri Shewale <bhagyashri.shewale@nttdata.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Closes-bug: #1745124
Change-Id: Iaa3139fade75f1e3708dce8525f3571aba997589
2018-02-08 03:11:20 +00:00
Nguyen Van Trung 97dbfb02d7 Add doc8 to pep8 check for glance project
This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.

Co-authored-By: Hoang Trung Hieu <hieuht@vn.fujitsu.com>
Change-Id: I5a9299200202576d97760ebf07bceb930888f2d7
2018-01-19 08:20:56 +00:00
Brian Rosmaita dbf7bbc9fb Add documentation for image import plugins
Add info to the admin guide about how to configure plugins for
image import.

Change-Id: I17a259b45b123ddf30d94fa2c6f3e57e96a8fb06
2018-01-12 16:22:51 +00:00
Brian Rosmaita d304d2c05c Add image import docs to admin guide
Change-Id: I0222b5d6d5685029eadf04a3d19160ba018fe2e5
Closes-bug: #1713180
2017-09-06 19:23:18 +00:00