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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
//
// ============LICENSE_START=======================================================
// Copyright (C) 2016-2018 Ericsson. All rights reserved.
// ================================================================================
// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
//
// SPDX-License-Identifier: CC-BY-4.0
// ============LICENSE_END=========================================================
//
// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
//
== Running APEX in Docker
This section explains how to create a Docker image that contains the base APEX package and shows how to run APEX in Docker.
It also explains how to use the base APEX Docker image to create application docker images that contain both APEX and your application policies.
We assume you have already installed Docker on your host.
For instructions on how to install Docker, see the link:https://www.docker.com/community-edition[Get Started with Docker] page on the Docker web site.
=== Create the APEX Base Docker Image
You need only perform this task once to create an APEX base image that you can use as a base for your applications from then on.
This task sets up an Ubuntu Docker image and then installs Java and APEX on Ubuntu running in the Docker image.
. Create an empty directory, here the directory is called `apex`, and change into that directory
+
[source%nowrap,bash,numbered]
----
# mkdir apex
# cd apex
----
+
. Copy the APEX Debian package from the APEX download site into the directory
. Open a text editor and create a file called `Dockerfile` in your directory
. Paste the following text into the editor that is editing `Dockerfile`
+
[source%nowrap,bash,numbered,subs="attributes+"]
----
#
# Docker file to build an image that runs APEX on Java 8 in Ubuntu
#
FROM ubuntu:16.04
MAINTAINER <YOUR> <NAME> <YOUR>.<NAME>@ericsson.com
RUN apt-get update && \
apt-get upgrade -y && \
apt-get install -y software-properties-common && \
add-apt-repository ppa:webupd8team/java -y && \
apt-get update && \
echo oracle-javax8-installer shared/accepted-oracle-license-v1-1 select true | /usr/bin/debconf-set-selections && \
apt-get install -y oracle-java8-installer
RUN mkdir /packages
COPY apex-apps.uservice-packages-{release-version}-full.deb /packages
RUN dpkg -i packages/apex-apps.uservice-packages-{release-version}-full.deb
RUN rm /packages/apex-apps.uservice-packages-{release-version}-full.deb
ENV PATH /opt/ericsson/apex/apex/bin:$PATH
RUN apt-get clean
RUN chown -R apexuser:apexuser /home/apexuser/*
WORKDIR /home/apexuser
----
+
. Replace the fields <YOUR> and <NAME> above with your name and email address
. Save the `Dockerfile`
. An example working base `Dockerfile` appears below
+
[source%nowrap,bash,numbered,subs="attributes+"]
----
#
# Docker file to build an image that runs APEX on Java 8 in Ubuntu
#
FROM ubuntu:16.04
MAINTAINER Sean Citizen sean.citizen@ericsson.com
RUN apt-get update && \
apt-get upgrade -y && \
apt-get install -y software-properties-common && \
add-apt-repository ppa:webupd8team/java -y && \
apt-get update && \
echo oracle-javax8-installer shared/accepted-oracle-license-v1-1 select true | /usr/bin/debconf-set-selections && \
apt-get install -y oracle-java8-installer
RUN mkdir /packages
COPY apex-apps.uservice-packages-{release-version}-full.deb /packages
RUN dpkg -i packages/apex-apps.uservice-packages-{release-version}-full.deb
RUN rm /packages/apex-apps.uservice-packages-{release-version}-full.deb
ENV PATH /opt/ericsson/apex/apex/bin:$PATH
RUN apt-get clean
RUN chown -R apexuser:apexuser /home/apexuser/*
WORKDIR /home/apexuser
----
+
. Create and tag the base Docker image for APEX using this command
+
[source%nowrap,bash,numbered]
----
docker build -t apex/base .
docker tag apex/base apex/base:latest
docker tag apex/base apex/base:{release-version}
----
+
. Test the APEX Docker base image with the following command, APEX will start a sample policy:
+
[source%nowrap,bash,numbered]
----
docker run --name apex --user=apexuser:apexuser -it --rm -p 12345:12345 apex/base apexEngine.sh -c examples/config/SampleDomain/Stdin2StdoutJsonEventJavascript.json
----
+
. Paste the following event into the shell and the APEX Policy will process the event
+
[source%nowrap,json,numbered]
----
{
"nameSpace": "org.onap.policy.apex.sample.events",
"name": "Event0000",
"version": "0.0.1",
"source": "test",
"target": "apex",
"TestSlogan": "Test slogan for External Event0",
"TestMatchCase": 0,
"TestTimestamp": 1469781869269,
"TestTemperature": 9080.866
}
----
+
. APEX returns the following event
+
[source%nowrap,json,numbered]
----
{
"nameSpace" : "org.onap.policy.apex..sample.events",
"name" : "Event0004",
"version" : "0.0.1",
"source" : "",
"target" : "",
"TestActCaseSelected" : 3,
"TestActStateTime" : 1481215910429,
"TestTemperature" : 9080.866,
"TestDecideCaseSelected" : 1,
"TestMatchCaseSelected" : 2,
"TestTimestamp" : 1469781869269,
"TestDecideStateTime" : 1481215910425,
"TestMatchCase" : 0,
"TestSlogan" : "Test slogan for External Event0",
"TestEstablishCaseSelected" : 0,
"TestEstablishStateTime" : 1481215910421,
"TestMatchStateTime" : 1481215910415
}
----
+
. You now have built and tested an APEX base Docker image.
You can connect the APEX Deployment and Monitoring servlet to this APEX engine instance. For example, assuming the APEX Deployment and Monitoring servlet is deploying on the localhost computer on port 8080 you can use the following URL:
+
----
http://localhost:8080/apex-services.client-{release-version}/?hostname=0.0.0.0&port=12345
----
=== Create an APEX Application Docker Image using the APEX Base Docker Image
We assume you have created an APEX application, that you wish to use static deployment, and that you have APEX metadata to add to the base APEX Docker image.
. 1.Create an empty directory for your application, here the directory is called `myApplication`, and change into that directory
+
[source%nowrap,bash,numbered]
----
mkdir myApplication
cd myApplication
----
+
. Copy the directories containing your application metadata into that directory, for example, if you have three directories called `myappDirectory0`, `myappDirectory1`, and `myappDirectoryn`, you will have the following directory structure
+
[source%nowrap,bash,numbered]
----
ls | cat
myappDirectory0
myappDirectory1
myappDirectoryn
----
+
. Open a text editor and create a file called `Dockerfile` in your application directory
. Paste the following text into the editor that is editing `Dockerfile`
+
[source%nowrap,bash,numbered]
----
#
# Docker file to build an image that runs APEX Applications on Java 8 in Ubuntu
#
FROM apex/base:{release-version}
MAINTAINER <YOUR> <NAME> <YOUR>.<NAME>@ericsson.com
# Copy your application metadata
COPY <MY_APP_DIRECTORY_0> /home/apexuser/<MY_APP_DIRECTORY_0>
COPY <MY_APP_DIRECTORY_1> /home/apexuser/<MY_APP_DIRECTORY_1>
COPY <MY_APP_DIRECTORY_N> /home/apexuser/<MY_APP_DIRECTORY_N>
run chown -R apexuser:apexuser /home/apexuser/*
----
+
. Edit the template fields
.. Replace the fields <YOUR> and <NAME> with your name and email address
.. Replace the <MY_APP_DIRECTORY_x> fields with the names of your actual application directory names, myappDirectoryx in our example here. Do this for all application directories you have.
. Save the `Dockerfile`
. An example working application `Dockerfile` appears below
+
[source%nowrap,bash,numbered]
----
#
# Docker file to build an image that runs APEX Applications on Java 8 in Ubuntu
#
FROM apex/base:{release-version}
MAINTAINER Sean Citizen sean.citizen@ericsson.com
# Copy your application metadata
COPY myappDirectory0 /home/apexuser/myappDirectory0
COPY myappDirectory1 /home/apexuser/myappDirectory1
COPY myappDirectoryn /home/apexuser/myappDirectoryn
run chown -R apexuser:apexuser /home/apexuser/*
----
+
. Create the Docker image for your APEX application using this command
+
[source%nowrap,bash,numbered]
----
docker build -t apex/myapplication .
----
+
. Test the APEX Docker base image with the following command, APEX will start to a bash shell in the `apexuser` home directory:
+
[source%nowrap,bash,numbered]
----
docker run --name myapplication -it --rm -p 12345:12345 apex/myapplication apexBash.sh
----
+
. Check that your application directories have been created, the command returns the directory list:
+
[source%nowrap,bash,numbered]
----
> pwd
/opt/ericsson
> ls -l
total 16
drwxr-xr-x 8 apexuser apexuser 4096 Dec 9 13:28 examples
drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectory0
drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectory1
drwxr-xr-x 2 apexuser apexuser 4096 Dec 9 13:28 myappDirectoryn
----
+
. You now have built an APEX Application docker image and you can use the `apexEngine.sh` command to run your application using the appropriate configuration file for your application.
|
