diff --git a/spring-cloud-task-docs/src/main/asciidoc/batch.adoc b/spring-cloud-task-docs/src/main/asciidoc/batch.adoc index 34430944..dda67393 100644 --- a/spring-cloud-task-docs/src/main/asciidoc/batch.adoc +++ b/spring-cloud-task-docs/src/main/asciidoc/batch.adoc @@ -44,6 +44,10 @@ public TaskBatchExecutionListenerBeanPostProcessor batchTaskExecutionListenerBea return postProcessor; } ``` +NOTE: A sample batch 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-job[here]. + [[batch-partitioning]] == Remote Partitioning @@ -92,6 +96,9 @@ public PartitionHandler partitionHandler(TaskLauncher taskLauncher, return partitionHandler; } ``` +NOTE: When passing environment variables to partitions, each partition may + be on a different machine with a different environment settings. + So only pass those that are required. The `Resource` to be executed is expected to be a Spring Boot über-jar with a `DeployerStepExecutionHandler` configured as a `CommandLineRunner` in the current context. @@ -111,6 +118,9 @@ public DeployerStepExecutionHandler stepExecutionHandler(JobExplorer jobExplorer return handler; } ``` +NOTE: A sample remote partition 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/partitioned-batch-job[here]. === Notes on developing a batch partitioned app for the Yarn platform @@ -140,6 +150,12 @@ Spring Cloud Yarn Deployer (with a version 1.0.2 or higher): * When setting up environment variables for the partitions in the PartitionHandler it is recommended that you do not copy the current working environment properties. +=== Notes on developing a batch partitioned app for the Kubernetes platform + +Application name for the task application and its partitions need to follow +the following regex pattern `[a-z0-9]([-a-z0-9]*[a-z0-9])`. +Else an exception will be thrown. + [[batch-informational-messages]] == Batch Informational Messages diff --git a/spring-cloud-task-docs/src/main/asciidoc/getting-started.adoc b/spring-cloud-task-docs/src/main/asciidoc/getting-started.adoc index 68957e83..5f640c08 100644 --- a/spring-cloud-task-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-cloud-task-docs/src/main/asciidoc/getting-started.adoc @@ -286,3 +286,8 @@ If you notice, there are three lines of interest in the above output: * The execution of our `CommandLineRunner`, demonstrated by the "Hello World!" output. * `SimpleTaskRepository` logging the completion of the task in the `TaskRepository`. +NOTE: A simple task 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/timestamp[here]. + + diff --git a/spring-cloud-task-docs/src/main/asciidoc/stream.adoc b/spring-cloud-task-docs/src/main/asciidoc/stream.adoc index a9c4abe7..2c0e8f85 100644 --- a/spring-cloud-task-docs/src/main/asciidoc/stream.adoc +++ b/spring-cloud-task-docs/src/main/asciidoc/stream.adoc @@ -112,6 +112,10 @@ or sink downstream does not have the spring-cloud-task-core jar on its classpath NOTE: A binder implementation is also required to be on the classpath. +NOTE: A sample task 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/task-events[here]. + [[stream-integration-disable-task-events]] === Disabling Specific Task Events @@ -151,6 +155,10 @@ spring.cloud.stream.bindings.input.destination=job-execution-events NOTE: A binder implementation is also required to be on the classpath. +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 One of the options that Spring Cloud Task offers for batch events is the ability to alter the channel to which a diff --git a/spring-cloud-task-docs/src/main/docbook/images/task_schema.png b/spring-cloud-task-docs/src/main/docbook/images/task_schema.png index 11f14fba..8d7a5732 100644 Binary files a/spring-cloud-task-docs/src/main/docbook/images/task_schema.png and b/spring-cloud-task-docs/src/main/docbook/images/task_schema.png differ