Commit Graph

771 Commits

Author SHA1 Message Date
Brian Rosmaita
ba5f556d27 Update migration constant
Update the data migration current release to 'yoga'.  Include a
semver pseudo-header in this commit message so that pbr will
increment the major version number, otherwise
glance.tests.unit.gate.test_data_migration_version will break.

Also add a reminder about this to the release cycle tasks list.

Change-Id: Ibdbeb752d29afeb48628587442577ab139be9ac9
Sem-Ver: api-break
2022-02-10 09:31:16 -05:00
Zuul
909597c434 Merge "Update Interop doc" 2022-01-18 18:45:54 +00:00
Kashyap Chamarthy
bfc7a178e3 Add "bochs" as a possible video model
In Xena, this commit[1] support for the "bochs" video model (the device
is recommended for UEFI guest), but neglected to update Glance
documentation.  Correct that now.

[1] https://opendev.org/openstack/nova/commit/c590843974
    "Allow 'bochs' as a display device option"

Change-Id: I2026a81d3611e069fbcd1a79c2384d18cb5a653d
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2021-11-15 14:42:49 +01:00
Martin Kopec
fd36d6450e Update Interop doc
The commit replaces DefCore committee (a former name) by
Interop Working Group (the current name) and updates a few
more old interop references.

Change-Id: I09c02f3adc2ba5acb2c325e462bc6e54dd23d0fb
2021-11-08 10:47:05 +00:00
Zuul
a693e066b3 Merge "Fix typos" 2021-10-20 00:01:42 +00:00
Zuul
9b30e7fe0e Merge "Use singular they instead of "he/she" where possible" 2021-10-13 08:00:17 +00:00
Cyril Roelandt
0ca2f92161 Fix typos
Change-Id: I5e7776324c01e467799b1296c35b84dc0c10cce2
2021-10-13 03:02:52 +02:00
Cyril Roelandt
88d586f038 Use singular they instead of "he/she" where possible
Change-Id: I5a30a62f8d62e2c97c30e795317e95c207e196b9
Closes-Bug: #1946166
2021-10-06 15:33:46 +02:00
Adrien Cunin
da0eb87e85 Fixed image_format typo in doc
Closes-Bug: #1943264
Change-Id: I76d1ef2f8242171b4728e10e2d748acefebd7f2a
2021-09-10 14:49:25 +00:00
Zuul
2841892229 Merge "Clean out deprecations from paste.ini" 2021-08-05 17:34:57 +00:00
Erno Kuvaja
652780d029 Remove SSL configuration section from docs
Since supporting only PY3 (Ussuri) Glance has not been supporting
termination of encrypted connection to the service [0]. The
section was left behind on the configuring doc.

[0] https://docs.openstack.org/releasenotes/glance/ussuri.html#security-issues

Change-Id: I9356bceb914327f526da7b727fa58522ae18856e
Closes-Bug: #1930597
2021-07-29 12:27:42 +00:00
Erno Kuvaja
04541ae72b Clean out deprecations from paste.ini
The etc/glance-api-paste.ini had still couple of pipelines left
behind from registry and osprofile options deprecated in 2015.

This change clears those and removes the reference note from
configuring doc.

Change-Id: Idb78cd2935a9ea5a1b1bc3ee6153311190422ca5
2021-07-29 12:50:36 +01:00
Stephen Finucane
ae43625781 db: Remove "support" for configurable migration backends
This doesn't actually do anything, and hasn't since we merged change
I77921366a05ba6f9841143af89c1f4059d8454c6 way back in Ocata. Drop it.

Change-Id: I623b2ffb8bdd72525241835b5d1164c275f9fe73
Implements: blueprint remove-sqlalchemy-migrate
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-07-13 17:19:33 +01:00
Dan Smith
da771fce25 Add unified quotas documentation
Related to blueprint glance-unified-quotas

Change-Id: I59d0b48f0652120eaae39509685345a12447933e
2021-07-02 08:29:07 -07:00
Abhishek Kekane
c5c7a2a634 [Doc] Update Freenode to OFTC as our IRC server
Change-Id: I13dd0ada65e882591e3584c04b4bf0e943d1faf1
2021-06-01 04:53:19 +00:00
Abhishek Kekane
120cb146ab Guidelines for core reviewers
Change-Id: Ia8ff60f8184c533b9fc2a709d33cbdfc02793c41
2021-04-05 05:33:01 +00:00
Zuul
2f6e3bc578 Merge "Make some metadef operations admin-only" 2021-03-17 18:08:04 +00:00
Dan Smith
cf94c9aab2 Fix a typo in contributor docs
This just makes a trivial typo fix in the minor-code-changes doc.

