From a93f57edf407434db69409b429a892c380306bb8 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Fri, 2 Sep 2016 09:22:48 +0100 Subject: [PATCH] [glossary] Consolodate project codenames [neutron] - Combine "networking service" entry with "neutron" entry - Rename "Networking service" to "Networking service (neutron)" - Link "neutron" to "Networking service (neutron)" - Make sure description matches project.yaml - Combine "Networking API" and "Neutron API" - Resolve glossary references Implements: blueprint improve-glossary-usage Change-Id: Ib55edcdd291ef677a60daf215c685c6c18942439 --- ...compute-focus-technical-considerations.rst | 2 +- ...eneralpurpose-technical-considerations.rst | 2 +- doc/common/glossary.rst | 17 +++++++------- doc/networking-guide/source/intro.rst | 8 +++---- doc/ops-guide/source/ops-maintenance-slow.rst | 22 +++++++++---------- 5 files changed, 26 insertions(+), 25 deletions(-) diff --git a/doc/arch-design/source/compute-focus-technical-considerations.rst b/doc/arch-design/source/compute-focus-technical-considerations.rst index 0d0ab5db52..81404ee7fa 100644 --- a/doc/arch-design/source/compute-focus-technical-considerations.rst +++ b/doc/arch-design/source/compute-focus-technical-considerations.rst @@ -206,7 +206,7 @@ Also consider several specialized components: OpenStack Block Storage (cinder) in the infrastructure, but typically it is not a central component. -* :term:`Networking service` (neutron) +* :term:`Networking service (neutron)` When choosing a networking platform, ensure that it either works with all desired hypervisor and container technologies and their OpenStack drivers, or that it includes an implementation of an ML2 mechanism diff --git a/doc/arch-design/source/generalpurpose-technical-considerations.rst b/doc/arch-design/source/generalpurpose-technical-considerations.rst index 3db2f9a882..7b291be0e5 100644 --- a/doc/arch-design/source/generalpurpose-technical-considerations.rst +++ b/doc/arch-design/source/generalpurpose-technical-considerations.rst @@ -346,7 +346,7 @@ OpenStack core services recommended in a general purpose cloud are: * :term:`Compute service (nova)` -* :term:`Networking service` (:term:`neutron`) +* :term:`Networking service (neutron)` * :term:`Image service` (:term:`glance`) diff --git a/doc/common/glossary.rst b/doc/common/glossary.rst index 9552548025..7d23ac2f04 100644 --- a/doc/common/glossary.rst +++ b/doc/common/glossary.rst @@ -2510,25 +2510,26 @@ N services such as giving an IP address to a booting nova instance. - Networking service + Networking service (neutron) - A core OpenStack project that provides a network connectivity - abstraction layer to OpenStack Compute. The project name of Networking - is neutron. + The OpenStack projects which implements services and associated + libraries to provide on-demand, scalable, and technology-agnostic + network abstraction. - Networking API + Networking API (Neutron API) API used to access OpenStack Networking. Provides an extensible architecture to enable custom plug-in creation. neutron - A core OpenStack project that provides a network connectivity - abstraction layer to OpenStack Compute. + Codename for OpenStack :term:`Networking service `. neutron API - An alternative name for Networking API. + An alternative name for :term:`Networking API `. neutron manager diff --git a/doc/networking-guide/source/intro.rst b/doc/networking-guide/source/intro.rst index 74c5ade25d..acddd7c0e0 100644 --- a/doc/networking-guide/source/intro.rst +++ b/doc/networking-guide/source/intro.rst @@ -4,10 +4,10 @@ Introduction ============ -The OpenStack :term:`Networking service` provides an API that allows users -to set up and define network connectivity and addressing in the -cloud. The project code-name for Networking services is neutron. -OpenStack Networking handles the creation and management of a virtual +The OpenStack :term:`Networking service ` +provides an API that allows users to set up and define network connectivity +and addressing in the cloud. The project code-name for Networking services is +neutron. OpenStack Networking handles the creation and management of a virtual networking infrastructure, including networks, switches, subnets, and routers for devices managed by the OpenStack Compute service (nova). Advanced services such as firewalls or :term:`virtual private diff --git a/doc/ops-guide/source/ops-maintenance-slow.rst b/doc/ops-guide/source/ops-maintenance-slow.rst index 41b3a62c41..e24c450aa3 100644 --- a/doc/ops-guide/source/ops-maintenance-slow.rst +++ b/doc/ops-guide/source/ops-maintenance-slow.rst @@ -51,17 +51,17 @@ services, SQL is used extensively. OpenStack Networking service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Slowness in the OpenStack :term:`Networking service` can be caused by services -that it relies upon, but it can also be related to either physical or -virtual networking. For example: network namespaces that do not exist or -are not tied to interfaces correctly; DHCP daemons that have hung or are -not running; a cable being physically disconnected; a switch not being -configured correctly. When debugging Networking service problems, begin -by verifying all physical networking functionality (switch -configuration, physical cabling, etc.). After the physical networking is -verified, check to be sure all of the Networking services are running -(neutron-server, neutron-dhcp-agent, etc.), then check on AMQP and SQL -back ends. +Slowness in the OpenStack :term:`Networking service ` can be caused by services that it relies upon, but it can +also be related to either physical or virtual networking. For example: +network namespaces that do not exist or are not tied to interfaces correctly; +DHCP daemons that have hung or are not running; a cable being physically +disconnected; a switch not being configured correctly. When debugging +Networking service problems, begin by verifying all physical networking +functionality (switch configuration, physical cabling, etc.). After the +physical networking is verified, check to be sure all of the Networking +services are running (neutron-server, neutron-dhcp-agent, etc.), then check +on AMQP and SQL back ends. AMQP broker ~~~~~~~~~~~