Skip to content

Commit 4fd9a85

Browse files
ryanjbaxterryanjbaxter
authored
Merge pull request #2041 from wind57/drop-enabled-property
Drop enable-api property (3)
2 parents e89bf7e + f01e0c6 commit 4fd9a85

File tree

119 files changed

+360
-330
lines changed

Some content is hidden

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

119 files changed

+360
-330
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ spring:
184184
cloud:
185185
kubernetes:
186186
config:
187-
enableApi: true
187+
enabled: true
188188
useNameAsPrefix: true
189189
namespace: spring-k8s
190190
sources:
@@ -455,7 +455,7 @@ spring:
455455
cloud:
456456
kubernetes:
457457
secrets:
458-
enableApi: true
458+
enabled: true
459459
useNameAsPrefix: true
460460
namespace: spring-k8s
461461
sources:
@@ -487,7 +487,7 @@ spring:
487487
cloud:
488488
kubernetes:
489489
secrets:
490-
enableApi: true
490+
enabled: true
491491
useNameAsPrefix: true
492492
namespace: spring-k8s
493493
sources:
@@ -575,7 +575,6 @@ NOTE: Since version `5.0.0`, we have introduced the possibility to read sources
575575
| `spring.cloud.kubernetes.config.enabled` | `Boolean` | `true` | Enable ConfigMaps `PropertySource`
576576
| `spring.cloud.kubernetes.config.name` | `String` | `${spring.application.name}` | Sets the name of `ConfigMap` to look up
577577
| `spring.cloud.kubernetes.config.namespace` | `String` | Client namespace | Sets the Kubernetes namespace where to lookup
578-
| `spring.cloud.kubernetes.config.enableApi` | `Boolean` | `true` | Enable or disable consuming `ConfigMap` instances through APIs
579578
| `spring.cloud.kubernetes.config.fail-fast` | `Boolean` | `false` | Enable or disable failing the application start-up when an error occurred while loading a `ConfigMap`
580579
| `spring.cloud.kubernetes.config.retry.enabled` | `Boolean` | `true` | Enable or disable config retry.
581580
| `spring.cloud.kubernetes.config.retry.initial-interval` | `Long` | `1000` | Initial retry interval in milliseconds.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ This setting is supported since `3.0.6` and upwards.
151151
| `spring.cloud.kubernetes.secrets.name` | `String` | `${spring.application.name}` | Sets the name of the secret to look up
152152
| `spring.cloud.kubernetes.secrets.namespace` | `String` | Client namespace | Sets the Kubernetes namespace where to look up
153153
| `spring.cloud.kubernetes.secrets.labels` | `Map` | `null` | Sets the labels used to lookup secrets
154-
| `spring.cloud.kubernetes.secrets.enableApi` | `Boolean` | `false` | Enables or disables consuming secrets through APIs (examples 2 and 3)
155154
| `spring.cloud.kubernetes.secrets.fail-fast` | `Boolean` | `false` | Enable or disable failing the application start-up when an error occurred while loading a `Secret`
156155
| `spring.cloud.kubernetes.secrets.retry.enabled` | `Boolean` | `true` | Enable or disable secrets retry.
157156
| `spring.cloud.kubernetes.secrets.retry.initial-interval` | `Long` | `1000` | Initial retry interval in milliseconds.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ To enable the Kubernetes environment repository the `kubernetes` profile must be
1818
You may activate other profiles as well to use other environment repository implementations.
1919

2020
=== Config Map and Secret PropertySources
21-
By default, only Config Map data will be fetched. To enable Secrets as well you will need to set `spring.cloud.kubernetes.secrets.enableApi=true`.
22-
You can disable the Config Map `PropertySource` by setting `spring.cloud.kubernetes.config.enableApi=false`.
21+
By default, only Config Map data will be fetched. To enable Secrets as well you will need to set `spring.cloud.kubernetes.secrets.enabled=true`.
22+
You can disable the Config Map `PropertySource` by setting `spring.cloud.kubernetes.config.enabled=false`.
2323

