Skip to content

Commit

Permalink
Update appendix and documentation.
Browse files Browse the repository at this point in the history
Update package scripts.
  • Loading branch information
corneil committed Aug 15, 2023
1 parent 37d1aae commit b741275
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 30 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build-snapshot-worker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ jobs:
# build and publish to configured target
- name: Build and Publish
run: |
jfrog rt mvn clean install -Pfull -B $MAVEN_THREADS
./spring-cloud-dataflow-package/build-package.sh jfrog
./spring-cloud-dataflow-package/set-package-version.sh
jfrog rt mvn clean install -Pfull -B $MAVEN_THREADS
jfrog rt build-publish
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) >> $GITHUB_ENV
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_buildname=spring-cloud-dataflow-main >> $GITHUB_ENV
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ jobs:
# build and publish
- name: Build and Publish
run: |
mvn clean
jfrog rt mvn install -Pfull,asciidoctordocs,restdocs -B $MAVEN_THREADS
./spring-cloud-dataflow-package/build-package.sh jfrog
mvn clean
./spring-cloud-dataflow-package/set-package-version.sh
jfrog rt mvn install -Pfull,asciidoctordocs,restdocs -B $MAVEN_THREADS
jfrog rt build-publish
- name: Capture Test Results
if: ${{ always() }}
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/github-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ jobs:
--draft \
--title "Spring Cloud Data Flow $BUILD_ZOO_HANDLER_spring_cloud_dataflow_version" \
--notes-file $RELEASE_NOTES_FILE
# TODO retrieve spring-cloud-dataflow-package and upload to
# zoo success
- name: Notify Build Success Zoo Handler Controller
uses: jvalkeal/[email protected]
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/milestone-worker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ jobs:
-DnewVersion=${BUILD_ZOO_HANDLER_spring_cloud_dataflow_ui_version} \
-B
jfrog rt build-clean
./spring-cloud-dataflow-package/set-package-version.sh
jfrog rt mvn clean install \
-gs .github/settings.xml \
-P-spring,stagingmilestone,full,deploymentfiles \
./spring-cloud-dataflow-package/build-package.sh jfrog
-P-spring,stagingmilestone,full,deploymentfiles \
-DskipTests -B $MAVEN_THREADS
jfrog rt build-publish
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_version=$(mvn -gs .github/settings.xml -Pstagingmilestone help:evaluate -Dexpression=project.version -q -DforceStdout) >> $GITHUB_ENV
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/next-dev-version-worker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ jobs:
-DnewVersion=${BUILD_ZOO_HANDLER_spring_cloud_dataflow_ui_version} \
-B
jfrog rt build-clean
jfrog rt mvn clean install -DskipTests -B $MAVEN_THREADS
./spring-cloud-dataflow-package/build-package.sh jfrog
./spring-cloud-dataflow-package/set-package-version.sh
jfrog rt mvn clean install -DskipTests -B $MAVEN_THREADS
jfrog rt build-publish
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_buildname=spring-cloud-dataflow-main-ndv >> $GITHUB_ENV
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_buildnumber=$GITHUB_RUN_NUMBER >> $GITHUB_ENV
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-worker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,11 @@ jobs:
-DnewVersion=${BUILD_ZOO_HANDLER_spring_cloud_dataflow_ui_version} \
-B
jfrog rt build-clean
./spring-cloud-dataflow-package/set-package-version.sh
jfrog rt mvn clean install \
-gs .github/settings.xml \
-Pstagingrelease,full,deploymentfiles \
-DskipTests -B $MAVEN_THREADS
./spring-cloud-dataflow-package/build-package.sh jfrog
jfrog rt build-publish
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_buildname=spring-cloud-dataflow-main-release >> $GITHUB_ENV
echo BUILD_ZOO_HANDLER_spring_cloud_dataflow_buildnumber=$GITHUB_RUN_NUMBER >> $GITHUB_ENV
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
<module>spring-cloud-dataflow-dependencies</module>
<module>spring-cloud-dataflow-classic-docs</module>
<module>spring-cloud-dataflow-docs</module>
<module>spring-cloud-dataflow-package</module>
</modules>
<build>
<plugins>
Expand Down
1 change: 1 addition & 0 deletions spring-cloud-dataflow-docs/src/main/asciidoc/appendix.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ Having trouble with Spring Cloud Data Flow, We'd like to help!
include::appendix-dataflow-template.adoc[]
include::appendix-howto.adoc[]
include::appendix-identity-providers.adoc[]
include::spring-boot-3x.adoc[]
// include::appendix-development-tasks.adoc[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[[getting-started]]
= Getting Started

NOTE: This version of Spring Cloud Data Flow provides: <<appendix-boot3>>

include::getting-started-local.adoc[]
include::getting-started-cloudfoundry.adoc[]
include::getting-started-kubernetes.adoc[]
6 changes: 3 additions & 3 deletions spring-cloud-dataflow-docs/src/main/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinat
:github-repo: spring-cloud/spring-cloud-dataflow
:github-code: https://github.com/{github-repo}
:microsite-version: master
:spring-boot-version: 2.7.6
:spring-cloud-task-version: 2.4.5
:spring-batch-version: 4.3.7
:spring-boot-version: 2.7.14
:spring-cloud-task-version: 2.4.6
:spring-batch-version: 4.3.8
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/htmlsingle
:scs-stream-apps-docs: https://docs.spring.io/stream-applications/docs/current/reference/html
:dataflow-asciidoc-images: https://raw.githubusercontent.com/spring-cloud/spring-cloud-dataflow/main/spring-cloud-dataflow-docs/src/main/asciidoc/images
Expand Down
3 changes: 2 additions & 1 deletion spring-cloud-dataflow-docs/src/main/asciidoc/preface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Having trouble with Spring Cloud Data Flow? We would like to help!

