DRAFT - THIS GUIDE IS A WORK IN PROGRESS

This documentation will help you to up and run AAF service from the docker image

Step 1:

-----------

^{git clone https://gerrit.onap.org/r/aaf/authz}

Build

Note:  use ONAP maven repo settings.xml file

^{$ cd authz}

^{$ mvn clean install -DskipTests}

Note: we are working on Test cases and some of them are failing during build phase. Use ONAP maven repo settings.xml file 

Build Docker Image

^{$ cd authz-service}

^{$ mvn clean install docker:build}

Note: This process will create the authz-service docker image, and pull openjdk:8-jdk as part of the build

Step 2:

-----------

Make sure you have installed Docker & Docker Compose on your VM / Server ( Linux/Windows)

We have written a docker-compose file which will bind AAF service & Cassandra DB  and loads data to Cassandra DB.

Path to docker- compose folder

^{$ cd src/main/resources/docker-compose}

Check  read & write permissions for docker-compose folder

^{$ chmod +x *.sh}

Open

To start AAF service use the following command. Which will up AAF & Cassandra docker instances.

^{$ docker-compose up -d}

at this point AAF & Cassandra Images will be downloaded and containers will start and service will be up.

Note: ecomp.cql is the default data  template which will be loaded into Cassandra container. Which contains default namespaces,roles,permissions and APPID to test AAF service.

To check running containers 

^{$ docker ps}

To check container logs with docker logs <container-name/ID>

For example, to use the container Id of the attos/aaf container in the screenshot above:

^{$ docker logs 91e6c35286b1}

To access files inside the container

^{$ docker exec -it dockercompose_aaf_container_1 bash}

AAF files are located in the following folder    : /opt

• /opt/app/aaf/authz-service/2.0.15/etc

• /opt/app/aaf/authz-service/2.0.15/lib
  
  
  

  Open

  

to find authz-service logs find them in the following folders:

 logs

_LOG_DIR_

Step 3:  access the cassandra command line from bash

---------------------------------------------------

docker exec -it dockercompose_cassandra_container_1 bash

1.cqlsh -u root -p root    

2.use authz;   ( to use keyspace)

3.describe tables;   ( to list all the tables)

3.select * from ns;     ( to check name spaces ,perm,roles etc)

To come out from bash & container

quit

exit

Step 4:  AAF Command line to  create & grant permissions

 ---------------------------------------------------

Get into the aaf container

1.docker exec -it dockercompose_aaf_container_1 bash

2.cd opt/app/aaf/authz-service/

3. sh runaafcli.sh –c

aaf_id :   dgl@openecomp.org

pass:        ecomp_admin

At this point you get access to AAF command line

aafcli> ns list name org.openecomp       

will give you the details of namespace org.openecomp

To get list of permission types of the user

>> perm list user dgl@openecomp.org

Create and grant permissions

>> perm create org.openecomp.dmaapBC.mr.topic :topic.org.openecomp.dmaapBC.mytopic1 pub org.openecomp.dmaapBC.admin org.openecomp.dmaapBC.access

>> perm create org.openecomp.dmaapBC.mr.topic :topic.org.openecomp.dmaapBC.mytopic1 sub org.openecomp.dmaapBC.admin org.openecomp.dmaapBC.access

AAF Command Line

AAF commands are broken into 4 major categories:

• ns - commands dealing with a namespace

• perm - commands dealing with permissions

• role - commands dealing with roles

• user - commands dealing with users

If you know you want to do something namespace related, type "ns" and hit return; you will be given a list of all the subcommands to "ns", along with the syntax of each.

Output of "Help"

Detailed Help