From 683c26e1f7071079c6f5e8d1c71a8e91915d1fc9 Mon Sep 17 00:00:00 2001
From: Rocky <shi.yan@unimelb.edu.au>
Date: Fri, 11 Dec 2020 09:11:13 +1100
Subject: [PATCH] Installation document improvement

1) v2 api is used since v1 is deprecated and removed
2) host_ip configures the ip address on which cyborg-api listens, and
its default value(localhost) does not work in real cases
3) [nova] section config in cyborg.conf is also required

Change-Id: I4776147cdb6274fe269e1f1017ff9aad47bd63cc
---
 doc/source/install/common.rst | 29 +++++++++++++++++++++++------
 1 file changed, 23 insertions(+), 6 deletions(-)

diff --git a/doc/source/install/common.rst b/doc/source/install/common.rst
index 07a6178d..287b3fef 100644
--- a/doc/source/install/common.rst
+++ b/doc/source/install/common.rst
@@ -77,11 +77,11 @@ A database, service credentials, and API endpoints must be created.
    .. code-block:: console
 
       $ openstack endpoint create --region RegionOne \
-        accelerator public http://<cyborg-ip>/accelerator/v1
+        accelerator public http://<cyborg-ip>/accelerator/v2
       $ openstack endpoint create --region RegionOne \
-        accelerator internal http://<cyborg-ip>/accelerator/v1
+        accelerator internal http://<cyborg-ip>/accelerator/v2
       $ openstack endpoint create --region RegionOne \
-        accelerator admin http://<cyborg-ip>/accelerator/v1
+        accelerator admin http://<cyborg-ip>/accelerator/v2
    ..
 
    * Otherwise, if cyborg-api service is running as a python process, create
@@ -90,11 +90,11 @@ A database, service credentials, and API endpoints must be created.
    .. code-block:: console
 
       $ openstack endpoint create --region RegionOne \
-        accelerator public http://<cyborg-ip>:6666/v1
+        accelerator public http://<cyborg-ip>:6666/v2
       $ openstack endpoint create --region RegionOne \
-        accelerator internal http://<cyborg-ip>:6666/v1
+        accelerator internal http://<cyborg-ip>:6666/v2
       $ openstack endpoint create --region RegionOne \
-        accelerator admin http://<cyborg-ip>:6666/v1
+        accelerator admin http://<cyborg-ip>:6666/v2
    ..
 
    .. note::
@@ -120,6 +120,11 @@ Configure Cyborg
 
         ...
 
+        [api]
+        host_ip = 0.0.0.0
+
+        ...
+
         [database]
         connection = mysql+pymysql://%DATABASE_USER%:%DATABASE_PASSWORD%@%OPENSTACK_HOST_IP%/cyborg
 
@@ -149,6 +154,18 @@ Configure Cyborg
 
         ...
 
+        [nova]
+        project_domain_name = Default
+        project_name = service
+        user_domain_name = Default
+        password = password
+        username = nova
+        auth_url = http://%OPENSTACK_HOST_IP%/identity
+        auth_type = password
+        auth_section = keystone_authtoken
+
+        ...
+
         [keystone_authtoken]
         memcached_servers = localhost:11211
         signing_dir = /var/cache/cyborg/api