Change-Id: If0093316c393b09ed4d936d2625b2d27024bfdbc
Co-Authored-By: Abhishek Kekane <akekane@redhat.com>
2021-03-15 11:26:44 -07:00
Abhishek Kekane
f8551de8c9 Make some metadef operations admin-only
This restricts all metadef resource manipulation to admin-only, but
still allow users to see everything. There are multiple low-grade
security issues with the metadef API, detailed in the related bug.
Restricting resource manipulation to admin-only solves most of these
concerns.

SecurityImpact
Depends-On: https://review.opendev.org/c/openstack/tempest/+/780108
Change-Id: I333c58e73c202c1f523030e54e03f2868459b595
Related-Bug: #1916926
2021-03-15 07:59:05 -07:00
Zuul
66281f0dbf Merge "Cleanup remaining tenant terminology in glance API docs" 2021-03-04 19:43:32 +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
Lance Bragstad
7d8aa54c75 Cleanup remaining tenant terminology in glance API docs
This commit addresses follow-on concerns from:

  https://review.opendev.org/c/openstack/glance/+/763920

Change-Id: I1785da0a791691c08b299e74c02b0c576477d88e
2021-02-12 00:05:27 +00:00
Cyril Roelandt
7839ab0925 Remove unused option "owner_is_tenant"
This option has been deprecated since Rocky.

Change-Id: I8edc957ad50ec28d80a06e76912f4226cea53562
2021-02-11 16:17:10 +01:00
Zuul
f2452863e7 Merge "[goal] Deprecate the JSON formatted policy file" 2021-02-03 14:45:20 +00:00
Zuul
5eca0f66db Merge "Add policy sample file in doc" 2021-02-02 17:12:25 +00:00
Ghanshyam Mann
0a9faeece4 Add policy sample file in doc
policy sample file with all the default rules
commented out is missing in glance doc which can be
used for reference or when few rules needs to
be overriden (and keep all other default rule commented
out).

Change-Id: I0cc461f7061358389186ac4751f6e037e1bf6dc7
2021-02-01 12:22:38 -06: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
Dan Smith
07951b095b Update docs and renos for os_glance reservation
This adds some words to the api-ref doc, as well as a release note
about the blanket reservation of os_glance* properties.

Change-Id: I0cd6f35296a647fdb1f2cb44a688b34c0382c556
Related-Bug: #1912001
2021-01-25 12:30:50 -08:00
Takashi Kajinami
81c6d4d678 [Doc] Remove description about v1 api and glance-registry
Image v1 API and glance-registry has been removed from Glance.
This patch removes all descriptions about these 2 items, since they
are no longer available.

Change-Id: Ic72921523f73dcae5e9c443a55edecb710b2d251
2020-12-17 17:26:06 +09:00
Brian Rosmaita
f102b74a28 Remove 'admin_role' option
This option was deprecated in the Ussuri release by change
I0f61f85a0aaa4f68e345fa08fbb6b039d3d32587 and it is now eligible
for removal following the standard OpenStack deprecation policy.

Change-Id: I78ec79f97bfdcc39772448296140f8d8f35adea1
2020-11-24 20:31:21 -05:00
Stephen Finucane
54a2231f17 docs: Remove cruft from 'conf.py'
Change-Id: Ie44453b647ce78a26246b8293794ebdec68fd120
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-17 17:21:55 +01:00
Stephen Finucane
d3d9982e66 docs: Convert table of image properties to definition list
This renders much flatter as is similar to what's used nowadays for
config options (via the 'oslo_config.sphinxext' extension)

Change-Id: If204d887ed0d65cfc5e75cc7739b0f8f59ce000f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-17 17:21:51 +01:00
Stephen Finucane
e1fe3024bb docs: Remove references to XenAPI driver
The XenAPI driver is dead. Let's hold the tissues and clear out
references from the documentation instead.

