Add initial glossary
These are the (hopefully) least-controversial glossary terms from the initial Etherpad (https://etherpad.openstack.org/p/sdk-glossary). Additional terms will be added as they are solidified. Change-Id: I656aef799d786b8e7cb81c452f0180580e142f4d
This commit is contained in:
parent
8f5a677921
commit
fc2bf9ee67
|
@ -0,0 +1,120 @@
|
|||
Glossary
|
||||
========
|
||||
|
||||
CLI
|
||||
|
||||
Command-Line Interface; a textual user interface.
|
||||
|
||||
compute
|
||||
|
||||
OpenStack Compute (Nova).
|
||||
|
||||
container
|
||||
|
||||
One of the :ref:`object-store <object-store>` resources; a container holds
|
||||
:ref:`objects <object>` being stored.
|
||||
|
||||
endpoint
|
||||
|
||||
A base URL used in a REST request. An `authentication endpoint` is
|
||||
specifically the URL given to a user to identify a cloud. A service
|
||||
endpoint is generally obtained from the service catalog.
|
||||
|
||||
host
|
||||
|
||||
A physical computer. Contrast with :ref:`node <node>` and :ref:`server <server>`.
|
||||
|
||||
identity
|
||||
|
||||
OpenStack Identity (Keystone).
|
||||
|
||||
image
|
||||
|
||||
OpenStack Image (Glance). Also the attribute name of the disk
|
||||
files stored for use by servers.
|
||||
|
||||
keypair
|
||||
|
||||
The attribute name of the SSH public key used in the OpenStack Compute
|
||||
API for server authentication.
|
||||
|
||||
node
|
||||
|
||||
A logical system, may refer to a :ref:`server <server>` (virtual machine)
|
||||
or a :ref:`host <host>`.
|
||||
Generally used to describe an OS instance where a specific process is
|
||||
running, e.g. a 'network node' is where the network processes run,
|
||||
and may be directly on a host or in a server. Contrast with :ref:`host <host>`
|
||||
and :ref:`server <server>`.
|
||||
|
||||
object
|
||||
|
||||
A generic term which normally refers to the a Python `object`.
|
||||
The OpenStack Object Store service (Swift) also uses `object` as the
|
||||
name of the item being stored within a :ref:`container <container>`.
|
||||
|
||||
object-store
|
||||
|
||||
OpenStack Object Store (Swift).
|
||||
|
||||
project
|
||||
|
||||
The name of the owner of resources in an OpenStack cloud. A `project`
|
||||
can map to a customer, account or organization in different OpenStack
|
||||
deployments. Used instead of the deprecated :ref:`tenant <tenant>`.
|
||||
|
||||
region
|
||||
|
||||
The attribute name of a partitioning of cloud resources.
|
||||
|
||||
.. TODO(dtroyer): Resource needs further fleshing out, revise once the
|
||||
.. object model in the SDK is finalized.
|
||||
|
||||
resource
|
||||
|
||||
A Python object representing an OpenStack resource inside the SDK
|
||||
code. Also used to describe the items managed by OpenStack.
|
||||
|
||||
role
|
||||
|
||||
A personality that a user assumes when performing a specific set of
|
||||
operations. A `role` includes a set of rights and privileges that a
|
||||
user assuming that role inherits. The OpenStack Identity service
|
||||
includes the set of roles that a user can assume in the
|
||||
:ref:`token <token>` that is issued to that user.
|
||||
|
||||
The individual services determine how the roles are interpreted
|
||||
and access granted to operations or resources. The OpenStack Identity service
|
||||
treats a role as an arbitrary name assigned by the cloud administrator.
|
||||
|
||||
server
|
||||
|
||||
A virtual machine or a bare-metal host managed by the OpenStack Compute
|
||||
service. Contrast with :ref:`host <host>` and :ref:`node <node>`.
|
||||
|
||||
service
|
||||
|
||||
In OpenStack this refers to a service/endpoint in the
|
||||
:ref:`ServiceCatalog <service catalog>`.
|
||||
It could also be a collection of endpoints for different :ref:`regions <region>`.
|
||||
A service has a type and a name.
|
||||
|
||||
service catalog
|
||||
|
||||
The list of :ref:`services <service>` configured at a given authentication
|
||||
endpoint available to the authenticated user.
|
||||
|
||||
tenant
|
||||
|
||||
Deprecated in favor of :ref:`project <project>`.
|
||||
|
||||
token
|
||||
|
||||
An arbitrary bit of text that is used to access resources. Some tokens
|
||||
are `scoped` to determine what resources are accessible with it. A
|
||||
token may be revoked at any time and is valid for a finite duration.
|
||||
|
||||
volume
|
||||
|
||||
OpenStack Volume (Cinder). Also the attribute name of the
|
||||
virtual disks managed by the OpenStack Volume service.
|
|
@ -9,5 +9,6 @@ Contents:
|
|||
installation
|
||||
usage
|
||||
contributing
|
||||
glossary
|
||||
|
||||
.. include:: ../../README.rst
|
||||
|
|
Loading…
Reference in New Issue