Client Docs
[aaf/authz.git] / docs / sections / installation / client_vol.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
4
5 ========================================
6 Setting up Certs and CADI Configurations
7 ========================================
8
9 *Note: this document assumes UNIX Bash Shell.  Being Java, AAF works in Windows, but you will have to create your own script/instruction conversions.*
10
11 ------------------
12 Strategy
13 ------------------
14
15 ONAP is deployed in Docker Containers or Kubernetes managed Docker Containers.  Therefore, this instruction utilizes a Docker Container as a standalone Utility... (This means that this container will stop as soon as it is done with its work... it is not a long running daemon)
16
17 Given that all ONAP entities are also in Docker Containers, they all can access Persistent Volumes.
18
19 This tool creates all the Configurations, including Certificates, onto a declared Volume on the directories starting with "/opt/app/osaaf"
20
21 ------------------
22 Prerequisites
23 ------------------
24   * Docker
25     * Note: it does NOT have to be the SAME Docker that AAF is deployed on...
26     | but it DOES have be accessible to the AAF Instance.  
27   * For ONAP, this means
28     
29         * Windriver VPN
30         * include "10.12.6.214 aaf-onap-test.osaaf.org" in your /etc/hosts or DNS
31
32 -----------------------
33 Obtain the Agent Script
34 -----------------------
35 Choose the directory you wish to start in... 
36
37 If you don't want to clone all of AAF, just get the "agent.sh" from a Browser:
38
39   https://gerrit.onap.org/r/gitweb?p=aaf/authz.git;a=blob_plain;f=auth/docker/agent.sh;hb=HEAD
40
41   Note: curl/wget get html, instead of text
42   | You might have to mv, and rename it to "agent.sh", but avoids full clone
43
44 -------------------------
45 Run Script
46 -------------------------
47
48 In your chosen directory ::
49  
50   $ bash agent.sh
51
52 The Agent will look for "aaf.props", and if it doesn't exist, or is missing information, it will ask for it
53
54
55 --------------- ---------------
56 Tag             Value
57 --------------- ---------------
58 CADI Version    Defaults to CADI version of this
59 AAF's FQDN      PUBLIC Name for AAF. For ONAP Test, it is 'aaf-onap-test.osaaf.org'
60 Deployer's FQI  deployer@people.osaaf.org.  In a REAL system, this would be a person or process 
61 App's Root FQDN This will show up in the Cert Subject, and should be the name given by Docker. i.e. clamp.onap
62 App's FQI       Fully Qualified ID given by Organization and with AAF NS/domain.  ex: clamp@clamp.onap.org 
63 App's Volume    Volume to put the data, see above. ex: clamp_aaf
64 DRIVER          Docker Volume type... See Docker Volume documentation
65 LATITUDE        Global latitude coordinate of Node (best guess for Kubernetes)
66 LONGITUDE       Global longitude coordinate of Node (best guess for Kubernetes)
67 --------------- ---------------
68
69
70