48 Commits

Author SHA1 Message Date
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
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
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
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
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
qiaomin
6f858c3cf7 [doc] Modify the description for the command
The displayed image attributes of the command 'openstack image list'
do not has 'Server', so this patch remove it. The available status
of image should be 'active' according to the output of the command.

Change-Id: I90efd2b3f1838cdcaa79feea78d73429cded1257
2018-01-11 13:24:26 +00:00
Guoqiang Ding
4c4663bafc Update the documentation links
The documentation about "ops-guide" has been moved.

Change-Id: I9fc5ad2a3f5cd7790c6e1bc314892cac511a404d
2017-12-06 06:32:42 +00:00
chenxing
f8a5a40224 Update the valid disk bus list for qemu and kvm hypervisors
The Nova project has added 'sata' as a valid disk bus for qemu and
kvm hypervisors, see https://review.openstack.org/#/c/459794/6

DocImpact: add to metadefs release note

Related-Bug: #1686136
Change-Id: If8e23756616e46391827ac3d85d287940862613f
2017-12-06 03:16:27 +00:00
Zuul
ef458d5105 Merge "Correct sphinx syntax of glance doc" 2017-11-09 17:40:33 +00:00
Rui Yuan Dou
914bf760fb Correct sphinx syntax of glance doc
Change-Id: I0050ef32196e8ea73ef50837c27bf9e67727d1af
2017-11-03 08:56:34 +08:00
Matthew Treinish
e6219582c8
Update http deploy docs to be a bit more explicit
There have been some lessons learned on how to best deploy glance from
using uwsgi in the gate. This commit updates the docs a bit to explain
some pitfalls to avoid.

This also adds a glossary at th end of the docs to explain common terms.
There are several very similar terms with related meanings used in the doc
so to clear up confusing the glossary should be helpful.

Change-Id: I255d2049a5d519909c88101833ddd259328fcee7
2017-11-02 01:19:19 -04:00
Brian Rosmaita
53ec4d5ab1 Document Glance Registry deprecation
Update the docs and add a release note.

Partially-implements: bp deprecate-registry

Change-Id: I759d38728a50ba516131e13745df651802fcce63
2017-10-19 10:31:27 -04:00
Jenkins
3e2c555701 Merge "Switch base to latest in link address" 2017-09-20 17:11:44 +00:00
Jenkins
0ef045d7bd Merge "Clean up database section of admin docs" 2017-09-20 16:56:29 +00:00
junboli
7dfaa552f8 Switch base to latest in link address
1. Using the relative pointer to the resource on latest version, and this
   can avoid the manually change on every release.
2. Pretty format the json data.

Change-Id: I5eb5c156f3f730c2c51dc5d917e591a28c059282
2017-09-20 05:30:07 +00:00
Brian Rosmaita
62ee9e7390 Clean up database section of admin docs
The db.rst file had two top level headings and the second wasn't
being rendered in the html pages.  Separated the zero downtime
section into its own section to fix this and made a few updates
to the text.

Change-Id: I913326653642d8f19173f18868d4e8cbb89a5b77
2017-09-13 01:47:30 -04: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
lingyongxu
7c1764b85d Update the documention for doc migration
This patch is proposed according to the Direction 10 of doc
migration(https://etherpad.openstack.org/p/doc-migration-tracking).

Change-Id: I71ced5bd5a0979acf21a60c6157b0af98f061f20
2017-08-02 07:22:46 +00:00
Doug Hellmann
c024c792b1 import the cli examples from the admin guide in openstack-manuals
Change-Id: I17da383eb3a3b32e73d0dcdd5f5e9e7f4dff73ee
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:02:00 +00:00
Doug Hellmann
6f865190c9 import troubleshooting section of admin guide from openstack-manuals
Change-Id: If8c63a7f4929227084a1bde3767356e28689dc94
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:01:52 +00:00
Doug Hellmann
ca7a572d11 use :ref: instead of :doc: for xref
Using :ref: makes it easier to move files around.

Change-Id: I6e5e4403f01cf78fcfe2c5f716bb59455766e652
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
Doug Hellmann
1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00