summaryrefslogtreecommitdiffstats
path: root/dpo/spec/rcc_spec.json
blob: 2cae9ff8cff52ba929ee50610f6b7b168f21adb4 (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
{
  "self": {
    "version": "1.0.0",
    "name": "dcae-restconfcollector",
    "description": "Collector for subscribing events/notification from external controller in rest format and publishing those events to Ves collector",
    "component_type": "docker"
  },
  "streams": {
    "subscribes": [],
    "publishes": [{
      "config_key": "rcc_handle_out",
      "format": "DCAE_RCC_OUTPUT",
      "version": "1.0.0",
      "type": "message router"
    }]
  },
  "services": {
    "calls": [],
    "provides": []
  },
  "parameters": [
        {
          "name": "collector.rcc.appName",
          "description": "DCAE RestConf Collector Application",
          "value": "dcae-rcc",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.appDescription",
          "description": "DCAE RestConf Collector Application",
          "value": "DCAE RestConf Collector Application",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.dmaap.streamid",
          "description": "Stream id",
          "value": "notification=device-registration",
          "sourced_at_deployment": true,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.inputQueue.maxPending",
          "description": "Number of max queue outstanding",
          "value": "8096",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.service.port",
          "value": "-1",
          "description": "standard http port collector will open for listening; this will be disabled when collector.header.authflag is set to 1",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.service.secure.port",
          "value": "-1",
          "description": "standard https port collector will open for listening; this will be enabled when collector.header.authflag is set to 1",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.header.authflag",
          "value": "-1",
          "description": "Should be set to 1 when open secure port",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.header.authlist",
          "value": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi",
          "description": "List of id and base 64 encoded password.Password value should be base64 encoded in config here",
          "policy_editable": false,
          "sourced_at_deployment": true,
          "designer_editable": true
        },
        {
          "name": "collector.rcc.keystore.file.location",
          "value": "/opt/app/RCCollector/dcae-certificate/keystore.jks",
          "description": "fs location of keystore file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.keystore.passwordfile",
          "value": "/opt/app/RCCollector/dcae-certificate/.password",
          "description": "location of keystore password file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.keystore.alias",
          "value": "dynamically generated",
          "description": "alias to access the keystore; collector will identify this based on keystore and password file",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.truststore.file.location",
          "value": "/opt/app/RCCollector/dcae-certificate/truststore.jks",
          "description": "fs location of truststore file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.rcc.truststore.passwordfile",
          "value": "/opt/app/RCCollector/dcae-certificate/.trustpassword",
          "description": "location of truststore password file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "tomcat.maxthreads",
          "description": "Max threads",
          "value": "200",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "rcc_policy",
          "description": "RCC Policy JSON",
          "value":"[{\"controller_name\":\"AccessM&C\",\"controller_restapiUrl\":\"192.167.1.3:8080\",\"controller_restapiUser\":\"access\",\"controller_restapiPassword\":\"Huawei@123\",\"controller_accessTokenUrl\":\"/rest/plat/smapp/v1/oauth/token\",\"controller_accessTokenFile\":\"./etc/access-token.json\",\"controller_accessTokenMethod\":\"put\",\"controller_subsMethod\":\"post\",\"controller_subscriptionUrl\":\"/restconf/v1/operations/huawei-nce-notification-action:establish-subscription\",\"event_details\":[{\"event_name\":\"ONT_registration\",\"event_description\":\"ONTregistartionevent\",\"event_sseventUrlEmbed\":\"true\",\"event_sseventsField\":\"output.url\",\"event_sseventsUrl\":\"null\",\"event_subscriptionTemplate\":\"./etc/ont_registartion_subscription_template.json\",\"event_unSubscriptionTemplate\":\"./etc/ont_registartion_unsubscription_template.json\",\"event_ruleId\":\"12345678\"}]}]",
          "sourced_at_deployment": false,
          "policy_editable": true,
          "designer_editable": false
        },
        {
          "name": "collector.keystore.file.location",
          "value": "/opt/app/restconfcolletcor/etc/keystore",
          "description": "fs location of keystore file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        },
        {
          "name": "collector.keystore.passwordfile",
          "value": "/opt/app/restconfcolletcor/etc/rcc_passwordfile",
          "description": "location of keystore password file in vm",
          "sourced_at_deployment": false,
          "policy_editable": false,
          "designer_editable": false
        }
  ],

  "auxilary": {
    "healthcheck": {
      "type": "https",
      "interval": "15s",
      "timeout": "1s",
      "endpoint": "/healthcheck"
    },
    "volumes": [
      {
        "container": {
          "bind": "/opt/app/dcae-certificate"
        },
        "host": {
          "path": "/opt/app/restconfcollector/dcae-certificate"
        }
      },
      {
        "container": {
          "bind": "/opt/app/restconfcollector/logs"
        },
        "host": {
          "path": "/opt/logs/DCAE/restconfcollector/logs"
        }
      },
      {
        "container": {
          "bind": "/opt/app/restconfcollector/etc"
        },
        "host": {
          "path": "/opt/logs/restconfcollector/etc"
        }
      }
    ]
  },
  "artifacts": [
    {
      "type": "docker image",
      "uri": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.restconfcollector"
    }
  ]
}