{"id":16514619,"url":"https://github.com/danielliu1123/kubernetes-cloud-starter","last_synced_at":"2026-04-18T01:02:49.386Z","repository":{"id":63498614,"uuid":"568284763","full_name":"DanielLiu1123/kubernetes-cloud-starter","owner":"DanielLiu1123","description":"Build cloud-native Spring Boot/Cloud applications on Kubernetes","archived":false,"fork":false,"pushed_at":"2023-04-25T15:08:24.000Z","size":398,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-01T13:55:23.169Z","etag":null,"topics":["distributed-configuration","kubernetes","spring-boot","spring-cloud"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DanielLiu1123.png","metadata":{"files":{"readme":"README-zh-CN.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-11-20T02:53:16.000Z","updated_at":"2022-12-04T05:53:47.000Z","dependencies_parsed_at":"2025-07-01T19:31:32.090Z","dependency_job_id":null,"html_url":"https://github.com/DanielLiu1123/kubernetes-cloud-starter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/DanielLiu1123/kubernetes-cloud-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielLiu1123%2Fkubernetes-cloud-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielLiu1123%2Fkubernetes-cloud-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielLiu1123%2Fkubernetes-cloud-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielLiu1123%2Fkubernetes-cloud-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DanielLiu1123","download_url":"https://codeload.github.com/DanielLiu1123/kubernetes-cloud-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanielLiu1123%2Fkubernetes-cloud-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31952208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"ssl_error","status_checked_at":"2026-04-18T00:39:20.671Z","response_time":62,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["distributed-configuration","kubernetes","spring-boot","spring-cloud"],"created_at":"2024-10-11T16:13:07.260Z","updated_at":"2026-04-18T01:02:49.361Z","avatar_url":"https://github.com/DanielLiu1123.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kubernetes-cloud-starter\n\n[![Build](https://img.shields.io/github/actions/workflow/status/DanielLiu1123/kubernetes-cloud-starter/build.yml?branch=main)](https://github.com/DanielLiu1123/kubernetes-cloud-starter/actions)\n[![Maven Central](https://img.shields.io/maven-central/v/com.freemanan/kubernetes-config-cloud-starter?versionPrefix=3.0)](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)\n[![Maven Central](https://img.shields.io/maven-central/v/com.freemanan/kubernetes-config-cloud-starter?versionPrefix=2.6)](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)\n[![Maven Central](https://img.shields.io/maven-central/v/com.freemanan/kubernetes-config-cloud-starter?versionPrefix=2.4)](https://search.maven.org/artifact/com.freemanan/kubernetes-config-cloud-starter)\n[![License](https://img.shields.io/github/license/DanielLiu1123/kubernetes-cloud-starter)](./LICENSE)\n\n[English](./README.md) | [中文](./README-zh-CN.md)\n\n## Modules\n\n- [kubernetes-config-cloud-starter](#kubernetes-config-cloud-starter)\n\n  这个模块的主要目的是使用 Kubernetes 的 ConfigMap/Secret 作为分布式配置中心，在不重启应用的情况下实现配置的动态更新。\n\n- [kubernetes-discovery-cloud-starter](#kubernetes-discovery-cloud-starter)\n\n  该模块是 Spring Cloud DiscoveryClient 的 Kubernetes 实现。\n\n- [kubernetes-grey-cloud-starter](#kubernetes-grey-cloud-starter)\n\n  该模块使用 Kubernetes 的原生服务发现实现服务灰度发布。\n\n### kubernetes-config-cloud-starter\n\n#### Usage\n\nMaven 用户:\n\n```xml\n\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.freemanan\u003c/groupId\u003e\n    \u003cartifactId\u003ekubernetes-config-cloud-starter\u003c/artifactId\u003e\n    \u003cversion\u003e3.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nGradle 用户:\n\n```groovy\nimplementation 'com.freemanan:kubernetes-config-cloud-starter:3.0.0'\n```\n\n#### Quick Start\n\n首先你需要一个 Kubernetes 集群，你可以使用 [docker-desktop](https://www.docker.com/products/docker-desktop/)\n或者 [minikube](https://minikube.sigs.k8s.io/docs/) 来创建一个集群。\n\n1. Clone 项目\n\n    ```bash\n    git clone --depth=1 https://github.com/DanielLiu1123/kubernetes-cloud-starter.git\n    cd kubernetes-cloud-starter\n    ```\n\n2. 为 ServiceAccount 创建 Role 和 RoleBinding\n    ```bash\n    # 为了示例我们创建了 ClusterRole，但其实你可以更加精细化地控制资源，只需要 ConfigMap/Secret 的 get,list,watch 权限\n    kubectl create clusterrole config-cluster-reader --verb=get,list,watch --resource=configmaps,secrets\n    # 绑定 ClusterRole 到 ServiceAccount (namespace: default, name: default)\n    kubectl create clusterrolebinding config-cluster-reader-default-default --clusterrole config-cluster-reader --serviceaccount default:default\n    ```\n\n3. 构建并启动\n    ```shell\n    ./gradlew clean bootJar\n    \n    docker build -f examples/kubernetes-config/Dockerfile -t kubernetes-config:1.0.0 .\n    \n    kubectl apply -f examples/kubernetes-config/deployment.yaml\n    ```\n    ```shell\n    # 在应用启动后执行下面的命令，启动过程应该会很快（小于3s）\n    curl http://localhost:`kubectl get svc kubernetes-config -o jsonpath='{..nodePort}'`/price\n    \n    # 你应该看到响应结果是 `100`\n    ```\n\n4. 添加一个 ConfigMap\n    ```shell\n    # 这个 ConfigMap 正在由当前应用程序所监听，因此当这个 ConfigMap 被添加后，应用会自动更新配置\n    kubectl apply -f examples/kubernetes-config/configmap-example-01.yaml\n   \n    # 再次访问\n    curl http://localhost:`kubectl get svc kubernetes-config -o jsonpath='{..nodePort}'`/price\n   \n    # 你应该看到响应结果是 `200`\n    ```\n   你可以通过修改 `configmap-example-01.yaml` 中的配置，然后重新 apply 该文件来观察接口结果的变化。\n\n   通过上述操作，你可以看到应用程序不需要重启就可以实现配置的动态更新。\n\n5. 删除资源\n    ```shell\n    # 删除上述操作创建的所有资源\n    kubectl delete -f examples/kubernetes-config/deployment.yaml\n    kubectl delete -f examples/kubernetes-config/configmap-example-01.yaml\n    kubectl delete clusterrole config-cluster-reader\n    kubectl delete clusterrolebinding config-cluster-reader-default-default\n    ```\n\n#### 主要特性\n\n- 动态更新配置（ConfigMap/Secret）\n\n  可以手动配置是否需要监听配置文件变化。\n\n- 配置优先级\n\n  通过配置选择优先使用本地配置还是远程配置。\n\n- 支持多种配置文件格式\n\n  支持 `yaml`、`properties`、`json`、key-value 键值对\n\n#### 配置项\n\n```yaml\nmicroservice-base:\n  kubernetes:\n    config:\n      enabled: true # 是否启用 config 模块功能，默认为 true\n      namespace: default # 配置所在的命名空间（全局配置），如果在 Kubernetes 集群内部，默认为当前 pod 所在的命名空间；如果在 Kubernetes 集群外部，默认为当前 context 的命名空间\n      preference: remote # 配置优先级（全局配置），remote 优先使用远程配置，local 优先使用本地配置，默认为 remote\n      refresh-enabled: true # 是否启用动态更新配置（全局配置），默认为 true\n      refresh-on-delete: false # 在删除配置时是否自动刷新，启用该配置可能会带来一定风险，如果你的配置项只存在与远端而本地没有，假如误删 configmap 可能会导致程序出现异常，因此该默认值为 false\n      config-maps:\n        - name: my-configmap # configmap name\n          namespace: default # configmap 所在的命名空间，会覆盖 namespace 的全局配置\n          preference: remote # 配置优先级，会覆盖 preference 的全局配置\n          refresh-enabled: true # 是否启用动态更新配置，会覆盖 refresh-enabled 的全局配置\n      secrets:\n        - name: my-secret # secret name\n          namespace: default # secret 所在的命名空间，会覆盖 namespace 的全局配置\n          preference: remote # 配置优先级，会覆盖 preference 的全局配置\n          refresh-enabled: false # 是否启用动态更新配置，会覆盖 refresh-enabled 的全局配置，因为 secret 一般不会有动态刷新的需求，所以默认值为 false\n```\n\n#### 最佳实践\n\nSpring Cloud 提供了在运行时动态刷新 Environment 的功能，主要会对两类 Bean 的属性进行动态更新：\n\n- @ConfigurationProperties 注解的 Bean\n- @RefreshScope 注解的 Bean\n\n一个比较好的实践就是使用 @ConfigurationProperties 来组织你的配置类。\n\n一般一个应用程序的配置分为两类：\n\n- 基础配置\n\n    - 公有\n\n      可以通过配置中心或者公共 jar 包来管理，一般不会有动态更新的需求，比如 Tomcat 连接池参数、数据库连接池参数等。\n\n    - 私有\n\n      可以放在本地配置文件中，比如数据库连接信息，这类配置一般比较敏感，可以通过 Kubernetes Secret 来管理。\n\n- 业务配置\n\n  这类配置应该与业务强相关，但是需要用户自行判断是否需要放入配置中心，是否有动态更新的需求。\n\n## Versions\n\n主要维护的版本: `3.0.x`, `2.6.x`, `2.4.x`\n\n| Branch | Support Spring Boot Version | Latest Version |\n|:------:|:---------------------------:|:--------------:|\n|  main  |            3.0.x            |     3.0.0      |\n| 2.6.x  |       [2.6.0, 3.0.0)        |     2.6.2      |\n| 2.4.x  |       [2.4.0, 2.6.0)        |     2.4.2      |\n\n根据你使用的 Spring Boot 版本选择对应的版本。例如，如果你使用的是 Spring Boot 2.4.x，那么你可以使用 2.4.x\n分支的任何版本，但请尽量使用最新版本。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielliu1123%2Fkubernetes-cloud-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielliu1123%2Fkubernetes-cloud-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielliu1123%2Fkubernetes-cloud-starter/lists"}