From 168d344241e61f3770a1a04b92411fad15b002f7 Mon Sep 17 00:00:00 2001 From: David Mueller Date: Thu, 31 Aug 2023 16:30:38 -0400 Subject: [PATCH] add starter info #4746 --- modules/ROOT/pages/deploy-spring-boot.adoc | 9 ++++---- .../feature/springBoot-1.5/description.adoc | 19 ++++++++++++++++ .../feature/springBoot-2.0/description.adoc | 22 +++++++++++++++++++ .../feature/springBoot-3.0/description.adoc | 22 +++++++++++++++++++ 4 files changed, 68 insertions(+), 4 deletions(-) create mode 100644 modules/reference/pages/feature/springBoot-1.5/description.adoc create mode 100644 modules/reference/pages/feature/springBoot-2.0/description.adoc create mode 100644 modules/reference/pages/feature/springBoot-3.0/description.adoc diff --git a/modules/ROOT/pages/deploy-spring-boot.adoc b/modules/ROOT/pages/deploy-spring-boot.adoc index 9b4aa1e43c..cdee2557b1 100644 --- a/modules/ROOT/pages/deploy-spring-boot.adoc +++ b/modules/ROOT/pages/deploy-spring-boot.adoc @@ -14,7 +14,7 @@ You can enable Open Liberty to support a Spring Boot application. Open Liberty can also configure Spring Boot application arguments and properties and provides tools that optimize the deployment of Spring Boot applications to containers. -To enable Liberty to support a Spring Boot application, add one of the feature:springBoot[display=Spring Boot Support] features to your `server.xml` file. When you deploy a Spring Boot application, Liberty disables the web container that is embedded in the application and uses the Liberty web container instead. You can deploy one Spring Boot application for each server configuration. +To enable Liberty to support a Spring Boot application, add one of the feature:springBoot[display=Spring Boot Support] features to your `server.xml` file. When you deploy a Spring Boot application, Liberty disables the web container that is embedded in the application and uses the Liberty web container instead. You can deploy one Spring Boot application for each server configuration. OPen LIberty supports deploying Spring Boot applications as JAR files or as WAR files. The examples in the following sections use a sample application that is called `hellospringboot.jar` that is based on the finished application from the link:https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] guide. If you are not familiar with Spring Boot, complete that guide first. The guide includes instructions to build the application as an executable JAR, which is the file format that is used in these examples. @@ -38,9 +38,9 @@ server create helloserver This command creates the `/usr/servers/helloserver/apps` directory. 2. Enable the version of the Open Liberty feature:springBoot[display=Spring Boot Suppor]t feature that your application requires by adding it to the `featureManager` element of the `server.xml` file. + -- If your application uses Spring Boot 1.5.8, enable the `springBoot-1.5` feature. -- If your application uses Spring Boot 2.0.1, enable the `springBoot-2.0` feature. -- If your application uses Spring Boot 3.x, enable the `springBoot-3.0` feature. +- If your application uses Spring Boot 1.5.8, enable the feature:springBoot-1.5[] feature. +- If your application uses Spring Boot 2.0.1, enable the feature:springBoot-2.0[] feature. +- If your application uses Spring Boot 3.x, enable the feature:springBoot-3.0[] feature. + The `hellospringboot.jar` application uses the `spring-boot-starter-web` dependency, which also requires you to enable a feature:servlet[display=Servlet] feature, as shown in the following `server.xml` file example: + @@ -51,6 +51,7 @@ The `hellospringboot.jar` application uses the `spring-boot-starter-web` depende servlet-6.0 ---- +For more information about the Open Liberty features that are required to support certain link:https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters[Spring Boot Starters], see the feature:springBoot[Spring Boot Support] feature. 3. Copy the `hellospringboot.jar` application into the `/usr/servers/helloserver/apps` directory that the `server create` command created. 4. Configure the application by updating the `server.xml` file. diff --git a/modules/reference/pages/feature/springBoot-1.5/description.adoc b/modules/reference/pages/feature/springBoot-1.5/description.adoc new file mode 100644 index 0000000000..b61b18f5b1 --- /dev/null +++ b/modules/reference/pages/feature/springBoot-1.5/description.adoc @@ -0,0 +1,19 @@ +link:https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters[Spring Boot Starters] are a set of convenient dependency descriptors provided by the Spring Boot that you can include in your application. When you use these starters with a Spring Boot application that is deployed on Open Liberty, you might need to enable features beyond the Spring Boot Support feature. The following table lists the Open Liberty features that are required to support certain Spring Boot 1.5 starters. + +.Open Liberty features that support Spring Boot 1.5 starters +[%header,cols=2*] +|=== + +|Spring Boot Starter +|Open Liberty features + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter/1.5.0.RELEASE/spring-boot-starter-1.5.0.RELEASE.pom[spring-boot-starter] +|`springBoot-1.5` + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-web/1.5.0.RELEASE/spring-boot-starter-web-1.5.0.RELEASE.pom[spring-boot-starter-web] +|`springBoot-1.5` and feature:servlet-3.1[], featureservlet-4.0[], or featurejsp-2.3[] + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-websocket/1.5.0.RELEASE/spring-boot-starter-websocket-1.5.0.RELEASE.pom[spring-boot-starter-websocket] +|`springBoot-1.5` and feature:websocket-1.0[] or feature:websocket-1.1[] + +|=== diff --git a/modules/reference/pages/feature/springBoot-2.0/description.adoc b/modules/reference/pages/feature/springBoot-2.0/description.adoc new file mode 100644 index 0000000000..c7cfb19281 --- /dev/null +++ b/modules/reference/pages/feature/springBoot-2.0/description.adoc @@ -0,0 +1,22 @@ +link:https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters[Spring Boot Starters] are a set of convenient dependency descriptors provided by the Spring Boot that you can include in your application. When you use these starters with a Spring Boot application that is deployed on Open Liberty, you might need to enable features beyond the Spring Boot Support feature. The following table lists the Open Liberty features that are required to support certain Spring Boot 2.0 starters. + +.Open Liberty features that support Spring Boot 2.0 starters +[%header,cols=2*] +|=== + +|Spring Boot Starter +|Open Liberty features + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter/2.0.0.RELEASE/spring-boot-starter-2.0.0.RELEASE.pom[spring-boot-starter] +|`springBoot-2.0` + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-web/1.5.0.RELEASE/spring-boot-starter-web-1.5.0.RELEASE.pom[spring-boot-starter-web] +|`springBoot-2.0` and feature:servlet-3.1[], featureservlet-4.0[], or featurejsp-2.3[] + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-websocket/1.5.0.RELEASE/spring-boot-starter-websocket-1.5.0.RELEASE.pom[spring-boot-starter-websocket] +|`springBoot-2.0` and feature:websocket-1.0[] or feature:websocket-1.1[] + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-webflux/2.0.1.RELEASE/spring-boot-starter-webflux-2.0.1.RELEASE.pom[spring-boot-starter-webflux] +|`springBoot-2.0` and `servlet-3.1`, `servlet-4.0`, or `jsp-2.3` + +|=== diff --git a/modules/reference/pages/feature/springBoot-3.0/description.adoc b/modules/reference/pages/feature/springBoot-3.0/description.adoc new file mode 100644 index 0000000000..f7786fd625 --- /dev/null +++ b/modules/reference/pages/feature/springBoot-3.0/description.adoc @@ -0,0 +1,22 @@ +link:https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters[Spring Boot Starters] are a set of convenient dependency descriptors provided by the Spring Boot that you can include in your application. When you use these starters with a Spring Boot application that is deployed on Open Liberty, you might need to enable features beyond the Spring Boot Support feature. The following table lists the Open Liberty features that are required to support certain Spring Boot 3.0 starters. + +.Open Liberty features that support Spring Boot 3.0 starters +[%header,cols=2*] +|=== + +|Spring Boot Starter +|Open Liberty features + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter/3.0.0/spring-boot-starter-3.0.0.pom[spring-boot-starter] +|`springBoot-3.0` + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-web/3.0.0/spring-boot-starter-web-3.0.0.pom[spring-boot-starter-web] +|`springBoot-3.0` and feature:servlet-6.0[], featureservlet-6.1[], or featurejsp-2.3[] + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-websocket/3.0.0/spring-boot-starter-websocket-3.0.0.pom[spring-boot-starter-websocket] +|`springBoot-3.0` and feature:websocket-2.0[] + +|link:https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-starter-webflux/3.0.0/spring-boot-starter-webflux-3.0.0.pom[spring-boot-starter-webflux] +|`springBoot-3.0` and feature:servlet-6.0[], featureservlet-6.1[], or featurejsp-2.3[] + +|===