aboutsummaryrefslogtreecommitdiffstats
path: root/INFO.yaml
blob: 345217e0f5aaeed175eb98f2a931cd0cc0738f5f (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

---
project: 'clamp'
project_creation_date: '2017-06-15'
lifecycle_state: 'Incubation'
project_lead: &onap_releng_ptl
    name: 'Gervais-Martial Ngueko'
    email: 'gn422w@intl.att.com'
    id: 'osgn422w'
    company: 'ATT'
    timezone: 'Belgium/Namur'
primary_contact: *onap_releng_ptl
issue_tracking:
    type: 'jira'
    url: 'https://jira.onap.org/projects/CLAMP'
    key: 'CLAMP'
meetings:
    - type: 'zoom'
        agenda: 'https://wiki.onap.org/pages/viewpage.action?pageId=6593117'
        url: 'https://wiki.onap.org/pages/viewpage.action?pageId=6593117'
        server: 'n/a'
        channel: 'n/a'
        repeats: 'weekly'
        time: '13:00 UTC'
committers:
    - name: 'Christophe Closset'
        email: 'cc697w@intl.att.com'
        company: 'ATT'
        id: 'ChrisC'
        timezone: 'Belgium/Namur'
    - name: 'Eddy Hautot'
        email: 'eh552t@intl.att.com'
        company: 'ATT'
        id: 'ehautot'
        timezone: 'Belgium/Namur'
    - name: 'Pierre Close'
        email: 'pc457b@intl.att.com'
        company: 'ATT'
        id: 'piclose'
        timezone: 'Belgium/Namur'
    - name: 'Sébastien Determe'
        email: 'sd378r@intl.att.com'
        company: 'ATT'
        id: 'sebdet'
        timezone: 'Belgium/Namur'
    - name: 'Xinyuan Wang'
        email: 'wang.xinyuan1@zte.com.cn'
        company: 'ZTE'
        id: 'Xinyuan'
        timezone: 'Belgium/Namur'
tsc:
    approval: 'https://lists.onap.org/pipermail/onap-tsc'
class="s2">"clamp.config.files.sdcController":"file:/opt/clamp/config/sdc-controllers-config.json" } ``` ### SDC-Controllers config This file is a JSON that must be specified to Spring config, here is an example: ```json { "sdc-connections":{ "sdc-controller1":{ "user": "clamp", "consumerGroup": "consumerGroup1", "consumerId": "consumerId1", "environmentName": "AUTO", "sdcAddress": "localhost:8443", "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981", "pollingInterval":30, "pollingTimeout":30, "activateServerTLSAuth":"false", "keyStorePassword":"", "keyStorePath":"", "messageBusAddresses":["dmaaphost.com"] }, "sdc-controller2":{ "user": "clamp", "consumerGroup": "consumerGroup1", "consumerId": "consumerId1", "environmentName": "AUTO", "sdcAddress": "localhost:8443", "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981", "pollingInterval":30, "pollingTimeout":30, "activateServerTLSAuth":"false", "keyStorePassword":"", "keyStorePath":"", "messageBusAddresses":["dmaaphost.com"] } } } ``` Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers. Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification. The environmentName is normally the Dmaap Topic used by SDC. If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers) ### Docker-compose A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/). Once the image has been built and is available locally, you can use the `docker-compose up` command to deploy a prepopullated database and a clamp instance available on [http://localhost:8080/designer/index.html](http://localhost:8080/designer/index.html). ### Logs Clamp uses logback framework to generate logs. The logback.xml file cand be found under the [src/main/resources/ folder](src/main/resources). With the default log settings, all logs will be generated into console and into root.log file under the Clamp root folder. The root.log file is not allowed to be appended, thus restarting the clamp will result in cleaning of the old log files. ### Api You can see the swagger definition for the jaxrs apis at `/restservices/clds/v1/openapi.json` ## Clamp Credentials Credentials should be specified in `src/main/resources/clds/clds-users.json`. You might specify you own credential file by redefining the `clamp.config.files.cldsUsers` in `application.properties`. Passwords should be hashed using Bcrypt : ``` # pip3 install bcrypt # if you don't have the bcrypt python lib installed, should be done once. # python3 -c 'import bcrypt; print(bcrypt.hashpw("password".encode(), bcrypt.gensalt(rounds=10, prefix=b"2a")))' ``` Default credentials are admin/password and cs0008/password.