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>
When using more than one worker, only one of them will return data, thus
leading users to not have access to every single piece of data at once.
Change-Id: I0e7e0f0ff7821465a74eb284e8401ddd7238f6df
Partial-Bug: #1619508
Co-Authored-By: Cyril Roelandt <cyril@redhat.com>
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
Support for the 'vhdx' disk format was added by Change-Id:
I4e172c78d7afeb8be5a0123238efe3d8e4b044c9 but this value is not listed
in configuring.rst. This patch updates that document.
Change-Id: Ic009e5e9f0f58396e784bea412290c390e62b55c
Closes-bug: #1655326
The document openstack-object-storage has been removed several years ago
from docs.openstack.org, remove the link since there's no real
replacement for the content.
Also, swift.openstack.org is a redirect to docs.openstack.org, replace
the link with current location.
Change-Id: Ib3d5ea880df673125d412ad25c26a4a06d7482a2
As we are removing the s3 driver from source tree per change
I032b0fc16400cbd2112687d38e010128be699221 , it seems right to remove the
references of the same in the glance tree.
Updated here are files that referenced s3; these files include:
* documentation files
* documentation of the glance architecture (source and png files)
* config help text
* stores associated with location strategy
* tests
UpgradeImpact
Change-Id: I680ee2baf39b49156d173e2ae108ae5d0221eca7
Depends-On: I032b0fc16400cbd2112687d38e010128be699221
Depends-On: I5d2da0611365b838f41285b64cdcfef9adf50e85
Use oslo.config sphinx extension "sphinxconfiggen" to generate sample
configuration files at the beginning of each sphinx build. Include the
generated sample configuration files as part of the developer docs so
that they can be removed from the code tree eventually.
Change-Id: I42934a437272b3822efd84bfe16392341804baed
Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>
Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
This patch aims to make a few of the parts of the config file a bit
more relevant.
* Changing the old store names (glance.store.*.Store)
* "New file"
* Small note about more config files.
* config file -> configuration file
Change-Id: I1fd5012b60fe66ede95d08fc353ffddc8ac60142
There are many warnings and errors that occur when the docs are
generated.
Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
Closes-Bug: 1556818
Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354
Update the configuration doc about notification according to this
commit[1].
TrivialFix
[1]: https://review.openstack.org/#/c/249508/
Change-Id: I50155f5746cf19ac65234f5979afb2d4091a137f
This updates the description about config options added and
deprecated in Cinder store.
Change-Id: I2f5bf837f08253b729b1f1a06b2aba66ab285711
Depends-On: Ie228d1d95365e81881691af4cb8b170335a73868
Currently the "Configuring Multiple Swift Accounts/Stores"
section is regarded as a section, but it should be placed in
the "Configuring the Swift Storage Backend" subsection.
In addition, all the glance stores configuration subsections
should be placed under "Configuring Glance Storage Backends"
section, but it is now misplaced by inserted sections.
This moves the sections to valid places.
Change-Id: I24fff19d2a631c8106b996f9a9061f7e50dacece
Parameter 'use_user_token' in glance-api.conf
was considered as harmful and not acceptable
for real deployments, because if it's disabled,
it changes system behaviour and allows any regular
user to perform requests with admin credentials.
In functional tests the default value was set
to True to prevent possible failures in the future.
Besides, several admin authN parameters were
deprecated as well, because they are useless without
'use_user_token'.
All required information was added to related
documentation sections, sample config file was
updated as well.
https://wiki.openstack.org/wiki/OSSN/OSSN-0060
Change-Id: Icfef49d787fa58e2af2e60e4fdc96633c5f0c010
Related-bug: #1493448
Gridfs was marked as deprecated some releases go and now it has
been removed from Glance_store. So Glance should not support this
driver anymore.
Change-Id: Ia81e109c3919ad8ee8336f9051fa7920780f5bbd
EXPERIMENTAL Glance v3 API has been removed in favor of standalone API
(EXPERIMENTAL Artifacts API of v0.1).
This patch introduces a new process entry point to run on a different
port (9494 by default), with its own configuration file and a paste
config.
A controller stub for old /v3 api remains in the glnace.api package for
the compatibility with existing paste configuration which may reference
it. This stub returns a 301 redirects to glare endpoint if it is present
or 410 errors otherwise.
To reuse the existing version_negotiation middleware some refactoring
has been made.
Implements blueprint: move-v3-to-glare
Change-Id: I5b7bd4cdcc5f2a40fc4a5f74bcc422fd700c4fb0
Use oslo_config.sphinxext to automatically document the available
configuration options in the sphinx documentation.
See https://etherpad.openstack.org/p/automating-oslo-config-documentation
for work to implement this to each project. Glance is one of the first
six projects for a consolidated operators configuration reference.
Change-Id: If701f7dfa240075457e6e149bcb12ff713a8c79b
Starting with opsrofiler 0.3.1 release there is no need to set HMAC_KEYS
and ENABLED arguments in the glance-api-paste.ini and
glance-registry-paste.ini files, this can be set in glance-api.conf and
glance-registry.conf configuration files.
DocImpact
Change-Id: I068504913c93be0f506262930eadc2e40879ce0f
The description of cache middleware flavor in the configuring doc
should be updated.
Change-Id: I6bf6083b01e4e5e3402817279ed367fbfb4cf42e
Closes-bug: #1479116
Add documentation explaining how operators can add or remove supported
disk_formats.
Change-Id: I14f6c53506590e6fa373afdbdc3b6f052a0a532c
Closes-bug: 1519006
Since v3 is still unstable and has experimental status it's
better to disable it by default for security reasons. This
commit does it by setting 'enable_v3_api=False'.
Also all required documentation was added to related sections.
DocImpact
Change-Id: I412d0645d667400333532123008a24966aa23880
Setting sensible maximum size for Request ID. 64 should be enough for
normal use cases but limited enough from current 16384 to not flood
the logs by malicious requests.
DocImpact
SecurityImpact
Related-to-bug: #1482301
Change-Id: I52ebf810f4699826baa2bdf91d28e24d902cf950
This patch adds a new parameter rados_connect_timeout
and its description to the Configuring the RBD Storage Backend
sub-section in the Basic Configuration section.
Change-Id: Ib909519e46902a2f8888625951c6e761de15d48d
Depends-On: Ib44f74063d5a8332c6b5f3e15bcfa044c86bef9b
This commit updates the developer docs to reflect
the change in default digest algorithm to sha256
made by https://review.openstack.org/#/c/197372/
Closes-Bug: #1471938
Change-Id: I1b1044a506d7e3657ec360489fb236c6e5214688
Provide healthcheck middleware from oslo_middleware to be able to
disable given nodes from loadbalancer. It's achieved by adding a new
pipeline which depending on existing of the
/etc/glance/healthcheck_disable file can return one of the following
results:
- 200 OK (if file does not exist)
- 503 DISABLED BY FILE (if file exist)
The healthcheck is available under /healthcheck URL, and the whole
mechanism behave similar to the Swift healthcheck system.
implements bp: healthcheck-middleware
Co-Authored-By: Erno Kuvaja <jokke@usr.fi>
Co-Authored-By: Kamil Rykowski <kamil.rykowski@intel.com>
DocImpact
Change-Id: I45f6a8c59ec3040aaf06f8bab46d8001c44dac7a
Add a parameter to take advantage of the new(ish) eventlet socket timeout
behaviour. Allows closing idle client connections after a period of
time, eg:
$ time nc localhost 9292
real 1m0.063s
Setting 'client_socket_timeout = 0' means do not timeout.
DocImpact
Closes-bug: 1371022
Change-Id: I9e7edcbf25ece61dc16b8cd5a8bef5ed9a14e3d6
Doug Hellmann