Merge "Set environment variables for protonclient"

doc/source/devref/gluon-auth.rst

@@ -189,6 +189,8 @@ Configuration
 The /etc/proton/proton.conf file can be used to configure the authentication details. A sample
 configuration is shown below. Change 127.0.0.1 to your keystone endpoint.
 
+.. code-block:: conf
+
     [api]
     auth_strategy = keystone
 
@@ -205,6 +207,21 @@ configuration is shown below. Change 127.0.0.1 to your keystone endpoint.
     [oslo_policy]
     policy_file = /etc/proton/policy.json
 
+Set Environment Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~
+If Keystone is enabled for authentication, some environment variables will need
+to be set up in order for protonclient commands to work properly. Modify the openrc
+file in gluon home directory with the appropriate value for you Keystone endpoint.
+A sample is shown below.
+Then run ``source openrc <project_name> <user_name> <user_password>``to set these variables.
+
+.. code-block:: bash
+
+    #
+    # set Keystone endpoint
+    #
+    export OS_AUTH_URL="http://192.168.56.101:5000"
+
 Appendix
 --------
 Configuring identity details for Keystone, change 10.0.2.15 to your gluon endpoint:

openrc

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+#
+# source openrc
+#
+# Configure a set of credentials for $PROJECT/$USERNAME:
+#   set OS_AUTH_URL to Keystone end point
+#   Set OS_PROJECT_NAME to openstack project name
+#   Set OS_USERNAME to openstack user name
+#   Set ADMIN_PASSWORD to openstack password
+
+# If using devstack:
+#   set both OS_USERNAME and OS_TENANT_NAME to 'admin' or 'demo'
+# Example config for devstack:
+#   export OS_AUTH_URL="http://192.168.56.101:5000"
+#   export OS_TENANT_NAME="admin"
+#   export OS_USERNAME="admin"
+#   export OS_PASSWORD="ubuntu"
+
+#
+# set Keystone endpoint
+#
+export OS_AUTH_URL="<keystone endpoint>:5000"
+
+
+#
+# set openstack credentials
+#
+if [[ $# -ne 3 ]]; then
+    echo "wrong number of arguments!"
+    echo "enter openstack credentials in the following order:"
+    echo "source openrc <project_name> <user_name> <user_password>"
+    return
+else
+
+    if [[ -n "$1" ]]; then
+        OS_PROJECT_NAME=$1
+    else
+        echo "Openstack project name cannot be an empty string"
+        return
+    fi
+
+    if [[ -n "$2" ]]; then
+        OS_USERNAME=$2
+    else
+        echo "Openstack user name cannot be an empty string"
+        return
+    fi
+
+    if [[ -n "$3" ]]; then
+        OS_PASSWORD=$3
+    else
+        echo "Openstack password cannot be an empty string"
+        return
+    fi
+
+    export OS_TENANT_NAME=${OS_PROJECT_NAME}
+    export OS_USERNAME=${OS_USERNAME}
+    export OS_PASSWORD=${OS_PASSWORD}
+fi