From 1ac6401196a453945895aacd672c77250586b55b Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Fri, 2 Sep 2016 10:22:59 +0100 Subject: [PATCH] [glossary] Consolodate project codenames [keystone] - Rename "Identity service" to "Identity service (keystone)" - Link "keystone" to "Identity service (keystone)" - Make sure description matches project.yaml - Resolve glossary references Change-Id: Id828fce4d43fedcecbfb390d82f93380cffc372f Implements: blueprint improve-glossary-usage --- .../compute-focus-technical-considerations.rst | 2 +- .../generalpurpose-technical-considerations.rst | 2 +- doc/common/get-started-identity.rst | 6 +++--- doc/common/glossary.rst | 14 +++++++------- doc/networking-guide/source/intro.rst | 2 +- doc/ops-guide/source/ops-maintenance-slow.rst | 7 ++++--- 6 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/arch-design/source/compute-focus-technical-considerations.rst b/doc/arch-design/source/compute-focus-technical-considerations.rst index 21b2259a45..0b256ca574 100644 --- a/doc/arch-design/source/compute-focus-technical-considerations.rst +++ b/doc/arch-design/source/compute-focus-technical-considerations.rst @@ -180,7 +180,7 @@ includes the typical OpenStack components: * :term:`Image service` (glance) -* :term:`Identity service` (keystone) +* :term:`Identity service (keystone)` Also consider several specialized components: diff --git a/doc/arch-design/source/generalpurpose-technical-considerations.rst b/doc/arch-design/source/generalpurpose-technical-considerations.rst index 90f9df67bb..557915340f 100644 --- a/doc/arch-design/source/generalpurpose-technical-considerations.rst +++ b/doc/arch-design/source/generalpurpose-technical-considerations.rst @@ -350,7 +350,7 @@ OpenStack core services recommended in a general purpose cloud are: * :term:`Image service` (:term:`glance`) -* :term:`Identity service` (:term:`keystone`) +* :term:`Identity service (keystone)` * :term:`Dashboard (horizon)` diff --git a/doc/common/get-started-identity.rst b/doc/common/get-started-identity.rst index 73c1d87497..887a649c22 100644 --- a/doc/common/get-started-identity.rst +++ b/doc/common/get-started-identity.rst @@ -2,9 +2,9 @@ Identity service overview ========================= -The OpenStack :term:`Identity service` provides a single point of -integration for managing authentication, authorization, and a catalog of -services. +The OpenStack :term:`Identity service ` provides +a single point of integration for managing authentication, authorization, and +a catalog of services. The Identity service is typically the first service a user interacts with. Once authenticated, an end user can use their identity to access other OpenStack diff --git a/doc/common/glossary.rst b/doc/common/glossary.rst index 7474767546..181f2aab96 100644 --- a/doc/common/glossary.rst +++ b/doc/common/glossary.rst @@ -1804,13 +1804,13 @@ I name and password. It is a typical source of authentication tokens. - Identity service + Identity service (keystone) - The OpenStack core project that provides a central directory of - users mapped to the OpenStack services they can access. It also - registers endpoints for OpenStack services. It acts as a common - authentication system. The project name of Identity is - keystone. + The project that facilitates API client authentication, service + discovery, distributed multi-tenant authorization, and auditing. + It provides a central directory of users mapped to the OpenStack + services they can access. It also registers endpoints for OpenStack + services and acts as a common authentication system. Identity service API @@ -2115,7 +2115,7 @@ K keystone - The project that provides OpenStack Identity services. + Codename of the :term:`Identity service `. Kickstart diff --git a/doc/networking-guide/source/intro.rst b/doc/networking-guide/source/intro.rst index 702d2a7e33..c4cb07c284 100644 --- a/doc/networking-guide/source/intro.rst +++ b/doc/networking-guide/source/intro.rst @@ -26,7 +26,7 @@ to that specific host instead. OpenStack Networking integrates with various OpenStack components: -* OpenStack :term:`Identity service` (keystone) is used for authentication +* OpenStack :term:`Identity service (keystone)` is used for authentication and authorization of API requests. * OpenStack :term:`Compute service (nova)` is used to plug each virtual diff --git a/doc/ops-guide/source/ops-maintenance-slow.rst b/doc/ops-guide/source/ops-maintenance-slow.rst index 96747ba4c4..c569e9b649 100644 --- a/doc/ops-guide/source/ops-maintenance-slow.rst +++ b/doc/ops-guide/source/ops-maintenance-slow.rst @@ -16,9 +16,10 @@ designed to be an exhaustive list. OpenStack Identity service ~~~~~~~~~~~~~~~~~~~~~~~~~~ -If OpenStack :term:`Identity service` is responding slowly, it could be due -to the token table getting large. This can be fixed by running the -:command:`keystone-manage token_flush` command. +If OpenStack :term:`Identity service ` is +responding slowly, it could be due to the token table getting large. +This can be fixed by running the :command:`keystone-manage token_flush` +command. Additionally, for Identity-related issues, try the tips in :ref:`sql_backend`.