https://github.com/danielliu1123/kubernetes-cloud-starter
Build cloud-native Spring Boot/Cloud applications on Kubernetes
https://github.com/danielliu1123/kubernetes-cloud-starter
distributed-configuration kubernetes spring-boot spring-cloud
Last synced: 2 months ago
JSON representation
Build cloud-native Spring Boot/Cloud applications on Kubernetes
- Host: GitHub
- URL: https://github.com/danielliu1123/kubernetes-cloud-starter
- Owner: DanielLiu1123
- License: mit
- Created: 2022-11-20T02:53:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T15:08:24.000Z (about 3 years ago)
- Last Synced: 2025-07-01T13:55:23.169Z (12 months ago)
- Topics: distributed-configuration, kubernetes, spring-boot, spring-cloud
- Language: Java
- Homepage:
- Size: 389 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh-CN.md
- License: LICENSE
Awesome Lists containing this project
README
# kubernetes-cloud-starter
[](https://github.com/DanielLiu1123/kubernetes-cloud-starter/actions)
[](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)
[](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)
[](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)
[](./LICENSE)
[English](./README.md) | [中文](./README-zh-CN.md)
## Modules
- [kubernetes-config-cloud-starter](#kubernetes-config-cloud-starter)
这个模块的主要目的是使用 Kubernetes 的 ConfigMap/Secret 作为分布式配置中心，在不重启应用的情况下实现配置的动态更新。
- [kubernetes-discovery-cloud-starter](#kubernetes-discovery-cloud-starter)
该模块是 Spring Cloud DiscoveryClient 的 Kubernetes 实现。
- [kubernetes-grey-cloud-starter](#kubernetes-grey-cloud-starter)
该模块使用 Kubernetes 的原生服务发现实现服务灰度发布。
### kubernetes-config-cloud-starter
#### Usage
Maven 用户:
```xml
com.freemanan
kubernetes-config-cloud-starter
3.0.0
```
Gradle 用户:
```groovy
implementation 'com.freemanan:kubernetes-config-cloud-starter:3.0.0'
```
#### Quick Start
首先你需要一个 Kubernetes 集群，你可以使用 [docker-desktop](https://www.docker.com/products/docker-desktop/)
或者 [minikube](https://minikube.sigs.k8s.io/docs/) 来创建一个集群。
1. Clone 项目
```bash
git clone --depth=1 https://github.com/DanielLiu1123/kubernetes-cloud-starter.git
cd kubernetes-cloud-starter
```
2. 为 ServiceAccount 创建 Role 和 RoleBinding
```bash
# 为了示例我们创建了 ClusterRole，但其实你可以更加精细化地控制资源，只需要 ConfigMap/Secret 的 get,list,watch 权限
kubectl create clusterrole config-cluster-reader --verb=get,list,watch --resource=configmaps,secrets
# 绑定 ClusterRole 到 ServiceAccount (namespace: default, name: default)
kubectl create clusterrolebinding config-cluster-reader-default-default --clusterrole config-cluster-reader --serviceaccount default:default
```
3. 构建并启动
```shell
./gradlew clean bootJar
docker build -f examples/kubernetes-config/Dockerfile -t kubernetes-config:1.0.0 .
kubectl apply -f examples/kubernetes-config/deployment.yaml
```
```shell
# 在应用启动后执行下面的命令，启动过程应该会很快（小于3s）
curl http://localhost:`kubectl get svc kubernetes-config -o jsonpath='{..nodePort}'`/price
# 你应该看到响应结果是 `100`
```
4. 添加一个 ConfigMap
```shell
# 这个 ConfigMap 正在由当前应用程序所监听，因此当这个 ConfigMap 被添加后，应用会自动更新配置
kubectl apply -f examples/kubernetes-config/configmap-example-01.yaml
# 再次访问
curl http://localhost:`kubectl get svc kubernetes-config -o jsonpath='{..nodePort}'`/price
# 你应该看到响应结果是 `200`
```
你可以通过修改 `configmap-example-01.yaml` 中的配置，然后重新 apply 该文件来观察接口结果的变化。
通过上述操作，你可以看到应用程序不需要重启就可以实现配置的动态更新。
5. 删除资源
```shell
# 删除上述操作创建的所有资源
kubectl delete -f examples/kubernetes-config/deployment.yaml
kubectl delete -f examples/kubernetes-config/configmap-example-01.yaml
kubectl delete clusterrole config-cluster-reader
kubectl delete clusterrolebinding config-cluster-reader-default-default
```
#### 主要特性
- 动态更新配置（ConfigMap/Secret）
可以手动配置是否需要监听配置文件变化。
- 配置优先级
通过配置选择优先使用本地配置还是远程配置。
- 支持多种配置文件格式
支持 `yaml`、`properties`、`json`、key-value 键值对
#### 配置项
```yaml
microservice-base:
kubernetes:
config:
enabled: true # 是否启用 config 模块功能，默认为 true
namespace: default # 配置所在的命名空间（全局配置），如果在 Kubernetes 集群内部，默认为当前 pod 所在的命名空间；如果在 Kubernetes 集群外部，默认为当前 context 的命名空间
preference: remote # 配置优先级（全局配置），remote 优先使用远程配置，local 优先使用本地配置，默认为 remote
refresh-enabled: true # 是否启用动态更新配置（全局配置），默认为 true
refresh-on-delete: false # 在删除配置时是否自动刷新，启用该配置可能会带来一定风险，如果你的配置项只存在与远端而本地没有，假如误删 configmap 可能会导致程序出现异常，因此该默认值为 false
config-maps:
- name: my-configmap # configmap name
namespace: default # configmap 所在的命名空间，会覆盖 namespace 的全局配置
preference: remote # 配置优先级，会覆盖 preference 的全局配置
refresh-enabled: true # 是否启用动态更新配置，会覆盖 refresh-enabled 的全局配置
secrets:
- name: my-secret # secret name
namespace: default # secret 所在的命名空间，会覆盖 namespace 的全局配置
preference: remote # 配置优先级，会覆盖 preference 的全局配置
refresh-enabled: false # 是否启用动态更新配置，会覆盖 refresh-enabled 的全局配置，因为 secret 一般不会有动态刷新的需求，所以默认值为 false
```
#### 最佳实践
Spring Cloud 提供了在运行时动态刷新 Environment 的功能，主要会对两类 Bean 的属性进行动态更新：
- @ConfigurationProperties 注解的 Bean
- @RefreshScope 注解的 Bean
一个比较好的实践就是使用 @ConfigurationProperties 来组织你的配置类。
一般一个应用程序的配置分为两类：
- 基础配置
- 公有
可以通过配置中心或者公共 jar 包来管理，一般不会有动态更新的需求，比如 Tomcat 连接池参数、数据库连接池参数等。
- 私有
可以放在本地配置文件中，比如数据库连接信息，这类配置一般比较敏感，可以通过 Kubernetes Secret 来管理。
- 业务配置
这类配置应该与业务强相关，但是需要用户自行判断是否需要放入配置中心，是否有动态更新的需求。
## Versions
主要维护的版本: `3.0.x`, `2.6.x`, `2.4.x`
| Branch | Support Spring Boot Version | Latest Version |
|:------:|:---------------------------:|:--------------:|
| main | 3.0.x | 3.0.0 |
| 2.6.x | [2.6.0, 3.0.0) | 2.6.2 |
| 2.4.x | [2.4.0, 2.6.0) | 2.4.2 |
根据你使用的 Spring Boot 版本选择对应的版本。例如，如果你使用的是 Spring Boot 2.4.x，那么你可以使用 2.4.x
分支的任何版本，但请尽量使用最新版本。