From 3f2ea6e9d68efdc9f7e48557ce6345c18f5f5c6c Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Mon, 15 Aug 2016 13:29:21 +0100 Subject: [PATCH] [glossary] Remove acronyms [E-I] - Remove acronym-only entries starting with [E-I]. - Consolodate duplicate entries. - Resolve glossary references Implements: blueprint improve-glossary-usage Change-Id: I0112705305aba0c22346d9dd3386a308c93f6003 --- .../source/blockstorage-manage-volumes.rst | 4 +- doc/admin-guide/source/compute-flavors.rst | 3 +- doc/admin-guide/source/compute.rst | 2 +- doc/admin-guide/source/ts-cinder-config.rst | 5 +- .../source/ts-duplicate-3par-host.rst | 4 +- .../source/ts-non-existent-host.rst | 4 +- ...hnical-requirements-hardware-selection.rst | 4 +- .../source/overview-customer-requirements.rst | 11 +-- .../source/generalpurpose-architecture.rst | 4 +- .../generalpurpose-user-requirements.rst | 2 +- ...storage-focus-technical-considerations.rst | 11 +-- doc/common/get-started-compute.rst | 4 +- doc/common/get-started-with-openstack.rst | 2 +- doc/common/glossary.rst | 87 ++++++++----------- doc/config-reference/source/config-format.rst | 4 +- .../source/rst-conv/inline-markups.rst | 7 +- .../source/cinder-storage-install.rst | 6 +- doc/install-guide/source/launch-instance.rst | 2 +- doc/install-guide/source/overview.rst | 6 +- doc/ops-guide/source/preface.rst | 2 +- 20 files changed, 81 insertions(+), 93 deletions(-) diff --git a/doc/admin-guide/source/blockstorage-manage-volumes.rst b/doc/admin-guide/source/blockstorage-manage-volumes.rst index 249a031599..9ebff12eb1 100644 --- a/doc/admin-guide/source/blockstorage-manage-volumes.rst +++ b/doc/admin-guide/source/blockstorage-manage-volumes.rst @@ -28,8 +28,8 @@ to a server instance. #. Use the :command:`openstack volume create ` command to create a volume. This command creates an LV into the volume group (VG) ``cinder-volumes``. #. Use the :command:`openstack server add volume` command to attach the - volume to an instance. This command creates a unique :term:`IQN` that is - exposed to the compute node. + volume to an instance. This command creates a unique :term:`IQN ` that is exposed to the compute node. * The compute node, which runs the instance, now has an active iSCSI session and new local storage (usually a ``/dev/sdX`` diff --git a/doc/admin-guide/source/compute-flavors.rst b/doc/admin-guide/source/compute-flavors.rst index 02b12a51cd..abcf245133 100644 --- a/doc/admin-guide/source/compute-flavors.rst +++ b/doc/admin-guide/source/compute-flavors.rst @@ -197,7 +197,8 @@ Disk I/O limits is -1 which indicates unlimited usage. - ``disk_io_reservation``: Specifies the guaranteed minimum disk - allocation in terms of :term:`IOPS`. + allocation in terms of :term:`IOPS `. - ``disk_io_shares_level``: Specifies the allocation level. This can be ``custom``, ``high``, ``normal`` or ``low``. diff --git a/doc/admin-guide/source/compute.rst b/doc/admin-guide/source/compute.rst index 34a66ef7e8..95a1481b9e 100644 --- a/doc/admin-guide/source/compute.rst +++ b/doc/admin-guide/source/compute.rst @@ -3,7 +3,7 @@ Compute ======= The OpenStack Compute service allows you to control an -:term:`Infrastructure-as-a-Service (IaaS) ` cloud computing platform. +:term:`Infrastructure-as-a-Service (IaaS)` cloud computing platform. It gives you control over instances and networks, and allows you to manage access to the cloud through users and projects. diff --git a/doc/admin-guide/source/ts-cinder-config.rst b/doc/admin-guide/source/ts-cinder-config.rst index b7097f8703..2f220752e6 100644 --- a/doc/admin-guide/source/ts-cinder-config.rst +++ b/doc/admin-guide/source/ts-cinder-config.rst @@ -108,7 +108,8 @@ Problem The OpenStack Block Storage uses ``tgtd`` as the default iSCSI helper and implements persistent targets. This means that in the case of a ``tgt`` restart, or even a node reboot, your existing volumes on that -node will be restored automatically with their original :term:`IQN`. +node will be restored automatically with their original :term:`IQN `. By default, Block Storage uses a ``state_path`` variable, which if installing with Yum or APT should be set to ``/var/lib/cinder/``. @@ -119,7 +120,7 @@ file-tree: ``/var/lib/cinder/volumes/``. Solution -------- -In order to ensure nodes are restored to their original :term:`IQN`, +In order to ensure nodes are restored to their original IQN, the iSCSI target information needs to be stored in a file on creation that can be queried in case of restart of the ``tgt daemon``. While the installer should handle all this, it can go wrong. diff --git a/doc/admin-guide/source/ts-duplicate-3par-host.rst b/doc/admin-guide/source/ts-duplicate-3par-host.rst index dca8fe51e7..8ff1af3e87 100644 --- a/doc/admin-guide/source/ts-duplicate-3par-host.rst +++ b/doc/admin-guide/source/ts-duplicate-3par-host.rst @@ -7,8 +7,8 @@ Problem This error may be caused by a volume being exported outside of OpenStack using a host name different from the system name that OpenStack expects. -This error could be displayed with the :term:`IQN` if the host was exported -using iSCSI: +This error could be displayed with the :term:`IQN ` if the host was exported using iSCSI: .. code-block:: console diff --git a/doc/admin-guide/source/ts-non-existent-host.rst b/doc/admin-guide/source/ts-non-existent-host.rst index 0b2a3e6ffe..f25cdbd2ad 100644 --- a/doc/admin-guide/source/ts-non-existent-host.rst +++ b/doc/admin-guide/source/ts-non-existent-host.rst @@ -7,8 +7,8 @@ Problem This error could be caused by a volume being exported outside of OpenStack using a host name different from the system name that -OpenStack expects. This error could be displayed with the :term:`IQN` -if the host was exported using iSCSI. +OpenStack expects. This error could be displayed with the :term:`IQN ` if the host was exported using iSCSI. .. code-block:: console diff --git a/doc/arch-design-draft/source/arch-guide-draft-mitaka/technical-requirements-hardware-selection.rst b/doc/arch-design-draft/source/arch-guide-draft-mitaka/technical-requirements-hardware-selection.rst index f55d411914..12f242df8c 100644 --- a/doc/arch-design-draft/source/arch-guide-draft-mitaka/technical-requirements-hardware-selection.rst +++ b/doc/arch-design-draft/source/arch-guide-draft-mitaka/technical-requirements-hardware-selection.rst @@ -275,8 +275,8 @@ balance of resources. Server hardware must provide the following: * Network capacity (number and speed of links) -* Storage capacity (gigabytes or terabytes as well as Input/Output - Operations Per Second (:term:`IOPS`) +* Storage capacity (gigabytes or terabytes as well as :term:`Input/Output + Operations Per Second (IOPS)` The best form factor for server hardware supporting a general purpose OpenStack cloud is driven by outside business and cost factors. No diff --git a/doc/arch-design-draft/source/overview-customer-requirements.rst b/doc/arch-design-draft/source/overview-customer-requirements.rst index 43c0db8eac..08ebc622dd 100644 --- a/doc/arch-design-draft/source/overview-customer-requirements.rst +++ b/doc/arch-design-draft/source/overview-customer-requirements.rst @@ -182,11 +182,12 @@ Input-Output requirements Scale Scaling storage solutions in a storage-focused OpenStack architecture design is driven by initial requirements, including - :term:`IOPS`, capacity, bandwidth, and future needs. Planning - capacity based on projected needs over the course of a budget cycle - is important for a design. The architecture should balance cost and - capacity, while also allowing flexibility to implement new - technologies and methods as they become available. + :term:`IOPS `, capacity, + bandwidth, and future needs. Planning capacity based on projected needs + over the course of a budget cycle is important for a design. The + architecture should balance cost and capacity, while also allowing + flexibility to implement new technologies and methods as they become + available. Network ~~~~~~~ diff --git a/doc/arch-design/source/generalpurpose-architecture.rst b/doc/arch-design/source/generalpurpose-architecture.rst index 0e4d4718de..17132c6661 100644 --- a/doc/arch-design/source/generalpurpose-architecture.rst +++ b/doc/arch-design/source/generalpurpose-architecture.rst @@ -29,8 +29,8 @@ balance of resources. Server hardware must provide the following: * Network capacity (number and speed of links) -* Storage capacity (gigabytes or terabytes as well as Input/Output - Operations Per Second (:term:`IOPS`) +* Storage capacity (gigabytes or terabytes as well as :term:`Input/Output + Operations Per Second (IOPS)` Evaluate server hardware around four conflicting dimensions: diff --git a/doc/arch-design/source/generalpurpose-user-requirements.rst b/doc/arch-design/source/generalpurpose-user-requirements.rst index 6f169fcbe4..b06f2608a3 100644 --- a/doc/arch-design/source/generalpurpose-user-requirements.rst +++ b/doc/arch-design/source/generalpurpose-user-requirements.rst @@ -3,7 +3,7 @@ User requirements ================= When building a general purpose cloud, you should follow the -Infrastructure-as-a-Service (:term:`IaaS`) model; a platform best suited +:term:`Infrastructure-as-a-Service (IaaS)` model; a platform best suited for use cases with simple requirements. General purpose cloud user requirements are not complex. However, it is important to capture them even if the project has minimum business and technical requirements, such diff --git a/doc/arch-design/source/storage-focus-technical-considerations.rst b/doc/arch-design/source/storage-focus-technical-considerations.rst index 20d67a46f3..55bb640b8c 100644 --- a/doc/arch-design/source/storage-focus-technical-considerations.rst +++ b/doc/arch-design/source/storage-focus-technical-considerations.rst @@ -19,11 +19,12 @@ Input-Output requirements Scale Scaling storage solutions in a storage-focused OpenStack architecture design is driven by initial requirements, including - :term:`IOPS`, capacity, bandwidth, and future needs. Planning - capacity based on projected needs over the course of a budget cycle - is important for a design. The architecture should balance cost and - capacity, while also allowing flexibility to implement new - technologies and methods as they become available. + :term:`IOPS `, capacity, + bandwidth, and future needs. Planning capacity based on projected + needs over the course of a budget cycle is important for a design. + The architecture should balance cost and capacity, while also allowing + flexibility to implement new technologies and methods as they become + available. Security Designing security around data has multiple points of focus that diff --git a/doc/common/get-started-compute.rst b/doc/common/get-started-compute.rst index 2db59a4763..d2149fc446 100644 --- a/doc/common/get-started-compute.rst +++ b/doc/common/get-started-compute.rst @@ -3,8 +3,8 @@ Compute service overview ======================== Use OpenStack Compute to host and manage cloud computing systems. -OpenStack Compute is a major part of an Infrastructure-as-a-Service -(:term:`IaaS`) system. The main modules are implemented in Python. +OpenStack Compute is a major part of an :term:`Infrastructure-as-a-Service +(IaaS)` system. The main modules are implemented in Python. OpenStack Compute interacts with OpenStack Identity for authentication; OpenStack Image service for disk and server images; and OpenStack diff --git a/doc/common/get-started-with-openstack.rst b/doc/common/get-started-with-openstack.rst index c6429ace1e..82f07e28e1 100644 --- a/doc/common/get-started-with-openstack.rst +++ b/doc/common/get-started-with-openstack.rst @@ -15,7 +15,7 @@ types of clouds, which aims to be simple to implement, massively scalable, and feature rich. Developers and cloud computing technologists from around the world create the OpenStack project. -OpenStack provides an Infrastructure-as-a-Service (:term:`IaaS`) solution +OpenStack provides an :term:`Infrastructure-as-a-Service (IaaS)` solution through a set of interrelated services. Each service offers an :term:`application programming interface (API)` that facilitates this integration. Depending on your needs, you can install some or all diff --git a/doc/common/glossary.rst b/doc/common/glossary.rst index 590f722985..a35b7976ef 100644 --- a/doc/common/glossary.rst +++ b/doc/common/glossary.rst @@ -1475,7 +1475,7 @@ F implemented in Compute using iptables, arptables, ip6tables, and ebtables. - FWaaS + FireWall-as-a-Service (FWaaS) A Networking extension that provides perimeter firewall functionality. @@ -1780,28 +1780,12 @@ I .. glossary:: - IaaS - - Infrastructure-as-a-Service. IaaS is a provisioning model in - which an organization outsources physical components of a data center, - such as storage, hardware, servers, and networking components. A - service provider owns the equipment and is responsible for housing, - operating and maintaining it. The client typically pays on a per-use - basis. IaaS is a model for providing cloud services. - Icehouse The code name for the ninth release of OpenStack. The design summit took place in Hong Kong and Ice House is a street in that city. - ICMP - - Internet Control Message Protocol, used by network - devices for control messages. For example, - :command:`ping` uses ICMP to test - connectivity. - ID number Unique numeric ID associated with each user in Identity, @@ -1835,10 +1819,6 @@ I The API used to access the OpenStack Identity service provided through keystone. - IDS - - Intrusion Detection System. - image A collection of files for a specific operating system (OS) that @@ -1908,12 +1888,21 @@ I A community project may be elevated to this status and is then promoted to a core project. + Infrastructure-as-a-Service (IaaS) + + IaaS is a provisioning model in which an organization outsources + physical components of a data center, such as storage, hardware, + servers, and networking components. A service provider owns the + equipment and is responsible for housing, operating and maintaining + it. The client typically pays on a per-use basis. + IaaS is a model for providing cloud services. + ingress filtering The process of filtering incoming network traffic. Supported by Compute. - INI + INI format The OpenStack configuration files use an INI format to describe options and their values. It consists of sections @@ -1924,6 +1913,12 @@ I The process of putting a file into a virtual machine image before the instance is started. + Input/Output Operations Per Second (IOPS) + + IOPS are a common performance measurement used to benchmark computer + storage devices like hard disk drives, solid state drives, and + storage area networks. + instance A running VM, or a VM in a known state such as suspended, that @@ -1956,6 +1951,15 @@ I Unique ID assigned to each guest VM instance. + Intelligent Platform Management Interface (IPMI) + + IPMI is a standardized computer system interface used by system + administrators for out-of-band management of computer systems and + monitoring of their operation. In layman's terms, it is a way to + manage a computer using a direct network connection, whether it is + turned on or not; connecting to the hardware rather than an operating + system or login shell. + interface A physical or virtual device that provides connectivity @@ -1966,6 +1970,12 @@ I Unique ID for a Networking VIF or vNIC in the form of a UUID. + Internet Control Message Protocol (ICMP) + + A network protocol used by network devices for control messages. + For example, :command:`ping` uses ICMP to test + connectivity. + Internet protocol (IP) Principal communications protocol in the internet protocol @@ -1980,19 +1990,13 @@ I Storage protocol that encapsulates SCSI frames for transport over IP networks. + Supported by Compute, Object Storage, and Image service. ironic OpenStack project that provisions bare metal, as opposed to virtual machines. - IOPS - - IOPS (Input/Output Operations Per Second) are a common - performance measurement used to benchmark computer storage - devices like hard disk drives, solid state drives, and - storage area networks. - IP address Number that is unique to every computer system on the Internet. @@ -2005,20 +2009,6 @@ I and management. Currently provided by Compute, melange, and Networking. - IPL - - Initial Program Loader. - - IPMI - - Intelligent Platform Management Interface. IPMI is a - standardized computer system interface used by system administrators - for out-of-band management of computer systems and monitoring of their - operation. In layman's terms, it - is a way to manage a computer using a direct network connection, - whether it is turned on or not; connecting to the hardware rather than - an operating system or login shell. - ip6tables Tool used to set up, maintain, and inspect the tables of IPv6 @@ -2043,21 +2033,16 @@ I ip6tables to IPv6, arptables to ARP, and ebtables to Ethernet frames. Requires root privilege to manipulate. - IQN + iSCSI Qualified Name (IQN) - iSCSI Qualified Name (IQN) is the format most commonly used - for iSCSI names, which uniquely identify nodes in an iSCSI network. + IQN is the format most commonly used for iSCSI names, which uniquely + identify nodes in an iSCSI network. All IQNs follow the pattern iqn.yyyy-mm.domain:identifier, where 'yyyy-mm' is the year and month in which the domain was registered, 'domain' is the reversed domain name of the issuing organization, and 'identifier' is an optional string which makes each IQN under the same domain unique. For example, 'iqn.2015-10.org.openstack.408ae959bce1'. - iSCSI - - The SCSI disk protocol tunneled within Ethernet, supported by - Compute, Object Storage, and Image service. - ISO9660 One of the VM image disk formats supported by Image diff --git a/doc/config-reference/source/config-format.rst b/doc/config-reference/source/config-format.rst index cdb002ff22..4cf1c00e88 100644 --- a/doc/config-reference/source/config-format.rst +++ b/doc/config-reference/source/config-format.rst @@ -2,8 +2,8 @@ Configuration file format ========================= -OpenStack uses the :term:`INI` file format for configuration files. -An INI file is a simple text file that specifies options as +OpenStack uses the :term:`INI ` file format for configuration +files. An INI file is a simple text file that specifies options as ``key=value`` pairs, grouped into sections. The ``DEFAULT`` section contains most of the configuration options. Lines starting with a hash sign (``#``) are comment lines. diff --git a/doc/contributor-guide/source/rst-conv/inline-markups.rst b/doc/contributor-guide/source/rst-conv/inline-markups.rst index 24e28475f4..6b0db82776 100644 --- a/doc/contributor-guide/source/rst-conv/inline-markups.rst +++ b/doc/contributor-guide/source/rst-conv/inline-markups.rst @@ -88,12 +88,11 @@ A term that appears in the glossary. +------------------------+---------------------------------------------------+ | **Markup** | ``:term:`` | +------------------------+---------------------------------------------------+ -| **Syntax** | ``:term:`IaaS``` | +| **Syntax** | ``:term:`neutron``` | | | or ``:term:`services ``` | +------------------------+---------------------------------------------------+ -| **Example of output** | OpenStack provides an :term:`IaaS` solution | -| | through a variety of complementary | -| | :term:`services `. | +| **Example of output** | OpenStack :term:`neutron` provides | +| | network-related :term:`services `. | +------------------------+---------------------------------------------------+ .. _gui_element: diff --git a/doc/install-guide/source/cinder-storage-install.rst b/doc/install-guide/source/cinder-storage-install.rst index be54499c0f..003d0eec99 100644 --- a/doc/install-guide/source/cinder-storage-install.rst +++ b/doc/install-guide/source/cinder-storage-install.rst @@ -11,9 +11,9 @@ value for your particular node. The service provisions logical volumes on this device using the :term:`LVM ` driver and provides them -to instances via :term:`iSCSI` transport. You can follow these -instructions with minor modifications to horizontally scale your -environment with additional storage nodes. +to instances via :term:`iSCSI ` transport. +You can follow these instructions with minor modifications to horizontally +scale your environment with additional storage nodes. Prerequisites ------------- diff --git a/doc/install-guide/source/launch-instance.rst b/doc/install-guide/source/launch-instance.rst index e7d7888ae5..d84a7997fc 100644 --- a/doc/install-guide/source/launch-instance.rst +++ b/doc/install-guide/source/launch-instance.rst @@ -116,7 +116,7 @@ secure shell (SSH). * Add rules to the ``default`` security group: - * Permit :term:`ICMP` (ping): + * Permit :term:`ICMP ` (ping): .. code-block:: console diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 977629e870..3262c6d4d2 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -7,7 +7,7 @@ supports all types of cloud environments. The project aims for simple implementation, massive scalability, and a rich set of features. Cloud computing experts from around the world contribute to the project. -OpenStack provides an :term:`Infrastructure-as-a-Service (IaaS)` solution +OpenStack provides an :term:`Infrastructure-as-a-Service (IaaS)` solution through a variety of complementary services. Each service offers an :term:`Application Programming Interface (API)` that facilitates this integration. @@ -210,8 +210,8 @@ instances. This option lacks support for self-service (private) networks, layer-3 (routing) services, and advanced services such as :term:`LBaaS ` and - :term:`FWaaS`. Consider the self-service networks option if you - desire these features. + :term:`FWaaS`. + Consider the self-service networks option if you desire these features. .. _figure-network1-services: diff --git a/doc/ops-guide/source/preface.rst b/doc/ops-guide/source/preface.rst index 9a6dee659a..228b2c6a1e 100644 --- a/doc/ops-guide/source/preface.rst +++ b/doc/ops-guide/source/preface.rst @@ -3,7 +3,7 @@ Preface ======= OpenStack is an open source platform that lets you build an -:term:`Infrastructure-as-a-Service (IaaS)` cloud that runs on commodity +:term:`Infrastructure-as-a-Service (IaaS)` cloud that runs on commodity hardware. Introduction to OpenStack