655 Commits

Author SHA1 Message Date
Brian Rosmaita
de6c36abaf Update "Release Notes" in contributor docs
Moves the Release Notes section to its own page to give it a higher
level heading to make it easier to find.  Also updates info about
the Glance team's policy about the "prelude" section.

Change-Id: I31351068124e0981519ccc2e33a7bdc16f8197fd
2018-08-09 17:38:56 -04:00
Zuul
e4ecf7c0ea Merge "Document hw_cpu_policy and hw_cpu_thread_policy image properties" 2018-08-08 20:01:05 +00: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
Zuul
54329c6a21 Merge "Replace Chinese punctuation with English punctuation" 2018-06-20 17:22:14 +00:00
Zuul
e005e65833 Merge "Update Release CPL doc about periodic jobs" 2018-06-14 16:10:21 +00: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
bc80aad4f3 Update Release CPL doc about periodic jobs
At the weekly Glance meeting on 2018-05-17 it was agreed that the
Release CPL will monitor the periodic "tips" test jobs and report
on their status at the weekly meeting.  This patch updates the
appropriate section of the Glance Contributor's Guide.

Change-Id: Ieeab3e3a42b8197f8b0544e97748ffdb8f620f13
2018-06-07 13:34:47 +00:00
inspurericzhang
612e5cf12b Replace Chinese punctuation with English punctuation
Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I9b8830179fb98f3a6bef479bbaa12df70311269a
2018-06-07 17:00:12 +08:00
Zuul
b19dd14878 Merge "Update pypi url to new url" 2018-06-05 02:08:48 +00:00
Brian Rosmaita
7f47da7a50 Add py35 statement
Add a statement about the current state of Glance Python 3.5
support to the install docs.

Change-Id: I2cb2e05f81c22c00aad55d3b8a1d3463ced6cf28
Partial-bug: #1769006
2018-05-30 12:55:17 -04: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
Zuul
65f7e49537 Merge "Add 'useful image properties' document" 2018-05-03 06:38:18 +00: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
junboli
927aaf870d Follow the OpenStack Sphinx theme configuration
Follow docs[1] and update the sphinx theme configuration,
Also updated bug_tag values for api-ref and documentation.

[1] https://docs.openstack.org/openstackdocstheme/latest/

Co-authored-by: wanghui <wang_hui@inspur.com>

Closes-bug: #1768365
Change-Id: I76308497122f4522fe307b3c29b696780e073027
2018-05-01 15:03:56 +08:00
Brian Rosmaita
aba20e70ea Add redirect capability to glance docs
Adds .htaccess containing redirects so old URLs can retrieve
the correct document from the docs reorganization introduced
with commit 1c7f556d4f77d2dd7f282f2b41bdfb2abb6e5740.

Change-Id: I9678eedd5634ac04482f3f8b5ee0e4177cf985e3
Needed-by: https://review.openstack.org/564344
Partial-bug: #1766257
2018-04-25 21:38:59 -04:00
Zuul
75b180fe78 Merge "Update auth_uri option to www_authenticate_uri" 2018-04-24 13:27:37 +00:00
wangxiyuan
71a36c98ed Pending-delete rollback ability
Now there is no way to revert the pending-delete images. Once the
admin operators want to revert the delete action, Glance should
give them this kind of ability.

This patch will enhance the glance-scrubber tool to support restoring
the image from pending-delete to active.

Change-Id: I11fe58403e3af102b63d15b3cc702e567e526bad
blueprint: pending-delete-rollback
2018-04-19 11:03:59 +08:00
Nguyen Hai
5e5ba92aec Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove the '[build_sphinx]' and [pbr] sections as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Adds the use of sphinxcontrib.apidoc to get (mostly) the same output as what
was provided by the removed [pbr] section.

