Merge pull request #9 from spring-cloud/main

sync

Author: mostcool

.github/dco.yml

@@ -0,0 +1,2 @@
+require:
+  members: false

.github/dependabot.yml

@@ -20,6 +20,7 @@ updates:
       - dependency-name: "*"
         update-types:
           - version-update:semver-major
+          - version-update:semver-minor
   - package-ecosystem: maven
     directory: /
     schedule:
@@ -31,6 +32,17 @@ updates:
         update-types:
           - version-update:semver-major
           - version-update:semver-minor
+  - package-ecosystem: maven
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: 3.2.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: /
@@ -46,3 +58,8 @@ updates:
     directory: /docs
     schedule:
       interval: weekly
+  - package-ecosystem: npm
+    target-branch: 3.2.x
+    directory: /docs
+    schedule:
+      interval: weekly

.github/workflows/composites/maven-build-with-dry-run-for-tests/action.yaml

@@ -8,7 +8,7 @@ runs:
       shell: bash
       run: |
         ./mvnw install -B  \
-              -Dskip.build.image=true \
+              -Dspring-boot.build-image.skip=true \
               -DskipTests -DskipITs \
               -T 1C -U -q
 

.github/workflows/composites/pre-test-actions/action.yaml

@@ -24,7 +24,7 @@ runs:
     - name: build project
       shell: bash
       run: |
-        ./mvnw clean install -Dskip.build.image=true -DskipITs -DskipTests -T1C -U -B -q  
+        ./mvnw clean install -Dspring-boot.build-image.skip=true -DskipITs -DskipTests -T1C -U -B -q  
 
     - name: build controllers project
       uses: ./.github/workflows/composites/build-controllers-project

.github/workflows/composites/restore-docker-images/action.yaml

@@ -29,8 +29,8 @@ runs:
       uses: actions/cache/save@v4
       if: steps.images-cache.outputs.cache-hit != 'true'
       with:
-        path: |
-          /tmp/docker/images
+        path: /tmp/docker/images
+        key: docker-images-github-cache-${{ hashFiles('**/current-images.txt') }}
 
     - name: print images
       shell: bash

.github/workflows/composites/run-and-save-test-times-when-cache-missing/action.yaml

@@ -47,7 +47,7 @@ runs:
             -Dmaven.wagon.http.pool=false \
             -Dmaven.wagon.http.retryHandler.class=standard \
             -Dmaven.wagon.http.retryHandler.count=3 \
-            -Dskip.build.image=true          
+            -Dspring-boot.build-image.skip=true          
         
         touch /tmp/test_times_${{ env.CURRENT_INDEX }}.txt
         

.github/workflows/composites/run-and-save-test-times-when-cache-present/action.yaml

@@ -156,7 +156,7 @@ runs:
               -Dmaven.wagon.http.pool=false \
               -Dmaven.wagon.http.retryHandler.class=standard \
               -Dmaven.wagon.http.retryHandler.count=3 \
-              -Dskip.build.image=true
+              -Dspring-boot.build-image.skip=true
 
         touch /tmp/test_times_${{ env.CURRENT_INDEX }}.txt
 

.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.1.x, 3.0.x ]
+    branches: [ main, 3.0.x, 3.1.x, 3.2.x ]
   pull_request:
-    branches: [ main, 3.1.x, 3.0.x ]
+    branches: [ main, 3.0.x, 3.1.x, 3.2.x ]
 
 jobs:
   build:
@@ -41,16 +41,14 @@ 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({
               owner: context.repo.owner,
               repo: context.repo.repo,
             })
-            for (const cache of caches.data.actions_caches) {
-              console.log(cache)
-            }  
+            console.log(caches.data)
 
       - name: maven build with dry-run for tests
         uses: ./.github/workflows/composites/maven-build-with-dry-run-for-tests
@@ -65,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
 

README.adoc

@@ -5,3 +5,34 @@ Edit the files in the src/main/asciidoc/ directory instead.
 ////
 
 
+[[spring-cloud-kubernetes]]
+= Spring Cloud Kubernetes
+
+This reference guide covers how to use Spring Cloud Kubernetes.
+
+[[why-do-you-need-spring-cloud-kubernetes]]
+== Why do you need Spring Cloud Kubernetes?
+
+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].
+
+[[configuration-properties]]
+== Configuration properties
+
+To see the list of all Kubernetes related configuration properties please check link:appendix.html[the Appendix page].
+
+[[building]]
+== Building
+
+Click https://docs.spring.io/spring-cloud-build/reference/building.html[here] for basic building instructions.
+
+
+[[contributing]]
+== Contributing
+
+Click https://docs.spring.io/spring-cloud-build/reference/contributing.html[here] for instructions on contributing to this project.
+
+
+[[aot-and-native-image-support]]
+== AOT and native image support
+
+At this point, Spring Cloud Kubernetes does not support Spring Boot AOT transformations or native images. Partial support might be added in future releases.

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/property-source-config/propertysource-reload.adoc

@@ -2,8 +2,8 @@
 = `PropertySource` Reload
 
 WARNING:  This functionality has been deprecated in the 2020.0 release.  Please see
-the xref:spring-cloud-kubernetes-configuration-watcher.adoc#spring-cloud-kubernetes-configuration-watcher[null] controller for an alternative way
-to achieve the same functionality.
+the xref:spring-cloud-kubernetes-configuration-watcher.adoc#spring-cloud-kubernetes-configuration-watcher[Spring Cloud Kubernetes Configuration Watcher]
+controller for an alternative way to achieve the same functionality.
 
 Some applications may need to detect changes on external property sources and update their internal status to reflect the new configuration.
 The reload feature of Spring Cloud Kubernetes is able to trigger an application reload when a related `ConfigMap` or

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
@@ -29,6 +29,14 @@ list of namespace values.
 NOTE: If you set `spring.cloud.kubernetes.configserver.config-map-namespaces` and/or `spring.cloud.kubernetes.configserver.secrets-namespaces`
 you will need to include the namespace in which the Config Server is deployed in order to continue to fetch Config Map and Secret data from that namespace.
 
