Merge "Distribution fails when no user input required in design"
[so.git] / adapters / mso-vnfm-adapter / mso-vnfm-etsi-adapter / Readme.txt
1 The following describes how to configure authentication for the VNFM adapter.\r
2 \r
3 \r
4 ==========================================\r
5 To confgure TLS\r
6 ==========================================\r
7 \r
8 ---------------\r
9 VNFM Adapter\r
10 ---------------\r
11 The following parameters can be set to configure the certificate for the VNFM adapter\r
12 server:\r
13   ssl:\r
14     key-alias: so@so.onap.org\r
15     key--store-password: 'I,re7WWEJR$e]x370wRgx?qE'\r
16     key-store: classpath:org.onap.so.p12\r
17     key-store-type: PKCS12\r
18 The values shown above relate to the certificate included in the VNFM adapter jar which has been generated from AAF. If a different certificate is to be used then these values should be changed accordingly.\r
19 \r
20 The following paramters can be set to configure the trust store for the VNFM adapter:\r
21 http:\r
22   client:\r
23     ssl:\r
24       trust-store: org.onap.so.trust.jks\r
25       trust-store-password: NyRD](z:EJJNIt?},QgM3o7H\r
26 The values shown above relate to the trust store included in the VNFM adapter jar which has been generated from AAI. If a different trust store is to be used then these values should be changed accordingly.\r
27 \r
28 Ensure the value for the below parameter uses https instead of http\r
29 vnfmadapter:\r
30   endpoint: http://so-vnfm-adapter.onap:9092\r
31   \r
32 ---------------\r
33 bpmn-infra\r
34 ---------------\r
35 For bpmn-infra, ensure the value for the below parameter uses https instead of http\r
36 so:\r
37   vnfm:\r
38     adapter:\r
39       url: https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1/\r
40 \r
41 \r
42 ==========================================\r
43 To use two way TLS\r
44 ==========================================\r
45 \r
46 Ensure the value for username and password are empty in the AAI entry for the VNFM (The VNFM adapter will use oauth instead of two way TLS if the username/password is set).\r
47 Ensure TLS has been configuered as detailed above.\r
48 \r
49 ---------------\r
50 VNFM adapter\r
51 ---------------\r
52 Set the following parameter for the VNFM adapter:\r
53 server:\r
54   ssl:\r
55     client-auth: need\r
56         \r
57 ---------------\r
58 bpmn-infra:\r
59 ---------------\r
60 Set the following paramters for bpmn-infra:\r
61 rest:\r
62   http:\r
63     client:\r
64       configuration:\r
65         ssl:\r
66           keyStore: classpath:org.onap.so.p12\r
67           keyStorePassword: 'RLe5ExMWW;Kd6GTSt0WQz;.Y'\r
68           trustStore: classpath:org.onap.so.trust.jks\r
69           trustStorePassword: '6V%8oSU$,%WbYp3IUe;^mWt4'\r
70 Ensure the value for the below parameter uses https instead of http\r
71 so:\r
72   vnfm:\r
73     adapter:\r
74       url: https://so-vnfm-adapter.onap:9092/so/vnfm-adapter/v1/\r
75           \r
76 ---------------   \r
77 VNFM simulator:\r
78 ---------------\r
79 Set the following parameters for the VNFM simulator (if used):\r
80 server:\r
81   ssl:\r
82     client-auth: need\r
83   request:\r
84     grant:\r
85       auth: twowaytls\r
86 \r
87 ==========================================\r
88 To use oauth token base authentication\r
89 ==========================================\r
90 \r
91 ---------------   \r
92 VNFM adapter:\r
93 ---------------\r
94 Ensure the value for username and password set set in the AAI entry for the VNFM. The VNFM adapter will use this username/password as the client credentials in the request for a token for the VNFM. The token endpoint\r
95 for the VNFM will by default will be derived from the service url for the VNFM in AAI as follows: <base of service url>/oauth/token, e.g. if the service url is https://so-vnfm-simulator.onap/vnflcm/v1 then the token url will\r
96 be taken to be https://so-vnfm-simulator.onap/oauth/token. This can be overriden using the following parameter for the VNFM adapter:\r
97 vnfmadapter:\r
98   temp:\r
99     vnfm:\r
100           oauth:\r
101             endpoint:\r
102                 \r
103 The VNFM adapter exposes a token point at url: https://<hostname>:<port>/oauth/token e.g. https://so-vnfm-adapter.onap:9092/oauth/token. The VNFM can request a token from this endpoint for use in grant requests and notifications\r
104 to the VNFM adapter. The username/password to be used in the token request are passed to the VNFM in a subscription request. The username/password sent by the VNFM adpater in the subscription request can be configuered using the \r
105 following parameter:\r
106 vnfmadapter:\r
107   auth: <encoded value>\r
108 where <encoded value> is '<username>:<password>' encoded using org.onap.so.utils.CryptoUtils with the key set by the paramter:\r
109 mso:\r
110   key: <key>\r
111 The default username:password is vnfm-adapter:123456 when vnfm-adapter.auth is not set.\r
112                   \r
113 ---------------   \r
114 VNFM simulator:\r
115 ---------------\r
116 Set the following parameters for the simulator:\r
117 spring:\r
118   profiles:\r
119     active: oauth-authentication\r
120 server:\r
121   request:\r
122     grant:\r
123       auth: oauth\r
124                 \r
125 ==========================================\r
126 To use basic auth for notifications\r
127 ==========================================              \r
128 The same username/password is used as for oauth token requests as describe above and passed to the VNFM in the subscription request.