Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piomin/sample-spring-microservices-kubernetes
Sample Spring Boot application that uses some features provided by Spring Cloud Kubernetes, Spring Cloud OpenFeign and Spring Cloud Gateway deployed on Kubernetes
https://github.com/piomin/sample-spring-microservices-kubernetes
configmap docker kubernetes microservices minikube openshift ribbon spring-boot spring-cloud spring-cloud-kubernetes swagger2 zuul
Last synced: 9 days ago
JSON representation
Sample Spring Boot application that uses some features provided by Spring Cloud Kubernetes, Spring Cloud OpenFeign and Spring Cloud Gateway deployed on Kubernetes
- Host: GitHub
- URL: https://github.com/piomin/sample-spring-microservices-kubernetes
- Owner: piomin
- Created: 2018-07-31T12:08:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T18:53:35.000Z (15 days ago)
- Last Synced: 2024-10-26T04:48:35.255Z (13 days ago)
- Topics: configmap, docker, kubernetes, microservices, minikube, openshift, ribbon, spring-boot, spring-cloud, spring-cloud-kubernetes, swagger2, zuul
- Language: Java
- Homepage: https://piotrminkowski.com
- Size: 215 KB
- Stars: 436
- Watchers: 18
- Forks: 279
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Microservices with Spring Boot and Spring Cloud on Kubernetes Demo Project [](https://twitter.com/piotr_minkowski)
[](https://circleci.com/gh/piomin/sample-spring-microservices-kubernetes)
[](https://sonarcloud.io/dashboard?id=piomin_spring-microservices-kubernetes)
[](https://sonarcloud.io/dashboard?id=piomin_spring-microservices-kubernetes)
[](https://sonarcloud.io/dashboard?id=piomin_spring-microservices-kubernetes)
[](https://sonarcloud.io/dashboard?id=piomin_spring-microservices-kubernetes)
In this project I'm demonstrating you the most interesting features of [Spring Cloud Project](https://spring.io/projects/spring-cloud) for building microservice-based architecture that is deployed on Kubernetes. All the samples may be easily deployed on local Kubernetes single-node cluster - Minikube.
## Getting Started
Currently you may find here some examples of microservices implementation using different projects from Spring Cloud. All the examples are divided into the branches and described in a separated articles on my blog. Here's a full list of available examples:
1. Using Spring Boot and Spring Cloud for building microservices that may be easily deployed on Kubernetes. The example is available in the branch [master](https://github.com/piomin/sample-spring-microservices-kubernetes/tree/master). A detailed guide may be find in the following article: Detailed description can be found here: [Quick Guide to Microservices with Kubernetes, Spring Boot 2.0 and Docker](https://piotrminkowski.com/2018/08/02/quick-guide-to-microservices-with-kubernetes-spring-boot-2-0-and-docker/)
2. An introduction to Spring Cloud Kubernetes project, that shows its the most interesting features like discovery across many namespaces or Spring Boot property sources based on ConfigMap and Secret. The example is available in the branch [hybrid](https://github.com/piomin/sample-spring-microservices-kubernetes/tree/hybrid). A detailed guide may be find in the following article: Detailed description can be found here: [Microservices with Spring Cloud Kubernetes](https://piotrminkowski.com/2019/12/20/microservices-with-spring-cloud-kubernetes/)
3. Using Spring Boot Admin to monitor Spring Boot applications running on Kubernetes. The example is available in the branch [master](https://github.com/piomin/sample-spring-microservices-kubernetes/tree/master). A detailed guide may be find in the following article: [Spring Boot Admin on Kubernetes](https://piotrminkowski.com/2020/02/18/spring-boot-admin-on-kubernetes/)
### Usage
1. Download and run **Minikube** using command: `minikube start --vm-driver=virtualbox --memory='4000mb'`
2. Build Maven project with using command: `mvn clean install`
3. Build Docker images for each module using command, for example: `docker build -t piomin/employee:1.1 .`
4. Go to `/kubernetes` directory in repository
5. Apply all templates to Minikube using command: `kubectl apply -f .yaml`
6. Check status with `kubectl get pods`
## Architecture
Our sample microservices-based system consists of the following modules:
- **gateway-service** - a module that Spring Cloud Netflix Zuul for running Spring Boot application that acts as a proxy/gateway in our architecture.
- **employee-service** - a module containing the first of our sample microservices that allows to perform CRUD operation on Mongo repository of employees
- **department-service** - a module containing the second of our sample microservices that allows to perform CRUD operation on Mongo repository of departments. It communicates with employee-service.
- **organization-service** - a module containing the third of our sample microservices that allows to perform CRUD operation on Mongo repository of organizations. It communicates with both employee-service and department-service.
- **admin-service** - a module containing embedded Spring Boot Admin Server used for monitoring Spring Boot microservices running on Kubernetes
The following picture illustrates the architecture described above including Kubernetes objects.
You can distribute applications across multiple namespaces and use Spring Cloud Kubernetes `DiscoveryClient` and `Ribbon` for inter-service communication.
## Before you start
Go to the `k8s` directory. You will find there several YAML scripts you need to apply before running applications.
1. `privileges.yaml` - `Role` and `RoleBinding` for Spring Cloud Kubernetes to allow access Kubernetes API from pod
2. `mongo-secret.yaml` - credentials for MongoDB
3. `mongo-configmap.yaml` - user for MongoDB
4. `mongo-deployment.yaml` - `Deployment` for MongoDB
Just apply those scripts using `kubectl apply`.
You can easily deploy all applications using `skaffold dev` command.