Skip to content

Commit

Permalink
Merge pull request #105 from arunans23/update-dashboard-readme
Browse files Browse the repository at this point in the history
Update Dashboard ReadMe and modify file permissions
  • Loading branch information
arunans23 authored Jul 28, 2020
2 parents 041257d + ad71441 commit 5411e21
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 28 deletions.
13 changes: 2 additions & 11 deletions monitoring-dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,10 @@
```
cd to the <DASHBOARD_HOME>/bin
Execute `dashboard.sh or dashboard.bat as appropriate.
Execute dashboard.sh or dashboard.bat as appropriate.
```
- Load the login page with the dashboard context. i.e: https://localhost:9743/dashboard .
- Please note that in order to connect the monitoring dashboard to an instance of WSO2 Micro integrator, the
said instance should have the Management Api enabled.
### How to Enable the Management API.
Please note that Management Api is disabled by default. To use the Management Api you must use the
system property `-DenableManagementApi` when starting the micro integrator. This can be done by
navigating to <DASHBOARD_HOME>/bin and executing the script as follows.
1. `sh micro-integrator.sh -DenableManagementApi` - Linux and Unix
2. `docker run -p 8290:8290 -p 9164:9164 -e JAVA_OPTS="-DenableManagementApi=true" <Docker_Image_Name>` - Docker
- Load the login page with the dashboard context. i.e: https://localhost:9743/dashboard.
### Management API Address and Port
The Management API address and Port is required when logging into the dashboard.
Expand Down
8 changes: 2 additions & 6 deletions monitoring-dashboard/distribution/carbon-home/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,16 @@ Monitoring Dashboard for WSO2 Micro Integrator
======================================================================

Welcome to the Monitoring Dashboard @product.version@ for WSO2 Micro Integrator @mi.version@
This is a lightweight UI server that hosts the React application used to implement the monitoring dashboard.
This is a lightweight UI server that hosts a React application which is used to monitor the Micro Integrator runtime.


Running the Monitoring Dashboard
======================================================================
1. Go to the DASHBOARD_HOME/bin directory and run the dashboard.sh file for Linux and Unix or the dashboard.bat file for Windows.
2. Access the dashboard login page found at https://localhost:9743/dashboard
3. To connect the monitoring dashboard to a WSO2 Micro Integrator instance, the instance should have the management API enabled.
This can be done by starting the WSO2 Micro Integrator with the -DenableManagementApi property as follows.
sh micro-integrator.sh -DenableManagementApi - Linux and Unix.
micro-integrator.bat -DenableManagementApi - Windows

More information regarding the dashboard configurations can be found at
(https://ei.docs.wso2.com/en/latest/micro-integrator/administer-and-observe/working-with-monitoring-dashboard/)
(https://ei.docs.wso2.com/en/7.1.0/micro-integrator/administer-and-observe/working-with-monitoring-dashboard/)


Known issues of WSO2 Micro Integrator @mi.version@
Expand Down
15 changes: 4 additions & 11 deletions monitoring-dashboard/distribution/src/assembly/bin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,6 @@
<exclude>**/*.eclipse</exclude>
</excludes>
</fileSet>
<fileSet>
<directory>../..</directory>
<outputDirectory>.</outputDirectory>
<includes>
<include>README.md</include>
</includes>
</fileSet>

<fileSet>
<directory>carbon-home/conf/server</directory>
Expand Down Expand Up @@ -87,7 +80,7 @@
<includes>
<include>**/*.txt</include>
</includes>
<fileMode>444</fileMode>
<fileMode>644</fileMode>
</fileSet>

<fileSet>
Expand All @@ -111,19 +104,19 @@
<source>carbon-home/updates/product.txt</source>
<outputDirectory>updates/</outputDirectory>
<filtered>true</filtered>
<fileMode>444</fileMode>
<fileMode>644</fileMode>
</file>
<file>
<source>target/wso2carbon-kernel-${carbon.kernel5.version}/bin/kernel-version.txt</source>
<outputDirectory>bin/</outputDirectory>
<filtered>true</filtered>
<fileMode>444</fileMode>
<fileMode>644</fileMode>
</file>
<file>
<source>target/wso2carbon-kernel-${carbon.kernel5.version}/bin/README.txt</source>
<outputDirectory>bin/</outputDirectory>
<filtered>true</filtered>
<fileMode>444</fileMode>
<fileMode>644</fileMode>
</file>
<file>
<source>carbon-home/bin/version.txt</source>
Expand Down

0 comments on commit 5411e21

Please sign in to comment.