summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..3a4b4cd2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+This source repository contains the files for building the OpenECOMP Policy Engine Docker images.
+
+To build it using Maven 3, first build 'policy-common-modules', 'policy-engine', 'policy-drools-pdp', and 'policy-drools-applications' repositories, and then run: mvn prepare-package. This will pull the installation zip files needed for building the policy-pe and policy-drools Docker images into the target directory. It will not actually build the docker images; the following additional steps are needed to accomplish this:
+
+- Copy the files under policy-pe to target/policy-pe
+- Copy the files under policy-drools to target/policy-drools
+- Run the 'docker build' command on the following directories, in order:
+ policy-os
+ policy-db
+ policy-nexus
+ policy-base
+ target/policy-pe
+ target/policy-drools
+
+In addition, the 'config' dirctory contains configuration files that are read during the startup of the containers; this directory is referenced by the docker-compose.yml file.
+