From 5067771c30d60a2d072559c26279ae6c0bb51c8b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 7 Feb 2014 20:28:41 +0100 Subject: [PATCH] Further glossary project edits Changes for neutron and swift to use official names. Also remove the entry "device" that is not really usefull. Change-Id: I561ed8826340c9c82e2ce477a372c49e5c33db81 --- doc/glossary/glossary-terms.xml | 311 ++++++++++++++++---------------- 1 file changed, 155 insertions(+), 156 deletions(-) diff --git a/doc/glossary/glossary-terms.xml b/doc/glossary/glossary-terms.xml index 99083ac8e6..21a53c2d3f 100644 --- a/doc/glossary/glossary-terms.xml +++ b/doc/glossary/glossary-terms.xml @@ -51,7 +51,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, account - The swift context of an account. Do not confuse + The Object Storage context of an account. Do not confuse with a user account from an authentication service such as Active Directory, /etc/passwd, OpenLDAP, OpenStack Identity Service, and so on. @@ -60,8 +60,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, account auditor - Checks for missing replicas, incorrect, and - corrupted objects in a specified swift account by + Checks for missing replicas and incorrect or + corrupted objects in a specified Object Storage account by running queries against the back-end SQLite database. @@ -69,30 +69,31 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, account database - A SQLite database that contains swift accounts - and related metadata and is accessed by the - accounts server. + A SQLite database that contains Object Storage accounts + and related metadata and that the + accounts server accesses. account reaper - A swift worker that scans for and deletes - account databases that are marked for deletion on - an account server. + An Object Storage worker that scans for and deletes + account databases and that the account server has marked + for deletion. + account server - Lists containers in swift and stores container + Lists containers in Object Storage and stores container information in the account database. account service - A swift component that provides account services + An Object Storage component that provides account services such as list, create, modify, and audit. Do not confuse with OpenStack Identity Service, OpenLDAP, or similar user account services. @@ -290,8 +291,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, API extension plug-in - Alternative term for a neutron plug-in or - neutron API extension. + Alternative term for a Networking plug-in or + Networking API extension. @@ -392,7 +393,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, attach The process of connecting a VIF or vNIC to a L2 - network in neutron. In the context of Compute, this + network in Networking. In the context of Compute, this process connects a storage volume to an instance. @@ -415,8 +416,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, auditor A worker process that verifies the integrity - of swift objects, containers, and accounts. - Auditors is the collective term for the swift + of Object Storage objects, containers, and accounts. + Auditors is the collective term for the Object Storage account auditor, container auditor, and object auditor. @@ -431,7 +432,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, auth node - Alternative term for a swift authorization + Alternative term for an Object Storage authorization node. @@ -464,16 +465,13 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, authorization The act of verifying that a user, process, or - client is authorized to perform an action, such as - delete a swift object, list a swift container, - start a guest VM, reset a password, and so - on. + client is authorized to perform an action. authorization node - A swift node that provides authorization + An Object Storage node that provides authorization services. @@ -546,7 +544,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Object Storage objects, current state of guest VMs, lists of user names, and so on. Also, the method that the Image Service uses to get and store VM images. - Options include swift, local file system, S3, and + Options include Object Storage, local file system, S3, and HTTP. @@ -563,7 +561,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, bare - A Image Service container format that indicates that no + An Image Service container format that indicates that no container exists for the VM image. @@ -670,10 +668,10 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, builder file - Contains configuration information for a swift - ring, and is used to re-configure the ring or to - recreate it from scratch after a serious - failure. + Contains configuration information that Object + Storage uses to reconfigure a ring or recreate it from + scratch after a serious failure. + @@ -913,7 +911,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Cisco neutron plug-in - A neutron plug-in for Cisco devices and + A Networking plug-in for Cisco devices and technologies including UCS and Nexus. @@ -1029,9 +1027,11 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, compression - OpenStack supports compression at the Linux file + Reduce the size of files by special encoding, the file + can be decompressed again to its original content. + OpenStack supports compression at the Linux file system level but does not support compression for - things such as swift objects or Image Service VM + things such as Object Storage objects or Image Service VM images. @@ -1095,9 +1095,9 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, concatenated object - A segmented large object within swift that is - put back together again and then sent to the - client. + A set of segment objects that Object Storage combines + and sends to the client. + @@ -1112,7 +1112,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, consistency window - The amount of time it takes for a new swift + The amount of time it takes for a new Object Storage object to become accessible to all clients. @@ -1126,9 +1126,9 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, container - Used to organize and store objects within swift, - similar to the concept as a Linux directory but - cannot be nested. Alternative term for a Image Service + Organizes and stores objects in Object Storage. + Similar to the concept of a Linux directory but + cannot be nested. Alternative term for an Image Service container format. @@ -1136,16 +1136,18 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, container auditor Checks for missing replicas or incorrect objects - in the specified swift containers through queries + in specified Object Storage containers through queries to the SQLite back-end database. container database - A SQLite database that contains swift containers - and related metadata and is accessed by the - container server + + A SQLite database that stores Object Storage + containers and container metadata. The container + server accesses this database. + @@ -1161,13 +1163,13 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, container server - A swift that manages containers. + An Object Storage server that manages containers. container service - The swift component that provides container + The Object Storage component that provides container services, such as create, delete, list, and so on. @@ -1308,7 +1310,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, database replicator - A swift component that copies changes in the + An Object Storage component that copies changes in the account, container, and object databases to other nodes. @@ -1317,9 +1319,10 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, deallocate The process of removing the association between - a floating IP address and a fixed IP address thus - returning the floating IP to the address - pool. + a floating IP address and a fixed IP address. + Once this association is removed, the floating IP + returns to the address pool. + @@ -1394,26 +1397,21 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, user. - - device - - In the context of swift this refers to the - underlying storage device. - - device ID - Maps swift partitions to physical storage + Maps Object Storage partitions to physical storage devices. device weight - Used to distribute the partitions among swift - devices. The distribution is usually proportional - to the storage capacity of the device. + + Distributes partitions proportionately across + Object Storage devices based on the storage + capacity of each device. + @@ -1500,7 +1498,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, dispersion - In swift, tools to test and ensure dispersion of + In Object Storage, tools to test and ensure dispersion of objects and containers to ensure fault tolerance. @@ -1721,8 +1719,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Any piece of hardware or software that wants to connect to the network services provided by - neutron, the Network Connectivity service. An - entity can make use of neutron by implementing a + Networking, the Network Connectivity service. An + entity can make use of Networking by implementing a VIF. @@ -1778,7 +1776,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, ETag - MD5 hash of an object within swift, used to + MD5 hash of an object within Object Storage, used to ensure data integrity. @@ -1845,7 +1843,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, File system option that enables storage of additional information beyond owner, group, permissions, modification time, and so on. The - underlying swift file system must support extended + underlying Object Storage file system must support extended attributes. @@ -2020,7 +2018,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, FormPost - swift middleware that uploads + Object Storage middleware that uploads (posts) an image through a form on a web page. @@ -2147,7 +2145,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, handover - An object state in swift where a new replica of + An object state in Object Storage where a new replica of the object is automatically created due to a drive failure. @@ -2446,7 +2444,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, image store The back-end store used by Image Service to store VM - images, options include swift, local file system, + images, options include Object Storage, local file system, S3, or HTTP. @@ -2525,7 +2523,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, interface ID - Unique ID for a neutron VIF or vNIC in the form + Unique ID for a Networking VIF or vNIC in the form of a UUID. @@ -2711,7 +2709,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, large object - An object within swift that is larger than 5 + An object within Object Storage that is larger than 5 GBs. @@ -2747,7 +2745,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Linux Bridge neutron plug-in Enables a Linux bridge to understand - a neutron port, interface attachment, and other + a Networking port, interface attachment, and other abstractions. @@ -2818,13 +2816,13 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, manifest Used to track segments of a large object within - swift. + Object Storage. manifest object - A special swift object that contains the + A special Object Storage object that contains the manifest for a large object. @@ -2839,7 +2837,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, melange Project name for OpenStack Network Information - Service. To be merged with neutron. + Service. To be merged with Networking. @@ -2861,7 +2859,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, memcached A distributed memory object caching system that - is used by swift for caching. + is used by Object Storage for caching. @@ -2924,7 +2922,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Can concurrently use multiple layer 2 networking technologies, such as 802.1Q and - VXLAN, in neutron. + VXLAN, in Networking. @@ -2991,7 +2989,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, A virtual network that provides connectivity between entities. For example, a collection of virtual ports that share network connectivity. In - neutron terminology, a network is always a Layer-2 + Networking terminology, a network is always a Layer-2 network. @@ -3023,7 +3021,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, network ID Unique ID assigned to each network segment - within neutron. Same as network UUID + within Networking. Same as network UUID @@ -3045,7 +3043,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, network segment Represents a virtual, isolated OSI layer 2 - subnet in neutron. + subnet in Networking. @@ -3059,7 +3057,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, network UUID - Unique ID for a neutron network segment. + Unique ID for a Networking network segment. @@ -3079,6 +3077,14 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, neutron. + + Networking API + + API used to access OpenStack Networking. Provides an + extensible architecture to enable custom plug-in + creation. + + neutron @@ -3090,9 +3096,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, neutron API - API used to access neutron. Provides an - extensible architecture to enable custom plug-in - creation. + An alternative name for Networking API. @@ -3106,7 +3110,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, neutron plug-in - Interface within neutron that enables + Interface within Networking that enables organizations to create custom plug-ins for advanced features such as QoS, ACLs, or IDS. @@ -3123,7 +3127,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Nicira NVP neutron plug-in Provides support for the Nicira Network - Virtualization Platform (NVP) in neutron. + Virtualization Platform (NVP) in Networking. @@ -3193,17 +3197,10 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, object - A BLOB of data held by swift, can be in any + A BLOB of data held by Object Storage, can be in any format. - - Object API - - Alternative term for the swift object - API. - - object auditor @@ -3215,7 +3212,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, object expiration - A configurable option within swift to + A configurable option within Object Storage to automatically delete objects after a specified amount of time has passed or a certain date is reached. @@ -3224,13 +3221,13 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, object hash - Uniquely ID for a swift object. + Uniquely ID for an Object Storage object. object path hash - Used by swift to determine the location of an + Used by Object Storage to determine the location of an object in the ring. Maps objects to partitions. @@ -3238,31 +3235,32 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, object replicator - A swift component that copies and object to + An Object Storage component that copies and object to remote partitions for fault tolerance. object server - A swift component that is responsible for + An Object Storage component that is responsible for managing objects. - - Object Service API - - Alternative term for the swift object - API. - - Object Storage - The OpenStack core project that provides - eventually consistent and redundant storage and - retrieval of fixed digital content. The project name - of Object Storage is swift. + The OpenStack core project that + provides eventually consistent and redundant + storage and retrieval of fixed digital + content. The project name of OpenStack + Object Storage is swift. + + + + + Object Storage API + + API used to access OpenStack Object Storage. @@ -3274,7 +3272,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, object versioning - Allows a user to set a flag on a swift container + Allows a user to set a flag on an Object Storage container so all objects within the container are versioned. @@ -3282,7 +3280,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Oldie - Term for a swift process that runs + Term for an Object Storage process that runs for a long time. Can indicate a hung process. @@ -3307,7 +3305,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Open vSwitch neutron plug-in Provides support for - Open vSwitch in neutron. + Open vSwitch in Networking. @@ -3349,7 +3347,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, orphan - In the context of swift this is a process that + In the context of Object Storage this is a process that is not terminated after an upgrade, restart, or reload of the service. @@ -3370,7 +3368,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, partition - A unit of storage within swift used to store + A unit of storage within Object Storage used to store objects, exists on top of devices, replicated for fault tolerance. @@ -3378,14 +3376,14 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, partition index - Contains the locations of all swift partitions + Contains the locations of all Object Storage partitions within the ring. partition shift value - Used by swift to determine which partition data + Used by Object Storage to determine which partition data should reside on. @@ -3432,7 +3430,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, plug-in Software component providing the actual - implementation for neutron APIs, or for Compute + implementation for Networking APIs, or for Compute APIs, depending on the context. @@ -3447,14 +3445,14 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, port - A virtual network port within neutron, VIFs / + A virtual network port within Networking, VIFs / vNICs are connected to a port. port UUID - Unique ID for a neutron port. + Unique ID for a Networking port. @@ -3525,14 +3523,14 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, proxy node - A node that provides the swift proxy + A node that provides the Object Storage proxy service. proxy server - Users of swift interact with the service through + Users of Object Storage interact with the service through the proxy server which in-turn looks up the location of the requested data within the ring and returns the results to the user. @@ -3605,7 +3603,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, quarantine - If swift finds objects, containers, or accounts + If Object Storage finds objects, containers, or accounts that are corrupt they are placed in this state, are not replicated, cannot be read by clients, and a correct copy is re-replicated. @@ -3643,7 +3641,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Rackspace Cloud Files Released as open source by Rackspace in 2010, - the basis for swift. + the basis for Object Storage. @@ -3682,7 +3680,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, rate limit - Configurable option within swift to limit + Configurable option within Object Storage to limit database writes on a per-account and/or per-container basis. @@ -3697,7 +3695,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, rebalance - The process of distributing swift partitions + The process of distributing Object Storage partitions across all drives in the ring, used during initial ring creation and after ring reconfiguration. @@ -3728,7 +3726,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Recon - A swift component that collects metrics. + An Object Storage component that collects metrics. @@ -3749,7 +3747,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, record ID A number within a database that is incremented - each time a change is made. Used by swift when + each time a change is made. Used by Object Storage when replicating. @@ -3801,7 +3799,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, (RADOS) A collection of components that provides object - storage within Ceph. Similar to swift. + storage within Ceph. Similar to OpenStack Object + Storage. @@ -3815,7 +3814,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, replica Provides data redundancy and fault tolerance by - creating copies of swift objects, accounts, and + creating copies of Object Storage objects, accounts, and containers so they are not lost when the underlying storage fails. @@ -3823,7 +3822,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, replica count - The number of replicas of the data in a swift + The number of replicas of the data in an Object Storage ring. @@ -3838,7 +3837,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, replicator - The swift back-end process that creates and + The Object Storage back-end process that creates and manages object replicas. @@ -3881,7 +3880,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, ring - An entity that maps swift data to partitions. A + An entity that maps Object Storage data to partitions. A separate ring exists for each service, such as account, object, and container. @@ -3889,7 +3888,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, ring builder - Builds and manages rings within swift, assigns + Builds and manages rings within Object Storage, assigns partitions to devices, and pushes the configuration to other storage nodes. @@ -3968,7 +3967,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Ryu neutron plug-in Enables the Ryu network operating system to - function as a neutron OpenFlow controller. + function as a Networking OpenFlow controller. @@ -3979,7 +3978,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, S3 Object storage service by Amazon, similar in - function to swift, can act as a back-end store for + function to Object Storage, can act as a back-end store for Image Service VM images. @@ -4039,7 +4038,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, segmented object - A swift large object that has been broken up + An Object Storage large object that has been broken up into pieces, the re-assembled object is called a concatenated object. @@ -4266,7 +4265,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, StaticWeb - WSGI middleware component of swift that serves + WSGI middleware component of Object Storage that serves container data as a static web page. @@ -4280,7 +4279,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, storage node - A swift node that provides container services, + An Object Storage node that provides container services, account services, and object services, controls the account databases, container databases, and object storage. @@ -4304,7 +4303,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, storage services - Collective name for the swift object services, + Collective name for the Object Storage object services, container services, and account services. @@ -4352,8 +4351,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, swawth An authentication and authorization service for - swift, implemented through WSGI middleware, uses - swift itself as the persistent backing + Object Storage, implemented through WSGI middleware, uses + Object Storage itself as the persistent backing store. @@ -4367,28 +4366,28 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, swift All in One (SAIO) - Creates a full swift development environment + Creates a full Object Storage development environment within a single VM. swift middleware - Collective term for swift components that + Collective term for Object Storage components that provide additional functionality. swift proxy server - Acts as the gatekeeper to swift and is + Acts as the gatekeeper to Object Storage and is responsible for authenticating the user. swift storage node - A node that runs swift account, container, and + A node that runs Object Storage account, container, and object services. @@ -4397,7 +4396,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Point in time since the last container and accounts database sync among nodes within - swift. + Object Storage. @@ -4434,8 +4433,8 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, TempAuth - An authentication facility within swift that - enables swift itself to perform authentication and + An authentication facility within Object Storage that + enables Object Storage itself to perform authentication and authorization. Frequently used in testing and development. @@ -4451,7 +4450,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, TempURL - A swift middleware component that enables creation of URLs for temporary object access. + An Object Storage middleware component that enables creation of URLs for temporary object access. @@ -4501,7 +4500,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, tombstone - Used to mark swift objects that have been + Used to mark Object Storage objects that have been deleted, ensures the object is not updated on another node after it has been deleted. @@ -4524,7 +4523,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, transaction ID - Unique ID assigned to each swift request, used + Unique ID assigned to each Object Storage request, used for debugging and tracing. @@ -4581,14 +4580,14 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, unscoped token - Alternative term for a Identity Service default + Alternative term for an Identity Service default token. updater - Collective term for a group of swift components + Collective term for a group of Object Storage components that processes queued and failed updates for containers and objects. @@ -4631,7 +4630,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, VIF UUID - Unique ID assigned to each neutron VIF. + Unique ID assigned to each Networking VIF. @@ -4678,7 +4677,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, virtual network - An L2 network segment within neutron. + An L2 network segment within Networking. @@ -4692,7 +4691,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, Virtual Network InterFace (VIF) An interface that is plugged into a port in a - neutron network. Typically a virtual network + Networking network. Typically a virtual network interface belonging to a VM. @@ -4896,7 +4895,7 @@ Each entry in a typical ACL specifies a subject and an operation. For instance, weight - Used by swift storage devices to determine which + Used by Object Storage storage devices to determine which storage devices are suitable for the job. Devices are weighted by size.