Updating documentation for 3.x release
Updated versions and links in docs * Set the baseline to Java 17 * Update links resolves #814
This commit is contained in:
@@ -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`.
|
||||
|
||||
@@ -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`.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -4,4 +4,3 @@
|
||||
|
||||
include::appendix-task-repository-schema.adoc[]
|
||||
include::appendix-building-the-documentation.adoc[]
|
||||
include::appendix-cloud-foundry.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
|
||||
|
||||
@@ -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]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-deployer-cloudfoundry</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.projectreactor</groupId>
|
||||
<artifactId>reactor-core</artifactId>
|
||||
<version>3.1.5.RELEASE</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.projectreactor.ipc</groupId>
|
||||
<artifactId>reactor-netty</artifactId>
|
||||
<version>0.7.5.RELEASE</version>
|
||||
</dependency>
|
||||
----
|
||||
* 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
|
||||
|
||||
Reference in New Issue
Block a user