Update to hyphened spelling of front-end and back-end (#203)

* Update to hyphened spelling of front-end and back-end
* Update docker-compose information

Author: e-pettersson-ericsson

wiki/markdown/add-subscription.md

@@ -1,6 +1,6 @@
 # Add Subscription
 
-This form is used to add subscription through frontend GUI. Here is a
+This form is used to add subscription through front-end GUI. Here is a
 description of the elements available on this form.
 
 <img src="images/subscription_add_form1.png">

wiki/markdown/curl-examples.md

@@ -9,7 +9,7 @@ Below are some examples of using CURL towards different endpoints, together with
 Most endpoints are also documented in the [Eiffel Intelligence backend repository](https://github.com/eiffel-community/eiffel-intelligence/tree/master/wiki/markdown)
 
 **Note**: If you have multiple url parameters, you need to add quotation mark around the entire query. For example:
-    
+
     curl -X GET "http://localhost:8080/endpoint?varible1=1&varible2=2"
 
 #### Quick access to endpoints:
@@ -178,7 +178,7 @@ The second entry is invalid due to having the same name as the first entry. The
 
 #### Deleting a back-end instance via curl
 
-It is possible to delete a back-end instance using curl. The full JSON object has to be specified to identify which instance should be deleted. It is not possible to delete a default backend instance.
+It is possible to delete a back-end instance using curl. The full JSON object has to be specified to identify which instance should be deleted. It is not possible to delete a default back-end instance.
 
     {"name":"My Back-End","host":"localhost","port":8090,"contextPath":"","https":false,"defaultBackend":false},
 

wiki/markdown/docker.md

@@ -1,7 +1,7 @@
 # Docker
 
-In Eiffel-Intelligence frontend source code repository, a Dockerfile is provided which helps the developer or user to build the local Eiffel-Intellegence frontend source code repository changes to a Docker image.
-With the Docker image user can try-out the Eiffel-Intelligence frontend on a Docker Host or in a Kubernetes cluster.
+In Eiffel-Intelligence front-end source code repository, a Dockerfile is provided which helps the developer or user to build the local Eiffel-Intellegence front-end source code repository changes to a Docker image.
+With the Docker image user can try-out the Eiffel-Intelligence front-end on a Docker Host or in a Kubernetes cluster.
 
 ## Requirements
 - Docker
@@ -13,12 +13,12 @@ With the Docker image user can try-out the Eiffel-Intelligence frontend on a Doc
   Windows: https://docs.docker.com/docker-for-windows/install/
 
 - Docker Compose
-  
+
   Linux and Windows:  https://docs.docker.com/compose/install/
 
 ## Follow these step to build the Docker image.
 
-1. Build the Eiffel-Intelligence frontend war file:
+1. Build the Eiffel-Intelligence front-end war file:
 
 `mvn package -DskipTests`
 
@@ -27,7 +27,7 @@ This will produce a war file in the "target" folder.
 
 2. Build the Docker image with the war file that was produced from previous step:
 
-`docker build -t eiffel-intelligence-frontend:0.0.19 --build-arg URL=./target/eiffel-intelligence-frontend-0.0.19.war -f src/main/docker/Dockerfile .` 
+`docker build -t eiffel-intelligence-frontend:0.0.19 --build-arg URL=./target/eiffel-intelligence-frontend-0.0.19.war -f src/main/docker/Dockerfile .`
 
 Now docker image has build with tag "eiffel-intelligence-frontend:0.0.19"
 
@@ -70,10 +70,10 @@ When Eiffel-Intelligence container is running on your local Docker host Eiffel-I
 
 In web-browser use url with docker host ip number: "\<docker host ip\>:8071/"
 
-Switch-backend functionality do not work when "localhost" address is used.
+Switch-back-end functionality do not work when "localhost" address is used.
 
-Another option to configure Eiffel-Intelligence Front-end is to provide the application properties file into the container, which can be made in two ways:
-1. Put application.properties file in Tomcat Catalina config folder in container and run Eiffe-Intelligence Front-end:
+Another option to configure Eiffel Intelligence front-end is to provide the application properties file into the container, which can be made in two ways:
+1. Put application.properties file in Tomcat Catalina config folder in container and run Eiffel Intelligence front-end:
 
 `docker run -p 8070:8080 --expose 8080 --volume /path/to/application.properties:/usr/local/tomcat/config/application.properties eiffel-intelligence-frontend:0.0.19`
 
@@ -84,60 +84,66 @@ Another option to configure Eiffel-Intelligence Front-end is to provide the appl
 
 # Run Docker image with provided docker-compose file
 This docker-compose file includes these components, [docker-compose.yml](https://github.com/Ericsson/eiffel-intelligence-frontend/blob/master/src/main/docker/docker-compose.yml):
-- MongoDb
+- MongoDB
 - RabbitMq
-- ER
-- EI-Backend
-- EI-Frontend (Using the local EI-Frontend Docker image build from previous steps)
+- ER (Event Repository)
+- Mail server
+- Jenkins
+- Eiffel REMReM services (Generate and Publish)
+- 3 instances of EI backend (using different rule sets)
+- EI frontend (Using the local EI front-end Docker image build from previous steps)
 
-If you have used a different image tag when you build the EI Frontend docker image, then you need to update docker-compose.yml file.
+NOTE: Only MongoDB, RabbitMQ, ER and EI components are needed to start.
+The rest of the components can be commented out if not needed.
 
-This line need to changed, in ei_backend service section:
+### 1 Source environment variables used in docker-compose.yml
 
-"image: eiffel-intelligence-frontend:0.0.19"
+For easier configuration, the Docker images to be used and ports for the different
+services are set in [env.bash](https://github.com/Ericsson/eiffel-intelligence-frontend/blob/master/src/main/docker/env.bash)
+file. Update to whichever ports you want to use, or keep default values. If you have used a different image tag when you built the EI front-end
+docker image, then you need to update the [env.bash file](https://github.com/Ericsson/eiffel-intelligence-frontend/blob/master/src/main/docker/env.bash)
+with the locally built image.
 
-To:
+To run docker-compose commands, the environment variables needs to be set:
 
-"image: \<your image tag\>"
+    source src/main/docker/env.bash
 
 Two variables need to be set before we can start up all services with docker-compose tool.
-Set Docker host ip to the HOST variable. 
-If on Linux:
-
+Set Docker host IP to the HOST variable. This is done automatically when sourcing [env.bash](https://github.com/Ericsson/eiffel-intelligence-frontend/blob/master/src/main/docker/env.bash).
+But it is also possible to do it manually. If on Linux:
 `export HOST=$(hostname -I | tr " " "\n"| head -1)`
+If on Windows, get Docker Host IP with command: `dockermachine ip`
+Set that Docker host IP to HOST environment variable.
 
-If on Windows, get Docker Host ip with command: `dockermachine ip`
-
-Set that Docker host ip to HOST environment varaible.
+Currently we need to provide EI back-end instances list outside of docker-compose.yml file.
+This is also done via the [env.bash](https://github.com/Ericsson/eiffel-intelligence-frontend/blob/master/src/main/docker/env.bash)
+file.
 
-Currently we need to provide EI Back-end instances list outside of docker-compose.yml file.
+### 2 Then run following docker-compose command to startup all components:
 
-`export EIFFEL2_EI_FRONTEND_EI_INSTANCES_LIST=$(echo [{ \"contextPath\": \"\", \"port\": \"8080\", \"name\": \"EI-Backend\", \"host\": \"ei-backend\", \"https\": false, \"defaultBackend\": true}])`
+    docker-compose -f src/main/docker/docker-compose.yml up -d
 
-Then run following docker-compose command to startup all components:
-
-`docker-compose -f src/main/docker/docker-compose.yml up -d`
-
-It will take some minutes until all components has started. When all components has loaded, you should be able to access EI Front-end web page with address:
+It will take some minutes until all components has started. When all components has loaded, you should be able to access EI front-end web page with address:
 http://\<docker host ip\>:8081/
 
-Curl command can be used to make request via EI Front-end bridge to EI Back-end Rest-Api, example for getting all subscriptions:
+Curl command can be used to make request via EI front-end bridge to EI back-end REST API, example for getting all subscriptions:
 
 
 `curl -X GET http://localhost:8081/subscriptions`
 
 It is also possible to access these Rest-Api addresses in web-browser and get result presented in a Json view in web-browser.
 
-Following command can be used to get the logs from the EI Front-end container/service:
+Following command can be used to get the logs from the EI front-end container/service:
 
 `docker-compose -f src/main/docker/docker-compose.yml logs ei_frontend`
 
-All service names can be retreived with following command:
+All service names can be retrieved with following command:
 
 `docker-compose -f src/main/docker/docker-compose.yml config --services`
 
 It is also possible to retrieve the logs by only using "docker logs <container_id or container_name>" command:
 
+`docker logs <container_id or container_name>`
 `docker logs <container_id or container_name>`
 
 Container id can be retrieved with docker command:

wiki/markdown/index.md

@@ -1,13 +1,12 @@
 # Home
 
-Eiffel Intelligence Frontend provides Eiffel Intelligence (EI) users a simple 
-and easy to use GUI. More precisely, Eiffel Intelligence Frontend allows the 
-configuration of subscription and aggregation rules in Eiffel Intelligence 
+Eiffel Intelligence front-end provides Eiffel Intelligence (EI) users a simple
+and easy to use GUI. More precisely, Eiffel Intelligence front-end allows the
+configuration of subscription and aggregation rules in Eiffel Intelligence
 through a graphical interface.
 
-EI has two components, namely Eiffel Intelligence (Backend) and Eiffel 
-Intelligence Frontend. In Eiffel GitHub these two components are represented by 
-two different repositories. Eiffel Intelligence (Backend) implements core 
-functionalities of EI and Eiffel Intelligence Frontend take care of the user 
+EI has two components, namely Eiffel Intelligence (back-end) and Eiffel
+Intelligence front-end. In Eiffel GitHub these two components are represented by
+two different repositories. Eiffel Intelligence (back-end) implements core
+functionalities of EI and Eiffel Intelligence front-end take care of the user
 interactions through an interface.
-

wiki/markdown/subscription-handling.md

@@ -4,7 +4,7 @@ Clicking on the Subscription Handling element will display some buttons in main
 page which help perform a number of subscription related actions. A table may
 become visible, which is populated by the information about the stored (if any)
 subscriptions in the connected database. This view is also the default view of
-the Eiffel Intelligence Frontend, once the authentication (if enabled) is done.
+the Eiffel Intelligence front-end, once the authentication (if enabled) is done.
 
 <img src="images/subscription_overview.png">
 </img>
@@ -22,9 +22,9 @@ database.
 This button downloads a subscription template
 #### _Upload Subscriptions_
 This button help uploads a subscription by opening a file explorer
-#### _EI Backend Status_
-This button indicates, through its color, whether a backend instance is
-connected with frontend or not. The green color means backend is connected
+#### _EI Back-end Status_
+This button indicates, through its color, whether a back-end instance is
+connected with front-end or not. The green color means back-end is connected
 while red means no instance is connected.
 
 

wiki/markdown/test-rules.md

@@ -276,7 +276,7 @@ aggregated object will show up on the screen.
 ## Curl ##
 
 It is possible to use curl to get required information. To get information
-about test rules status, if this functionality is enabled in back end or
+about test rules status, if this functionality is enabled in back-end or
 not, you can execute command below.
 
     curl -X GET http://<host>:8080/rules/rule-check/testRulePageEnabled?backendurl="http://127.0.0.1:8090/"