Skip to content

Commit a323ff7

Browse files
committed
Merge branch '2.6.x' into 2.7.x
Closes gh-28945
2 parents f5364e9 + 8b2b836 commit a323ff7

File tree

6 files changed

+52
-52
lines changed

6 files changed

+52
-52
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -988,21 +988,21 @@ They are also exposed as separate HTTP Probes by using <<actuator#actuator.endpo
988988

989989
You can then configure your Kubernetes infrastructure with the following endpoint information:
990990

991-
[source,yml,indent=0,subs="verbatim"]
991+
[source,yaml,indent=0,subs="verbatim"]
992992
----
993-
livenessProbe:
994-
httpGet:
995-
path: /actuator/health/liveness
996-
port: <actuator-port>
997-
failureThreshold: ...
998-
periodSeconds: ...
999-
1000-
readinessProbe:
1001-
httpGet:
1002-
path: /actuator/health/readiness
1003-
port: <actuator-port>
1004-
failureThreshold: ...
1005-
periodSeconds: ...
993+
livenessProbe:
994+
httpGet:
995+
path: "/actuator/health/liveness"
996+
port: <actuator-port>
997+
failureThreshold: ...
998+
periodSeconds: ...
999+
1000+
readinessProbe:
1001+
httpGet:
1002+
path: "/actuator/health/readiness"
1003+
port: <actuator-port>
1004+
failureThreshold: ...
1005+
periodSeconds: ...
10061006
----
10071007

10081008
NOTE: `<actuator-port>` should be set to the port that the actuator endpoints are available on.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -461,10 +461,10 @@ The following example `scrape_config` adds to `prometheus.yml`:
461461
[source,yaml,indent=0,subs="verbatim"]
462462
----
463463
scrape_configs:
464-
- job_name: 'spring'
465-
metrics_path: '/actuator/prometheus'
464+
- job_name: "spring"
465+
metrics_path: "/actuator/prometheus"
466466
static_configs:
467-
- targets: ['HOST:PORT']
467+
- targets: ["HOST:PORT"]
468468
----
469469

470470
For ephemeral or batch jobs that may not exist long enough to be scraped, you can use https://github.com/prometheus/pushgateway[Prometheus Pushgateway] support to expose the metrics to Prometheus.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/monitoring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ For example, doing so lets a management server be available over HTTP while the
7777
ssl:
7878
enabled: true
7979
key-store: "classpath:store.jks"
80-
key-password: secret
80+
key-password: "secret"
8181
management:
8282
server:
8383
port: 8080

spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,8 @@ You can further tune how `Sniffer` is configured, as shown in the following exam
308308
elasticsearch:
309309
restclient:
310310
sniffer:
311-
interval: 10m
312-
delay-after-failure: 30s
311+
interval: "10m"
312+
delay-after-failure: "30s"
313313
----
314314

315315

