From 82ad24079eb8f9f8ef7d3a8b238ac43f417d9342 Mon Sep 17 00:00:00 2001 From: annegentle Date: Mon, 26 Mar 2012 21:54:09 -0500 Subject: [PATCH] Adds glossary file * Adds a common/glossary.xml file * Not yet published anywhere, but want to add to the Compute Admin manual for starters. * Commented out some definitions, removed Rackspace-specific content. Change-Id: Iaadfd9cb56123805972d1e28aa41dbab354428d8 --- .../src/docbkx/api-quick-start-intro.xml | 177 ++++ doc/src/docbkx/common/glossary.xml | 913 ++++++++++++++++++ 2 files changed, 1090 insertions(+) create mode 100644 doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start-intro.xml create mode 100644 doc/src/docbkx/common/glossary.xml diff --git a/doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start-intro.xml b/doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start-intro.xml new file mode 100644 index 0000000000..26cac82f15 --- /dev/null +++ b/doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start-intro.xml @@ -0,0 +1,177 @@ + +
+ OpenStack API Quick Start + The OpenStack system has several key projects that are + separate installations but can work together depending on your + cloud needs: OpenStack Compute, OpenStack Object Storage, + OpenStack Identity Service, and OpenStack Image Store. With + the TryStack OpenStack installation, the OpenStack Compute, + OpenStack Identity, and OpenStack Image Store projects are all + working together in the background of the installation. +
+ + OpenStack API Introduction + This page covers the basics for talking to your + OpenStack cloud through the Compute API after authorizing + with the Identity Service API. You can then build a cloud + by launching images and assigning metadata to instances, + all through the API. For an API reference of all the + possible commands, see the OpenStack Compute API 1.1 specification and + the Identity Service 2.0 specification published + at docs.openstack.org/api. +
+
+ Getting Credentials + Credentials are a combination of your username, + password, and what tenant (or project) your cloud is + running under. You only need to generate an additional + token if you are interacting with your cloud directly with + API endpoints, and not with a client. Your cloud + administrator can give you a username and a password as + well as your tenant identifier so you can generate + authorization tokens. You can also get the tenant ID from + the Dashboard URLs, for example + https://trystack.org/dash/296/images/ indicates a tenant + ID of 296. + These tokens are typically good for 24 hours, and when + the token expires, you will find out with a 401 + (Unauthorized) error and can request another token + programmatically. The general workflow goes something like + this: + + + Begin API requests by asking for an + authorization token from the endpoint your cloud + administrator gave you, typically + http://hostname:port/v2.0/tokens. You send your + username, password, and what group or account you + are with (the "tenant" in auth-speak). + curl -k -X 'POST' -v https://nova-api.trystack.org:5443/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json' + + + The server returns a response in which the + 24-hours token is contained. Use that token to + send API requests with the X-Auth-Token included + as an header field. + curl -k -D - -H "X-Auth-Token: 7d2f63fd-4dcc-4752-8e9b-1d08f989cc00" -X 'GET' -v https://nova-api.trystack.org:9774/v1.1/296/extensions -H 'Content-type: application/json' + + + + Repeatedly send API requests with that token in + the x-auth-token header until either: 1) the job's + done or 2) you get a 401 (Unauthorized) code in + return. + + + Request a token again when you get a 401 + response until the script's job is done. + + + + For a typical OpenStack deployment running the Identity + Service you can request a token with this command in + cURL: +$ curl -X 'POST' -v https://nova-api.trystack.org:5443/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json' + + In return, you should get a 200 OK response with a token + in the form of "id": + "cd427a33-bb4a-4079-a6d7-0ae148bdeda9" and an expiration + date 24 hours from now. Here's what it looks like: + + +{ + "access": { + "serviceCatalog": [ + { + "endpoints": [ + { + "adminURL": "https://nova-api.trystack.org:9774/v1.1/1", + "internalURL": "https://nova-api.trystack.org:9774/v1.1/1", + "publicURL": "https://nova-api.trystack.org:9774/v1.1/1", + "region": "RegionOne" + } + ], + "name": "nova", + "type": "compute" + }, + { + "endpoints": [ + { + "adminURL": "https://GLANCE_API_IS_NOT_DISCLOSED/v1.1/1", + "internalURL": "https://GLANCE_API_IS_NOT_DISCLOSED/v1.1/1", + "publicURL": "https://GLANCE_API_IS_NOT_DISCLOSED/v1.1/1", + "region": "RegionOne" + } + ], + "name": "glance", + "type": "image" + }, + { + "endpoints": [ + { + "adminURL": "https://nova-api.trystack.org:5443/v2.0", + "internalURL": "https://keystone.trystack.org:5000/v2.0", + "publicURL": "https://keystone.trystack.org:5000/v2.0", + "region": "RegionOne" + } + ], + "name": "keystone", + "type": "identity" + } + ], + "token": { + "expires": "2012-02-15T19:32:21", + "id": "5df9d45d-d198-4222-9b4c-7a280aa35666", + "tenant": { + "id": "1", + "name": "admin" + } + }, + "user": { + "id": "14", + "name": "annegentle", + "roles": [ + { + "id": "2", + "name": "Member", + "tenantId": "1" + } + ] + } + } +} + + +
+
+ Sending Requests to the API + You have a couple of options for sending requests to + OpenStack through an API. Developers and testers may + prefer to use cURL, the command-line tool from http://curl.haxx.se/. With cURL you can send + HTTP requests and receive responses back from the command + line. + If you like to use a more graphical interface, the REST + client for Firefox also works well for testing and trying + out commands, see https://addons.mozilla.org/en-US/firefox/addon/restclient/. + You can also download and install rest-client, a Java + application to test RESTful web services, from http://code.google.com/p/rest-client/. + You need to generate a token as shown above if you use + cURL or a REST client. +
+ + +
diff --git a/doc/src/docbkx/common/glossary.xml b/doc/src/docbkx/common/glossary.xml new file mode 100644 index 0000000000..666e53dbe3 --- /dev/null +++ b/doc/src/docbkx/common/glossary.xml @@ -0,0 +1,913 @@ + + + Glossary + + + Licensed under the Apache License, Version 2.0 (the + "License"); you may not use this file except in + compliance with the License. You may obtain a copy of + the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in + writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR + CONDITIONS OF ANY KIND, either express or implied. See + the License for the specific language governing + permissions and limitations under the License. + + + + A + + API + + Stands for Application Programming Interface. An + API allows independent programmers to develop + newly created application services, using an open + application. + + + + Apache + + The most common web server software presently + being used on the Internet. + + + + Applet + + A Java program that can be embedded into a web + page. + + + + Application Server + + A piece of software that makes available another + piece of software over a network. + + + + ASPs + + An abbreviation for Application Service + Providers. These are companies that rent + specialized applications that help businesses and + organizations provide additional services with + less cost. + + + + attachment (network) + Association of an interface identifier to a logical + port, which represent 'plugging' an interface into + a port. + + + + + + + + + + + B + + + Bandwidth + + The amount of available data used by + communication resources such as the Internet. It + refers the amount of data that is used to download + things or the amount of data available to + download. + + + + Binary + + Information that consists solely of ones and + zeroes, which is the language of computers. + + + + Bit + + Is a single digit number that’s in base of 2 + (either a zero or one). Bandwidth usage is + measured in bits-per-second. + + + + Bit Torrent + + A peer-to-peer system that legally shares files + such as legal software updates, movies and other + resources. + + + + Blog + + Refers to an online journal. Blogs can be either + personal or professional in tone. + + + + BPS + + Stands for bit-per-second, the most universal + measurement of how quickly data is transferred + from place to place. + + + + Browser + + Any client software that allows a computer or + device to access the Internet (Microsoft Internet + Explorer, Mozilla Firefox, Google Chrome, + etc…). + + + + Byte + + Set of bits that make up a single character + there are usually 8 bits to a byte. + + + + + + + + + + + + C + + Certificate Authority + + Issuer of online security certificates that + shows if a web site is verified as safe. + + + + Cloud Computing + + Cloud computing is a model for enabling + access to a shared pool of configurable computing + resources (such as networks, servers, storage, + applications, and services) that can be rapidly + provisioned and released with minimal management + effort or service provider interaction. The acronym OSSM + stands for on-demand, self-service, scalable, and measurable + + + + Cloudware + + Refers to software that only exists on the + Internet. There is no material product that + resides on your computer or disks. + + + + Connection Logging + + The connection logging feature allows logs to be + delivered to a Cloud Files account every hour. For + HTTP-based protocol traffic, these are + Apache-style access logs. For all other traffic, + this is connection and transfer logging. + + + + Cookie + + Information that web pages save and send back as + a way to recognize a user so that on succeeding + visits, the users are easily recognized. + + + + + + + + + + + + + D + + DHTML + + Stands for Dynamic HyperText Markup Language. + Used to refer to pages that use HTML, JavaScript. + and CCS to allow users to interact with a web page + or show simple animation. + + + + Download + + The transfer of data – usually in the form of + files – from one computer to another. + + + + DNS + + The Domain Name System (DNS) is a system by + which Internet domain name-to-address and + address-to-name resolutions are determined. All + domains and their components, such as mail + servers, utilize DNS to resolve to the appropriate + locations. DNS servers are usually set up in a + master-slave relationship such that failure of the + master invokes the slave. DNS servers may also be + clustered or replicated such that changes made to + one DNS server are automatically propagated to + other active servers. + A system by which Internet domain + name-to-address and address-to-name resolutions + are determined. Stands for Domain Name System. DNS + helps navigate the Internet by translating the IP + address into an address that is easier to remember + (for example, translating 111.111.111.1 into + www.yahoo.com). + + + + DNS Record + + A record that specifies information about a + particular domain and belongs to the + domain. + + + + Domain + + Is a name that identifies a web site and + separates it from other sites. Often, the domain + name will have 2 or more parts that are separated + by dots (i.e. yahoo.com, usa.gov, Harvard.edu or + mail.yahoo.com). + A domain is an entity/container of all + DNS-related information containing one or more + records. + + + + + Domain Name System + + A system by which Internet domain + name-to-address and address-to-name resolutions + are determined. + + + + + + + + + E + + Email + + Messages either text or graphical that are sent + from one server to another via the + Internet. + + + + entity + + A generic term for any piece of hardware or + software desiring to connect to the network + services provided by Quantum, the Network Connectivity service. An entity may + make use of Quantum by implementing a VIF. + + + + + + F + + Firewall + + Software and hardware that communicate with each + other to help protect a computer by separating it + into two or more parts on a network, making it + more difficult to be hacked. + + + + Fixed IP address + + A fixed IP address can be set and the purpose of + the server assigned to the IP address can remain + the same even if the server assigned to that IP + address changes. This feature lets you swap out + virtual machines and the DHCP server re-assigns + the same IP address to the swapped-in + server. + + + + Flash + + Technology that is used for Internet animation, + originated by Macromedia, now maintained by Adobe. + + + + Flavor + + A flavor is an available hardware configuration + for a server. Each flavor has a unique combination + of disk space, memory capacity and priority for + CPU time. + + + + FTP + + Stands for File Transfer Protocol which is a + method of moving files between two separate sites + on the Internet. + + + + + + + + + + + + G + + Gateway + + Hardware or software that translates between two + different protocols. + + + + GIF + + Stands for Graphic Interchange Format, a type of + image file that is commonly used for animated + images on web pages. + + + + glance + + The name of the project that provides the OpenStack Image Service. + + + + + + H + + Hacker + + An intruder who attempts to enter a site for the + purpose of causing intentional damage. + + + + + horizon + + The project that provides the OpenStack Dashboard. + + + + Host + + A computer and/or network facility that stores + data that is available to be accessed by other + computers. + + + + HTML + + Stands for HyperText Markup Language, the coding + that creates documents for use on the + Internet. + + + + HTTP + + Stands for HyperText Transfer Protocol, the + protocol that tells browsers where to go to find + information. + + + + Hypertext + + Any kind of text that contains a link to some + other site, commonly found in documents where + clicking on a word or words opens up a different + web site. + + + + + + + + + + + + I + + Image + + An image is a collection of files used to + create or rebuild a server. Cloud providers can provide a + number of pre-built OS images by default. You may + also create custom images from cloud servers you + have launched. These custom images are useful for + backup purposes or for producing “gold” server + images if you plan to deploy a particular server + configuration frequently. + + + + Instance + + An instance is a virtual machine running or in a known + state such as "suspended" that can be used like a hardware server. + + + + IP Address + + Number that’s unique to every computer system on + the Internet. + + + + ISP + + Refers to Internet Service Provider, which is + any business that provides Internet access to + individuals or businesses. + + + + + + + + + + + + J + + + Java + + A programming language that is used to create + systems that involve more than one computer by way + of a network. + + + + Javascript + + A programming language used in web pages. + + + + + + + + + + + + K + + keystone + + The name of the project that provides OpenStack Identity services. + + + + + + L + + Layer-2 network + A virtual Ethernet network managed by the Quantum + service. For the time being, Quantum will manage + only Ethernet networks. + + + Load Balancer + + A load balancer is a logical device which + belongs to a cloud account. It is used to + distribute workloads between multiple back-end + systems or services, based on the criteria defined + as part of its configuration. + + + + + + + + + + + + M + + + + + + + + + + N + + network + A virtual network providing connectivity + between entities, i.e.: collection of virtual + ports sharing network connectivity. In the + Network Connectivity (Quantum) terminology, a network is always a Layer-2 + network. + + + Node + + A node is a back-end device providing a service + on a specified IP and port. + + + + nova + + The name of the project that provides OpenStack Compute. + + + + + + O + + Object storage + + Provides eventually consistent and redundant storage and retrieval of fixed digital content. + + + + + + P + + plugin + Software component providing the actual + implementation for Quantum APIs, or for Compute APIs, depending on the context. + + + port + + A port on the virtual network switch represented + by a Quantum virtual Layer-2 network. + + + + + + Q + + quantum + + The project that provides a network connectivity abstraction layer to OpenStack Compute. + + + + + + R + + Rackspace Cloud DNS + + A Domain Name System (DNS) available to + Rackspace Cloud customers. Interactions with + Rackspace Cloud DNS occur programmatically via the + Rackspace Cloud DNS API as described in this Cloud + DNS Developer Guide. + + + + Reboot + + The reboot function allows for either a soft or + hard reboot of a server. With a soft reboot, the + operating system is signaled to restart, which + allows for a graceful shutdown of all processes. A + hard reboot is the equivalent of power cycling the + server. + + + + Rebuild + + The rebuild function removes all data on the + server and replaces it with the specified image. + Server ID and IP addresses remain the same. + + + + + Record + + A DNS record belongs to a particular domain and + is used to specify information about the domain. + There are several types of DNS records. Each + record type contains particular information used + to describe that record's purpose. Examples + include mail exchange (MX) records, which specify + the mail server for a particular domain, and name + server (NS) records, which specify the + authoritative name servers for a domain. + + + + Resize + + The resize function converts an existing server + to a different flavor, in essence, scaling the + server up or down. The original server is saved + for a period of time to allow rollback if there is + a problem. All resizes should be tested and + explicitly confirmed, at which time the original + server is removed. All resizes are automatically + confirmed after 24 hours if they are not confirmed + or reverted. + + + + + RESTful + + A kind of web service API that uses REST, or + Representational State Transfer. REST is the style + of architecture for hypermedia systems that is + used for the World Wide Web. + + + + + + S + + Server + + Computer that provides explicit services to the + client software running on that system, often + managing a variety of computer operations. + A server is a virtual machine instance in the + Cloud Servers system. Flavor and image are + requisite elements when creating a server. + + + + Session Persistence + + Session persistence is a feature of the load + balancing service. It attempts to force subsequent + connections to a service to be redirected to the + same node as long as it is online. + + + + Shared IP Address + + Public IP addresses can be shared across + multiple servers for use in various high + availability scenarios. When an IP address is + shared to another server, the cloud network + restrictions are modified to allow each server to + listen to and respond on that IP address (you may + optionally specify that the target server network + configuration be modified). Shared IP addresses + can be used with many standard heartbeat + facilities (e.g. keepalived) that monitor for + failure and manage IP failover. + + + + Shared IP Group + + A shared IP group is a collection of servers + that can share IPs with other members of the + group. Any server in a group can share one or more + public IPs with any other server in the group. + With the exception of the first server in a shared + IP group, servers must be launched into shared IP + groups. A server may only be a member of one + shared IP group. + + + + + Social Networking + + The act of joining groups and websites where you will find + people with similar interests. Individuals and + businesses use social networking sites such as Facebook, + LinkedIn and Twitter to share experiences + with others online. + + + + swift + + The project that provides OpenStack Object Storage services. + + + + subdomain + + A domain within a parent domain. Subdomains + cannot be registered. Subdomains allow you to + delegate domains. Subdomains can themselves have + subdomains, so third-level, fourth-level, + fifth-level, and deeper levels of nesting are + possible. + Subdomains are domains within a parent domain, + and subdomains cannot be registered. Subdomains + allow you to delegate domains. Subdomains can + themselves have subdomains, so third-level, + fourth-level, fifth-level, and deeper levels of + nesting are possible. + + + + + + + T + + + + + + + + + + U + + + + + + + + + + V + + VIF + A Virtual network InterFace plugged into a port of a Quantum + network; typically a virtual network interface + belonging to a VM + + + Virtual IP + + A virtual IP is an Internet Protocol (IP) + address configured on the load balancer for use by + clients connecting to a service that is load + balanced. Incoming connections are distributed to + back-end nodes based on the configuration of the + load balancer. + + + + Virus + + Harmful piece of computer programming that + interferes with normal computer and Internet + operations. + + + + + + + + + + + + W + + + + + + + + + + X + + + + + + + + + + Y + + + + + + + + + + Z + + + + + + + + + +