doc migration: update the doc link address[2/3]
Update the doc link brought by the doc migration. Although we had some effort to fix these, it still left lots of bad doc link, I separate these changes into 3 patches aim to fix all of these, this is the 2st patch for doc/manpages. Change-Id: Id426c5dd45a812ef801042834c93701bb6e63a05
This commit is contained in:
junboli
Tim Burke
parent
6da17e9923
commit
df00122e74
40
CHANGELOG
40
CHANGELOG
@ -244,7 +244,7 @@ swift (2.13.0, OpenStack Ocata)
|
||||
|
||||
* PUT subrequests generated from a client-side COPY will now properly log
|
||||
the SSC (server-side copy) Swift source field. See
|
||||
https://docs.openstack.org/developer/swift/logs.html#swift-source for
|
||||
https://docs.openstack.org/swift/latest/logs.html#swift-source for
|
||||
more information.
|
||||
|
||||
* Fixed a bug where an SLO download with a range request may have resulted
|
||||
@ -391,13 +391,13 @@ swift (2.10.0, OpenStack Newton)
|
||||
* Object versioning now supports a "history" mode in addition to
|
||||
the older "stack" mode. The difference is in how DELETE requests
|
||||
are handled. For full details, please read
|
||||
http://docs.openstack.org/developer/swift/overview_object_versioning.html.
|
||||
https://docs.openstack.org/swift/latest/overview_object_versioning.html.
|
||||
|
||||
* New config variables to change the schedule priority and I/O
|
||||
scheduling class. Servers and daemons now understand
|
||||
`nice_priority`, `ionice_class`, and `ionice_priority` to
|
||||
schedule their relative importance. Please read
|
||||
http://docs.openstack.org/developer/swift/deployment_guide.html
|
||||
https://docs.openstack.org/swift/latest/admin_guide.html
|
||||
for full config details.
|
||||
|
||||
* On newer kernels (3.15+ when using xfs), Swift will use the O_TMPFILE
|
||||
@ -410,7 +410,7 @@ swift (2.10.0, OpenStack Newton)
|
||||
improved in clusters that are not completely healthy.
|
||||
|
||||
* Significant improvements to the api-ref doc available at
|
||||
http://developer.openstack.org/api-ref/object-storage/.
|
||||
https://developer.openstack.org/api-ref/object-storage/.
|
||||
|
||||
* A PUT or POST to a container will now update the container's
|
||||
Last-Modified time, and that value will be included in a
|
||||
@ -464,7 +464,7 @@ swift (2.9.0)
|
||||
|
||||
For more information on the details of the at-rest encryption
|
||||
feature, please see the docs at
|
||||
http://docs.openstack.org/developer/swift/overview_encryption.html.
|
||||
https://docs.openstack.org/swift/latest/overview_encryption.html.
|
||||
|
||||
* `swift-recon` can now be called with more than one server type.
|
||||
|
||||
@ -606,7 +606,7 @@ swift (2.7.0, OpenStack Mitaka)
|
||||
default it will stagger the firing.
|
||||
|
||||
* Added an operational procedures guide to the docs. It can be
|
||||
found at http://docs.openstack.org/developer/swift/ops_runbook/index.html and
|
||||
found at https://docs.openstack.org/swift/latest/ops_runbook/index.html and
|
||||
includes information on detecting and handling day-to-day
|
||||
operational issues in a Swift cluster.
|
||||
|
||||
@ -776,7 +776,7 @@ swift (2.6.0)
|
||||
* Container sync has been improved to more quickly find and iterate over
|
||||
the containers to be synced. This reduced server load and lowers the
|
||||
time required to see data propagate between two clusters. Please see
|
||||
http://docs.openstack.org/developer/swift/overview_container_sync.html for more details
|
||||
https://docs.openstack.org/swift/latest/overview_container_sync.html for more details
|
||||
about the new on-disk structure for tracking synchronized containers.
|
||||
|
||||
* A container POST will now update that container's put-timestamp value.
|
||||
@ -862,7 +862,7 @@ swift (2.4.0)
|
||||
server config setting ("allow_versions"), if it is currently enabled.
|
||||
The existing container server config setting enables existing
|
||||
containers to continue being versioned. Please see
|
||||
http://docs.openstack.org/developer/swift/middleware.html#how-to-enable-object-versioning-in-a-swift-cluster
|
||||
https://docs.openstack.org/swift/latest/middleware.html#how-to-enable-object-versioning-in-a-swift-cluster
|
||||
for further upgrade notes.
|
||||
|
||||
* Allow 1+ object-servers-per-disk deployment
|
||||
@ -987,7 +987,7 @@ swift (2.3.0, OpenStack Kilo)
|
||||
ssync for durability. Deployers are urged to do extensive testing and
|
||||
not deploy production data using an erasure code storage policy.
|
||||
|
||||
Full docs are at http://docs.openstack.org/developer/swift/overview_erasure_code.html
|
||||
Full docs are at https://docs.openstack.org/swift/latest/overview_erasure_code.html
|
||||
|
||||
* Add support for container TempURL Keys.
|
||||
|
||||
@ -996,7 +996,7 @@ swift (2.3.0, OpenStack Kilo)
|
||||
|
||||
* Swift now supports composite tokens. This allows another service to
|
||||
act on behalf of a user, but only with that user's consent.
|
||||
See http://docs.openstack.org/developer/swift/overview_auth.html for more details.
|
||||
See https://docs.openstack.org/swift/latest/overview_auth.html for more details.
|
||||
|
||||
* Multi-region replication was improved. When replicating data to a
|
||||
different region, only one replica will be pushed per replication
|
||||
@ -1004,7 +1004,7 @@ swift (2.3.0, OpenStack Kilo)
|
||||
locally instead of pushing more data over the inter-region network.
|
||||
|
||||
* Internal requests from the ratelimit middleware now properly log a
|
||||
swift_source. See http://docs.openstack.org/developer/swift/logs.html for details.
|
||||
swift_source. See https://docs.openstack.org/swift/latest/logs.html for details.
|
||||
|
||||
* Improved storage policy support for quarantine stats in swift-recon.
|
||||
|
||||
@ -1052,7 +1052,7 @@ swift (2.2.2)
|
||||
The overload and dispersion metrics have been exposed in the
|
||||
swift-ring-build CLI tools.
|
||||
|
||||
See http://docs.openstack.org/developer/swift/overview_ring.html
|
||||
See https://docs.openstack.org/swift/latest/overview_ring.html
|
||||
for more info on how data placement works now.
|
||||
|
||||
* Improve replication of large out-of-sync, out-of-date containers.
|
||||
@ -1140,7 +1140,7 @@ swift (2.2.0, OpenStack Juno)
|
||||
now requires that ACLs be set on IDs, which are unique across
|
||||
domains, and further restricts setting new ACLs to only use IDs.
|
||||
|
||||
Please see http://docs.openstack.org/developer/swift/overview_auth.html for
|
||||
Please see https://docs.openstack.org/swift/latest/overview_auth.html for
|
||||
more information on configuring Swift and Keystone together.
|
||||
|
||||
* Swift now supports server-side account-to-account copy. Server-
|
||||
@ -1257,7 +1257,7 @@ swift (2.0.0)
|
||||
them. A policy is set on a Swift container at container creation
|
||||
time and cannot be changed.
|
||||
|
||||
Full docs are at http://docs.openstack.org/developer/swift/overview_policies.html
|
||||
Full docs are at https://docs.openstack.org/swift/latest/overview_policies.html
|
||||
|
||||
* Add profiling middleware in Swift
|
||||
|
||||
@ -1351,7 +1351,7 @@ swift (1.13.0)
|
||||
the header is a JSON dictionary string to be interpreted by the
|
||||
auth system. A reference implementation is given in TempAuth.
|
||||
Please see the full docs at
|
||||
http://docs.openstack.org/developer/swift/overview_auth.html
|
||||
https://docs.openstack.org/swift/latest/overview_auth.html
|
||||
|
||||
* Added a WSGI environment flag to stop swob from always using
|
||||
absolute location. This is useful if middleware needs to use
|
||||
@ -1433,8 +1433,8 @@ swift (1.12.0)
|
||||
* New container sync configuration option, separating the end user
|
||||
from knowing the required end point and adding more secure
|
||||
signed requests. See
|
||||
http://docs.openstack.org/developer/swift/overview_container_sync.html for full
|
||||
information.
|
||||
https://docs.openstack.org/swift/latest/overview_container_sync.html
|
||||
for full information.
|
||||
|
||||
* bulk middleware now can be configured to retry deleting containers.
|
||||
|
||||
@ -1699,7 +1699,7 @@ swift (1.9.0)
|
||||
bugrelated to content-disposition names.
|
||||
|
||||
* Added crossdomain.xml middleware. See
|
||||
http://docs.openstack.org/developer/swift/crossdomain.html for details
|
||||
https://docs.openstack.org/swift/latest/crossdomain.html for details
|
||||
|
||||
* Added rsync bandwidth limit setting for object replicator
|
||||
|
||||
@ -1720,7 +1720,7 @@ swift (1.9.0)
|
||||
* Improved container-sync resiliency
|
||||
|
||||
* Added example Apache config files. See
|
||||
http://docs.openstack.org/developer/swift/apache_deployment_guide.html
|
||||
https://docs.openstack.org/swift/latest/apache_deployment_guide.html
|
||||
for more info
|
||||
|
||||
* If an account is marked as deleted but hasn't been reaped and is still
|
||||
@ -1768,7 +1768,7 @@ swift (1.8.0, OpenStack Grizzly)
|
||||
|
||||
This is a change that may require an update to your proxy server
|
||||
config file or custom middleware that you may be using. See the full
|
||||
docs at http://docs.openstack.org/developer/swift/misc.html#module-swift.common.middleware.proxy_logging.
|
||||
docs at https://docs.openstack.org/swift/latest/misc.html.
|
||||
|
||||
* Changed the default sample rate for a few high-traffic requests.
|
||||
|
||||
|
||||
@ -75,7 +75,7 @@ working on.
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
http://docs.openstack.org/developer/swift/first_contribution_swift.html
|
||||
https://docs.openstack.org/swift/latest/first_contribution_swift.html
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
@ -116,7 +116,7 @@ Recommended workflow
|
||||
====================
|
||||
|
||||
- Set up a `Swift All-In-One
|
||||
VM <http://docs.openstack.org/developer/swift/development_saio.html>`__\ (SAIO).
|
||||
VM <https://docs.openstack.org/swift/latest/development_saio.html>`__\ (SAIO).
|
||||
|
||||
- Make your changes. Docs and tests for your patch must land before or
|
||||
with your patch.
|
||||
|
||||
20
README.rst
20
README.rst
@ -31,7 +31,7 @@ To build documentation install sphinx (``pip install sphinx``), run
|
||||
``python setup.py build_sphinx``, and then browse to
|
||||
/doc/build/html/index.html. These docs are auto-generated after every
|
||||
commit and available online at
|
||||
http://docs.openstack.org/developer/swift/.
|
||||
https://docs.openstack.org/swift/latest/.
|
||||
|
||||
For Developers
|
||||
--------------
|
||||
@ -39,13 +39,14 @@ For Developers
|
||||
Getting Started
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Swift is part of OpenStack and follows the code contribution, review, and testing processes common to all OpenStack projects.
|
||||
Swift is part of OpenStack and follows the code contribution, review, and
|
||||
testing processes common to all OpenStack projects.
|
||||
|
||||
If you would like to start contributing, check out these
|
||||
`notes <CONTRIBUTING.rst>`__ to help you get started.
|
||||
|
||||
The best place to get started is the
|
||||
`"SAIO - Swift All In One" <http://docs.openstack.org/developer/swift/development_saio.html>`__.
|
||||
`"SAIO - Swift All In One" <https://docs.openstack.org/swift/latest/development_saio.html>`__.
|
||||
This document will walk you through setting up a development cluster of
|
||||
Swift in a VM. The SAIO environment is ideal for running small-scale
|
||||
tests against swift and trying out new features and bug fixes.
|
||||
@ -72,7 +73,7 @@ continue to work.
|
||||
|
||||
Probe tests are "white box" tests that validate the internal workings of a
|
||||
Swift cluster. They are written to work against the
|
||||
`"SAIO - Swift All In One" <http://docs.openstack.org/developer/swift/development_saio.html>`__
|
||||
`"SAIO - Swift All In One" <https://docs.openstack.org/swift/latest/development_saio.html>`__
|
||||
dev environment. For example, a probe test may create an object, delete one
|
||||
replica, and ensure that the background consistency processes find and correct
|
||||
the error.
|
||||
@ -119,10 +120,9 @@ For Deployers
|
||||
-------------
|
||||
|
||||
Deployer docs are also available at
|
||||
http://docs.openstack.org/developer/swift/. A good starting point is at
|
||||
http://docs.openstack.org/developer/swift/deployment_guide.html
|
||||
|
||||
There is an `ops runbook <http://docs.openstack.org/developer/swift/ops_runbook/>`__
|
||||
https://docs.openstack.org/swift/latest/. A good starting point is at
|
||||
https://docs.openstack.org/swift/latest/deployment_guide.html
|
||||
There is an `ops runbook <https://docs.openstack.org/swift/latest/ops_runbook/index.html>`__
|
||||
that gives information about how to diagnose and troubleshoot common issues
|
||||
when running a Swift cluster.
|
||||
|
||||
@ -138,11 +138,11 @@ For client applications, official Python language bindings are provided
|
||||
at http://github.com/openstack/python-swiftclient.
|
||||
|
||||
Complete API documentation at
|
||||
http://developer.openstack.org/api-ref/object-store/
|
||||
https://developer.openstack.org/api-ref/object-store/
|
||||
|
||||
There is a large ecosystem of applications and libraries that support and
|
||||
work with OpenStack Swift. Several are listed on the
|
||||
`associated projects <http://docs.openstack.org/developer/swift/associated_projects.html>`__
|
||||
`associated projects <https://docs.openstack.org/swift/latest/associated_projects.html>`__
|
||||
page.
|
||||
|
||||
--------------
|
||||
|
||||
@ -1493,6 +1493,6 @@ See :ref:`custom-logger-hooks-label` for sample use cases.
|
||||
Securing OpenStack Swift
|
||||
------------------------
|
||||
|
||||
Please refer to the security guide at http://docs.openstack.org/security-guide
|
||||
Please refer to the security guide at https://docs.openstack.org/security-guide
|
||||
and in particular the `Object Storage
|
||||
<http://docs.openstack.org/security-guide/object-storage.html>`__ section.
|
||||
<https://docs.openstack.org/security-guide/object-storage.html>`__ section.
|
||||
|
||||
@ -169,14 +169,14 @@ The API Reference describes the operations that you can perform with the
|
||||
Object Storage API:
|
||||
|
||||
- `Storage
|
||||
accounts <http://developer.openstack.org/api-ref/object-storage/index.html#accounts>`__:
|
||||
accounts <https://developer.openstack.org/api-ref/object-storage/index.html#accounts>`__:
|
||||
Use to perform account-level tasks.
|
||||
|
||||
Lists containers for a specified account. Creates, updates, and
|
||||
deletes account metadata. Shows account metadata.
|
||||
|
||||
- `Storage
|
||||
containers <http://developer.openstack.org/api-ref/object-storage/index.html#containers>`__:
|
||||
containers <https://developer.openstack.org/api-ref/object-storage/index.html#containers>`__:
|
||||
Use to perform container-level tasks.
|
||||
|
||||
Lists objects in a specified container. Creates, shows details for,
|
||||
@ -184,7 +184,7 @@ Object Storage API:
|
||||
container metadata.
|
||||
|
||||
- `Storage
|
||||
objects <http://developer.openstack.org/api-ref/object-storage/index.html#objects>`__:
|
||||
objects <https://developer.openstack.org/api-ref/object-storage/index.html#objects>`__:
|
||||
Use to perform object-level tasks.
|
||||
|
||||
Creates, replaces, shows details for, and deletes objects. Copies
|
||||
|
||||
@ -222,4 +222,4 @@ Note that if the above example is copied exactly, and used in a command
|
||||
shell, then the ampersand is interpreted as an operator and the URL
|
||||
will be truncated. Enclose the URL in quotation marks to avoid this.
|
||||
|
||||
.. _tempurl: http://docs.openstack.org/developer/python-swiftclient/cli.html#tempurl
|
||||
.. _tempurl: https://docs.openstack.org/python-swiftclient/latest/cli/index.html#swift-tempurl
|
||||
|
||||
@ -104,8 +104,8 @@ can be found in the KeystoneMiddleware_ distribution.
|
||||
The :ref:`keystoneauth` middleware performs authorization and mapping the
|
||||
Keystone roles to Swift's ACLs.
|
||||
|
||||
.. _KeystoneMiddleware: http://docs.openstack.org/developer/keystonemiddleware/
|
||||
.. _Keystone: http://docs.openstack.org/developer/keystone/
|
||||
.. _KeystoneMiddleware: https://docs.openstack.org/keystonemiddleware/latest/
|
||||
.. _Keystone: https://docs.openstack.org/keystone/latest/
|
||||
|
||||
.. _configuring_keystone_auth:
|
||||
|
||||
@ -167,7 +167,7 @@ your situation, but in short:
|
||||
service. The example values shown here assume a user named 'swift' with admin
|
||||
role on a project named 'service', both being in the Keystone domain with id
|
||||
'default'. Refer to the `KeystoneMiddleware documentation
|
||||
<http://docs.openstack.org/developer/keystonemiddleware/middlewarearchitecture.html#configuration>`_
|
||||
<https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitecture.html#configuration>`_
|
||||
for other examples.
|
||||
|
||||
* ``cache`` is set to ``swift.cache``. This means that the middleware
|
||||
|
||||
@ -238,7 +238,7 @@ Keys currently stored in Barbican can be listed using the
|
||||
The keymaster uses the explicitly configured username and password (and
|
||||
project name etc.) from the `keymaster.conf` file for retrieving the encryption
|
||||
root secret from an external key management system. The `Castellan library
|
||||
<http://docs.openstack.org/developer/castellan/>`_ is used to communicate with
|
||||
<https://docs.openstack.org/castellan/latest/>`_ is used to communicate with
|
||||
Barbican.
|
||||
|
||||
For the proxy server, reading the encryption root secret directly from the
|
||||
|
||||
@ -357,7 +357,7 @@ user_test5_tester5 = testing5 service
|
||||
# Following parameters are known to work with keystonemiddleware v2.3.0
|
||||
# (above v2.0.0), but checking the latest information in the wiki page[1]
|
||||
# is recommended.
|
||||
# 1. http://docs.openstack.org/developer/keystonemiddleware/middlewarearchitecture.html#configuration
|
||||
# 1. https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitecture.html#configuration
|
||||
#
|
||||
# [filter:authtoken]
|
||||
# paste.filter_factory = keystonemiddleware.auth_token:filter_factory
|
||||
|
||||
Loading…
Reference in New Issue
Block a user