-
Notifications
You must be signed in to change notification settings - Fork 81
Wiki Trampoline: English
Welcome to Trampoline.
Are you Admin Spring Boot locally? Are you tired of that set of scripts? Relax, Trampoline has come into your life.
The aim is to help during the course of developing an application based on the paradigm of microservices with Spring Boot. How? Easy, thanks to a comfortable interface you can do all your brain can imagine regarding your spring boot instances... well, almost.
Let's start registering a microservice and play with it.
The first thing you should do to be able to register your first api is visit Settings section.
If you are going to work with Maven as a build tool, you will have to set Maven Location on Maven Settings form.
Then, in order to register you first microservice, you will find two options:
- Register a spring-boot from your file system
- Register a spring-boot from a Git repository
After selecting an option, and filling the proper form, your microservice will appear on the Microservices Registered list.
Using those buttons, you will be able to:
- Copy its information into the File System Registery From, to be able to reduce time on a new registration.
- Checkout and Pull another branch OR Checkout and Pull another branch and Restart instances.
- Edit its information
- Remove it.
Congratulations, you can start an instance of it!
Now that you have registered a ms, let's start one instance. To do so, let's move to Instance Section and select you ms inside Launch Instance form.
When the ms is selected, the rest of the form will be autocompleted, you only have to click on launch button!
Automatically, the new instance will appear on Instance List. After a while, depending on your pc performance, its status must be deployed. For each instance, you can:
- Check Git info (take a look on ms-examples provided and see gradle and maven plugins used).
- Check Logs (take a look on ms-examples provided and see spring-boot properties).
- Check Traces.
- Check Metrics.
- Restart it.
- Kill it.
Well done, now you only need to register as many ms as you may need!
Now that you had a first contact with Trampoline, you can move on to advanced features!
Most of times, you will have to start several microservices. Doesn't seems really userfriendly to start them one by one. Here is when Microservices Groups come to help you.
If you go to Settings section, you will find a form called Register Microservices Group:
There you can set a name for your group and select those ms will be included on it. Once you click on Create Group button, you will be able to set up launching order and launch delay for each of them.
For instance, you can use these delays to wait for certain service/resource be ready (it could be a cache or a configuration server).
After this step, you will watch it created on Microservice Group list.
Clicking on each info icon you will remember which microservices has been included and also its delay.
Now everything is ready to start your group, so move to Instance section and you select it on Launch Group form!
Sometimes, you may need to monitor other instance which is not running locally. If that's your case, you can use this features.
Go to Settings section and fill Register External Instance form.
You can check all your external instances on the following list:
Now, if you move to Instances section and you select it on the External Instance form:
You will be able to add it on Instances List, there, as long as will be properly set, you will be able to:
- Check Git info (take a look on ms-examples provided and see gradle and maven plugins used).
- Check Logs (take a look on ms-examples provided and see spring-boot properties).
- Check Traces.
- Check Metrics.
Notice that you will not be able to kill or restart it, unless they are running under your localhost ip (127.0.0.1).
If you are not working in an opensource enviroment, you may need to set up Git creed in order to be able to make an intetraction between Tramponline and GIT.
To do so, go to Settings section and set up Git info on GIT Settings form. Notice that you can use HTTPS or SSH methods:
After that you will can go to Microservices Registered list:
and click on Github button and Checkout and Pull another branch OR Checkout and Pull another branch and Restart instances.