Finished documentation for API

api/doc/source/index.rst

@@ -14,15 +14,16 @@
       under the License.
 
 ==============================================
-Welcome to Portas, the Keero REST API Service!
+Welcome to Glazier API Service!
 ==============================================
 
-Portas is a project that provides access to engine via API.
+Glazier API is a project that provides access to engine via API.
 
-This document describes Portas for contributors of the project, and assumes
+This document describes Glazier API for contributors of the project,
-that you are already familiar with Portas from an `end-user perspective`_.
+and assumes that you are already familiar with Glazier API from an
+`end-user perspective`_.
 
-.. _`end-user perspective`: http://keero.mirantis.com/
+.. _`end-user perspective`: http://glazier.mirantis.com/
 
 This documentation is generated by the Sphinx toolkit and lives in the source
 tree.
@@ -31,19 +32,19 @@ Installation Guide
 ==================
 Install
 -------
-1. Check out sources to some directory (<home>/keero)::
+1. Check out sources to some directory (<home>/glazier)::
 
     user@work:~/$ git clone ssh://<user>@gerrit.mirantis.com:29418/keero/keero.git
 
-2. Install Portas::
+2. Install Glazier API::
 
-    user@work:~/$ cd keero/portas && sudo python setup.py install
+    user@work:~/$ cd glazier/api && sudo python setup.py install
 
 Configure
 ---------
 1. Open first configuration file for editing::
 
-    user@work:~/$ cd keero/portas/etc && nano portas-api.conf
+    user@work:~/$ cd glazier/api/etc && nano glazier-api.conf
 
 2. Configure according to you environment (please note rabbitmq section)::
 
@@ -58,9 +59,9 @@ Configure
     bind_port = 8082
     # Log to this file. Make sure the user running skeleton-api has
     # permissions to write to this file!
-    log_file = /tmp/portas-api.log
+    log_file = /tmp/glazier-api.log
     #A valid SQLAlchemy connection string for the metadata database
-    sql_connection = sqlite:///portas.sqlite
+    sql_connection = sqlite:///glazier.sqlite
 
     [reports]
     results_exchange = task-results
@@ -77,16 +78,16 @@ Configure
 
 3. Open second configuration file for editing::
 
-    smelikyan@work:~/cd keero/portas/etc && nano portas-api.conf
+    smelikyan@work:~/cd glazier/api/etc && nano glazier-api.conf
 
 4. Configure according to you environment (please note filter:authtoken section)::
 
-    [pipeline:portas-api]
+    [pipeline:glazier-api]
     pipeline = authtoken context apiv1app
     [app:apiv1app]
-    paste.app_factory = portas.api.v1.router:API.factory
+    paste.app_factory = glazierapi.api.v1.router:API.factory
     [filter:context]
-    paste.filter_factory = portas.api.middleware.context:ContextMiddleware.factory
+    paste.filter_factory = glazierapi.api.middleware.context:ContextMiddleware.factory
 
     [filter:authtoken]
     paste.filter_factory = keystoneclient.middleware.auth_token:filter_factory
@@ -96,13 +97,13 @@ Configure
     admin_tenant_name = admin
     admin_user = admin
     admin_password = password
-    signing_dir = /tmp/keystone-signing-portas
+    signing_dir = /tmp/keystone-signing-glazierapi
 
 Run
 ----
-Run Portas and supply valid configuration file::
+Run Glazier API and supply valid configuration file::
 
-    user@work:~/$ portas-api --config-file=./keero/portas/etc/portas-api.conf
+    user@work:~/$ glazier-api --config-file=./glazier/api/etc/glazier-api.conf
 
 Man Pages
 =========
@@ -110,4 +111,4 @@ Man Pages
 .. toctree::
     :maxdepth: 1
 
-    man/portasapi
+    man/glazierapi

api/doc/source/man/glazierapi.rst

@@ -0,0 +1,69 @@
+..
+      Copyright (c) 2013 Mirantis, Inc.
+
+      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.
+
+==========
+glazier-api
+==========
+
+-----------------------------
+Glazier API Server
+-----------------------------
+
+:Author: smelikyan@mirantis.com
+:Date:   2013-04-04
+:Copyright: Mirantis, Inc.
+:Version: 2013.1-dev
+:Manual section: 1
+:Manual group: cloud computing
+
+
+SYNOPSIS
+========
+
+  glazier-api [options]
+
+DESCRIPTION
+===========
+
+glazier-api is a server daemon that serves the Glazier API
+
+OPTIONS
+=======
+
+  **General options**
+
+  **-v, --verbose**
+        Print more verbose output
+
+  **--config-file**
+        Config file used for running service
+
+  **--bind-host=HOST**
+        Address of host running ``glazier-api``. Defaults to `0.0.0.0`.
+
+  **--bind-port=PORT**
+        Port that ``glazier-api`` listens on. Defaults to `8082`.
+
+
+FILES
+=====
+
+* /etc/glazier/glazier-api.conf
+* /etc/glazier/glazier-api-paste.conf
+
+SEE ALSO
+========
+
+* `Glazier <http://glazier.mirantis.com>`__

api/doc/source/man/portasapi.rst

@@ -1,59 +0,0 @@
-==========
-portas-api
-==========
-
------------------------------
-Portas API Server
------------------------------
-
-:Author: smelikyan@mirantis.com
-:Date:   2013-04-04
-:Copyright: Mirantis, Inc.
-:Version: 2013.1-dev
-:Manual section: 1
-:Manual group: cloud computing
-
-
-SYNOPSIS
-========
-
-  portas-api [options]
-
-DESCRIPTION
-===========
-
-portas-api is a server daemon that serves the Portas API
-
-OPTIONS
-=======
-
-  **General options**
-
-  **-v, --verbose**
-        Print more verbose output
-
-  **--config-file**
-        Config file used for running service
-
-  **--bind-host=HOST**
-        Address of host running ``portas-api``. Defaults to `0.0.0.0`.
-
-  **--bind-port=PORT**
-        Port that ``portas-api`` listens on. Defaults to `8082`.
-
-
-FILES
-=====
-
-* /etc/portas/portas-api.conf
-* /etc/portas/portas-api-paste.conf
-
-SEE ALSO
-========
-
-* `Keero <http://keero.mirantis.com>`__
-
-BUGS
-====
-
-* Portas is sourced in Launchpad so you can view current bugs at `Keero Portas <http://portas.launchpad.net>`__