summaryrefslogtreecommitdiffstats
path: root/plugins/plugins-event/plugins-event-carrier/plugins-event-carrier-grpc/pom.xml
blob: 74839cea63c29a2defd50e07b585fede7a741e70 (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
<?xml version="1.0"?>
<!--
  ============LICENSE_START=======================================================
   Copyright (C) 2020 Nordix Foundation.
  ================================================================================
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  SPDX-License-Identifier: Apache-2.0
  ============LICENSE_END=========================================================
-->
<project
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
 xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <modelVersion>4.0.0</modelVersion>
 <parent>
  <groupId>org.onap.policy.apex-pdp.plugins.plugins-event.plugins-event-carrier</groupId>
  <artifactId>plugins-event-carrier</artifactId>
  <version>2.5.3-SNAPSHOT</version>
 </parent>

 <artifactId>plugins-event-carrier-grpc</artifactId>
 <name>${project.artifactId}</name>
 <description>[${project.parent.artifactId}] Plugin for handling GRPC requests and responses</description>
    <dependencies>
        <dependency>
            <groupId>org.onap.policy.models.policy-models-interactions.model-impl</groupId>
            <artifactId>cds</artifactId>
            <version>${version.policy.models}</version>
        </dependency>
        <dependency>
            <groupId>org.onap.policy.models.policy-models-interactions.model-actors</groupId>
            <artifactId>actor.cds</artifactId>
            <version>${version.policy.models}</version>
        </dependency>
        <dependency>
            <groupId>org.assertj</groupId>
            <artifactId>assertj-core</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.mockito</groupId>
            <artifactId>mockito-all</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>
| string | Inserted by Policy. Maps to the UUID sent by DCAE i.e. the ID | | | | used throughout the closed loop lifecycle to identify a request. | +----------------------------------+---------+----------------------------------------------------------------------+ | *nsInstanceId* | string | Set by Policy, using the | | | | "service-instance.service-instance-id" property | | | | found within the enrichment data. | +----------------------------------+---------+----------------------------------------------------------------------+ +----------------------------------+---------+----------------------------------------------------------------------+ | healVnfData: | | | +----------------------------------+---------+----------------------------------------------------------------------+ | *cause* | string | Set by Policy to the name of the operation. | +----------------------------------+---------+----------------------------------------------------------------------+ | *vnfInstanceId* | string | Set by Policy, using the | | | | "generic-vnf.vnf-id" property | | | | found within the enrichment data. | +----------------------------------+---------+----------------------------------------------------------------------+ +----------------------------------+---------+----------------------------------------------------------------------+ | additionalParams: | | | +----------------------------------+---------+----------------------------------------------------------------------+ | *action* | | Set by Policy to the name of the operation. | +----------------------------------+---------+----------------------------------------------------------------------+ +----------------------------------+---------+----------------------------------------------------------------------+ | actionvminfo: | | | +----------------------------------+---------+----------------------------------------------------------------------+ | *vmid* | string | Set by Policy, using the | | | | "vserver.vserver-id" property | | | | found within the enrichment data. | +----------------------------------+---------+----------------------------------------------------------------------+ | *vmname* | string | Set by Policy, using the | | | | "vserver.vserver-name" property | | | | found within the enrichment data. | +----------------------------------+---------+----------------------------------------------------------------------+ Examples ######## Suppose the *ControlLoopOperationParams* were populated as follows: .. code-block:: bash { TBD } An example of a request constructed by the actor using the above parameters, sent to the VFC REST server: .. code-block:: bash { TBD } An example response received to the initial request, from the VFC REST service: .. code-block:: bash { TBD } An example URL used for the "get" (i.e., poll) request subsequently sent to VFC: .. code-block:: bash TBD An example response received to the poll request, when VFC has not completed the request: .. code-block:: bash { TBD } An example response received to the poll request, when VFC has completed the request: .. code-block:: bash { TBD } Configuration of the VFC Actor ############################### The following table specifies the fields that should be provided to configure the VFC actor. =============================== ==================== ================================================================== Field name type Description =============================== ==================== ================================================================== clientName string Name of the HTTP client to use to send the request to the VFC REST server. timeoutSec integer (optional) Maximum time, in seconds, to wait for a response to be received from the REST server. Defaults to 90s. =============================== ==================== ================================================================== The individual operations are configured using these same field names. However, all of them are optional, as they inherit their values from the corresponding actor-level fields. The following additional fields are specified at the individual operation level. =============================== ==================== =================================================================== Field name type Description =============================== ==================== =================================================================== path string URI appended to the URL. Note: this should not include a leading or trailing slash. maxGets integer (optional) Maximum number of get/poll requests to make to determine the final outcome of the request. Defaults to 0 (i.e., no polling). waitSecGet integer Time, in seconds, to wait between issuing "get" requests. Defaults to 20s. pathGet string Path to use when polling (i.e., issuing "get" requests). Note: this should include a trailing slash, but no leading slash. =============================== ==================== ===================================================================