[v3.1.0] Update README documentation

CHANGELOG.md

@@ -15,4 +15,4 @@ and Identity Server as Key Manager version 5.10.x profiles
 For detailed information on the tasks carried out during this release, please see the GitHub milestone
 [v3.1.0.1](https://github.com/wso2/docker-apim/milestone/13).
 
-[v3.0.0.1]: https://github.com/wso2/docker-apim/compare/v3.0.0.3...v3.1.0.1
+[v3.1.0.1]: https://github.com/wso2/docker-apim/compare/v3.0.0.3...v3.1.0.1

dockerfiles/alpine/apim-analytics/dashboard/README.md

@@ -28,14 +28,15 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9643:9643 wso2am-analytics-dashboard:3.1.0-alpine`
-> Here, only port 9643 has been mapped to a Docker host port.
+- `docker run -p 9640:9640 wso2am-analytics-dashboard:3.1.0-alpine`
+
+> Here, only port 9640 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ##### 4. Accessing the Dashboard portal.
 
 - For dashboard,
- + `https:<DOCKER_HOST>:9643/analytics-dashboard`
+ + `https:<DOCKER_HOST>:9640/analytics-dashboard`
 
 > In here, <DOCKER_HOST> refers to hostname or IP of the host machine on top of which containers are spawned.
 
@@ -44,11 +45,11 @@ You may map other container service ports, which have been exposed to Docker hos
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
-can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+can be found at `<DISTRIBUTION_HOME>/conf/dashboard`. Copy the file to some suitable location of the host machine, <br>
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 1.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 
@@ -60,12 +61,12 @@ chmod o+r <SOURCE_CONFIGS>/deployment.yaml
 
 ```
 docker run 
--p 7713:7713
+-p 9641:9641
 --volume <SOURCE_CONFIGS>/deployment.yaml:<TARGET_CONFIGS>/deployment.yaml
-wso2am-analytics-worker:3.1.0-alpine
+wso2am-analytics-dashboard:3.1.0-alpine
 ```
 
-> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/worker folder of the container.
+> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/dashboard folder of the container.
 
 ## Docker command usage references
 

dockerfiles/alpine/apim-analytics/worker/README.md

@@ -28,20 +28,21 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9091:9091 wso2am-analytics-worker:3.1.0-alpine`
-> Here, only port 9091 has been mapped to a Docker host port.
+- `docker run -p 9090:9090 wso2am-analytics-worker:3.1.0-alpine`
+
+> Here, only port 9090 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ## How to update configurations
 
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
 can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 2.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 

dockerfiles/alpine/apim/README.md

@@ -28,6 +28,7 @@ git clone https://github.com/wso2/docker-apim.git
 ##### 3. Running the Docker image.
 
 - `docker run -it -p 9443:9443 wso2am:3.1.0-alpine`
+
 > Here, only port 9443 (HTTPS servlet transport) has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 

dockerfiles/centos/apim-analytics/dashboard/README.md

@@ -28,14 +28,15 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9643:9643 wso2am-analytics-dashboard:3.1.0-centos`
-> Here, only port 9643 has been mapped to a Docker host port.
+- `docker run -p 9640:9640 wso2am-analytics-dashboard:3.1.0-centos`
+
+> Here, only port 9640 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ##### 4. Accessing the Dashboard portal.
 
 - For dashboard,
- + `https:<DOCKER_HOST>:9643/analytics-dashboard`
+ + `https:<DOCKER_HOST>:9640/analytics-dashboard`
 
 > In here, <DOCKER_HOST> refers to hostname or IP of the host machine on top of which containers are spawned.
 
@@ -44,11 +45,11 @@ You may map other container service ports, which have been exposed to Docker hos
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
-can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+can be found at `<DISTRIBUTION_HOME>/conf/dashboard`. Copy the file to some suitable location of the host machine, <br>
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 1.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 
@@ -60,12 +61,12 @@ chmod o+r <SOURCE_CONFIGS>/deployment.yaml
 
 ```
 docker run 
--p 7713:7713
+-p 9641:9641
 --volume <SOURCE_CONFIGS>/deployment.yaml:<TARGET_CONFIGS>/deployment.yaml
-wso2am-analytics-worker:3.1.0-centos
+wso2am-analytics-dashboard:3.1.0-centos
 ```
 
-> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/worker folder of the container.
+> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/dashboard folder of the container.
 
 ## Docker command usage references
 

dockerfiles/centos/apim-analytics/worker/README.md

@@ -28,20 +28,21 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9091:9091 wso2am-analytics-worker:3.1.0-centos`
-> Here, only port 9091 has been mapped to a Docker host port.
+- `docker run -p 9090:9090 wso2am-analytics-worker:3.1.0-centos`
+
+> Here, only port 9090 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ## How to update configurations
 
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
 can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 2.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 

dockerfiles/centos/apim/README.md

@@ -29,6 +29,7 @@ git clone https://github.com/wso2/docker-apim.git
 ##### 3. Running the Docker image.
 
 - `docker run -it -p 9443:9443 wso2am:3.1.0-centos`
+
 > Here, only port 9443 (HTTPS servlet transport) has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 

dockerfiles/ubuntu/apim-analytics/dashboard/README.md

@@ -28,14 +28,15 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9643:9643 wso2am-analytics-dashboard:3.1.0`
-> Here, only port 9643 has been mapped to a Docker host port.
+- `docker run -p 9640:9640 wso2am-analytics-dashboard:3.1.0`
+
+> Here, only port 9640 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ##### 4. Accessing the Dashboard portal.
 
 - For dashboard,
- + `https:<DOCKER_HOST>:9643/analytics-dashboard`
+ + `https:<DOCKER_HOST>:9640/analytics-dashboard`
 
 > In here, <DOCKER_HOST> refers to hostname or IP of the host machine on top of which containers are spawned.
 
@@ -44,11 +45,11 @@ You may map other container service ports, which have been exposed to Docker hos
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
-can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+can be found at `<DISTRIBUTION_HOME>/conf/dashboard`. Copy the file to some suitable location of the host machine, <br>
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 1.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 
@@ -60,12 +61,12 @@ chmod o+r <SOURCE_CONFIGS>/deployment.yaml
 
 ```
 docker run 
--p 7713:7713
+-p 9641:9641
 --volume <SOURCE_CONFIGS>/deployment.yaml:<TARGET_CONFIGS>/deployment.yaml
-wso2am-analytics-worker:3.1.0
+wso2am-analytics-dashboard:3.1.0
 ```
 
-> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/worker folder of the container.
+> In here, <TARGET_CONFIGS> refers to /home/wso2carbon/wso2am-analytics-3.1.0/conf/dashboard folder of the container.
 
 ## Docker command usage references
 

dockerfiles/ubuntu/apim-analytics/worker/README.md

@@ -28,20 +28,21 @@ git clone https://github.com/wso2/docker-apim.git
  
 ##### 3. Running Docker images specific to each profile.
 
-- `docker run -p 9091:9091 wso2am-analytics-worker:3.1.0`
-> Here, only port 9091 has been mapped to a Docker host port.
+- `docker run -p 9090:9090 wso2am-analytics-worker:3.1.0`
+
+> Here, only port 9090 has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.
 
 ## How to update configurations
 
 Configurations would lie on the Docker host machine and they can be volume mounted to the container. <br>
 As an example, steps required to change the port offset using `deployment.yaml` is as follows:
 
-##### 1. Stop the Identity Server Analytics container if it's already running.
+##### 1. Stop the API Manager Analytics container if it's already running.
 
 In WSO2 API Manager Analytics version 3.1.0 product distribution, `deployment.yaml` configuration file <br>
 can be found at `<DISTRIBUTION_HOME>/conf/worker`. Copy the file to some suitable location of the host machine, <br>
-referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the offset value under ports to 2.
+referred to as `<SOURCE_CONFIGS>/deployment.yaml` and change the `offset` value under `ports` to 2.
 
 ##### 2. Grant read permission to `other` users for `<SOURCE_CONFIGS>/deployment.yaml`.
 

dockerfiles/ubuntu/apim/README.md

@@ -28,6 +28,7 @@ git clone https://github.com/wso2/docker-apim.git
 ##### 3. Running the Docker image.
 
 - `docker run -it -p 9443:9443 wso2am:3.1.0`
+
 > Here, only port 9443 (HTTPS servlet transport) has been mapped to a Docker host port.
 You may map other container service ports, which have been exposed to Docker host ports, as desired.