2424
=== Fetching Config Map and Secret Data From Additional Namespaces
2525
By default, the Kubernetes environment repository will only fetch Config Map and Secrets from the namespace in which it is deployed.

‎docs/modules/ROOT/partials/_configprops.adoc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646
|spring.cloud.kubernetes.client.watch-reconnect-limit | |
4747
|spring.cloud.kubernetes.client.watchReconnectInterval | `+++1s+++` | Reconnect Interval
4848
|spring.cloud.kubernetes.client.watchReconnectLimit | `+++-1+++` | Reconnect Interval limit retries
49-
|spring.cloud.kubernetes.config.enable-api | `+++true+++` |
5049
|spring.cloud.kubernetes.config.enabled | `+++true+++` | Enable the ConfigMap property source locator.
5150
|spring.cloud.kubernetes.config.fail-fast | `+++false+++` |
5251
|spring.cloud.kubernetes.config.include-profile-specific-sources | `+++true+++` |
@@ -101,7 +100,6 @@
101100
|spring.cloud.kubernetes.reload.namespaces | | namespaces where an informer will be set-up. this property is only relevant for event based reloading.
102101
|spring.cloud.kubernetes.reload.period | `+++15000ms+++` | Sets the polling period to use when the detection mode is POLLING.
103102
|spring.cloud.kubernetes.reload.strategy | `+++REFRESH+++` | Sets reload strategy for Kubernetes configuration reload on change.
104-
|spring.cloud.kubernetes.secrets.enable-api | `+++false+++` |
105103
|spring.cloud.kubernetes.secrets.enabled | `+++true+++` | Enable the Secrets property source locator.
106104
|spring.cloud.kubernetes.secrets.fail-fast | `+++false+++` |
107105
|spring.cloud.kubernetes.secrets.include-profile-specific-sources | `+++true+++` |

