Insert explicit ids for headers

This commit is contained in:
Marcin Grzejszczak
2023-09-08 16:32:25 +02:00
parent 4f97031060
commit f54bda8221
10 changed files with 21 additions and 1 deletions

View File

@@ -1,3 +1,4 @@
[[spring-cloud-task]]
= Spring Cloud Task
Is a project centered around the idea of processing on demand. A user is able to develop
@@ -5,10 +6,12 @@ a “task” that can be deployed, executed and removed on demand, yet the resul
process persists beyond the life of the task for future reporting.
[[requirements:]]
== Requirements:
* Java 17 or Above
[[build-main-project:]]
== Build Main Project:
[source,shell,indent=2]
@@ -16,6 +19,7 @@ process persists beyond the life of the task for future reporting.
$ ./mvnw clean install
----
[[example:]]
== Example:
[source,java,indent=2]
@@ -43,9 +47,11 @@ public class MyApp {
}
----
[[code-of-conduct]]
== Code of Conduct
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
[[building-the-project]]
== 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.

View File

@@ -41,4 +41,4 @@
|spring.cloud.task.single-instance-lock-ttl | | Declares the maximum amount of time (in millis) that a task execution can hold a lock to prevent another task from executing with a specific task name when the single-instance-enabled is set to true. Default time is: Integer.MAX_VALUE.
|spring.cloud.task.table-prefix | `+++TASK_+++` | The prefix to append to the table names created by Spring Cloud Task.
|===
|===

View File

@@ -8,6 +8,7 @@ This appendix provides an ERD for the database schema used in the task repositor
image::task_schema.png[]
[[table-information]]
=== Table Information
--
@@ -84,6 +85,7 @@ Used for the `single-instance-enabled` feature discussed <<features-single-insta
NOTE: The DDL for setting up tables for each database type can be found https://github.com/spring-cloud/spring-cloud-task/tree/master/spring-cloud-task-core/src/main/resources/org/springframework/cloud/task[here].
--
[[sql-server]]
=== SQL Server
By default Spring Cloud Task uses a sequence table for determining the `TASK_EXECUTION_ID` for the `TASK_EXECUTION` table.
However, when launching multiple tasks simultaneously while using SQL Server, this can cause a deadlock to occur on the `TASK_SEQ` table.

View File

@@ -625,6 +625,7 @@ Second, this starter lets you configure two properties on the writer.
For more about the configuration options for the `KafkaItemWriter`, see the https://docs.spring.io/spring-batch/docs/4.3.x/api/org/springframework/batch/item/kafka/KafkaItemWriter.html[`KafkaItemWiter` documentation].
[[spring-aot]]
=== Spring AOT
When using Spring AOT with Single Step Batch Starter you must set the reader and
writer name properties at compile time (unless you create a bean(s) for the reader and or writer).

View File

@@ -135,6 +135,7 @@ NOTE: You can find a sample remote partition application in the samples module o
Spring Cloud Task project,
https://github.com/spring-cloud/spring-cloud-task/tree/master/spring-cloud-task-samples/partitioned-batch-job[here].
[[asynchronously-launch-remote-batch-partitions]]
=== Asynchronously launch remote batch partitions
By default batch partitions are launched sequentially. However, in some cases this may affect performance as each launch will block until the resource (For example: provisioning a pod in Kubernetes) is provisioned.
@@ -169,6 +170,7 @@ For example:
NOTE: We need to close the context since the use of `ThreadPoolTaskExecutor` leaves a thread active thus the app will not terminate. To close the application appropriately, we will need to set `spring.cloud.task.closecontextEnabled` property to `true`.
[[notes-on-developing-a-batch-partitioned-application-for-the-kubernetes-platform]]
=== Notes on Developing a Batch-partitioned application for the Kubernetes Platform
* When deploying partitioned apps on the Kubernetes platform, you must use the following

View File

@@ -372,6 +372,7 @@ application:
NOTE: The exit code for the application will be 1 if the task fails because this feature
is enabled and another task is running with the same task name.
[[single-instance-usage-for-spring-aot-and-native-compilation]]
==== Single Instance Usage for Spring AOT And Native Compilation
To use Spring Cloud Task's single-instance feature when creating a natively compiled app, you need to enable the feature at build time.
To do so, add the process-aot execution and set `spring.cloud.task.single-step-instance-enabled=true` as a JVM argument, as follows:
@@ -394,6 +395,7 @@ To do so, add the process-aot execution and set `spring.cloud.task.single-step-i
</executions>
</plugin>
[[enabling-observations-for-applicationrunner-and-commandlinerunner]]
=== Enabling Observations for ApplicationRunner and CommandLineRunner
@@ -401,6 +403,7 @@ To Enable Task Observations for `ApplicationRunner` or `CommandLineRunner` set `
An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-observations[here].
[[disabling-spring-cloud-task-auto-configuration]]
=== Disabling Spring Cloud Task Auto Configuration
In cases where Spring Cloud Task should not be autoconfigured for an implementation, you can disable Task's auto configuration.

View File

@@ -23,6 +23,7 @@ environment.
You need to have Java installed (Java 17 or better). To build, you need to have Maven
installed as well.
[[database-requirements]]
=== Database Requirements
Spring Cloud Task uses a relational database to store the results of an executed task.

View File

@@ -7,6 +7,7 @@ This section provides a brief overview of the Spring Cloud Task reference docume
Think of it as a map for the rest of the document. You can read this reference guide in a
linear fashion or you can skip sections if something does not interest you.
[[about-the-documentation]]
== About the documentation
The Spring Cloud Task reference guide is available in {spring-cloud-task-docs}[html]
and {spring-cloud-task-docs}/index.pdf[pdf]. The latest copy is available at

View File

@@ -1,3 +1,4 @@
[[spring-cloud-task-reference-guide]]
= Spring Cloud Task Reference Guide
Michael Minella, Glenn Renfro, Jay Bryant

View File

@@ -162,6 +162,7 @@ NOTE: A sample batch event application can be found in the samples module
of the Spring Cloud Task Project,
https://github.com/spring-cloud/spring-cloud-task/tree/master/spring-cloud-task-samples/batch-events[here].
[[sending-batch-events-to-different-channels]]
=== Sending Batch Events to Different Channels
One of the options that Spring Cloud Task offers for batch events is the ability to alter
@@ -174,6 +175,7 @@ following configuration:
`spring.cloud.task.batch.events.step-execution-events-binding-name=my-step-execution-events`
[[disabling-batch-events]]
=== Disabling Batch Events
To disable the listener functionality for all batch events, use the following
configuration:
@@ -197,6 +199,7 @@ spring.cloud.task.batch.events.item-write.enabled=false
spring.cloud.task.batch.events.skip.enabled=false
----
[[emit-order-for-batch-events]]
=== Emit Order for Batch Events
By default, batch events have `Ordered.LOWEST_PRECEDENCE`. To change this value (for
example, to 5 ), use the following configuration: