SeLaVi (ServiceLandscapeVisualizer) displays all microservices which are registered in a service registry and their relations to each other in a graphical mindmap. This grants an overview over a complex system landscape for developers, operators and product owners alike.
You can have a look at SeLaVi on our CI system:
https://selavi.herokuapp.com/selavi
Note: The system might take a couple of seconds to respond because heroku puts it into hibernation after a certain amount of inactivity.
The graph is drawn using vis.js.
- When you have a complex system landscape that is difficult to overview
- When you have the need to visualize dependencies between your services
- If you already have a Eureka service registry in operation, SeLaVi can easily be used on top of it
It is possible to build the application with Maven.
Make sure you have Maven installed (Version 3.1.0 or later).
From the root folder of the application, execute:
$ mvn spring-boot:run
$ mvn spring-boot:run -Drun.jvmArguments=-Dspring.profiles.active=development-h2
Run the spring boot runner form IDEA with the VM options:
$ -Dspring.profiles.active="development-h2"
$ mvn clean verify
The WAR file created during the build process can be deployed in a Servlet Container, e.g. Apache Tomcat.
The application can be run with a local H2 database or a MySQL database. A database user with alter table permission is needed for the MySQL database
To run MySQL in docker container for local development, simply run
$ docker pull mysql
$ docker run --name docker-mysql -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=selavi -e MYSQL_USER=selavi -e MYSQL_PASSWORD=supersicher -d -p 3306:3306 mysql
| Name | Description |
|---|---|
| local | all to localhost |
| development-h2 | use H2 database |
| development-mysql | use local installed MySQL databse |
| basic-ldap | enable embedded LDAP as authentication provider |
| active-directory | enable Active Directory as authentication provider |
It is possible to read microservices and their relations to each other from an Eureka serivce registry.
Therefore the link to the Eureka application interface has to be configured:
selavi.registry.url.environment=https://registry-host/eureka/apps
Run the spring boot app (see above), then run webpack in watch mode:
$ node_modules/webpack/bin/webpack.js --watch
Now, as soon as a Javascript source file changes, the webpack bundle is re-build and deployed
$ npm run test
Launches the frontend test runner in watch mode, eg. re-running the tests automatically when a source (or test) file changes
The project offers multiple ways using Spring AuthenticationProvider.class to authenticate and search for persons (A feature in SeLaVi which allows you to add persons to a service via auto complete).
- In Memory authentication with 1 dummy user (default)
- Embedded basic ldap authentication with 2 users. Spring Profile: [basic-ldap]
- Active Directory (AD) authentication with custom search filter. Spring Profile [active-directory]. You have to specifiy your own AD server
In memory authentication is the default.
- You can log in with username [user] and password [password]
You can enable basic authentification with the Spring profile [basic-ldap]. You will get an embedded ldap service and already have two users in the system:
- User Bob: You can log in with username [bob] and password [bobspassword]
- User Ben: You can log in with username [ben] and password [benspassword]
If you want to change your ldap profile you can see the additional properties in the application-basic-ldap.properties under ./selavi/src/main/resources/application-basic-ldap.properties:
spring.ldap.embedded.ldif=classpath:test-server.ldif
spring.ldap.embedded.base-dn=dc=springframework,dc=org
spring.ldap.embedded.port=8389
spring.ldap.embedded.credential.username=uid=bob,ou=people
spring.ldap.embedded.credential.password=bobspassword
spring.ldap.embedded.validation.enabled=true
You can enable basic authentification with the Spring profile [active-directory]. For this profile you have to specify your AD in the following
If you want to change your ldap profile you can see the additional properties in the application-.properties under ./selavi/src/main/resources/application-basic-ldap.properties:
selavi.ad.url=ldaps://localhost:636
selavi.ad.password=secret
selavi.ad.userDn=user
selavi.ad.base=dc=springframework,dc=org
selavi.ad.domain=DOMAIN
Copyright (c) 2017 dm-drogerie markt GmbH & Co. KG, https://dm.de
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.