+### Using Advanced Features Of Spring Vault
+In order to use some of the https://docs.spring.io/spring-cloud-config/reference/server/environment-repository/vault-backend.html[more advanced Spring Vault features] of the **Spring Cloud Config Server**, https://mvnrepository.com/artifact/org.springframework.vault/spring-vault-core[`spring-vault-core`] must be on the classpath. By default, Spring Cloud Kubernetes can generate a Docker image for deploying Config Server to Kubernetes, but it does not include `spring-vault-core` in the classpath. If you need `spring-vault-core` to enable certain functionality in the Config Server you can build your own version of Docker image by enabling the `vault` Maven profile when running Maven build.
+
+Example:
+```bash
+$ ../../mvnw clean install -Pvault
+```
+
 ### Kubernetes Access Controls
 The Kubernetes Config Server uses the Kubernetes API server to fetch Config Map and Secret data.  In order for it to do that
 it needs ability to `get` and `list` Config Map and Secrets (depending on what you enable/disable).

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
 

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

@@ -6,23 +6,7 @@ This reference guide covers how to use Spring Cloud Kubernetes.
 [[why-do-you-need-spring-cloud-kubernetes]]
 == Why do you need Spring Cloud Kubernetes?
 
-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].
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+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].
 
 [[configuration-properties]]
 == Configuration properties

docs/modules/ROOT/partials/_configprops.adoc

@@ -58,7 +58,7 @@
 |spring.cloud.kubernetes.config.retry |  | 
 |spring.cloud.kubernetes.config.sources |  | 
 |spring.cloud.kubernetes.config.use-name-as-prefix | `+++false+++` | 
-|spring.cloud.kubernetes.discovery.all-namespaces | `+++false+++` | if discover is enabled for all namespaces
+|spring.cloud.kubernetes.discovery.all-namespaces | `+++false+++` | if discovery is enabled for all namespaces
 |spring.cloud.kubernetes.discovery.cache-loading-timeout-seconds | `+++60+++` | timeout for initializing discovery cache, will abort the application if exceeded.
 |spring.cloud.kubernetes.discovery.discovery-server-url |  | 
 |spring.cloud.kubernetes.discovery.enabled | `+++true+++` | if kubernetes discovery is enabled

docs/package.json

@@ -1,10 +1,10 @@
 {
 	"dependencies": {
-		"antora": "3.2.0-alpha.4",
+		"antora": "3.2.0-alpha.8",
 		"@antora/atlas-extension": "1.0.0-alpha.2",
-		"@antora/collector-extension": "1.0.0-alpha.3",
+		"@antora/collector-extension": "1.0.1",
 		"@asciidoctor/tabs": "1.0.0-beta.6",
-		"@springio/antora-extensions": "1.11.1",
-		"@springio/asciidoctor-extensions": "1.0.0-alpha.13"
+		"@springio/antora-extensions": "1.14.4",
+		"@springio/asciidoctor-extensions": "1.0.0-alpha.17"
 	}
 }

docs/pom.xml

@@ -8,7 +8,7 @@
 	<parent>
 		<groupId>org.springframework.cloud</groupId>
 		<artifactId>spring-cloud-kubernetes</artifactId>
-		<version>3.2.0-SNAPSHOT</version>
+		<version>3.3.0-SNAPSHOT</version>
 		<relativePath>..</relativePath>
 	</parent>
 	<packaging>jar</packaging>
@@ -21,24 +21,32 @@
 		<!-- Don't upload docs jar to central / repo.spring.io -->
 		<maven-deploy-plugin-default.phase>none</maven-deploy-plugin-default.phase>
 	</properties>
-	<dependencies>
-		<dependency>
-			<groupId>${project.groupId}</groupId>
-			<artifactId>spring-cloud-starter-kubernetes-fabric8</artifactId>
-		</dependency>
-		<dependency>
-			<groupId>${project.groupId}</groupId>
-			<artifactId>spring-cloud-starter-kubernetes-fabric8-all</artifactId>
-		</dependency>
-		<dependency>
-			<groupId>${project.groupId}</groupId>
-			<artifactId>spring-cloud-starter-kubernetes-fabric8-config</artifactId>
-		</dependency>
-	</dependencies>
 	<build>
 		<sourceDirectory>src/main/asciidoc</sourceDirectory>
 	</build>
 	<profiles>
+		<profile>
+			<id>enable-configuration-properties</id>
+			<activation>
+				<property>
+					<name>!disableConfigurationProperties</name>
+				</property>
+			</activation>
+			<dependencies>
+				<dependency>
+					<groupId>${project.groupId}</groupId>
+					<artifactId>spring-cloud-starter-kubernetes-fabric8</artifactId>
+				</dependency>
+				<dependency>
+					<groupId>${project.groupId}</groupId>
+					<artifactId>spring-cloud-starter-kubernetes-fabric8-all</artifactId>
+				</dependency>
+				<dependency>
+					<groupId>${project.groupId}</groupId>
+					<artifactId>spring-cloud-starter-kubernetes-fabric8-config</artifactId>
+				</dependency>
+			</dependencies>
+		</profile>
 		<profile>
 			<id>docs</id>
 			<build>

docs/src/main/asciidoc/README.adoc

@@ -0,0 +1 @@
+include::../../../modules/ROOT/pages/spring-cloud-kubernetes.adoc[]