KubeFreshener is a prototype tool enabling you to discover microservices' architectural smells by analyzing their deployment in Kubernetes.
The methodology implemented by KubeFreshener has been first presented in the paper:
J. Soldani, M. Marinò, A. Brogi. "Semi-automated Smell Resolution in Kubernetes Deployed Microservices", CLOSER 2023 [accepted for publication].
KubeFreshener can be configured to analyze a microservices application' deployment in Kubernetes by placing the manifest files specifying such deployment in a newly created manifests folder.
KubeFreshener can be further configured by editing the available config.yaml file to specify
invoked_services- list of microservices that are invoked by other microservicesignore_smells- list of architectural smells that should not be checked on given microservices.
Once all the configuration has been provided, KubeFreshener can be run by executing the command
cargo run analyze [-s]
which runs the analysis and returns an output like that below. If the option -s is set, KubeFreshener will also update the files in the manifest by providing the refactoring templates to be completed to resolve the occurrence of identified smells.
*** K8S FRESHENER ***
####### Parsing ########
[*] Parsing catalog-Deployment.yaml
[*] Parsing apache-Service.yaml
[*] Parsing customer-Deployment.yaml
[*] Parsing catalog-Service.yaml
[*] Parsing apache-Deployment.yaml
[*] Parsing order-Service.yaml
[*] Parsing order-Deployment.yaml
[*] Parsing customer-Service.yaml
[*] Parsing done
### Start Inspection ###
! [Wobbly Interaction]
(*) Service named customer is reached by another service
without any circuit breaker or timeout.
Hint: solve it by adding circuit_breaker and/or and timeout in between .
! [Wobbly Interaction]
(*) Service named order is reached by another service
without any circuit breaker or timeout.
Hint: solve it by adding circuit_breaker and/or and timeout in between .
! [Wobbly Interaction]
(*) Service named catalog is reached by another service
without any circuit breaker or timeout.
Hint: solve it by adding circuit_breaker and/or and timeout in between .
### Inspection Ended ###
The necessary inputs (config and manifest files) for running examples of analyses are available in the data/examples folder, together with the generated refactoring templates.