@@ -327,7 +327,7 @@ In addition to the properties described previously, the `spring.elasticsearch.we
327327
spring:
328328
elasticsearch:
329329
webclient:
330-
max-in-memory-size: 1MB
330+
max-in-memory-size: "1MB"
331331
----
332332

333333
If the `spring.elasticsearch.*` and `spring.elasticsearch.webclient.*` configuration properties are not enough and you'd like to fully control the client configuration, you can register a custom `ClientConfiguration` bean.
@@ -604,8 +604,8 @@ In yaml files, you can use the yaml list notation. In properties files, you must
604604
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
605605
----
606606
spring.ldap.embedded.base-dn:
607-
- dc=spring,dc=io
608-
- dc=pivotal,dc=io
607+
- "dc=spring,dc=io"
608+
- "dc=pivotal,dc=io"
609609
----
610610
====
611611

spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ You can configure a sleep execution in a preStop handler to avoid requests being
124124
This sleep should be long enough for new requests to stop being routed to the pod and its duration will vary from deployment to deployment.
125125
The preStop handler can be configured by using the PodSpec in the pod's configuration file as follows:
126126

127-
[source,yml,indent=0,subs="verbatim"]
127+
[source,yaml,indent=0,subs="verbatim"]
128128
----
129129
spec:
130130
containers:
131-
- name: example-container
132-
image: example-image
131+
- name: "example-container"
132+
image: "example-image"
133133
lifecycle:
134134
preStop:
135135
exec:
@@ -379,26 +379,26 @@ Normally, you put this file in `src/main/appengine`, and it should resemble the
379379

380380
[source,yaml,indent=0,subs="verbatim"]
381381
----
382-
service: default
382+
service: "default"
383383
384-
runtime: java
385-
env: flex
384+
runtime: "java"
385+
env: "flex"
386386
387387
runtime_config:
388-
jdk: openjdk8
388+
jdk: "openjdk8"
389389
390390
handlers:
391-
- url: /.*
392-
script: this field is required, but ignored
391+
- url: "/.*"
392+
script: "this field is required, but ignored"
393393
394394
manual_scaling:
395395
instances: 1
396396
397397
health_check:
398-
enable_health_check: False
398+
enable_health_check: false
399399
400400
env_variables:
401-
ENCRYPT_KEY: your_encryption_key_here
401+
ENCRYPT_KEY: "your_encryption_key_here"
402402
----
403403

404404
You can deploy the app (for example, with a Maven plugin) by adding the project ID to the build configuration, as shown in the following example:

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -293,18 +293,18 @@ For instance, the two examples below produce the same result:
293293
----
294294
spring:
295295
config:
296-
import: my.properties
296+
import: "my.properties"
297297
my:
298-
property: value
298+
property: "value"
299299
----
300300

301301
[source,yaml,indent=0,subs="verbatim",configblocks]
302302
----
303303
my:
304-
property: value
304+
property: "value"
305305
spring:
306306
config:
307-
import: my.properties
307+
import: "my.properties"
308308
----
309309

310310
In both of the above examples, the values from the `my.properties` file will take precedence over the file that triggered its import.
@@ -472,14 +472,14 @@ For example, the following file has two logical documents:
472472
----
473473
spring:
474474
application:
475-
name: MyApp
475+
name: "MyApp"
476476
---
477477
spring:
478478
application:
479-
name: MyCloudApp
479+
name: "MyCloudApp"
480480
config:
481481
activate:
482-
on-cloud-platform: kubernetes
482+
on-cloud-platform: "kubernetes"
483483
----
484484

485485
For `application.properties` files a special `#---` comment is used to mark the document splits:
@@ -528,14 +528,14 @@ For example, the following specifies that the second document is only active whe
528528
[source,yaml,indent=0,subs="verbatim",configblocks]
529529
----
530530
myprop:
531-
always-set
531+
"always-set"
532532
---
533533
spring:
534534
config:
535535
activate:
536536
on-cloud-platform: "kubernetes"
537537
on-profile: "prod | staging"
538-
myotherprop: sometimes-set
538+
myotherprop: "sometimes-set"
539539
----
540540

541541

@@ -568,11 +568,11 @@ For example, consider the following YAML document:
568568
----
569569
environments:
570570
dev:
571-
url: https://dev.example.com
572-
name: Developer Setup
571+
url: "https://dev.example.com"
572+
name: "Developer Setup"
573573
prod:
574-
url: https://another.example.com
575-
name: My Cool App
574+
url: "https://another.example.com"
575+
name: "My Cool App"
576576
----
577577

578578
In order to access these properties from the `Environment`, they would be flattened as follows:
@@ -593,8 +593,8 @@ For example, consider the following YAML:
593593
----
594594
my:
595595
servers:
596-
- dev.example.com
597-
- another.example.com
596+
- "dev.example.com"
597+
- "another.example.com"
598598
----
599599

600600
The preceding example would be transformed into these properties:
@@ -789,10 +789,10 @@ This style of configuration works particularly well with the `SpringApplication`
789789
service:
790790
remote-address: 192.168.1.1
791791
security:
792-
username: admin
792+
username: "admin"
793793
roles:
794-
- USER
795-
- ADMIN
794+
- "USER"
795+
- "ADMIN"
796796
----
797797

798798
To work with `@ConfigurationProperties` beans, you can inject them in the same way as any other bean, as shown in the following example:

0 commit comments

Comments
 (0)