From 7ba03500dce130f7cc07dc2b541d758ea7eb4e4a Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Thu, 5 May 2016 16:59:02 +0530 Subject: [PATCH] [Glossary] Table of contents for glossary file Modified the file to get a list of contents Change-Id: Ib33a8ce346d76ae4ac099d9904bf8e6be1ba3261 Closes-Bug: #1491122 Co-Authored-By: KATO Tomoyuki --- doc/admin-guide/source/index.rst | 14 +++ doc/arch-design-draft/source/index.rst | 14 +++ doc/arch-design/source/index.rst | 13 ++- doc/cli-reference/source/index.rst | 12 +++ doc/common/glossary.rst | 128 +++++++++++++++++++++++++ doc/config-reference/source/index.rst | 13 +++ doc/contributor-guide/source/index.rst | 7 ++ doc/ha-guide/source/index.rst | 12 +++ doc/image-guide/source/index.rst | 12 +++ doc/install-guide/source/index.rst | 22 +++-- doc/networking-guide/source/index.rst | 12 +++ doc/ops-guide/source/index.rst | 20 +++- doc/user-guide/source/index.rst | 12 +++ 13 files changed, 283 insertions(+), 8 deletions(-) diff --git a/doc/admin-guide/source/index.rst b/doc/admin-guide/source/index.rst index 37489605bc..6e99b14003 100644 --- a/doc/admin-guide/source/index.rst +++ b/doc/admin-guide/source/index.rst @@ -32,7 +32,21 @@ Contents orchestration.rst cli.rst cross_project.rst + +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/arch-design-draft/source/index.rst b/doc/arch-design-draft/source/index.rst index 0d14b56c1b..819fd98e8b 100644 --- a/doc/arch-design-draft/source/index.rst +++ b/doc/arch-design-draft/source/index.rst @@ -33,7 +33,21 @@ Contents security-requirements.rst legal-requirements.rst arch-examples.rst + +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/arch-design/source/index.rst b/doc/arch-design/source/index.rst index 62c6a3ba59..90d7fe73ab 100644 --- a/doc/arch-design/source/index.rst +++ b/doc/arch-design/source/index.rst @@ -21,7 +21,6 @@ Contents :maxdepth: 2 common/conventions.rst - introduction.rst legal-security-requirements.rst generalpurpose.rst @@ -34,8 +33,20 @@ Contents specialized.rst references.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/cli-reference/source/index.rst b/doc/cli-reference/source/index.rst index 9384824a88..95ebe43b88 100644 --- a/doc/cli-reference/source/index.rst +++ b/doc/cli-reference/source/index.rst @@ -42,8 +42,20 @@ Contents gnocchi.rst mistral.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/common/glossary.rst b/doc/common/glossary.rst index ebf1d9eb67..9b92061bec 100644 --- a/doc/common/glossary.rst +++ b/doc/common/glossary.rst @@ -11,6 +11,9 @@ repository update the source file ``doc/common/glossary.rst`` through the OpenStack contribution process. +0-9 +~~~ + .. glossary:: 6to4 @@ -19,6 +22,11 @@ OpenStack contribution process. over an IPv4 network, providing a strategy for migrating to IPv6. +A +~ + +.. glossary:: + absolute limit Impassable limits for guest VMs. Settings include total RAM @@ -363,6 +371,11 @@ OpenStack contribution process. collection of related resources. The Orchestration service supports a CloudFormation-compatible format (CFN). +B +~ + +.. glossary:: + back end Interactions and processes that are obfuscated from the user, @@ -535,6 +548,11 @@ OpenStack contribution process. Set of bits that make up a single character; there are usually 8 bits to a byte. +C +~ + +.. glossary:: + CA Certificate Authority or Certification Authority. In @@ -961,6 +979,11 @@ OpenStack contribution process. A user-created Python module that is loaded by horizon to change the look and feel of the dashboard. +D +~ + +.. glossary:: + daemon A process that runs in the background and waits for requests. @@ -1255,6 +1278,11 @@ OpenStack contribution process. enable users to interact with a web page or show simple animation. +E +~ + +.. glossary:: + east-west traffic Network traffic between servers in the same cloud or data center. @@ -1423,6 +1451,11 @@ OpenStack contribution process. to start a new instance. Examples include a minimum amount of network bandwidth or a GPU. +F +~ + +.. glossary:: + FakeLDAP An easy method to create a local LDAP directory for testing @@ -1548,6 +1581,11 @@ OpenStack contribution process. The point where a user interacts with a service; can be an API endpoint, the horizon dashboard, or a command-line tool. +G +~ + +.. glossary:: + gateway An IP address, typically assigned to a router, that @@ -1634,6 +1672,11 @@ OpenStack contribution process. An operating system instance running under the control of a hypervisor. +H +~ + +.. glossary:: + Hadoop Apache Hadoop is an open source software framework that supports @@ -1758,6 +1801,11 @@ OpenStack contribution process. A collection of hypervisors grouped together through host aggregates. +I +~ + +.. glossary:: + IaaS Infrastructure-as-a-Service. IaaS is a provisioning model in @@ -2046,6 +2094,11 @@ OpenStack contribution process. A default role in the Compute RBAC system that can quarantine an instance in any project. +J +~ + +.. glossary:: + Java A programming language that is used to create systems that @@ -2075,6 +2128,11 @@ OpenStack contribution process. design summit took place in Atlanta, Georgia, US and Juno is an unincorporated community in Georgia. +K +~ + +.. glossary:: + Kerberos A network authentication protocol which works on the basis of @@ -2116,6 +2174,11 @@ OpenStack contribution process. in the Pavillon de Breteuil in Sèvres, the community chose Kilo as the release name. +L +~ + +.. glossary:: + large object An object within Object Storage that is larger than 5 GB. @@ -2207,6 +2270,11 @@ OpenStack contribution process. devices that is more flexible than conventional partitioning schemes. +M +~ + +.. glossary:: + magnum Code name for the OpenStack project that provides the @@ -2384,6 +2452,11 @@ OpenStack contribution process. Facility in Compute that enables a virtual machine instance to have more than one VIF connected to it. +N +~ + +.. glossary:: + Nebula Released as open source by NASA in 2010 and is the basis for @@ -2553,6 +2626,11 @@ OpenStack contribution process. firewalls, and other network-related tasks. This is the legacy networking option and an alternative to Networking. +O +~ + +.. glossary:: + object A BLOB of data held by Object Storage; can be in any @@ -2704,6 +2782,11 @@ OpenStack contribution process. OpenStack project that produces a set of Python libraries containing code shared by OpenStack projects. +P +~ + +.. glossary:: + parent cell If a requested resource, such as CPU time, disk storage, or @@ -2901,6 +2984,11 @@ OpenStack contribution process. Programming language used extensively in OpenStack. +Q +~ + +.. glossary:: + QEMU Copy On Write 2 (QCOW2) One of the VM image disk formats supported by Image @@ -2929,6 +3017,11 @@ OpenStack contribution process. In Compute and Block Storage, the ability to set resource limits on a per-project basis. +R +~ + +.. glossary:: + RabbitMQ The default message queue software used by OpenStack. @@ -3162,6 +3255,11 @@ OpenStack contribution process. Soft limit on the amount of network traffic a Compute VM instance can send and receive. +S +~ + +.. glossary:: + S3 Object storage service by Amazon; similar in function to Object @@ -3557,6 +3655,11 @@ OpenStack contribution process. collects meters and usage information. This information can be used for billing. +T +~ + +.. glossary:: + Telemetry service An integrated project that provides metering and measuring @@ -3656,6 +3759,11 @@ OpenStack contribution process. OpenStack project that provides database services to applications. +U +~ + +.. glossary:: + Ubuntu A Debian-based Linux distribution. @@ -3686,6 +3794,11 @@ OpenStack contribution process. An OpenStack-supported hypervisor. +V +~ + +.. glossary:: + VIF UUID Unique ID assigned to each Networking VIF. @@ -3872,6 +3985,11 @@ OpenStack contribution process. An OpenStack-supported hypervisor. +W +~ + +.. glossary:: + weighting A Compute process that determines the suitability of the VM @@ -3903,6 +4021,11 @@ OpenStack contribution process. workflow execution state and state of individual tasks. The code name of the project is mistral. +X +~ + +.. glossary:: + Xen Xen is a hypervisor using a microkernel design, providing @@ -3933,6 +4056,11 @@ OpenStack contribution process. Graphics. Excels in parallel I/O operations and data consistency. +Z +~ + +.. glossary:: + zaqar OpenStack project that provides a message service to diff --git a/doc/config-reference/source/index.rst b/doc/config-reference/source/index.rst index 09b703dff2..42eebeea1b 100644 --- a/doc/config-reference/source/index.rst +++ b/doc/config-reference/source/index.rst @@ -33,12 +33,25 @@ Contents shared-file-systems.rst telemetry.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + policy-json-file.rst firewalls-default-ports.rst common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst + Search in this guide ~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/contributor-guide/source/index.rst b/doc/contributor-guide/source/index.rst index 553f542dac..913406a2af 100644 --- a/doc/contributor-guide/source/index.rst +++ b/doc/contributor-guide/source/index.rst @@ -36,6 +36,13 @@ Contents json-conventions.rst ui-text-guidelines.rst doc-tools.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/ha-guide/source/index.rst b/doc/ha-guide/source/index.rst index e65f1250aa..8752640459 100644 --- a/doc/ha-guide/source/index.rst +++ b/doc/ha-guide/source/index.rst @@ -33,8 +33,20 @@ Contents compute-node-ha.rst noncore-ha.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 common/app_support.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/image-guide/source/index.rst b/doc/image-guide/source/index.rst index 4987b70012..0322af3ffc 100644 --- a/doc/image-guide/source/index.rst +++ b/doc/image-guide/source/index.rst @@ -23,8 +23,20 @@ Contents create-images-automatically.rst convert-images.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index 1dbc5c3583..9bc08af658 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -101,9 +101,6 @@ Contents trove.rst launch-instance.rst - common/app_support.rst - common/glossary.rst - .. only:: debian .. toctree:: @@ -126,11 +123,24 @@ Contents trove.rst launch-instance.rst - common/app_support.rst - common/glossary.rst - .. end of contents +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + common/app_support.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + common/glossary.rst + Search in this guide ~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/networking-guide/source/index.rst b/doc/networking-guide/source/index.rst index efb0a3cd25..06a42c3370 100644 --- a/doc/networking-guide/source/index.rst +++ b/doc/networking-guide/source/index.rst @@ -30,8 +30,20 @@ Contents miscellaneous.rst adv-config.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide diff --git a/doc/ops-guide/source/index.rst b/doc/ops-guide/source/index.rst index 99ba8f6b08..a8c0912cdc 100644 --- a/doc/ops-guide/source/index.rst +++ b/doc/ops-guide/source/index.rst @@ -7,7 +7,6 @@ Abstract This book provides information about designing and operating OpenStack clouds. - Contents ~~~~~~~~ @@ -19,9 +18,28 @@ Contents common/conventions.rst architecture.rst operations.rst + +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + app_usecases.rst app_crypt.rst app_roadmaps.rst app_resources.rst common/app_support.rst + +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst + +Search in this guide +~~~~~~~~~~~~~~~~~~~~ + +* :ref:`search` diff --git a/doc/user-guide/source/index.rst b/doc/user-guide/source/index.rst index 5a2f627e64..91e52d041d 100644 --- a/doc/user-guide/source/index.rst +++ b/doc/user-guide/source/index.rst @@ -28,8 +28,20 @@ Contents hot.rst cli_cheat_sheet.rst +Appendix +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/app_support.rst +Glossary +~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + common/glossary.rst Search in this guide