Skip to content

Commit bf0cc39

Browse files
committed
2 parents 0355d7a + 9139943 commit bf0cc39

File tree

45 files changed

+3480
-163
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3480
-163
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
# if: github.repository_owner == 'spring-cloud'
1717
steps:
1818
- name: Checkout
19-
uses: actions/checkout@v3
19+
uses: actions/checkout@v4
2020
with:
2121
ref: docs-build
2222
fetch-depth: 1

.github/workflows/maven.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
uses: ./.github/workflows/composites/cache
4242

4343
- name: Show caches
44-
uses: actions/github-script@v6
44+
uses: actions/github-script@v7
4545
with:
4646
script: |
4747
const caches = await github.rest.actions.getActionsCacheList({
@@ -63,7 +63,7 @@ jobs:
6363

6464
- name: check test times cache exists
6565
id: check_files
66-
uses: andstor/file-existence-action@v2
66+
uses: andstor/file-existence-action@v3
6767
with:
6868
files: /tmp/sorted.txt
6969

docs/modules/ROOT/pages/discovery-client.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[discoveryclient-for-kubernetes]]
22
= DiscoveryClient for Kubernetes
33

4-
This project provides an implementation of https://github.com/spring-cloud/spring-cloud-commons/blob/master/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/DiscoveryClient.java[Discovery Client]
4+
This project provides an implementation of https://github.com/spring-cloud/spring-cloud-commons/blob/main/spring-cloud-commons/src/main/java/org/springframework/cloud/client/discovery/DiscoveryClient.java[Discovery Client]
55
for https://kubernetes.io[Kubernetes].
66
This client lets you query Kubernetes endpoints (see https://kubernetes.io/docs/user-guide/services/[services]) by name.
77
A service is typically exposed by the Kubernetes API server as a collection of endpoints that represent `http` and `https` addresses and that a client can

docs/modules/ROOT/pages/examples.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The same applies for `PropertySourceLocator`, where you need to add to the class
1010

1111
The following projects highlight the usage of these dependencies and demonstrate how you can use these libraries from any Spring Boot application:
1212

13-
* https://github.com/spring-cloud/spring-cloud-kubernetes/tree/master/spring-cloud-kubernetes-examples[Spring Cloud Kubernetes Examples]: the ones located inside this repository.
13+
* https://github.com/spring-cloud/spring-cloud-kubernetes/tree/main/spring-cloud-kubernetes-examples[Spring Cloud Kubernetes Examples]: the ones located inside this repository.
1414
* Spring Cloud Kubernetes Full Example: Minions and Boss
1515
** https://github.com/salaboy/spring-cloud-k8s-minion[Minion]
1616
** https://github.com/salaboy/spring-cloud-k8s-boss[Boss]

docs/modules/ROOT/pages/pod-health-indicator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Pod Health Indicator
33
:page-section-summary-toc: 1
44

5-
Spring Boot uses https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthEndpoint.java[`HealthIndicator`] to expose info about the health of an application.
5+
Spring Boot uses https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthEndpoint.java[`HealthIndicator`] to expose info about the health of an application.
66
That makes it really useful for exposing health-related information to the user and makes it a good fit for use as https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/[readiness probes].
77

88
The Kubernetes health indicator (which is part of the core module) exposes the following info:

docs/modules/ROOT/pages/property-source-config/configmap-propertysource.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Kubernetes provides a resource named https://kubernetes.io/docs/user-guide/configmap/[`ConfigMap`] to externalize the
55
parameters to pass to your application in the form of key-value pairs or embedded `application.properties` or `application.yaml` files.
6-
The link:https://github.com/spring-cloud/spring-cloud-kubernetes/tree/master/spring-cloud-kubernetes-fabric8-config[Spring Cloud Kubernetes Config] project makes Kubernetes `ConfigMap` instances available
6+
The link:https://github.com/spring-cloud/spring-cloud-kubernetes/tree/main/spring-cloud-kubernetes-fabric8-config[Spring Cloud Kubernetes Config] project makes Kubernetes `ConfigMap` instances available
77
during application startup and triggers hot reloading of beans or Spring context when changes are detected on
88
observed `ConfigMap` instances.
99

docs/modules/ROOT/pages/spring-cloud-kubernetes-configuration-watcher.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,9 @@ change to a ConfigMap or Secret occurs then the HTTP implementation will use the
193193
instances of the application which match the name of the ConfigMap or Secret and send an HTTP POST request to the application's actuator
194194
`/refresh` endpoint. By default, it will send the post request to `/actuator/refresh` using the port registered in the discovery client.
195195

196+
You can also configure the configuration watcher to call the instances `shutdown` actuator endpoint. To do this you can set
197+
`spring.cloud.kubernetes.configuration.watcher.refresh-strategy=shutdown`.
198+
196199
### Non-Default Management Port and Actuator Path
197200

198201
If the application is using a non-default actuator path and/or using a different port for the management endpoints, the Kubernetes service for the application
@@ -224,7 +227,13 @@ Another way you can choose to configure the actuator path and/or management port
224227
## Messaging Implementation
225228

226229
The messaging implementation can be enabled by setting profile to either `bus-amqp` (RabbitMQ) or `bus-kafka` (Kafka) when the Spring Cloud Kubernetes Configuration Watcher
227-
application is deployed to Kubernetes.
230+
application is deployed to Kubernetes. By default, when using the messaging implementation the configuration watcher will send a `RefreshRemoteApplicationEvent` using
231+
Spring Cloud Bus to all application instances. This will cause the application instances to refresh the application's configuration properties without
232+
restarting the instance.
233+
234+
You can also configure the configuration to shut down the application instances in order to refresh the application's configuration properties.
235+
When the application shuts down, Kubernetes will restart the application instance and the new configuration properties will be loaded. To use
236+
this strategy set `spring.cloud.kubernetes.configuration.watcher.refresh-strategy=shutdown`.
228237

229238
## Configuring RabbitMQ
230239

docs/modules/ROOT/pages/spring-cloud-kubernetes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This reference guide covers how to use Spring Cloud Kubernetes.
66
[[why-do-you-need-spring-cloud-kubernetes]]
77
== Why do you need Spring Cloud Kubernetes?
88

9-
Spring Cloud Kubernetes provides implementations of well known Spring Cloud interfaces allowing developers to build and run Spring Cloud applications on Kubernetes. While this project may be useful to you when building a cloud native application, it is also not a requirement in order to deploy a Spring Boot app on Kubernetes. If you are just getting started in your journey to running your Spring Boot app on Kubernetes you can accomplish a lot with nothing more than a basic Spring Boot app and Kubernetes itself. To learn more, you can get started by reading the https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#cloud-deployment-kubernetes[Spring Boot reference documentation for deploying to Kubernetes ] and also working through the workshop material https://hackmd.io/@ryanjbaxter/spring-on-k8s-workshop[Spring and Kubernetes].
9+
Spring Cloud Kubernetes provides implementations of well known Spring Cloud interfaces allowing developers to build and run Spring Cloud applications on Kubernetes. While this project may be useful to you when building a cloud native application, it is also not a requirement in order to deploy a Spring Boot app on Kubernetes. If you are just getting started in your journey to running your Spring Boot app on Kubernetes you can accomplish a lot with nothing more than a basic Spring Boot app and Kubernetes itself. To learn more, you can get started by reading the https://docs.spring.io/spring-boot/how-to/deployment/cloud.html#howto.deployment.cloud.kubernetes[Spring Boot reference documentation for deploying to Kubernetes ] and also working through the workshop material https://hackmd.io/@ryanjbaxter/spring-on-k8s-workshop[Spring and Kubernetes].
1010

1111

1212

docs/modules/ROOT/partials/_configprops.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
|spring.cloud.kubernetes.config.retry | |
5959
|spring.cloud.kubernetes.config.sources | |
6060
|spring.cloud.kubernetes.config.use-name-as-prefix | `+++false+++` |
61-
|spring.cloud.kubernetes.discovery.all-namespaces | `+++false+++` | if discover is enabled for all namespaces
61+
|spring.cloud.kubernetes.discovery.all-namespaces | `+++false+++` | if discovery is enabled for all namespaces
6262
|spring.cloud.kubernetes.discovery.cache-loading-timeout-seconds | `+++60+++` | timeout for initializing discovery cache, will abort the application if exceeded.
6363
|spring.cloud.kubernetes.discovery.discovery-server-url | |
6464
|spring.cloud.kubernetes.discovery.enabled | `+++true+++` | if kubernetes discovery is enabled

docs/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"dependencies": {
3-
"antora": "3.2.0-alpha.4",
3+
"antora": "3.2.0-alpha.6",
44
"@antora/atlas-extension": "1.0.0-alpha.2",
5-
"@antora/collector-extension": "1.0.0-beta.4",
5+
"@antora/collector-extension": "1.0.0-beta.5",
66
"@asciidoctor/tabs": "1.0.0-beta.6",
7-
"@springio/antora-extensions": "1.11.1",
7+
"@springio/antora-extensions": "1.14.2",
88
"@springio/asciidoctor-extensions": "1.0.0-alpha.14"
99
}
1010
}

0 commit comments

Comments
 (0)