Change-Id: I6ec331cf7d2d1ded924893f707ed963027939754
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-17 17:09:17 +01:00
Abhishek Kekane
9bd06d24ac [Docs] Cinder multiple stores for glance
Change-Id: I1ec4d3f3f57f8a0576ea5ed09a289ab27882104b
2020-09-09 15:04:07 +00:00
Abhishek Kekane
52eaa56e40 [Doc] Policy support to copy unowned images
Change-Id: If0fd74d9f2eecb21153493457c58d767f12ffdeb
2020-07-27 16:54:01 +00:00
Erno Kuvaja
785eefcf78 Fix admin docs deplying under HTTPD
During Pike cycle there was efforts to deploy services under
Apache HTTPD. It became clear very quickly that Glance did not
operate properly when deployed as bare wsgi app under web
server but admin documentation was merged that indicated that
being somehow the preferred method. It was added to the doc
that in Pike release there was issues in these models.

There was never interest nor resources to fix the underlying
issues but the doc stayed in place indicating that those
issues could be only Pike related when they in matter of
fact has got even worse over the time. Due to the fact that
Glance is even more relying on eventlet than back then it's
time to clarify the docs and make clear it's not adviced
deployment model, it won't work and there is no itention
to change that.

Change-Id: I93dc7c999ff7a180e6b3ff760fa65328b9a883f3
Closes-Bug: #1887994
2020-07-20 11:15:16 +00:00
Erno Kuvaja
781da9354f Remove configs and entries for deprecated registry
Including removal of the example conf in docs.
Including glance-registry command entrypoint to eventlet.
Including rpc_controller from wsgi, changed to reject.
Not including the files devstack is depending on.

This change means that glance-registry starts and announces
that it has been removed.
This change means that when ran as wsgi app, all calls to
/rpc endpoint will be rejected.

This will allow devstack to make a graceful transition to
life without the glance registry, which was deprecated in
Newton release.

Change-Id: I7bf3284cba4c38605fb50b3c458e53f896f34086
2020-06-08 21:11:45 +01: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
Andreas Jaeger
03cb88a437 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ib1796ac0c786c16bade68668f0d978ee71d29307
2020-05-30 16:56:09 +02:00
Dominic Schlegel
10f7130bcf fix typo in gerrit doc
Change-Id: I19bd52c949e146758d50a2732fdcc71a019b9228
2020-04-30 23:31:13 +02:00
khashf
bd16ab256e Add warning and note on image schema customization docs
An operator can modify /etc/schema-image.json to include arbitrary
properties (which was that file's original purpose) and assign them JSON
types other than 'string'. The type is enforced by image create/update
but an end-user making a call that sets a value on one of these gets a
500.

This patch add the following recommendations to the documentation:
- Value of `type` of each property in the JSON scheme must be `string`
- Do not delete items from the default schema-image.json file
- If operator's need is more complicated, suggest them using metadefs

Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: I879f4440a14b1e8420e230de84bfba5e0419a4d4
Closes-bug: #1856578
2020-04-15 09:16:30 -07:00
Zuul
fa18f745df Merge "Revise admin interoperable image import docs" 2020-04-14 14:45:47 +00:00
Zuul
8ccda62a21 Merge "Update 'common image properties' doc" 2020-04-14 14:45:44 +00:00
Abhishek Kekane
534dc9741a Ussuri final release notes
(Also hit a few lines in the docs affected by the heading-as-anchor
case sensitivity issue from Sphinx 3.0.0.)

Change-Id: Idc031028f6f78635c9836f9ef082f0eef632eb2f
2020-04-13 10:39:33 -04:00
Zuul
a14bd83f3e Merge "Do not decompress 'compressed' containers" 2020-04-09 11:40:16 +00:00
khashf
984e844c6a Update 'common image properties' doc
Update doc/source/user/common-image-properties.rst (live link [1]) to be
in sync with etc/schema-image.json

This patch does 2 actions:
1. Add the missing properties that are in etc/schema-image.json to
   the doc
2. Rearrange the order of appearance of properties in the doc to be
   the same as they appear in etc/schema-image.json

[1] docs.openstack.org/glance/latest/user/common-image-properties.html

Change-Id: I840f3cbeda28da8b02dd141fde582c9110aeb21e
Closes-bug: #1870336
2020-04-07 17:44:39 -07:00
Naohiro Sameshima
9e17151bdc Add description of how to use S3 driver
There is no description about S3 on the current page of Glance
Configuration Options Docs. So, add description which is required
to use the s3 driver.

Change-Id: I04373474f94537e2145f6acc30dded8cddc5ad3b
2020-04-07 19:46:32 +00:00
Zuul
2f2e118a58 Merge "Add Policy enforcement for several Metadata Definition delete APIs" 2020-04-07 19:29:26 +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
Zuul
2d21685ee4 Merge "Remove all references to sheepdog" 2020-04-07 04:05:36 +00:00