Shukra is an Akka cluster visualization and management dashboard for inspecting local and remote Akka clusters.
Shukra is lovingly developed by Headstorm's Open Source group. Please reach out to us at: opensource@headstorm.com
Shukra relies on akka-management which exposes an HTTP interface to interact with an Akka cluster.
These instructions guide you through the process to run Shukra in a production environment.
- Set
homepageproperty inpackage.jsonfile to reflect the deployment URL of the server. For example,"homepage": "http://localhost:8080/shukra". - Use the command
npm run build(uses create react appreact-scripts buildinternally) to generate a production build to serve it with a static server. - The
buildfolder contains files that are ready to be deployed. - Refer to https://create-react-app.dev/docs/production-build or https://reactjs.org/docs/optimizing-performance.html for more information on generating production ready builds.
- Move the files created in the
buildfolder to a static server. Do not change the folder structure. - Follow instructions in the Configuration section below to modify the Akka Management URL.
The following instructions will get the project up and running on your local machine for development and testing purposes.
Download and install the latest version of Vagrant to spin up a sample Akka cluster (Shukra Backend). Download and install the latest version of Node.js and NPM to install and start the Shukra UI.
Use the command below to start a sample Akka Docker cluster.
vagrant up
This will create 3 nodes, a seed and two regular nodes, called seed, c1, and c2 respectively (unless changed in docker-compose.yml). While running, try opening a new terminal and try things like docker-compose stop seed and watch the cluster nodes respond.
This also starts Akka Management on the seed node with the endpoint http://localhost:8402/ShukraCluster, unless changed in the application.conf file.
Navigate to the frontend folder and use the command below to install the dependencies for Shukra UI.
npm install
Use the command below to start the Shukra UI.
npm start
Akka Management for a member is disabled by default.
In order to enable Akka Management for a member, set AKKA_MANAGEMENT_ENABLE: enabled property under environment section in docker-compose.yml.
Specify the AKKA_MANAGEMENT_PORT: <port-number> property to change the Akka Management HTTP endpoint port.
Properties SEED_PORT_1600_TCP_ADDR and SEED_PORT_1600_TCP_PORT can be used to modify the seed node for a member.
By default, Shukra UI points to the Akka HTTP URL http://localhost:8402/ShukraCluster.
For local development or testing, change the proxy property in package.json to the Akka Management Host HTTP server address and change the akka.management.url property in public/akkaClusterProps.json to the Akka Management Host HTTP base path. The proxy property is used to set up reverse proxy to avoid CORS issue on local environments.
For production, change the akka.management.url property in public/akkaClusterProps.json to the entire Akka Management URL, i.e., Akka Management HTTP address + base path.
- Scala - Back end programming language
- SBT - Back end build tool
- Akka - Actor system framework
- React - Front end JavaScript library
- Fork it (https://github.com/Headstorm/shukra/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request
- Karthik Pasagada - kpasagada
See also the list of contributors who participated in this project.
- Thanks to akka-docker-cluster-example for initial akka cluster setup.
https://github.com/Headstorm/shukra/wiki/Shukra
Distributed under the Apache 2 license. See LICENSE for more information.