* Ask a question. We monitor https://stackoverflow.com[stackoverflow.com] for questions
tagged with https://stackoverflow.com/tags/spring-cloud-dataflow[`spring-cloud-dataflow`].
* Report bugs with Spring Cloud Data Flow at https://github.com/spring-cloud/spring-cloud-dataflow/issues.
* Report bugs with Spring Cloud Data Flow at https://github.com/{github-repo}/issues.
* Review the latest release notes at https://github.com/{github-repo}/releases.

NOTE: All of Spring Cloud Data Flow is open source, including the documentation! If you find problems
with the docs or if you just want to improve them, please {github-code}[get involved].
22 changes: 16 additions & 6 deletions spring-cloud-dataflow-docs/src/main/asciidoc/spring-boot-3x.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
= Spring Boot 3.x Support
[appendix]
[[appendix-boot3]]
== Spring Boot 3.x Support

== Stream Applications
=== Stream Applications
Spring Cloud Data Flow supports both Spring Boot `2.x` and `3.x` based Stream applications.

=== Differences in 3.x
==== Differences in 3.x
Be aware of the following areas that have changed across versions.

==== Metrics Configuration Properties
===== Metrics Configuration Properties
IMPORTANT: The following does **NOT** apply when configuring metrics for the Dataflow or Skipper server as they both run on Spring Boot 2.x. It is only applicable to applications managed by Dataflow.

The naming of the metrics registry-specific properties differ as follows:
Expand All @@ -28,10 +30,18 @@ This replication has been updated to target both the `2.x` and `3.x` expected fo
In other words, if your `2.x` stream apps are currently inheriting the Dataflow metrics configuration, they will continue to do so for your `3.x` stream apps.


=== Pre-packaged Stream Applications
==== Pre-packaged Stream Applications
The default <<ootb-stream-apps,pre-packaged stream applications>> are based on Spring Boot `2.x`.
To use the latest pre-packaged apps based on Spring Boot `3.x`, you must manually register the apps by pointing to the `3.x` specific coordinates.
See the section on https://dataflow.spring.io/docs/applications/pre-packaged/[pre-packaged apps] in the Dataflow Microsite for details.


== Spring Cloud Task / Batch Applications
=== Spring Cloud Task / Batch Applications

The database schemas for Spring Cloud Task 3.x and Spring Batch 5.x have been modified in the versions that forms part of Spring Boot 3.x

Spring Cloud Data Flow will create set of tables for the Boot 3.x version that is prefixed by `BOOT3_` and will configure the `spring.cloud.task.tablePrefix` and `spring.batch.jdbc.table-prefix` with the correct values.

In order to know that the specific task is a Boot 3.x application the version will have to be provided as part of registration. The rest endpoints accepts a `bootVersion=3` parameter and the shell commands accepts `--bootVersion 3`

Since there are now multiple sets of tables that represents task and batch executions, each schema has been assigned a schemaTarget name. This value form part of queries when retrieving execution data. The UI takes care of this by using the embedded resource links. If you are using the REST API directly you will need to update those requests.
1 change: 0 additions & 1 deletion spring-cloud-dataflow-package/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
<relativePath>../spring-cloud-dataflow-parent</relativePath>
</parent>
<artifactId>spring-cloud-dataflow-package</artifactId>
<packaging>pom</packaging>
<properties>
<package.version>${project.version}</package.version>
<scdf.type.version>oss</scdf.type.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,9 @@ MVNW=$SCDIR/../mvnw
if [ "$PACKAGE_VERSION" = "" ]; then
PACKAGE_VERSION=$($MVNW help:evaluate -Dexpression=project.version -q -DforceStdout)
fi

if [[ "$1" == "jfrog" ]]; then
MVNW=jfrog rt mvn
fi
echo "PACKAGE_VERSION=$PACKAGE_VERSION"
if [[ "$PACKAGE_VERSION" != *"SNAPSHOT"* ]]; then
yq '.default.version="release"' -i "$SCDIR/../src/deploy/versions.yaml"
echo "Setting default.version=release"
yq ".default.package-version=\"$PACKAGE_VERSION\"" -i "$SCDIR/../src/deploy/versions.yaml"
fi
pushd "$SCDIR" || exit
$MVNW clean install -Dpackage.version="$PACKAGE_VERSION"
popd || exit
2 changes: 1 addition & 1 deletion spring-cloud-dataflow-package/src/main/assembly/zip.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<id>distribution</id>
<includeBaseDirectory>false</includeBaseDirectory>
<formats>
<format>tar.gz</format>
<format>zip</format>
</formats>
<fileSets>
<fileSet>
Expand Down
2 changes: 1 addition & 1 deletion src/deploy/k8s/deploy-scdf.sh
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ if [ "$K8S_DRIVER" != "tmc" ] && [ "$K8S_DRIVER" != "gke" ]; then
;;
"rabbit" | "rabbitmq")
# TODO get version from yaml spec.template.spec.containers[0].image
sh "$SCDIR/load-image.sh" "rabbitmq" "3.8"
sh "$SCDIR/load-image.sh" "rabbitmq" "3.8-management"
;;
*)
echo "BROKER=$BROKER not supported"
Expand Down

0 comments on commit b741275

Please sign in to comment.