aboutsummaryrefslogtreecommitdiffstats
path: root/snmpmapper
diff options
context:
space:
mode:
Diffstat (limited to 'snmpmapper')
-rw-r--r--snmpmapper/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/snmpmapper/README.md b/snmpmapper/README.md
new file mode 100644
index 0000000..7ca23d9
--- /dev/null
+++ b/snmpmapper/README.md
@@ -0,0 +1,28 @@
+# DCAE SNMP Mapper
+
+DCAE SNMP mapper is a micro-service to upload the vendor specific mapper file into the database
+
+
+### Build Docker image
+
+The following Maven command will build the mapper JAR, build the Docker image to the local machine registry and then push the same image to the specified remote registry.
+
+```
+mvn clean package docker:build -DpushImageTag
+```
+
+The image will be tagged with the project version found in the `pom.xml`.
+
+### Run via Docker
+
+Execute this to run.
+
+
+```
+docker run -p 8081:8888 <image_name>
+
+```
+
+ ### Access
+ <host>:<expose port>
+ \ No newline at end of file