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
|
.. ============LICENSE_START==========================================
.. ===================================================================
.. Copyright © 2020 AT&T Intellectual Property. All rights reserved.
.. ===================================================================
.. Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License");
.. you may not use this documentation except in compliance with the License.
.. You may obtain a copy of the License at
..
.. https://creativecommons.org/licenses/by/4.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.
.. ============LICENSE_END============================================
=============
Building APPC
=============
Introduction
============
Building of the Appc containers requires a several steps to be performed. Appc is comprised of several repositories
which must be built in order, since they depend on each other.
Here is a quick overview of the appc repositories:
- **appc/parent:** The maven parent pom files for the rest of the appc projects are kept here. This repository needs to
be built first, since these parent pom files are referenced by other appc repositories.
- **appc:** The main Java code for appc is kept here. This repository should be built after building the appc/parent
repository.
- **appc/cdt:** This repository contains two parts. The "CdtProxyService" directory contains Java code for the proxy
service which recieves requests from the CDT application. The rest of the code in the appc/cdt project is Angular/JS
code for the APPC CDT front end gui. Both parts will be built as part of a maven build on the app/cdt repository.
- **appc/deployment:** This repository contains the scripts to build the APPC docker containers. This repository should
be built last, since it pulls artifacts from the appc and appc/cdt builds.
Building Prerequisites
======================
APPC is built using Maven. You will need to make sure that Maven and a Java compiler are installed. Currently, APPC is
building on Java 1.8.
In order to build the appc/deployment project and the Docker images, you must have a Docker host. Docker can be running
on the same system you use for Maven builds and development work. You can also run Docker on a separate host, if you
choose to do so. If your Docker host is on a separate system, you need to set the DOCKER_HOST environment variable
before running the appc/deployment Maven build.
.. code:: bash
#DOCKER_HOST should only need to be set if your Docker host is not local
export DOCKER_HOST=tcp://<ip address of your Docker host>:4243
Cloning Code Repositories
=========================
The first step in building APPC is to clone the four appc repositories (listed above) using git. (appc/parent, appc,
appc/cdt, appc/deployment)
Building APPC Parent
====================
First we'll build appc parent. From the appc/parent directory, run a maven clean install:
.. code:: bash
mvn clean install
Building main APPC
==================
Before building the main appc repository, you need to make sure that references to the appc parent files have the same
version as the pom files in the parent repository that you just built. You can search for the text
"org.onap.appc.parent" in all of the pom.xml files in the appc repository. Check if the version matches the version of
app/parent that you just built. A find/replace on the <version> tag can be performed, if it needs to be changed.
The appc repository can then be built with a maven clean install.
Building APPC CDT
=================
The appc/cdt repository should just be built with a maven clean install. This should build both the Java code in the
CdtProxyService, as well as the Angular code.
Building APPC Deployment (building the Docker images)
=====================================================
The appc/deployment repository will perform several build steps in order to build the APPC Docker images.
appc-image Docker Build Preparation
-----------------------------------
The appc-image build occurs first. The build begins by downloading the APPC artifacts that were created by the main appc
maven build. You need to make sure the version of APPC that will be downloaded matches the version of APPC that you
built in the previous steps, see the "Setting APPC Versions" section below.
The appc-image Docker image is built on top of the ccsdk-odlsli-alpine-image. The version of the ccsdk image that will
be used is defined in the installation/appc/src/main/docker/Dockerfile file. This image will need to be downloaded
before the Docker build is performed:
.. code:: bash
docker pull nexus3.onap.org:10001/onap/ccsdk-odlsli-alpine-image:<image version>
Using the "docker tag" command, you should then tag the image you downloaded so that the image name exactly matches what
is shown in the Dockerfile.
(Please see the "APPC Deployment Guidelines" page for more information on setting up Docker and downloading images)
appc-cdt-image Docker Build Preparation
---------------------------------------
The appc-cdt-image build will download the cdt Angular code zip file that was created during your appc/cdt build earlier.
Similar to the appc-image build, you will have to make sure that the version of this zip that is being downloaded
matches the version that you built earlier, see the "Setting APPC Versions" section below for how to do this.
Setting APPC Versions
---------------------
The versions of APPC that will be downloaded by the Docker build are set in the properties section of the
installation/appc/pom.xml file:
- **<appc.snapshot.version>:** This property sets the version of APPC to download to the Docker image. This version will
be used in any build where the appc/deployment pom versions are set to any "-SNAPSHOT" version (this will usually be
the case for local builds).
- **<appc.release.version>:** This property sets the version of APPC to download to the Docker image. This version will
be used in any build where the appc/deployment pom versions do NOT contain "-SNAPSHOT" (this will usually only be used
for the staging jobs on Jenkins).
- **<appc.cdt.version>:** This property sets the version of the APPC CDT proxy service that will be downloaded to the
Docker image. This property should be set to the version of the appc/cdt repository that you built earlier. Or, if you
didn't modify the CDT proxy code, you can leave this as it is, and a version will be downloaded from ONAP Nexus.
The version of the CDT code that will be downloaded by the Docker build is set in the properties section of the
cdt/pom.xml file:
- **<appc.snapshot.version>:** This property sets the version of APPC CDT to download to the Docker image. This version
will be used in any build where the appc/deployment pom versions are set to any "-SNAPSHOT" version (this will usually
be the case for local builds).
- **<appc.release.version>:** This property sets the version of APPC CDT to download to the Docker image. This version
will be used in any build where the appc/deployment pom versions do NOT contain "-SNAPSHOT" (this will usually only be
used for the staging jobs on Jenkins).
Building the Docker containers
------------------------------
A maven clean install with the profile "docker" is used to start the appc/deployment and Docker build:
.. code:: bash
mvn clean install -P docker
**NOTE:** In some cases, you may see the appc/deployment build downloading APPC artifacts from Nexus, instead of using
the artifacts that you built locally from the appc and appc/cdt builds. This can happen if two conditions are met:
1. Your appc and appc/cdt local versions are set to the same version as they are in Gerrit.
2. ONAP Jenkins has run a merge job more recently than you performed your local build.
In this case, your appc/deployment build will see that the snapshot version in Nexus is newer than the version which
exists locally, and it will download that version instead of using the local one.
|
