1 # ADML with REST Interface (ADML-HTTP)
5 Execute this [script](./example/diameter/launcher/deploy-adml-http.sh [Variant: Release by default]) and follow instructions.
7 ## Building docker image
9 In our image, we enable the `HTTP2 Service` to attack the `HTTP1.1 ADML interface`. This is done through nginx proxy configured as reverse proxy to translate `HTTP2` traffic coming to port *8074* towards *localhost* port *8000* where `ADML HTTP` is going to serve the *HTTP1.1* Rest Service.
11 To build the docker image, execute this script:
13 > tools/build-anna-adml-http [variant: [Release]|Debug]
15 ## Running docker image
17 > docker run --rm -d -p 8074:8074 --name anna-adml-http anna-adml-http:<version>
19 Service port is **8074**.
23 ### Monitoring ADML traces
25 > docker exec -it anna-adml-http tail -F /opt/adml/launcher.trace
27 ### Checking available diameter dictionaries
29 > docker exec -it anna-adml-http ls -1 /opt/adml/stacks
31 > DictionaryGx.16777238.xml
32 > DictionaryRx.16777236.xml
33 > DictionarySy.16777302.xml
36 ### Configure diameter nodes
38 You may use the *REST API* to load diameter services into *ADML*. This is the way to load stacks and nodes (origin hosts) in order to be up and running.
40 For example, consider an Origin-Host acting as diameter client with the name: **afHost.afRealm.com** and also a node named **ownHostId.operatorRealm.com** acting as diameter server, both using the *Rx interface* ( **/stacks/DictionaryRx.16777236.xml)**. You could configure any number of stacks/nodes to setup different diameter interfaces even having proxy/relay/translation capabilities.
42 You could load any number of services given by this [file specification](./example/diameter/launcher/resources/services_examples/services.dtd). Also, you could configure a single file and load together all the needed elements, for example:
45 `<stack id="16777236" dictionary="stacks/DictionaryRx.16777236.xml" fixMode="Always" ignoreFlagsOnValidation="yes"/>`
46 `<node originHost="afHost.afRealm.com" applicationId="16777236" entity="localhost:3868"/>`
47 `<node originHost="ownHostId.operatorRealm.com" applicationId="16777236" diameterServer="localhost:3868" diameterServerSessions="1"/>`
50 The REST API works with json format, then we shall use the [xml2json.py](./example/diameter/launcher/resources/rest_api/helpers/diameterJsonHelper/xml2json.py) tool to convert the previous one and insert on a node called "**servicesJson**":
53 > **"servicesJson": {**
57 > "@applicationId": "16777236",
58 > "@entity": "localhost:3868",
59 > "@originHost": "afHost.afRealm.com"
62 > "@applicationId": "16777236",
63 > "@diameterServer": "localhost:3868",
64 > "@diameterServerSessions": "1",
65 > "@originHost": "ownHostId.operatorRealm.com"
69 > "@dictionary": "stacks/DictionaryRx.16777236.xml",
70 > "@fixMode": "Always",
72 > "@ignoreFlagsOnValidation": "yes"
78 Then, you could load the former *services.json* file:
80 > nghttp -v -H ":method: POST" -d services.json http://localhost:8074/services
86 Read [this](./example/diameter/launcher/resources/rest_api/README.md).