From 355418374b117dbae5c90e65f51f7492e876bcef Mon Sep 17 00:00:00 2001 From: Pradeep Kumar Singh Date: Tue, 2 Jun 2015 19:45:45 +0530 Subject: [PATCH] Change "ReST" to "REST" in developer doc Closes-Bug: #1461023 Change-Id: I4a1142ef25f2cf5f4e1c2b41243173dc6cebcce1 --- doc/docbkx/api-ref/src/docbkx/api-ref.xml | 4 ++-- doc/source/architecture.rst | 2 +- doc/source/index.rst | 2 +- doc/source/scale_deployment.rst | 14 +++++++------- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/docbkx/api-ref/src/docbkx/api-ref.xml b/doc/docbkx/api-ref/src/docbkx/api-ref.xml index a336772291..fc42c334b5 100644 --- a/doc/docbkx/api-ref/src/docbkx/api-ref.xml +++ b/doc/docbkx/api-ref/src/docbkx/api-ref.xml @@ -110,7 +110,7 @@ Neutron, and so forth) - ReSTful web services + RESTful web services JSON and/or YAML data serialization @@ -178,7 +178,7 @@ General API Information - The &Deployment; API is implemented using a ReSTful web + The &Deployment; API is implemented using a RESTful web service interface. Like other OpenStack services, the &Deployment; Service shares a common token-based authentication system that allows seamless access between diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index e3c5795054..d931fbd512 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -17,7 +17,7 @@ Heat architecture ================= -Heat is a service to orchestrate multiple composite cloud applications using the .. _AWS CloudFormation: http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 template format, through both an OpenStack-native ReST API and a CloudFormation-compatible Query API. +Heat is a service to orchestrate multiple composite cloud applications using the .. _AWS CloudFormation: http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 template format, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. -------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index c5b433bcd9..d9ed180ae2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,7 +16,7 @@ Welcome to the Heat developer documentation! ================================================== Heat is a service to :term:`orchestrate` multiple composite cloud applications using the AWS CloudFormation template format, through -both an OpenStack-native ReST API and a CloudFormation-compatible Query API. +both an OpenStack-native REST API and a CloudFormation-compatible Query API. What is the purpose of the project and vision for it? ===================================================== diff --git a/doc/source/scale_deployment.rst b/doc/source/scale_deployment.rst index 07cc8787c7..fe9713ae44 100644 --- a/doc/source/scale_deployment.rst +++ b/doc/source/scale_deployment.rst @@ -20,7 +20,7 @@ to be handled, the API and engine services can be overloaded. In those scenarios, in order to increase the system performance, it can be helpful to run multiple load-balanced APIs and engines. -This guide details how to scale out the ReST API, the CFN API, and the engine, +This guide details how to scale out the REST API, the CFN API, and the engine, also known as the *heat-api*, *heat-api-cfn*, and *heat-engine* services, respectively. @@ -50,7 +50,7 @@ Basic Architecture The heat architecture is as defined at `heat architecture `_ and shown in the -diagram below, where we have a CLI that sends HTTP requests to the ReST and CFN +diagram below, where we have a CLI that sends HTTP requests to the REST and CFN APIs, which in turn make calls using AMQP to the heat engine. :: @@ -107,14 +107,14 @@ python scripts located at the *bin* directory of your heat repository. These scripts take as argument a configuration file. When using devstack, the configuration file is located at */etc/heat/heat.conf*. For instance, to start -new ReST and CFN API services, you must run: +new REST and CFN API services, you must run: :: python bin/heat-api --config-file=/etc/heat/heat.conf python bin/heat-api-cfn --config-file=/etc/heat/heat.conf Each API service must have a unique address to listen. This address have to be -defined in the configuration file. For ReST and CFN APIs, modify the +defined in the configuration file. For REST and CFN APIs, modify the *[heat_api]* and *[heat_api_cfn]* blocks, respectively. :: @@ -161,7 +161,7 @@ Deploying the Proxy =================== In order to simplify the deployment of the HAProxy server, we will replace -the ReST and CFN APIs deployed when installing devstack by the HAProxy server. +the REST and CFN APIs deployed when installing devstack by the HAProxy server. This way, there is no need to update, on the CLI, the addresses where it should look for the APIs. In this case, when it makes a call to any API, it will find the proxy, acting on their behalf. @@ -201,7 +201,7 @@ To deploy the HAProxy server on the devstack server, run option tcpka option httpchk # The values required below are the different addresses supplied when - # running the ReST API instances. + # running the REST API instances. server SERVER_1 {HOST_1}:{PORT_1} ... server SERVER_N {HOST_N}:{PORT_N} @@ -248,7 +248,7 @@ Target Architecture At this moment, everything is running in a single devstack server. The next subsections show how to deploy a scaling out heat architecture by: - 1. Running one ReST and one CFN API on the machines B and C; + 1. Running one REST and one CFN API on the machines B and C; 2. Setting up the HAProxy server on the machine A. Running the API and Engine Services