‎spring-cloud-kubernetes-client-config/src/test/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientConfigDataLocationResolverTests.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ void testBothMissing() {
103103
@Test
104104
void testBothPresent() {
105105
MockEnvironment environment = new MockEnvironment();
106+
environment.setProperty("spring.cloud.kubernetes.secrets.enabled", "true");
106107
ConfigurationPropertySources.attach(environment);
107108
Binder binder = new Binder(ConfigurationPropertySources.get(environment));
108109

@@ -200,6 +201,7 @@ void testBothPresentAndRetryEnabled() {
200201
environment.setProperty("spring.cloud.kubernetes.config.fail-fast", "true");
201202
environment.setProperty("spring.cloud.kubernetes.secrets.retry.enabled", "true");
202203
environment.setProperty("spring.cloud.kubernetes.secrets.fail-fast", "true");
204+
environment.setProperty("spring.cloud.kubernetes.secrets.enabled", "true");
203205
ConfigurationPropertySources.attach(environment);
204206
Binder binder = new Binder(ConfigurationPropertySources.get(environment));
205207

‎spring-cloud-kubernetes-client-config/src/test/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientConfigMapErrorOnReadingSourceTests.java‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ void namedSingleConfigMapFails(CapturedOutput output) {
110110

111111
stubFor(get(path).willReturn(aResponse().withStatus(500).withBody("Internal Server Error")));
112112

113-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
114-
true, name, namespace, false, true, false, RetryProperties.DEFAULT, ReadType.BATCH);
113+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
114+
name, namespace, false, true, false, RetryProperties.DEFAULT, ReadType.BATCH);
115115

116116
CoreV1Api api = new CoreV1Api();
117117
KubernetesClientConfigMapPropertySourceLocator locator = new KubernetesClientConfigMapPropertySourceLocator(api,
@@ -152,7 +152,7 @@ void namedTwoConfigMapsOneFails(CapturedOutput output) {
152152
ConfigMapConfigProperties.Source sourceTwo = new ConfigMapConfigProperties.Source(configMapNameTwo, namespace,
153153
Map.of(), null, null, null);
154154

155-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true,
155+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(
156156
List.of(sourceOne, sourceTwo), Map.of(), true, null, namespace, false, true, false,
157157
RetryProperties.DEFAULT, ReadType.BATCH);
158158

@@ -199,7 +199,7 @@ void namedTwoConfigMapsBothFail(CapturedOutput output) {
199199
ConfigMapConfigProperties.Source sourceTwo = new ConfigMapConfigProperties.Source(configMapNameTwo, namespace,
200200
Map.of(), null, null, null);
201201

202-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true,
202+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(
203203
List.of(sourceOne, sourceTwo), Map.of(), true, null, namespace, false, true, false,
204204
RetryProperties.DEFAULT, ReadType.BATCH);
205205

@@ -243,9 +243,8 @@ void labeledSingleConfigMapFails(CapturedOutput output) {
243243
ConfigMapConfigProperties.Source configMapSource = new ConfigMapConfigProperties.Source(null, namespace, labels,
244244
null, null, null);
245245

246-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true,
247-
List.of(configMapSource), labels, true, null, namespace, false, true, false, RetryProperties.DEFAULT,
248-
ReadType.BATCH);
246+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(configMapSource),
247+
labels, true, null, namespace, false, true, false, RetryProperties.DEFAULT, ReadType.BATCH);
249248

250249
CoreV1Api api = new CoreV1Api();
251250
KubernetesClientConfigMapPropertySourceLocator locator = new KubernetesClientConfigMapPropertySourceLocator(api,
@@ -295,7 +294,7 @@ void labeledTwoConfigMapsOneFails(CapturedOutput output) {
295294
ConfigMapConfigProperties.Source sourceTwo = new ConfigMapConfigProperties.Source(null, namespace,
296295
configMapTwoLabels, null, null, null);
297296

298-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true,
297+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(
299298
List.of(sourceOne, sourceTwo), Map.of("one", "1", "two", "2"), true, null, namespace, false, true,
300299
false, RetryProperties.DEFAULT, ReadType.BATCH);
301300

@@ -349,7 +348,7 @@ void labeledTwoConfigMapsBothFail(CapturedOutput output) {
349348
ConfigMapConfigProperties.Source sourceTwo = new ConfigMapConfigProperties.Source(null, namespace,
350349
configMapTwoLabels, null, null, null);
351350

352-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true,
351+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(
353352
List.of(sourceOne, sourceTwo), Map.of("one", "1", "two", "2"), true, null, namespace, false, true,
354353
false, RetryProperties.DEFAULT, ReadType.BATCH);
355354

‎spring-cloud-kubernetes-client-config/src/test/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientConfigMapPropertySourceLocatorTests.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ void locateWithoutSources() {
106106
CoreV1Api api = new CoreV1Api();
107107
stubFor(get("/api/v1/namespaces/default/configmaps")
108108
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(PROPERTIES_CONFIGMAP_LIST))));
109-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
110-
true, "bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
109+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
110+
"bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
111111
MockEnvironment mockEnvironment = new MockEnvironment();
112112
mockEnvironment.setProperty("spring.cloud.kubernetes.client.namespace", "default");
113113
PropertySource<?> propertySource = new KubernetesClientConfigMapPropertySourceLocator(api,
@@ -125,8 +125,8 @@ void locateWithSources() {
125125

126126
ConfigMapConfigProperties.Source source = new ConfigMapConfigProperties.Source("bootstrap-640", "default",
127127
Collections.emptyMap(), null, null, null);
128-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(source),
129-
Map.of(), true, "fake-name", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
128+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(source), Map.of(),
129+
true, "fake-name", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
130130

131131
PropertySource<?> propertySource = new KubernetesClientConfigMapPropertySourceLocator(api,
132132
configMapConfigProperties, new KubernetesNamespaceProvider(new MockEnvironment()))
@@ -148,8 +148,8 @@ void testLocateWithoutNamespaceConstructor() {
148148
stubFor(get("/api/v1/namespaces/default/configmaps")
149149
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(PROPERTIES_CONFIGMAP_LIST))));
150150

151-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
152-
true, "bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
151+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
152+
"bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
153153

154154
assertThatThrownBy(() -> new KubernetesClientConfigMapPropertySourceLocator(api, configMapConfigProperties,
155155
new KubernetesNamespaceProvider(new MockEnvironment()))
@@ -168,8 +168,8 @@ void testLocateWithoutNamespace() {
168168
CoreV1Api api = new CoreV1Api();
169169
stubFor(get("/api/v1/namespaces/default/configmaps")
170170
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(PROPERTIES_CONFIGMAP_LIST))));
171-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
172-
true, "bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
171+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
172+
"bootstrap-640", null, false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
173173
assertThatThrownBy(() -> new KubernetesClientConfigMapPropertySourceLocator(api, configMapConfigProperties,
174174
new KubernetesNamespaceProvider(ENV))
175175
.locate(ENV)).isInstanceOf(NamespaceResolutionFailedException.class);
@@ -181,8 +181,8 @@ public void locateShouldThrowExceptionOnFailureWhenFailFastIsEnabled() {
181181
stubFor(get("/api/v1/namespaces/default/configmaps")
182182
.willReturn(aResponse().withStatus(500).withBody("Internal Server Error")));
183183

184-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
185-
true, "bootstrap-640", "default", false, false, true, RetryProperties.DEFAULT, ReadType.BATCH);
184+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
185+
"bootstrap-640", "default", false, false, true, RetryProperties.DEFAULT, ReadType.BATCH);
186186

187187
KubernetesClientConfigMapPropertySourceLocator locator = new KubernetesClientConfigMapPropertySourceLocator(api,
188188
configMapConfigProperties, new KubernetesNamespaceProvider(new MockEnvironment()));
@@ -197,8 +197,8 @@ public void locateShouldNotThrowExceptionOnFailureWhenFailFastIsDisabled(Capture
197197
stubFor(get("/api/v1/namespaces/default/configmaps")
198198
.willReturn(aResponse().withStatus(500).withBody("Internal Server Error")));
199199

200-
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(true, List.of(), Map.of(),
201-
true, "bootstrap-640", "default", false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
200+
ConfigMapConfigProperties configMapConfigProperties = new ConfigMapConfigProperties(List.of(), Map.of(), true,
201+
"bootstrap-640", "default", false, false, false, RetryProperties.DEFAULT, ReadType.BATCH);
202202

203203
KubernetesClientConfigMapPropertySourceLocator locator = new KubernetesClientConfigMapPropertySourceLocator(api,
204204
configMapConfigProperties, new KubernetesNamespaceProvider(new MockEnvironment()));

‎spring-cloud-kubernetes-client-config/src/test/java/org/springframework/cloud/kubernetes/client/config/KubernetesClientConfigReloadAutoConfigurationTest.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ void reloadEventEnabledMonitoringConfigMapsDisabledMonitoringSecretsEnabled() {
279279
setup("spring.cloud.bootstrap.enabled=true", "spring.cloud.kubernetes.reload.enabled=true",
280280
"spring.main.cloud-platform=KUBERNETES", "spring.cloud.kubernetes.reload.monitoring-secrets=true",
281281
"spring.cloud.kubernetes.reload.monitoring-configMaps=false",
282-
"spring.cloud.kubernetes.reload.mode=event");
282+
"spring.cloud.kubernetes.reload.mode=event", "spring.cloud.kubernetes.secrets.enabled=true");
283283
Map<String, ConfigurationChangeDetector> map = context.getBeansOfType(ConfigurationChangeDetector.class);
284284
Assertions.assertThat(1).isEqualTo(map.size());
285285
Assertions.assertThat(map.values().iterator().next().getClass())
@@ -304,7 +304,7 @@ void reloadPollingEnabledMonitoringConfigMapsDisabledMonitoringSecretsEnabled()
304304
setup("spring.cloud.bootstrap.enabled=true", "spring.cloud.kubernetes.reload.enabled=true",
305305
"spring.main.cloud-platform=KUBERNETES", "spring.cloud.kubernetes.reload.monitoring-secrets=true",
306306
"spring.cloud.kubernetes.reload.monitoring-configMaps=false",
307-
"spring.cloud.kubernetes.reload.mode=polling");
307+
"spring.cloud.kubernetes.reload.mode=polling", "spring.cloud.kubernetes.secrets.enabled=true");
308308
Map<String, ConfigurationChangeDetector> map = context.getBeansOfType(ConfigurationChangeDetector.class);
309309
Assertions.assertThat(1).isEqualTo(map.size());
310310
Assertions.assertThat(map.values().iterator().next().getClass())
@@ -328,7 +328,7 @@ void reloadEventEnabledMonitoringConfigMapsEnabledMonitoringSecretsEnabled() {
328328
setup("spring.cloud.bootstrap.enabled=true", "spring.cloud.kubernetes.reload.enabled=true",
329329
"spring.main.cloud-platform=KUBERNETES", "spring.cloud.kubernetes.reload.monitoring-secrets=true",
330330
"spring.cloud.kubernetes.reload.monitoring-configMaps=true",
331-
"spring.cloud.kubernetes.reload.mode=event");
331+
"spring.cloud.kubernetes.reload.mode=event", "spring.cloud.kubernetes.secrets.enabled=true");
332332
Map<String, ConfigurationChangeDetector> map = context.getBeansOfType(ConfigurationChangeDetector.class);
333333
Assertions.assertThat(map.size()).isEqualTo(2);
334334
List<ConfigurationChangeDetector> result = map.values()
@@ -358,7 +358,7 @@ void reloadPollingEnabledMonitoringConfigMapsEnabledMonitoringSecretsEnabled() {
358358
setup("spring.cloud.bootstrap.enabled=true", "spring.cloud.kubernetes.reload.enabled=true",
359359
"spring.main.cloud-platform=KUBERNETES", "spring.cloud.kubernetes.reload.monitoring-secrets=true",
360360
"spring.cloud.kubernetes.reload.monitoring-configMaps=true",
361-
"spring.cloud.kubernetes.reload.mode=polling");
361+
"spring.cloud.kubernetes.reload.mode=polling", "spring.cloud.kubernetes.secrets.enabled=true");
362362
Map<String, ConfigurationChangeDetector> map = context.getBeansOfType(ConfigurationChangeDetector.class);
363363
Assertions.assertThat(map.size()).isEqualTo(2);
364364
List<ConfigurationChangeDetector> result = map.values()
@@ -470,7 +470,8 @@ void reloadPollingEnabledMonitoringConfigMapsEnabledMonitoringSecretsDisabled()
470470

471471
@Test
472472
void kubernetesConfigAndSecretEnabledByDefault() {
473-
setup("spring.cloud.bootstrap.enabled=true", "spring.main.cloud-platform=KUBERNETES");
473+
setup("spring.cloud.bootstrap.enabled=true", "spring.main.cloud-platform=KUBERNETES",
474+
"spring.cloud.kubernetes.secrets.enabled=true");
474475
assertThat(context.containsBean("configMapPropertySourceLocator")).isTrue();
475476
assertThat(context.containsBean("secretsPropertySourceLocator")).isTrue();
476477
}
@@ -486,7 +487,7 @@ void kubernetesConfigEnabledButSecretDisabled() {
486487
@Test
487488
void kubernetesSecretsEnabledButConfigDisabled() {
488489
setup("spring.cloud.bootstrap.enabled=true", "spring.cloud.kubernetes.config.enabled=false",
489-
"spring.main.cloud-platform=KUBERNETES");
490+
"spring.main.cloud-platform=KUBERNETES", "spring.cloud.kubernetes.secrets.enabled=true");
490491
assertThat(context.containsBean("configMapPropertySourceLocator")).isFalse();
491492
assertThat(context.containsBean("secretsPropertySourceLocator")).isTrue();
492493
}

0 commit comments

Comments
 (0)