openstack/swift
Code Issues Proposed changes

Use uppercase 'S' in word "OpenStack"

Browse Source 
Change-Id: I4692aa58b5173b1b662d5eee19fac770ae5aaed0
This commit is contained in:
venkatamahesh 2016-02-04 16:47:15 +05:30
parent eaf6af3179
commit 050e3b35dd
5 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -89,8 +89,8 @@ Specs
The [``swift-specs``](https://github.com/openstack/swift-specs) repo The [``swift-specs``](https://github.com/openstack/swift-specs) repo
can be used for collaborative design work before a feature is implemented. can be used for collaborative design work before a feature is implemented.
Openstack's gerrit system is used to collaborate on the design spec. Once OpenStack's gerrit system is used to collaborate on the design spec. Once
approved Openstack provides a doc site to easily read these [specs](http://specs.openstack.org/openstack/swift-specs/) approved OpenStack provides a doc site to easily read these [specs](http://specs.openstack.org/openstack/swift-specs/)
A spec is needed for more impactful features. Coordinating a feature between A spec is needed for more impactful features. Coordinating a feature between
many devs (especially across companies) is a great example of when a spec is many devs (especially across companies) is a great example of when a spec is

4
doc/source/associated_projects.rst
View File

@ -25,7 +25,7 @@ Application Bindings
* `java-openstack-swift <https://github.com/dkocher/java-openstack-swift>`_ - Java bindings for OpenStack Swift * `java-openstack-swift <https://github.com/dkocher/java-openstack-swift>`_ - Java bindings for OpenStack Swift
* `swift_client <https://github.com/mrkamel/swift_client>`_ - Small but powerful Ruby client to interact with OpenStack Swift * `swift_client <https://github.com/mrkamel/swift_client>`_ - Small but powerful Ruby client to interact with OpenStack Swift
* `nightcrawler_swift <https://github.com/tulios/nightcrawler_swift>`_ - This Ruby gem teleports your assets to a OpenStack Swift bucket/container * `nightcrawler_swift <https://github.com/tulios/nightcrawler_swift>`_ - This Ruby gem teleports your assets to a OpenStack Swift bucket/container
* `swift storage <https://rubygems.org/gems/swift-storage>`_ - Simple Openstack Swift storage client. * `swift storage <https://rubygems.org/gems/swift-storage>`_ - Simple OpenStack Swift storage client.
Authentication Authentication
-------------- --------------
@ -106,7 +106,7 @@ Other
* `Glance <https://github.com/openstack/glance>`_ - Provides services for discovering, registering, and retrieving virtual machine images (for OpenStack Compute [Nova], for example). * `Glance <https://github.com/openstack/glance>`_ - Provides services for discovering, registering, and retrieving virtual machine images (for OpenStack Compute [Nova], for example).
* `Better Staticweb <https://github.com/CloudVPS/better-staticweb>`_ - Makes swift containers accessible by default. * `Better Staticweb <https://github.com/CloudVPS/better-staticweb>`_ - Makes swift containers accessible by default.
* `Swiftsync <https://github.com/stackforge/swiftsync>`_ - A massive syncer between two swift clusters. * `Swiftsync <https://github.com/stackforge/swiftsync>`_ - A massive syncer between two swift clusters.
* `Django Swiftbrowser <https://github.com/cschwede/django-swiftbrowser>`_ - Simple Django web app to access Openstack Swift. * `Django Swiftbrowser <https://github.com/cschwede/django-swiftbrowser>`_ - Simple Django web app to access OpenStack Swift.
* `Swift-account-stats <https://github.com/enovance/swift-account-stats>`_ - Swift-account-stats is a tool to report statistics on Swift usage at tenant and global levels. * `Swift-account-stats <https://github.com/enovance/swift-account-stats>`_ - Swift-account-stats is a tool to report statistics on Swift usage at tenant and global levels.
* `PyECLib <https://bitbucket.org/kmgreen2/pyeclib>`_ - High Level Erasure Code library used by Swift * `PyECLib <https://bitbucket.org/kmgreen2/pyeclib>`_ - High Level Erasure Code library used by Swift
* `liberasurecode <http://www.bytebucket.org/tsg-/liberasurecode>`_ - Low Level Erasure Code library used by PyECLib * `liberasurecode <http://www.bytebucket.org/tsg-/liberasurecode>`_ - Low Level Erasure Code library used by PyECLib

10
doc/source/howto_installmultinode.rst
View File

@ -3,31 +3,31 @@ Instructions for a Multiple Server Swift Installation
===================================================== =====================================================
Please refer to the latest official Please refer to the latest official
`Openstack Installation Guides <http://docs.openstack.org/#install-guides>`_ `OpenStack Installation Guides <http://docs.openstack.org/#install-guides>`_
for the most up-to-date documentation. for the most up-to-date documentation.
Object Storage installation guide for Openstack Liberty Object Storage installation guide for OpenStack Liberty
------------------------------------------------------- -------------------------------------------------------
* `openSUSE 13.2 and SUSE Linux Enterprise Server 12 <http://docs.openstack.org/liberty/install-guide-obs/swift.html>`_ * `openSUSE 13.2 and SUSE Linux Enterprise Server 12 <http://docs.openstack.org/liberty/install-guide-obs/swift.html>`_
* `RHEL 7, CentOS 7 <http://docs.openstack.org/liberty/install-guide-rdo/swift.html>`_ * `RHEL 7, CentOS 7 <http://docs.openstack.org/liberty/install-guide-rdo/swift.html>`_
* `Ubuntu 14.04 <http://docs.openstack.org/liberty/install-guide-ubuntu/swift.html>`_ * `Ubuntu 14.04 <http://docs.openstack.org/liberty/install-guide-ubuntu/swift.html>`_
Object Storage installation guide for Openstack Kilo Object Storage installation guide for OpenStack Kilo
---------------------------------------------------- ----------------------------------------------------
* `openSUSE 13.2 and SUSE Linux Enterprise Server 12 <http://docs.openstack.org/kilo/install-guide/install/zypper/content/ch_swift.html>`_ * `openSUSE 13.2 and SUSE Linux Enterprise Server 12 <http://docs.openstack.org/kilo/install-guide/install/zypper/content/ch_swift.html>`_
* `RHEL 7, CentOS 7, and Fedora 21 <http://docs.openstack.org/kilo/install-guide/install/yum/content/ch_swift.html>`_ * `RHEL 7, CentOS 7, and Fedora 21 <http://docs.openstack.org/kilo/install-guide/install/yum/content/ch_swift.html>`_
* `Ubuntu 14.04 <http://docs.openstack.org/kilo/install-guide/install/apt/content/ch_swift.html>`_ * `Ubuntu 14.04 <http://docs.openstack.org/kilo/install-guide/install/apt/content/ch_swift.html>`_
Object Storage installation guide for Openstack Juno Object Storage installation guide for OpenStack Juno
---------------------------------------------------- ----------------------------------------------------
* `openSUSE 13.1 and SUSE Linux Enterprise Server 11 <http://docs.openstack.org/juno/install-guide/install/zypper/content/ch_swift.html>`_ * `openSUSE 13.1 and SUSE Linux Enterprise Server 11 <http://docs.openstack.org/juno/install-guide/install/zypper/content/ch_swift.html>`_
* `RHEL 7, CentOS 7, and Fedora 20 <http://docs.openstack.org/juno/install-guide/install/yum/content/ch_swift.html>`_ * `RHEL 7, CentOS 7, and Fedora 20 <http://docs.openstack.org/juno/install-guide/install/yum/content/ch_swift.html>`_
* `Ubuntu 14.04 <http://docs.openstack.org/juno/install-guide/install/apt/content/ch_swift.html>`_ * `Ubuntu 14.04 <http://docs.openstack.org/juno/install-guide/install/apt/content/ch_swift.html>`_
Object Storage installation guide for Openstack Icehouse Object Storage installation guide for OpenStack Icehouse
-------------------------------------------------------- --------------------------------------------------------
* `openSUSE and SUSE Linux Enterprise Server <http://docs.openstack.org/icehouse/install-guide/install/zypper/content/ch_swift.html>`_ * `openSUSE and SUSE Linux Enterprise Server <http://docs.openstack.org/icehouse/install-guide/install/zypper/content/ch_swift.html>`_

10
doc/source/overview_auth.rst
View File

@ -207,7 +207,7 @@ that the user is allowed to operate on project resources.
OpenStack Service Using Composite Tokens OpenStack Service Using Composite Tokens
---------------------------------------- ----------------------------------------
Some Openstack services such as Cinder and Glance may use Some OpenStack services such as Cinder and Glance may use
a "service account". In this mode, you configure a separate account where a "service account". In this mode, you configure a separate account where
the service stores project data that it manages. This account is not used the service stores project data that it manages. This account is not used
directly by the end-user. Instead, all access is done through the service. directly by the end-user. Instead, all access is done through the service.
@ -234,19 +234,19 @@ situation as follows:
(see ``/etc/keystone/default_catalog.templates`` above). Normally (see ``/etc/keystone/default_catalog.templates`` above). Normally
this is ``AUTH``. this is ``AUTH``.
* The second item in the reseller_prefix list is the prefix used by the * The second item in the reseller_prefix list is the prefix used by the
Openstack services(s). You must configure this value (``SERVICE`` in the OpenStack services(s). You must configure this value (``SERVICE`` in the
example) with whatever the other Openstack service(s) use. example) with whatever the other OpenStack service(s) use.
* Set the operator_roles option to contain a role or roles that end-user's * Set the operator_roles option to contain a role or roles that end-user's
have on project's they use. have on project's they use.
* Set the SERVICE_service_roles value to a role or roles that only the * Set the SERVICE_service_roles value to a role or roles that only the
Openstack service user has. Do not use a role that is assigned to OpenStack service user has. Do not use a role that is assigned to
"normal" end users. In this example, the role ``service`` is used. "normal" end users. In this example, the role ``service`` is used.
The service user is granted this role to a *single* project only. You do The service user is granted this role to a *single* project only. You do
not need to make the service user a member of every project. not need to make the service user a member of every project.
This configuration works as follows: This configuration works as follows:
* The end-user presents a user token to an Openstack service. The service * The end-user presents a user token to an OpenStack service. The service
then makes a Swift request to the account with the ``SERVICE`` prefix. then makes a Swift request to the account with the ``SERVICE`` prefix.
* The service forwards the original user token with the request. It also * The service forwards the original user token with the request. It also
adds it's own service token. adds it's own service token.

8
doc/source/overview_backing_store.rst
View File

@ -15,7 +15,7 @@ Glance writes the image to a Swift container as a set of objects.
Throughout this section, the following terminology and concepts are used: Throughout this section, the following terminology and concepts are used:
* User or end-user. This is a person making a request that will result in * User or end-user. This is a person making a request that will result in
an Openstack Service making a request to Swift. an OpenStack Service making a request to Swift.
* Project (also known as Tenant). This is the unit of resource ownership. * Project (also known as Tenant). This is the unit of resource ownership.
While data such as snapshot images or block volume backups may be While data such as snapshot images or block volume backups may be
@ -182,7 +182,7 @@ Using the HTTP_X_SERVICE_CATALOG to get Swift Account Name
The auth_token middleware populates the wsgi environment with information when The auth_token middleware populates the wsgi environment with information when
it validates the user's token. The HTTP_X_SERVICE_CATALOG item is a JSON it validates the user's token. The HTTP_X_SERVICE_CATALOG item is a JSON
string containing details of the Openstack endpoints. For Swift, this also string containing details of the OpenStack endpoints. For Swift, this also
contains the project's Swift account name. Here is an example of a catalog contains the project's Swift account name. Here is an example of a catalog
entry for Swift:: entry for Swift::
@ -236,7 +236,7 @@ requirement is that your Service User has the appropriate role. In practice:
reseller_prefix = AUTH_, SERVICE_ reseller_prefix = AUTH_, SERVICE_
SERVICE_service_role = service SERVICE_service_role = service
The ``service`` role should only be granted to Openstack Services. It should The ``service`` role should only be granted to OpenStack Services. It should
not be granted to users. not be granted to users.
Single or multiple Service Prefixes? Single or multiple Service Prefixes?
@ -244,7 +244,7 @@ Single or multiple Service Prefixes?
Most of the examples used in this document used a single prefix. The Most of the examples used in this document used a single prefix. The
prefix, ``SERVICE`` was used. By using a single prefix, an operator is prefix, ``SERVICE`` was used. By using a single prefix, an operator is
allowing all Openstack Services to share the same account for data allowing all OpenStack Services to share the same account for data
associated with a given project. For test systems or deployments well protected associated with a given project. For test systems or deployments well protected
on private firewalled networks, this is appropriate. on private firewalled networks, this is appropriate.