Fix incomplete aaf documentation

[aaf/authz.git] / docs / sections / installation / Installation.rst

diff --git a/docs/sections/installation/Installation.rst b/docs/sections/installation/Installation.rst
index 1852f84..dc4c6a4 100644 (file)
--- a/docs/sections/installation/Installation.rst
+++ b/docs/sections/installation/Installation.rst
@@ -3,17 +3,101 @@
 \r
 Installation\r
 ============\r
+This document will illustrates how to build and deploy all AAF components.\r
 \r
-Environment\r
------------\r
+Clone AAF Code:\r
+Build AAF with settings.xml:\r
+Build Docker Images:\r
+Modify the  properties file:\r
+Mount the sample to /opt/app/osaaf:\r
+Run the docker containers:\r
+Clone AAF Code:\r
+bharath@bharath:~$ git clone https://git.onap.org/aaf/authz\r
+\r
+\r
+Build AAF with settings.xml:\r
+---------------------------\r
+Copy the settings.xml from here and paste in ~/.m2/settings.xml\r
+\r
+Then run the following command\r
+\r
+.. code:: bash\r
+\r
+    bharath@bharath:~$ cd authz && mvn clean install -DskipTests\r
+\r
+\r
+If the build is successful, then you can see a folder in "authz/auth" called "aaf_VERSION-SNAPSHOT" which contains all binaries of the components\r
+\r
+.. code:: bash\r
+\r
+   bharath@bharath:~/authz/auth$ ls\r
+aaf_2.1.1-SNAPSHOT  auth-cass     auth-cmd   auth-deforg  auth-gui    auth-locate  auth-service  pom.xml  target\r
+auth-batch          auth-certman  auth-core  auth-fs      auth-hello  auth-oauth   docker        sample\r
+\r
+Build Docker Images:\r
+-------------------\r
+Now after building binaries, the next step is to build docker images for each aaf component.\r
+\r
+.. code:: bash\r
+\r
+    bharath@bharath:~/authz/auth/docker$ chmod +x *.sh\r
+    bharath@bharath:~/authz/auth/docker$ ./dbuild.sh\r
+       \r
+The above command will build the following images:\r
+\r
+aaf_service\r
+aaf_oauth\r
+aaf_locate\r
+aaf_hello\r
+aaf_gui\r
+aaf_fs\r
+aaf_cm\r
+Modify the  properties file:\r
+Modify the contents of the "authz/auth/docker/d.props\r
+\r
+.. code:: bash\r
+\r
+    bharath@bharath:~/authz/auth/docker$ cat d.props\r
+       \r
+# Variables for building Docker entities\r
+ORG=onap\r
+PROJECT=aaf\r
+DOCKER_REPOSITORY=nexus3.onap.org:10003\r
+OLD_VERSION=2.1.0-SNAPSHOT\r
+VERSION=2.1.1-SNAPSHOT\r
+CONF_ROOT_DIR=/opt/app/osaaf\r
+\r
+\r
+# Local Env info\r
+HOSTNAME="<HOSTNAME>"\r
+HOST_IP="<HOST_IP>"\r
+CASS_HOST="cass"\r
+\r
+Replace the <HOSTNAME>  with your hostname and HOST_IP with your host IP.\r
+\r
+Add  the following entry to your /etc/hosts file\r
+\r
+\r
+\r
+127.0.0.1 aaf.osaaf.org\r
+Mount the sample to /opt/app/osaaf:\r
+As you can see there is a parameter "CONF_ROOT_DIR" which is set to "/opt/app/osaaf". So we have to create a folder "/opt/app/osaaf" and copy the contents of authz/auth/sample to /opt/app/osaaf\r
+\r
+.. code:: bash\r
+\r
+   bharath@bharath:~/authz/auth$ mkdir -p /opt/app/osaaf\r
+   bharath@bharath:~/authz/auth$ cp -r sample/* /opt/app/osaaf/\r
+\r
+Run the docker containers:\r
+--------------------------\r
+.. code:: bash\r
+\r
+    bharath@bharath:~/authz/auth/docker$ ls\r
+    dbash.sh  dbuild.sh  dclean.sh  Dockerfile  d.props  dpush.sh  drun.sh  dstart.sh  dstop.sh\r
+    bharath@bharath:~/authz/auth/docker$ ./drun.sh\r
 \r
 \r
-Steps\r
------\r
 \r
 \r
 \r
-  \r
-Testing\r
--------\r
 \r