Browse Source

Polish adoc formatting

pull/38228/head
Phillip Webb 2 years ago
parent
commit
e891a3e24c
  1. 1
      spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc
  2. 17
      spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/packaging-oci-image.adoc
  3. 17
      spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

1
spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc

@ -611,6 +611,7 @@ For example, adding the following bean will automatically apply a `SameSite` of @@ -611,6 +611,7 @@ For example, adding the following bean will automatically apply a `SameSite` of
include::code:MySameSiteConfiguration[]
[[web.servlet.embedded-container.customizing.encoding]]
===== Character Encoding
The character encoding behavior of the embedded servlet container for request and response handling can be configured using the `server.servlet.encoding.*` configuration properties.

17
spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/packaging-oci-image.adoc

@ -397,9 +397,10 @@ The publish option can be specified on the command line as well, as shown in thi @@ -397,9 +397,10 @@ The publish option can be specified on the command line as well, as shown in thi
$ gradle bootBuildImage --imageName=docker.example.com/library/my-app:v1 --publishImage
----
[[build-image.examples.caches]]
=== Builder Cache Configuration
The CNB builder caches layers that are used when building and launching an image.
By default, these caches are stored as named volumes in the Docker daemon with names that are derived from the full name of the target image.
If the image name changes frequently, for example when the project version is used as a tag in the image name, then the caches can be invalidated frequently.
@ -418,12 +419,15 @@ include::../gradle/packaging/boot-build-image-caches.gradle[tags=caches] @@ -418,12 +419,15 @@ include::../gradle/packaging/boot-build-image-caches.gradle[tags=caches]
include::../gradle/packaging/boot-build-image-caches.gradle.kts[tags=caches]
----
[[build-image.examples.docker]]
=== Docker Configuration
[[build-image.examples.docker.minikube]]
==== Docker Configuration for minikube
The plugin can communicate with the https://minikube.sigs.k8s.io/docs/tasks/docker_daemon/[Docker daemon provided by minikube] instead of the default local connection.
On Linux and macOS, environment variables can be set using the command `eval $(minikube docker-env)` after minikube has been started.
@ -442,9 +446,10 @@ include::../gradle/packaging/boot-build-image-docker-host.gradle[tags=docker-hos @@ -442,9 +446,10 @@ include::../gradle/packaging/boot-build-image-docker-host.gradle[tags=docker-hos
include::../gradle/packaging/boot-build-image-docker-host.gradle.kts[tags=docker-host]
----
[[build-image.examples.docker.podman]]
==== Docker Configuration for podman
The plugin can communicate with a https://podman.io/[podman container engine].
The plugin can be configured to use podman local connection by providing connection details similar to those shown in the following example:
@ -463,9 +468,10 @@ include::../gradle/packaging/boot-build-image-docker-host-podman.gradle.kts[tags @@ -463,9 +468,10 @@ include::../gradle/packaging/boot-build-image-docker-host-podman.gradle.kts[tags
TIP: With the `podman` CLI installed, the command `podman info --format='{{.Host.RemoteSocket.Path}}'` can be used to get the value for the `docker.host` configuration property shown in this example.
[[build-image.examples.docker.colima]]
==== Docker Configuration for Colima
The plugin can communicate with the Docker daemon provided by https://github.com/abiosoft/colima[Colima].
The `DOCKER_HOST` environment variable can be set by using the command `export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}').`
@ -483,9 +489,10 @@ include::../gradle/packaging/boot-build-image-docker-host-colima.gradle[tags=doc @@ -483,9 +489,10 @@ include::../gradle/packaging/boot-build-image-docker-host-colima.gradle[tags=doc
include::../gradle/packaging/boot-build-image-docker-host-colima.gradle.kts[tags=docker-host]
----
[[build-image.examples.docker.auth]]
==== Docker Configuration for Authentication
If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.builderRegistry` properties as shown in the following example:
[source,groovy,indent=0,subs="verbatim,attributes",role="primary"]

17
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

@ -372,9 +372,10 @@ and reference the properties in the XML configuration: @@ -372,9 +372,10 @@ and reference the properties in the XML configuration:
include::../maven/packaging-oci-image/docker-pom-authentication-command-line.xml[tags=docker]
----
[[build-image.examples.caches]]
=== Builder Cache Configuration
The CNB builder caches layers that are used when building and launching an image.
By default, these caches are stored as named volumes in the Docker daemon with names that are derived from the full name of the target image.
If the image name changes frequently, for example when the project version is used as a tag in the image name, then the caches can be invalidated frequently.
@ -386,12 +387,15 @@ The cache volumes can be configured to use alternative names to give more contro @@ -386,12 +387,15 @@ The cache volumes can be configured to use alternative names to give more contro
include::../maven/packaging-oci-image/caches-pom.xml[tags=caches]
----
[[build-image.examples.docker]]
=== Docker Configuration
[[build-image.examples.docker.minikube]]
==== Docker Configuration for minikube
The plugin can communicate with the https://minikube.sigs.k8s.io/docs/tasks/docker_daemon/[Docker daemon provided by minikube] instead of the default local connection.
On Linux and macOS, environment variables can be set using the command `eval $(minikube docker-env)` after minikube has been started.
@ -403,9 +407,10 @@ The plugin can also be configured to use the minikube daemon by providing connec @@ -403,9 +407,10 @@ The plugin can also be configured to use the minikube daemon by providing connec
include::../maven/packaging-oci-image/docker-minikube-pom.xml[tags=docker-minikube]
----
[[build-image.examples.docker.podman]]
==== Docker Configuration for podman
The plugin can communicate with a https://podman.io/[podman container engine].
The plugin can be configured to use podman local connection by providing connection details similar to those shown in the following example:
@ -417,9 +422,10 @@ include::../maven/packaging-oci-image/docker-podman-pom.xml[tags=docker-podman] @@ -417,9 +422,10 @@ include::../maven/packaging-oci-image/docker-podman-pom.xml[tags=docker-podman]
TIP: With the `colima` CLI installed, the command `podman info --format='{{.Host.RemoteSocket.Path}}'` can be used to get the value for the `docker.host` configuration property shown in this example.
[[build-image.examples.docker.colima]]
==== Docker Configuration for Colima
The plugin can communicate with the Docker daemon provided by https://github.com/abiosoft/colima[Colima].
The `DOCKER_HOST` environment variable can be set by using the command `export DOCKER_HOST=$(docker context inspect colima -f '{{.Endpoints.docker.Host}}').`
@ -430,9 +436,10 @@ The plugin can also be configured to use Colima daemon by providing connection d @@ -430,9 +436,10 @@ The plugin can also be configured to use Colima daemon by providing connection d
include::../maven/packaging-oci-image/docker-colima-pom.xml[tags=docker-colima]
----
[[build-image.examples.docker.auth]]
==== Docker Configuration for Authentication
If the builder or run image are stored in a private Docker registry that supports user authentication, authentication details can be provided using `docker.builderRegistry` parameters as shown in the following example:
[source,xml,indent=0,subs="verbatim,attributes",tabsize=4]

Loading…
Cancel
Save