merge main

Author: wind57

.github/dependabot.yml

@@ -0,0 +1,48 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "main"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: maven
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: main
+    ignore:
+      # only upgrade by minor or patch
+      - dependency-name: "*"
+        update-types:
+          - version-update:semver-major
+  - package-ecosystem: maven
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: 3.1.x
+    ignore:
+      # only upgrade by minor or patch
+      - dependency-name: "*"
+        update-types:
+          - version-update:semver-major
+          - version-update:semver-minor
+  - package-ecosystem: npm
+    target-branch: docs-build
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: npm
+    target-branch: main
+    directory: /docs
+    schedule:
+      interval: weekly
+  - package-ecosystem: npm
+    target-branch: 3.1.x
+    directory: /docs
+    schedule:
+      interval: weekly

.github/workflows/deploy-docs.yml

@@ -16,7 +16,7 @@ jobs:
     # if: github.repository_owner == 'spring-cloud'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: docs-build
           fetch-depth: 1

.github/workflows/maven.yaml

@@ -2,9 +2,9 @@ name: github-workflow
 
 on:
   push:
-    branches: [ main, 3.0.x, 3.1.x ]
+    branches: [ main, 3.1.x, 3.0.x ]
   pull_request:
-    branches: [ main, 3.0.x, 3.1.x ]
+    branches: [ main, 3.1.x, 3.0.x ]
 
 jobs:
   build:
@@ -41,7 +41,7 @@ jobs:
         uses: ./.github/workflows/composites/cache
 
       - name: Show caches
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             const caches = await github.rest.actions.getActionsCacheList({
@@ -63,7 +63,7 @@ jobs:
 
       - name: check test times cache exists
         id: check_files
-        uses: andstor/file-existence-action@v2
+        uses: andstor/file-existence-action@v3
         with:
           files: /tmp/sorted.txt
 

docs/antora.yml

@@ -6,7 +6,7 @@ nav:
 ext:
   collector:
     run:
-      command: ./mvnw --no-transfer-progress -B process-resources -Pdocs -pl docs -Dantora-maven-plugin.phase=none -Dgenerate-docs.phase=none -Dgenerate-readme.phase=none -Dgenerate-cloud-resources.phase=none -Dmaven-dependency-plugin-for-docs.phase=none -Dmaven-dependency-plugin-for-docs-classes.phase=none -DskipTests
+      command: ./mvnw --no-transfer-progress -B process-resources -Pdocs -pl docs -Dantora-maven-plugin.phase=none -Dgenerate-docs.phase=none -Dgenerate-readme.phase=none -Dgenerate-cloud-resources.phase=none -Dmaven-dependency-plugin-for-docs.phase=none -Dmaven-dependency-plugin-for-docs-classes.phase=none -DskipTests -DdisableConfigurationProperties
       local: true
     scan:
       dir: ./target/classes/antora-resources/

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

@@ -1,7 +1,7 @@
 [[discoveryclient-for-kubernetes]]
 = DiscoveryClient for Kubernetes
 
-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]
+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]
 for https://kubernetes.io[Kubernetes].
 This client lets you query Kubernetes endpoints (see https://kubernetes.io/docs/user-guide/services/[services]) by name.
 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

@@ -10,7 +10,7 @@ The same applies for `PropertySourceLocator`, where you need to add to the class
 
 The following projects highlight the usage of these dependencies and demonstrate how you can use these libraries from any Spring Boot application:
 
-* https://github.com/spring-cloud/spring-cloud-kubernetes/tree/master/spring-cloud-kubernetes-examples[Spring Cloud Kubernetes Examples]: the ones located inside this repository.
+* https://github.com/spring-cloud/spring-cloud-kubernetes/tree/main/spring-cloud-kubernetes-examples[Spring Cloud Kubernetes Examples]: the ones located inside this repository.
 * Spring Cloud Kubernetes Full Example: Minions and Boss
 	** https://github.com/salaboy/spring-cloud-k8s-minion[Minion]
 	** https://github.com/salaboy/spring-cloud-k8s-boss[Boss]

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

@@ -2,7 +2,7 @@
 = Pod Health Indicator
 :page-section-summary-toc: 1
 
-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.
+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.
 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].
 
 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

@@ -3,7 +3,7 @@
 
 Kubernetes provides a resource named https://kubernetes.io/docs/user-guide/configmap/[`ConfigMap`] to externalize the
 parameters to pass to your application in the form of key-value pairs or embedded `application.properties` or `application.yaml` files.
-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
+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
 during application startup and triggers hot reloading of beans or Spring context when changes are detected on
 observed `ConfigMap` instances.
 

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

@@ -4,7 +4,7 @@
 The Spring Cloud Kubernetes Config Server, is based on https://spring.io/projects/spring-cloud-config[Spring Cloud Config Server] and adds an https://docs.spring.io/spring-cloud-config/docs/current/reference/html/#_environment_repository[environment repository] for Kubernetes
 https://kubernetes.io/docs/concepts/configuration/configmap/[Config Maps] and https://kubernetes.io/docs/concepts/configuration/secret/[Secrets].
 
-This is component is completely optional.  However, it allows you to continue to leverage configuration
+This component is completely optional.  However, it allows you to continue to leverage configuration
 you may have stored in existing environment repositories (Git, SVN, Vault, etc) with applications that you are running on Kubernetes.
 
 A default image is located on https://hub.docker.com/r/springcloud/spring-cloud-kubernetes-configserver[Docker Hub] which will allow you to easily get a Config Server deployed on Kubernetes without building

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

@@ -193,6 +193,9 @@ change to a ConfigMap or Secret occurs then the HTTP implementation will use the
 instances of the application which match the name of the ConfigMap or Secret and send an HTTP POST request to the application's actuator
 `/refresh` endpoint.  By default, it will send the post request to `/actuator/refresh` using the port registered in the discovery client.
 
+You can also configure the configuration watcher to call the instances `shutdown` actuator endpoint.  To do this you can set
+`spring.cloud.kubernetes.configuration.watcher.refresh-strategy=shutdown`.
+
 ### Non-Default Management Port and Actuator Path
 
 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
 ## Messaging Implementation
 
 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
-application is deployed to Kubernetes.
+application is deployed to Kubernetes.  By default, when using the messaging implementation the configuration watcher will send a `RefreshRemoteApplicationEvent` using
+Spring Cloud Bus to all application instances.  This will cause the application instances to refresh the application's configuration properties without
+restarting the instance.
+
+You can also configure the configuration to shut down the application instances in order to refresh the application's configuration properties.
+When the application shuts down, Kubernetes will restart the application instance and the new configuration properties will be loaded.  To use
+this strategy set `spring.cloud.kubernetes.configuration.watcher.refresh-strategy=shutdown`.
 
 ## Configuring RabbitMQ