Updated the README

Author: Araf Karsh Hamid

README.md

@@ -6,19 +6,23 @@ Microservice Template gives you a
 2. Open API 3 Ex, 
 3. Spring Actuator, 
 4. Spring Sleuth and 
-5. Pom file with (SpringBoot) Fat and Thin (Maven) jar file creation and 
+5. POM File with (SpringBoot) Fat and Thin (Maven) jar file creation and 
 6. Dockerfile for containerisation.
 
 ## Service Setup
 
-### Step 1 - Set the Org and Service Name, Versions, API Path
+### Step 1 - Setup Org, Service, & Container Name, Versions, API Path in app.props.tmpl
 
 1. Update the Org Name in src/main/resources/app.props.tmpl file (service.org)
-2. Update the microservice name in src/main/resources/app.props.tmpl file (service.name)
+2. Update the Microservice name in src/main/resources/app.props.tmpl file (service.name)
 3. Update the API Version in src/main/resources/app.props.tmpl file (service.api.version)
 4. Update the API Name in src/main/resources/app.props.tmpl file (service.api.name)
-5. Update the Server Version src/main/resources/app.props.tmpl file (server.version)
-6. Update the SRC_BASE (Your Service Repository Base Directory) in getServiceName shell script 
+5. Update the Container Name in src/main/resources/app.props.tmpl file (service.container)
+6. Update the Server Version src/main/resources/app.props.tmpl file (server.version)
+7. Update the SRC_BASE (Your Service Repository Base Directory) in getServiceName shell script
+
+Sample Property File Template
+![Property File](https://raw.githubusercontent.com/MetaArivu/microservice-template/master/diagrams/MS-Property-File.jpg)
 
 When you change the version in POM.xml, update that info in src/main/resources/app.props.tmpl - service.version property also.
 
@@ -44,28 +48,35 @@ Without generated application.properties file the service will not be running.
 
 ## Docker Container Setup
 
-### Step 1 - Setting Microservice Name
+### Step 1 - Verify Container Name and Org Name
 
-1. Change the EntryPoint in the Dockerfile (Last line - jar file name)
+1. Verify the Org Name in src/main/resources/app.props.tmpl file (service.org)
+2. Verify the container name in src/main/resources/app.props.tmpl file (service.container)
+3. Verify the microservice name in src/main/resources/app.props.tmpl file (service.api.name)
 
 ### Step 2 - Build the image
 
-1. build
-2. scan
+1. build (Build the Container)
+2. scan (Scan the container vulnerabilities)
 
 ### Step 3 - Test the image
 
-1. start
+1. start (Start the Container)
 2. logs (to view the container logs) - Wait for the Container to Startup
 3. Check the URL in a Browser
 
-### Step 4 - Push the image to Cloud Repo
+### Step 4 - Push the image to Container Cloud Repository
+
+Update the Org Name in src/main/resources/app.props.tmpl file (service.org)
+Setup the Docker Hub or any other Container Registry
 
-1. push
+1. push (Push the Container to Docker Hub)
 
 ### Other Commands
 
 1. stop (Stop the Container)_
 2. stats (show container stats)
 
 
+(C) Copyright 2021 - MetArivu
+Author: Araf Karsh Hamid

diagrams/MS-Property-File.jpg

@@ -1,28 +1,27 @@
 # Create Docker Container
-# -------------------------------------------------------------------------------------------
 
-## Step 1 - Setting Microservice Name
+## Step 1 - Verify Container Name and Org Name
 
-1. Update the microoservice name in src/main/resources/app.props.tmpl file (service.api.name)
-2. Update the Org Name in src/main/resources/app.props.tmpl file (service.org)
-3. Change the EntryPoint in the Dockerfile (Last line - jar file name) 
+1. Verify the Org Name in src/main/resources/app.props.tmpl file (service.org)
+2. Verify the container name in src/main/resources/app.props.tmpl file (service.container)
+3. Verify the microservice name in src/main/resources/app.props.tmpl file (service.api.name)
 
 ## Step 2 - Build the image
 
-1. build
-2. scan
+1. build (Build the Container)
+2. scan (Scan the container for vulnerabilities)
 
 ## Step 3 - Test the image
 
-1. start
+1. start (Start the Container)
 2. logs (to view the container logs) - Wait for the Container to Startup
 3. Check the URL in a Browser
 
 ## Step 4 - Push the image to Cloud Repo
 
-1. push 
+1. push (Push the image to Cloud)
 
 ## Other Commands
 
-1. stop (Stop the Container)_
+1. stop (Stop the Container)
 2. stats (show container stats)

src/docker/README.MD

@@ -4,9 +4,12 @@
 # -------------------------------------------------------------------------------------------
 # Start Container
 # -------------------------------------------------------------------------------------------
+PORT=9030
 ORG=`../../getServiceName 1`
 SERVICE=`../../getServiceName 4`
-echo "docker container run --name $SERVICE -d --rm -p 9010:9090 $ORG/$SERVICE"
-docker container run --name $SERVICE -d --rm -p 9010:9090 $ORG/$SERVICE
+API=`../../getServiceName 3`
+echo "docker container run --name $SERVICE -d --rm -p $PORT:9090 $ORG/$SERVICE"
+docker container run --name $SERVICE -d --rm -p $PORT:9090 $ORG/$SERVICE
+echo "Checkout API: http://localhost:$PORT/api/v1/$API/swagger-ui.html"
 echo "Container id for $SERVICE ="`docker container ls | grep $SERVICE | tr -s " " | cut -d " " -f 1`
 docker container ls | grep $SERVICE | tr -s " " | cut -d " " -f 1 > $SERVICE.cid

src/docker/start

@@ -7,7 +7,8 @@ service.api.prefix=api
 service.api.version=v1
 service.api.name=mock
 service.container=mock-service
-service.api.repository=https://github.com/MetaArivu/mock-${service.api.name}
+#service.api.repository=https://github.com/MetaArivu/${service.container}
+service.api.repository=https://github.com/MetaArivu/microservice-template
 service.api.path=/${service.api.prefix}/${service.api.version}/${service.api.name}
 service.url=http://www.metarivu.com/
 # =======================================================================