Change-Id: Ie7e3acef7161cb8f218c2333167490c8116a2122
Depends-On: https://review.openstack.org/#/c/560270/
2018-04-11 06:02:54 +00:00
caoyuan
d3ecbbdc5d Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: I1de0272fb7c20b8efa710d984ff8196c41b30b6b
2018-04-08 15:42:07 +08:00
Brian Rosmaita
57310ad88f Use 'Default' as sample install domain name
The Glance install guide suggests using 'default' as the
user_domain_name and project_domain_name, whereas the Keystone
install guide, which people would be consulting earlier, instructs
the installer to use 'Default'.  Since the name is case-sensitive,
this is causing problems for first-time installers of OpenStack.

Change-Id: Iade47bcd69b7a2a99b990885a0270c962de282a1
Closes-bug: #1747181
2018-04-07 18:02:25 -04:00
Brian Rosmaita
7dfce42027 Update auth_url in install docs
Beginning with the Queens release, the keystone install guide
recommends running all interfaces on the same port.  This patch
updates the glance install guide to reflect that change.

Closes-bug: #1754104

Change-Id: I6134097f4ec78bf34a03f3ce6d8564bd324eb1b3
2018-04-04 17:10:58 -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
Zuul
bbeb15d9c5 Merge "Update Release CPL doc" 2018-03-20 14:18:21 +00:00
Zuul
e17baf41fe Merge "Fix format in doc/source/cli/*" 2018-03-13 17:40:12 +00:00
David Rabel
7e60fc6e05 Fix format in doc/source/cli/*
Current indentation is wrongly interpreted as quotation.
Also fixed some minor formatting issues.

Change-Id: Ie29e71f0394a432c255804b0d549aba56d1d5a1d
2018-03-10 08:17:43 +00:00
Brian Rosmaita
8d53a388ba Update Release CPL doc
Remove an unnecessary task from post-release duties.

Change-Id: I0ef66a8ed79b53e1e741c291f303aa4cd8eda201
2018-03-09 11:02:55 -05: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
f3465f74ae Merge "Update installation guide: no uwsgi for glance" 2018-03-06 14:10:55 +00:00
Zuul
9df90bd538 Merge "[doc] Modify the description for the command" 2018-03-01 15:39:34 +00:00
Brian Rosmaita
9ff7d17890 Update installation guide: no uwsgi for glance
The Pike and Queens release notes recommend against running
Glance under uwsgi.  Add a note to the install guide as another
location where this information is available.

Change-Id: I3aa61ea45a3d3edaa5b8062813fc3e1388556f9f
2018-02-28 10:16:01 -05: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
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
Nicolas Bock
78501fb550 image-guide: Update cirros image
The current CirrOS image is version v0.4.0. Update the guide to
download this version.

Change-Id: Icf9fce5e46c5044976035942be22a0f4c3f7ca96
2018-02-13 12:02:51 -07:00
David Rabel
fff76ae4d2 Fix format cache.rst
Fix format in doc/source/admin/cache.rst :
- Fix indentation.
- Add two missing bullet points.

Change-Id: I8d88c9f1b15f7de7159bfda662aca0c7ad1b47ed
2018-02-12 14:20:39 +00:00
Zuul
b9e95a8db3 Merge "Update the valid disk bus list for qemu and kvm hypervisors" 2018-02-08 19:47:08 +00:00
Zuul
55fa35963a Merge "Revise import property injection plugin releasenote" 2018-02-08 07:01:10 +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
Brian Rosmaita
20fcf18897 Correct 1-character typo
Glad someone read the doc carefully enough to notice this!

Change-Id: I3affd699e79489d2928b3101c1b86a5dbc989ff7
Closes-bug: #1733964
2018-02-07 21:36:12 -05:00
Zuul
c531155ea0 Merge "Update Signature Documentation" 2018-01-28 09:26:01 +00:00
Brianna Poulos
806adc58e0 Update Signature Documentation
The castellan user interface library recently
deprecated the 'api_class' configuration option
in favor of the 'backend' configuration option.
This change updates the image signature
verification documentation to use the new
configuration option.

Change-Id: I0cc115eed1b7f271fe4bb7d0a385d487f2494d73
2018-01-19 12:01:38 -05: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