diff --git a/README.adoc b/README.adoc index ab72f3a8..6f38d6d9 100644 --- a/README.adoc +++ b/README.adoc @@ -14,7 +14,7 @@ process persists beyond the life of the task for future reporting. == Requirements: -* Java 8 or Above +* Java 17 or Above == Build Main Project: @@ -56,4 +56,4 @@ This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code == Building the Project This project requires that you invoke the Javadoc engine from the Maven command line. You can do so by appending `javadoc:aggregate` to the rest of your Maven command. -For example, to build the entire project, you could use `./mvnw -Pfull javadoc:aggregate`. +For example, to build the entire project, you could use `mvn clean install -DskipTests -P docs`. diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 5a980bef..2cb3623d 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -7,7 +7,7 @@ process persists beyond the life of the task for future reporting. == Requirements: -* Java 8 or Above +* Java 17 or Above == Build Main Project: @@ -49,4 +49,4 @@ This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code == Building the Project This project requires that you invoke the Javadoc engine from the Maven command line. You can do so by appending `javadoc:aggregate` to the rest of your Maven command. -For example, to build the entire project, you could use `./mvnw -Pfull javadoc:aggregate`. +For example, to build the entire project, you could use `mvn clean install -DskipTests -P docs`. diff --git a/docs/src/main/asciidoc/appendix-building-the-documentation.adoc b/docs/src/main/asciidoc/appendix-building-the-documentation.adoc index 55cb1f89..1103edaf 100644 --- a/docs/src/main/asciidoc/appendix-building-the-documentation.adoc +++ b/docs/src/main/asciidoc/appendix-building-the-documentation.adoc @@ -3,4 +3,4 @@ == Building This Documentation This project uses Maven to generate this documentation. To generate it for yourself, -run the following command: `$ ./mvnw clean package -P full`. +run the following command: `$ mvn clean install -DskipTests -P docs`. diff --git a/docs/src/main/asciidoc/appendix-cloud-foundry.adoc b/docs/src/main/asciidoc/appendix-cloud-foundry.adoc deleted file mode 100644 index a8b3971b..00000000 --- a/docs/src/main/asciidoc/appendix-cloud-foundry.adoc +++ /dev/null @@ -1,12 +0,0 @@ - -[[appendix-cloud-foundry]] -== Running a Task App on Cloud Foundry - -The simplest way to launch a Spring Cloud Task application as a task on Cloud Foundry -is to use Spring Cloud Data Flow. Via Spring Cloud Data Flow you can register your task application, -create a definition for it and then launch it. You then can track the task execution(s) -via a RESTful API, the Spring Cloud Data Flow Shell, or the UI. To learn out to get started installing Data Flow -follow the instructions in the -https://docs.spring.io/spring-cloud-dataflow/docs/current/reference/htmlsingle/#getting-started[Getting Started] -section of the reference documentation. For info on how to register and launch tasks, see the https://docs.spring.io/spring-cloud-dataflow/docs/current/reference/htmlsingle/#_the_lifecycle_of_a_task[Lifecycle of a Task] documentation. - diff --git a/docs/src/main/asciidoc/appendix.adoc b/docs/src/main/asciidoc/appendix.adoc index 3d0ac9d9..34185ba3 100644 --- a/docs/src/main/asciidoc/appendix.adoc +++ b/docs/src/main/asciidoc/appendix.adoc @@ -4,4 +4,3 @@ include::appendix-task-repository-schema.adoc[] include::appendix-building-the-documentation.adoc[] -include::appendix-cloud-foundry.adoc[] diff --git a/docs/src/main/asciidoc/batch-starter.adoc b/docs/src/main/asciidoc/batch-starter.adoc index 4f1e2016..570d9c53 100644 --- a/docs/src/main/asciidoc/batch-starter.adoc +++ b/docs/src/main/asciidoc/batch-starter.adoc @@ -296,7 +296,7 @@ Ingesting a partition of data from a Kafka topic is useful and exactly what the `KafkaItemReader` can do. To configure a `KafkaItemReader`, two pieces of configuration are required. First, configuring Kafka with Spring Boot's Kafka autoconfiguration is required (see the -https://docs.spring.io/spring-boot/docs/2.4.x/reference/htmlsingle/#boot-features-kafka[Spring Boot Kafka documentation]). +https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.kafka.additional-properties[Spring Boot Kafka documentation]). Once you have configured the Kafka properties from Spring Boot, you can configure the `KafkaItemReader` itself by setting the following properties: @@ -512,7 +512,7 @@ See the https://docs.spring.io/spring-batch/docs/4.3.x/api/org/springframework/b To write step output to a Kafka topic, you need `KafkaItemWriter`. This starter provides autoconfiguration for a `KafkaItemWriter` by using facilities from two places. -The first is Spring Boot's Kafka autoconfiguration. (See the https://docs.spring.io/spring-boot/docs/2.4.x/reference/htmlsingle/#boot-features-kafka[Spring Boot Kafka documentation].) +The first is Spring Boot's Kafka autoconfiguration. (See the https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.kafka.additional-properties[Spring Boot Kafka documentation].) Second, this starter lets you configure two properties on the writer. .`KafkaItemWriter` Properties diff --git a/docs/src/main/asciidoc/batch.adoc b/docs/src/main/asciidoc/batch.adoc index 7b6a3833..f2b45f27 100644 --- a/docs/src/main/asciidoc/batch.adoc +++ b/docs/src/main/asciidoc/batch.adoc @@ -151,58 +151,6 @@ dependency for the Spring Cloud Kubernetes Deployer: the following regex pattern: `[a-z0-9]([-a-z0-9]*[a-z0-9])`. Otherwise, an exception is thrown. -=== Notes on Developing a Batch-partitioned Application for the Cloud Foundry Platform - -* When deploying partitioned apps on the Cloud Foundry platform, you must use the -following dependencies for the Spring Cloud Foundry Deployer: -+ -[source,xml] ----- - - org.springframework.cloud - spring-cloud-deployer-cloudfoundry - - - io.projectreactor - reactor-core - 3.1.5.RELEASE - - - io.projectreactor.ipc - reactor-netty - 0.7.5.RELEASE - ----- -* When configuring the partition handler, Cloud Foundry Deployment -environment variables need to be established so that the partition handler -can start the partitions. The following list shows the required environment -variables: -- `spring_cloud_deployer_cloudfoundry_url` -- `spring_cloud_deployer_cloudfoundry_org` -- `spring_cloud_deployer_cloudfoundry_space` -- `spring_cloud_deployer_cloudfoundry_domain` -- `spring_cloud_deployer_cloudfoundry_username` -- `spring_cloud_deployer_cloudfoundry_password` -- `spring_cloud_deployer_cloudfoundry_services` -- `spring_cloud_deployer_cloudfoundry_taskTimeout` - -An example set of deployment environment variables for a partitioned task that -uses a `mysql` database service might resemble the following: - -[source,bash] ----- -spring_cloud_deployer_cloudfoundry_url=https://api.local.pcfdev.io -spring_cloud_deployer_cloudfoundry_org=pcfdev-org -spring_cloud_deployer_cloudfoundry_space=pcfdev-space -spring_cloud_deployer_cloudfoundry_domain=local.pcfdev.io -spring_cloud_deployer_cloudfoundry_username=admin -spring_cloud_deployer_cloudfoundry_password=admin -spring_cloud_deployer_cloudfoundry_services=mysql -spring_cloud_deployer_cloudfoundry_taskTimeout=300 ----- - -NOTE: When using PCF-Dev, the following environment variable is also required: -`spring_cloud_deployer_cloudfoundry_skipSslValidation=true` [[batch-informational-messages]] == Batch Informational Messages diff --git a/spring-cloud-task-samples/batch-events/README.adoc b/spring-cloud-task-samples/batch-events/README.adoc index 924e9fe8..12f5e351 100644 --- a/spring-cloud-task-samples/batch-events/README.adoc +++ b/spring-cloud-task-samples/batch-events/README.adoc @@ -10,11 +10,11 @@ This is a task application that emits batch job events to the following channels * item-write-events * skip-events -Note: More information on this topic is available https://docs.spring.io/spring-cloud-task/current-SNAPSHOT/reference/htmlsingle/#stream-integration-batch-events[here]. +Note: More information on this topic is available https://docs.spring.io/spring-cloud-task/docs/current/reference/html/#stream-integration-batch-events[here]. == Requirements: -* Java 8 or Above +* Java 17 or Above == Build: @@ -27,15 +27,15 @@ $ ./mvnw clean install [source,shell,indent=2] ---- -$ java -jar target/batch-events-1.2.1.RELEASE.jar +$ java -jar target/batch-events-3.0.0.jar ---- -For example you can listen for specific job execution events on a specified channel with a Spring Cloud Stream Sink -like the log sink using the following: +For example you can listen for specific job execution events on a specified channel with a Spring Cloud Stream Sink +like the https://github.com/spring-cloud/stream-applications/tree/main/applications/sink/log-sink[log sink] using the following: [source,shell,indent=2] ---- -$ java -jar /log-sink-rabbit-1.0.2.RELEASE.jar --server.port=9090 +$ java -jar /log-sink-rabbit-3.1.1.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=job-execution-events ---- diff --git a/spring-cloud-task-samples/batch-job/README.adoc b/spring-cloud-task-samples/batch-job/README.adoc index b09ed5be..0a0f9350 100644 --- a/spring-cloud-task-samples/batch-job/README.adoc +++ b/spring-cloud-task-samples/batch-job/README.adoc @@ -4,7 +4,7 @@ This is a Spring Cloud Task application that executes two simple Spring Batch Jo == Requirements: -* Java 8 or Above +* Java 17 or Above == Classes: @@ -22,5 +22,5 @@ $ mvn clean package [source,shell,indent=2] ---- -$ java -jar target/batch-job-1.2.1.RELEASE.jar +$ java -jar target/batch-job-3.0.0.jar ---- diff --git a/spring-cloud-task-samples/jpa-sample/README.adoc b/spring-cloud-task-samples/jpa-sample/README.adoc index cfda1572..493496dd 100644 --- a/spring-cloud-task-samples/jpa-sample/README.adoc +++ b/spring-cloud-task-samples/jpa-sample/README.adoc @@ -5,7 +5,7 @@ a data store. == Requirements: -* Java 8 or Above +* Java 17 or Above == Classes: @@ -24,5 +24,5 @@ $ mvn clean package [source,shell,indent=2] ---- -$ java -jar target/jpa-sample-1.2.1.RELEASE.jar +$ java -jar target/jpa-sample-3.0.0.jar ---- diff --git a/spring-cloud-task-samples/multiple-datasources/README.adoc b/spring-cloud-task-samples/multiple-datasources/README.adoc index 65d1b5f0..986735ef 100644 --- a/spring-cloud-task-samples/multiple-datasources/README.adoc +++ b/spring-cloud-task-samples/multiple-datasources/README.adoc @@ -5,7 +5,7 @@ which one to be used for the Spring Cloud Task repository. == Requirements: -* Java 8 or Above +* Java 17 or Above == Classes: @@ -27,7 +27,7 @@ $ mvn clean package [source,shell,indent=2] ---- -$ java -jar target/multiple-datasources-2.3.0-RELEASE.jar +$ java -jar target/multiple-datasources-3.0.0.jar ---- == Execute sample using 2 external databases: diff --git a/spring-cloud-task-samples/partitioned-batch-job/README.adoc b/spring-cloud-task-samples/partitioned-batch-job/README.adoc index f8b1257a..306afbc1 100644 --- a/spring-cloud-task-samples/partitioned-batch-job/README.adoc +++ b/spring-cloud-task-samples/partitioned-batch-job/README.adoc @@ -5,7 +5,7 @@ An example of the usage of the `DeployerPartitionHandler` and == Requirements: -* Java 7 or Above +* Java 17 or Above == Build: @@ -19,7 +19,7 @@ $ ./mvnw clean install [source,shell,indent=2] ---- $ export SPRING_APPLICATION_JSON='{"spring":{"datasource":{"url":"jdbc:mysql://localhost:3306/","username":"","password":"","driverClassName":"org.mariadb.jdbc.Driver"}}}' -$ java -jar target/partitioned-batch-job-1.2.1.RELEASE.jar +$ java -jar target/partitioned-batch-job-3.0.0.jar ---- NOTE: This example will use require a MySql RDBMS repository and currently uses the mariadb jdbc driver to connect. diff --git a/spring-cloud-task-samples/single-step-batch-job/README.adoc b/spring-cloud-task-samples/single-step-batch-job/README.adoc index 5bf38170..6bf91cd9 100644 --- a/spring-cloud-task-samples/single-step-batch-job/README.adoc +++ b/spring-cloud-task-samples/single-step-batch-job/README.adoc @@ -15,7 +15,7 @@ The profiles that are available are: == Requirements: -* Java 8 or Above +* Java 17 or Above == Classes: @@ -32,7 +32,7 @@ $ mvn clean package [source,shell,indent=2] ---- -$ java -jar target/single-step-batch-job-2.3.0-SNAPSHOT.jar --spring.config.name= +$ java -jar target/single-step-batch-job-3.0.0-SNAPSHOT.jar --spring.config.name= ---- == Examples diff --git a/spring-cloud-task-samples/task-events/README.adoc b/spring-cloud-task-samples/task-events/README.adoc index c0cf7947..8c31c879 100644 --- a/spring-cloud-task-samples/task-events/README.adoc +++ b/spring-cloud-task-samples/task-events/README.adoc @@ -4,7 +4,7 @@ This is a task application that emits events on a channel named `task-events` == Requirements: -* Java 8 or Above +* Java 17 or Above == Build: @@ -17,15 +17,15 @@ $ ./mvnw clean install [source,shell,indent=2] ---- -$ java -jar target/task-events-1.2.1.RELEASE.jar +$ java -jar target/task-events-3.0.0.RELEASE.jar ---- You can listen for the events on the task-events channel with a Spring Cloud Stream Sink -like the log sink using the following: +like the https://github.com/spring-cloud/stream-applications/tree/main/applications/sink/log-sink[log sink] using the following: [source,shell,indent=2] ---- -$ java -jar /log-sink-rabbit-1.0.2.RELEASE.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=task-events +$ java -jar /log-sink-rabbit-3.1.1.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=task-events ---- == Dependencies: diff --git a/spring-cloud-task-samples/taskprocessor/README.adoc b/spring-cloud-task-samples/taskprocessor/README.adoc index 4f9cdfa0..f2941fea 100644 --- a/spring-cloud-task-samples/taskprocessor/README.adoc +++ b/spring-cloud-task-samples/taskprocessor/README.adoc @@ -28,7 +28,7 @@ $ ./mvnw clean install == Requirements: -* Java 7 or Above +* Java 17 or Above == Build: diff --git a/spring-cloud-task-samples/tasksink/README.adoc b/spring-cloud-task-samples/tasksink/README.adoc index 3622c33a..298dd77b 100644 --- a/spring-cloud-task-samples/tasksink/README.adoc +++ b/spring-cloud-task-samples/tasksink/README.adoc @@ -5,7 +5,7 @@ launch the task that was specified in the request. == Requirements: -* Java 7 or Above +* Java 17 or Above == Build: diff --git a/spring-cloud-task-samples/timestamp/README.adoc b/spring-cloud-task-samples/timestamp/README.adoc index 57d18c11..200d396d 100644 --- a/spring-cloud-task-samples/timestamp/README.adoc +++ b/spring-cloud-task-samples/timestamp/README.adoc @@ -4,7 +4,7 @@ This is a Spring Cloud Task application that logs a timestamp. == Requirements: -* Java 8 or Above +* Java 17 or Above == Classes: @@ -22,5 +22,5 @@ $ mvn clean package [source,shell,indent=2] ---- -$ java -jar target/timestamp-task-1.1.0.RELEASE.jar +$ java -jar target/timestamp-task-3.0.0.jar ----