WIP
This commit is contained in:
51
.mvn/wrapper/MavenWrapperDownloader.java
vendored
Executable file → Normal file
51
.mvn/wrapper/MavenWrapperDownloader.java
vendored
Executable file → Normal file
@@ -1,22 +1,18 @@
|
||||
/*
|
||||
Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
*/
|
||||
|
||||
* Copyright 2007-present the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
import java.net.*;
|
||||
import java.io.*;
|
||||
import java.nio.channels.*;
|
||||
@@ -24,11 +20,12 @@ import java.util.Properties;
|
||||
|
||||
public class MavenWrapperDownloader {
|
||||
|
||||
private static final String WRAPPER_VERSION = "0.5.6";
|
||||
/**
|
||||
* Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
|
||||
*/
|
||||
private static final String DEFAULT_DOWNLOAD_URL =
|
||||
"https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar";
|
||||
private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
|
||||
+ WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
|
||||
|
||||
/**
|
||||
* Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
|
||||
@@ -76,13 +73,13 @@ public class MavenWrapperDownloader {
|
||||
}
|
||||
}
|
||||
}
|
||||
System.out.println("- Downloading from: : " + url);
|
||||
System.out.println("- Downloading from: " + url);
|
||||
|
||||
File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
|
||||
if(!outputFile.getParentFile().exists()) {
|
||||
if(!outputFile.getParentFile().mkdirs()) {
|
||||
System.out.println(
|
||||
"- ERROR creating output direcrory '" + outputFile.getParentFile().getAbsolutePath() + "'");
|
||||
"- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
|
||||
}
|
||||
}
|
||||
System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
|
||||
@@ -98,6 +95,16 @@ public class MavenWrapperDownloader {
|
||||
}
|
||||
|
||||
private static void downloadFileFromURL(String urlString, File destination) throws Exception {
|
||||
if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
|
||||
String username = System.getenv("MVNW_USERNAME");
|
||||
char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
|
||||
Authenticator.setDefault(new Authenticator() {
|
||||
@Override
|
||||
protected PasswordAuthentication getPasswordAuthentication() {
|
||||
return new PasswordAuthentication(username, password);
|
||||
}
|
||||
});
|
||||
}
|
||||
URL website = new URL(urlString);
|
||||
ReadableByteChannel rbc;
|
||||
rbc = Channels.newChannel(website.openStream());
|
||||
|
||||
BIN
.mvn/wrapper/maven-wrapper.jar
vendored
Executable file → Normal file
BIN
.mvn/wrapper/maven-wrapper.jar
vendored
Executable file → Normal file
Binary file not shown.
3
.mvn/wrapper/maven-wrapper.properties
vendored
Executable file → Normal file
3
.mvn/wrapper/maven-wrapper.properties
vendored
Executable file → Normal file
@@ -1 +1,2 @@
|
||||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip
|
||||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
|
||||
wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
|
||||
|
||||
144
README.adoc
144
README.adoc
@@ -1,4 +1,9 @@
|
||||
// Do not edit this file (e.g. go instead to src/main/asciidoc)
|
||||
////
|
||||
DO NOT EDIT THIS FILE. IT WAS GENERATED.
|
||||
Manual changes to this file will be lost when it is generated again.
|
||||
Edit the files in the src/main/asciidoc/ directory instead.
|
||||
////
|
||||
|
||||
|
||||
Spring Cloud Release Train is a curated set of dependencies across a
|
||||
range of Spring Cloud projects. You consume it by using the
|
||||
@@ -10,6 +15,8 @@ stations ("Angel" is the first release, "Brixton" is the second).
|
||||
|
||||
== Contributing
|
||||
|
||||
:spring-cloud-build-branch: master
|
||||
|
||||
Spring Cloud is released under the non-restrictive Apache 2.0 license,
|
||||
and follows a very standard Github development process, using Github
|
||||
tracker for issues and merging pull requests into master. If you want
|
||||
@@ -55,6 +62,139 @@ added after the original pull request but before a merge.
|
||||
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
|
||||
message (where XXXX is the issue number).
|
||||
|
||||
=== Checkstyle
|
||||
|
||||
Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are:
|
||||
|
||||
.spring-cloud-build-tools/
|
||||
----
|
||||
└── src
|
||||
├── checkstyle
|
||||
│ └── checkstyle-suppressions.xml <3>
|
||||
└── main
|
||||
└── resources
|
||||
├── checkstyle-header.txt <2>
|
||||
└── checkstyle.xml <1>
|
||||
----
|
||||
<1> Default Checkstyle rules
|
||||
<2> File header setup
|
||||
<3> Default suppression rules
|
||||
|
||||
==== Checkstyle configuration
|
||||
|
||||
Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins.
|
||||
|
||||
.pom.xml
|
||||
----
|
||||
<properties>
|
||||
<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> <1>
|
||||
<maven-checkstyle-plugin.failsOnViolation>true
|
||||
</maven-checkstyle-plugin.failsOnViolation> <2>
|
||||
<maven-checkstyle-plugin.includeTestSourceDirectory>true
|
||||
</maven-checkstyle-plugin.includeTestSourceDirectory> <3>
|
||||
</properties>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin> <4>
|
||||
<groupId>io.spring.javaformat</groupId>
|
||||
<artifactId>spring-javaformat-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin> <5>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin> <5>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-checkstyle-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
</build>
|
||||
----
|
||||
<1> Fails the build upon Checkstyle errors
|
||||
<2> Fails the build upon Checkstyle violations
|
||||
<3> Checkstyle analyzes also the test sources
|
||||
<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
|
||||
<5> Add checkstyle plugin to your build and reporting phases
|
||||
|
||||
If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example:
|
||||
|
||||
.projectRoot/src/checkstyle/checkstyle-suppresions.xml
|
||||
----
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE suppressions PUBLIC
|
||||
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
||||
"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
||||
<suppressions>
|
||||
<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
|
||||
<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
|
||||
</suppressions>
|
||||
----
|
||||
|
||||
It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script:
|
||||
|
||||
```bash
|
||||
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
|
||||
$ touch .springformat
|
||||
```
|
||||
|
||||
=== IDE setup
|
||||
|
||||
==== Intellij IDEA
|
||||
|
||||
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
|
||||
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project.
|
||||
|
||||
.spring-cloud-build-tools/
|
||||
----
|
||||
└── src
|
||||
├── checkstyle
|
||||
│ └── checkstyle-suppressions.xml <3>
|
||||
└── main
|
||||
└── resources
|
||||
├── checkstyle-header.txt <2>
|
||||
├── checkstyle.xml <1>
|
||||
└── intellij
|
||||
├── Intellij_Project_Defaults.xml <4>
|
||||
└── Intellij_Spring_Boot_Java_Conventions.xml <5>
|
||||
----
|
||||
<1> Default Checkstyle rules
|
||||
<2> File header setup
|
||||
<3> Default suppression rules
|
||||
<4> Project defaults for Intellij that apply most of Checkstyle rules
|
||||
<5> Project style conventions for Intellij that apply most of Checkstyle rules
|
||||
|
||||
.Code style
|
||||
|
||||
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style]
|
||||
|
||||
Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file.
|
||||
|
||||
.Inspection profiles
|
||||
|
||||
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style]
|
||||
|
||||
Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file.
|
||||
|
||||
.Checkstyle
|
||||
|
||||
To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions
|
||||
|
||||
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle]
|
||||
|
||||
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
|
||||
|
||||
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
|
||||
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
|
||||
- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
|
||||
|
||||
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
|
||||
|
||||
== Building and Deploying
|
||||
|
||||
Since there is no code to compile in the starters they should do not need to compile, but a compiler has to be available because they are built and deployed as JAR artifacts. To install locally:
|
||||
@@ -82,4 +222,4 @@ and for Maven Central use
|
||||
$ mvn install -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2
|
||||
----
|
||||
|
||||
(the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent).
|
||||
(the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent).
|
||||
|
||||
23
docs/pom.xml
23
docs/pom.xml
@@ -2,46 +2,33 @@
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-starter-docs</artifactId>
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-starter-build</artifactId>
|
||||
<version>2020.0.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
<packaging>pom</packaging>
|
||||
<packaging>jar</packaging>
|
||||
<name>Spring Cloud Starter Docs</name>
|
||||
<description>Spring Cloud Docs</description>
|
||||
<properties>
|
||||
<docs.main>spring-cloud-starters</docs.main>
|
||||
<main.basedir>${basedir}/..</main.basedir>
|
||||
<docs.whitelisted.branches>Greenwich,Hoxton</docs.whitelisted.branches>
|
||||
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<artifactId>maven-deploy-plugin</artifactId>
|
||||
<configuration>
|
||||
<skip>true</skip>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>docs</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>pl.project13.maven</groupId>
|
||||
<artifactId>git-commit-id-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
@@ -53,12 +40,10 @@
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>build-helper-maven-plugin</artifactId>
|
||||
<artifactId>maven-deploy-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
36
mvnw
vendored
36
mvnw
vendored
@@ -8,7 +8,7 @@
|
||||
# "License"); you may not use this file except in compliance
|
||||
# with the License. You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing,
|
||||
# software distributed under the License is distributed on an
|
||||
@@ -19,7 +19,7 @@
|
||||
# ----------------------------------------------------------------------------
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# Maven2 Start Up Batch script
|
||||
# Maven Start Up Batch script
|
||||
#
|
||||
# Required ENV vars:
|
||||
# ------------------
|
||||
@@ -114,7 +114,6 @@ if $mingw ; then
|
||||
M2_HOME="`(cd "$M2_HOME"; pwd)`"
|
||||
[ -n "$JAVA_HOME" ] &&
|
||||
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
|
||||
# TODO classpath?
|
||||
fi
|
||||
|
||||
if [ -z "$JAVA_HOME" ]; then
|
||||
@@ -212,7 +211,11 @@ else
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
|
||||
fi
|
||||
jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"
|
||||
if [ -n "$MVNW_REPOURL" ]; then
|
||||
jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
else
|
||||
jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
fi
|
||||
while IFS="=" read key value; do
|
||||
case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
|
||||
esac
|
||||
@@ -221,22 +224,38 @@ else
|
||||
echo "Downloading from: $jarUrl"
|
||||
fi
|
||||
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
|
||||
if $cygwin; then
|
||||
wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
|
||||
fi
|
||||
|
||||
if command -v wget > /dev/null; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Found wget ... using wget"
|
||||
fi
|
||||
wget "$jarUrl" -O "$wrapperJarPath"
|
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
|
||||
wget "$jarUrl" -O "$wrapperJarPath"
|
||||
else
|
||||
wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
|
||||
fi
|
||||
elif command -v curl > /dev/null; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Found curl ... using curl"
|
||||
fi
|
||||
curl -o "$wrapperJarPath" "$jarUrl"
|
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
|
||||
curl -o "$wrapperJarPath" "$jarUrl" -f
|
||||
else
|
||||
curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
|
||||
fi
|
||||
|
||||
else
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Falling back to using Java to download"
|
||||
fi
|
||||
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
|
||||
# For Cygwin, switch paths to Windows format before running javac
|
||||
if $cygwin; then
|
||||
javaClass=`cygpath --path --windows "$javaClass"`
|
||||
fi
|
||||
if [ -e "$javaClass" ]; then
|
||||
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
@@ -277,6 +296,11 @@ if $cygwin; then
|
||||
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
|
||||
fi
|
||||
|
||||
# Provide a "standardized" way to retrieve the CLI args that will
|
||||
# work with both Windows and non-Windows executions.
|
||||
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
|
||||
export MAVEN_CMD_LINE_ARGS
|
||||
|
||||
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
|
||||
|
||||
exec "$JAVACMD" \
|
||||
|
||||
343
mvnw.cmd
vendored
Executable file → Normal file
343
mvnw.cmd
vendored
Executable file → Normal file
@@ -1,161 +1,182 @@
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Licensed to the Apache Software Foundation (ASF) under one
|
||||
@REM or more contributor license agreements. See the NOTICE file
|
||||
@REM distributed with this work for additional information
|
||||
@REM regarding copyright ownership. The ASF licenses this file
|
||||
@REM to you under the Apache License, Version 2.0 (the
|
||||
@REM "License"); you may not use this file except in compliance
|
||||
@REM with the License. You may obtain a copy of the License at
|
||||
@REM
|
||||
@REM https://www.apache.org/licenses/LICENSE-2.0
|
||||
@REM
|
||||
@REM Unless required by applicable law or agreed to in writing,
|
||||
@REM software distributed under the License is distributed on an
|
||||
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
@REM KIND, either express or implied. See the License for the
|
||||
@REM specific language governing permissions and limitations
|
||||
@REM under the License.
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Maven2 Start Up Batch script
|
||||
@REM
|
||||
@REM Required ENV vars:
|
||||
@REM JAVA_HOME - location of a JDK home dir
|
||||
@REM
|
||||
@REM Optional ENV vars
|
||||
@REM M2_HOME - location of maven2's installed home dir
|
||||
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
|
||||
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending
|
||||
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
|
||||
@REM e.g. to debug Maven itself, use
|
||||
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
|
||||
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
|
||||
@echo off
|
||||
@REM set title of command window
|
||||
title %0
|
||||
@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on'
|
||||
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
|
||||
|
||||
@REM set %HOME% to equivalent of $HOME
|
||||
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
|
||||
|
||||
@REM Execute a user defined script before this one
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
|
||||
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
|
||||
if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
|
||||
:skipRcPre
|
||||
|
||||
@setlocal
|
||||
|
||||
set ERROR_CODE=0
|
||||
|
||||
@REM To isolate internal variables from possible post scripts, we use another setlocal
|
||||
@setlocal
|
||||
|
||||
@REM ==== START VALIDATION ====
|
||||
if not "%JAVA_HOME%" == "" goto OkJHome
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME not found in your environment. >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
:OkJHome
|
||||
if exist "%JAVA_HOME%\bin\java.exe" goto init
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME is set to an invalid directory. >&2
|
||||
echo JAVA_HOME = "%JAVA_HOME%" >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
@REM ==== END VALIDATION ====
|
||||
|
||||
:init
|
||||
|
||||
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
|
||||
@REM Fallback to current working directory if not found.
|
||||
|
||||
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
|
||||
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
|
||||
|
||||
set EXEC_DIR=%CD%
|
||||
set WDIR=%EXEC_DIR%
|
||||
:findBaseDir
|
||||
IF EXIST "%WDIR%"\.mvn goto baseDirFound
|
||||
cd ..
|
||||
IF "%WDIR%"=="%CD%" goto baseDirNotFound
|
||||
set WDIR=%CD%
|
||||
goto findBaseDir
|
||||
|
||||
:baseDirFound
|
||||
set MAVEN_PROJECTBASEDIR=%WDIR%
|
||||
cd "%EXEC_DIR%"
|
||||
goto endDetectBaseDir
|
||||
|
||||
:baseDirNotFound
|
||||
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
|
||||
cd "%EXEC_DIR%"
|
||||
|
||||
:endDetectBaseDir
|
||||
|
||||
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
|
||||
|
||||
@setlocal EnableExtensions EnableDelayedExpansion
|
||||
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
|
||||
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
|
||||
|
||||
:endReadAdditionalConfig
|
||||
|
||||
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
|
||||
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
|
||||
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
|
||||
|
||||
set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar"
|
||||
FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO (
|
||||
IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
|
||||
)
|
||||
|
||||
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
|
||||
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
|
||||
if exist %WRAPPER_JAR% (
|
||||
echo Found %WRAPPER_JAR%
|
||||
) else (
|
||||
echo Couldn't find %WRAPPER_JAR%, downloading it ...
|
||||
echo Downloading from: %DOWNLOAD_URL%
|
||||
powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"
|
||||
echo Finished downloading %WRAPPER_JAR%
|
||||
)
|
||||
@REM End of extension
|
||||
|
||||
%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
|
||||
if ERRORLEVEL 1 goto error
|
||||
goto end
|
||||
|
||||
:error
|
||||
set ERROR_CODE=1
|
||||
|
||||
:end
|
||||
@endlocal & set ERROR_CODE=%ERROR_CODE%
|
||||
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
|
||||
@REM check for post script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
|
||||
if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
|
||||
:skipRcPost
|
||||
|
||||
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
|
||||
if "%MAVEN_BATCH_PAUSE%" == "on" pause
|
||||
|
||||
if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
|
||||
|
||||
exit /B %ERROR_CODE%
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Licensed to the Apache Software Foundation (ASF) under one
|
||||
@REM or more contributor license agreements. See the NOTICE file
|
||||
@REM distributed with this work for additional information
|
||||
@REM regarding copyright ownership. The ASF licenses this file
|
||||
@REM to you under the Apache License, Version 2.0 (the
|
||||
@REM "License"); you may not use this file except in compliance
|
||||
@REM with the License. You may obtain a copy of the License at
|
||||
@REM
|
||||
@REM http://www.apache.org/licenses/LICENSE-2.0
|
||||
@REM
|
||||
@REM Unless required by applicable law or agreed to in writing,
|
||||
@REM software distributed under the License is distributed on an
|
||||
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
@REM KIND, either express or implied. See the License for the
|
||||
@REM specific language governing permissions and limitations
|
||||
@REM under the License.
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Maven Start Up Batch script
|
||||
@REM
|
||||
@REM Required ENV vars:
|
||||
@REM JAVA_HOME - location of a JDK home dir
|
||||
@REM
|
||||
@REM Optional ENV vars
|
||||
@REM M2_HOME - location of maven2's installed home dir
|
||||
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
|
||||
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
|
||||
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
|
||||
@REM e.g. to debug Maven itself, use
|
||||
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
|
||||
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
|
||||
@echo off
|
||||
@REM set title of command window
|
||||
title %0
|
||||
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
|
||||
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
|
||||
|
||||
@REM set %HOME% to equivalent of $HOME
|
||||
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
|
||||
|
||||
@REM Execute a user defined script before this one
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
|
||||
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
|
||||
if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
|
||||
:skipRcPre
|
||||
|
||||
@setlocal
|
||||
|
||||
set ERROR_CODE=0
|
||||
|
||||
@REM To isolate internal variables from possible post scripts, we use another setlocal
|
||||
@setlocal
|
||||
|
||||
@REM ==== START VALIDATION ====
|
||||
if not "%JAVA_HOME%" == "" goto OkJHome
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME not found in your environment. >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
:OkJHome
|
||||
if exist "%JAVA_HOME%\bin\java.exe" goto init
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME is set to an invalid directory. >&2
|
||||
echo JAVA_HOME = "%JAVA_HOME%" >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
@REM ==== END VALIDATION ====
|
||||
|
||||
:init
|
||||
|
||||
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
|
||||
@REM Fallback to current working directory if not found.
|
||||
|
||||
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
|
||||
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
|
||||
|
||||
set EXEC_DIR=%CD%
|
||||
set WDIR=%EXEC_DIR%
|
||||
:findBaseDir
|
||||
IF EXIST "%WDIR%"\.mvn goto baseDirFound
|
||||
cd ..
|
||||
IF "%WDIR%"=="%CD%" goto baseDirNotFound
|
||||
set WDIR=%CD%
|
||||
goto findBaseDir
|
||||
|
||||
:baseDirFound
|
||||
set MAVEN_PROJECTBASEDIR=%WDIR%
|
||||
cd "%EXEC_DIR%"
|
||||
goto endDetectBaseDir
|
||||
|
||||
:baseDirNotFound
|
||||
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
|
||||
cd "%EXEC_DIR%"
|
||||
|
||||
:endDetectBaseDir
|
||||
|
||||
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
|
||||
|
||||
@setlocal EnableExtensions EnableDelayedExpansion
|
||||
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
|
||||
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
|
||||
|
||||
:endReadAdditionalConfig
|
||||
|
||||
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
|
||||
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
|
||||
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
|
||||
|
||||
set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
|
||||
FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
|
||||
IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
|
||||
)
|
||||
|
||||
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
|
||||
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
|
||||
if exist %WRAPPER_JAR% (
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Found %WRAPPER_JAR%
|
||||
)
|
||||
) else (
|
||||
if not "%MVNW_REPOURL%" == "" (
|
||||
SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
)
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Couldn't find %WRAPPER_JAR%, downloading it ...
|
||||
echo Downloading from: %DOWNLOAD_URL%
|
||||
)
|
||||
|
||||
powershell -Command "&{"^
|
||||
"$webclient = new-object System.Net.WebClient;"^
|
||||
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
|
||||
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
|
||||
"}"^
|
||||
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
|
||||
"}"
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Finished downloading %WRAPPER_JAR%
|
||||
)
|
||||
)
|
||||
@REM End of extension
|
||||
|
||||
@REM Provide a "standardized" way to retrieve the CLI args that will
|
||||
@REM work with both Windows and non-Windows executions.
|
||||
set MAVEN_CMD_LINE_ARGS=%*
|
||||
|
||||
%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
|
||||
if ERRORLEVEL 1 goto error
|
||||
goto end
|
||||
|
||||
:error
|
||||
set ERROR_CODE=1
|
||||
|
||||
:end
|
||||
@endlocal & set ERROR_CODE=%ERROR_CODE%
|
||||
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
|
||||
@REM check for post script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
|
||||
if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
|
||||
:skipRcPost
|
||||
|
||||
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
|
||||
if "%MAVEN_BATCH_PAUSE%" == "on" pause
|
||||
|
||||
if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
|
||||
|
||||
exit /B %ERROR_CODE%
|
||||
|
||||
1
pom.xml
1
pom.xml
@@ -29,6 +29,7 @@
|
||||
<module>spring-cloud-dependencies</module>
|
||||
<module>spring-cloud-starter-parent</module>
|
||||
<module>docs</module>
|
||||
<module>train-docs</module>
|
||||
</modules>
|
||||
|
||||
<build>
|
||||
|
||||
120
train-docs/pom.xml
Normal file
120
train-docs/pom.xml
Normal file
@@ -0,0 +1,120 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>spring-cloud-docs</artifactId>
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-starter-build</artifactId>
|
||||
<version>2020.0.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
<packaging>jar</packaging>
|
||||
<name>Spring Cloud Release Train Docs</name>
|
||||
<description>Spring Cloud Release Train Docs</description>
|
||||
<properties>
|
||||
<docs.main>spring-cloud</docs.main>
|
||||
<main.basedir>${basedir}/..</main.basedir>
|
||||
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
|
||||
|
||||
<maven.version>3.6.3</maven.version>
|
||||
<!-- Resolver has to be aligned with Maven (e.g resolver 1.4 and Maven 3.6 or resolver 1.3 and Maven 3.5) -->
|
||||
<maven.resolver.version>1.4.2</maven.resolver.version>
|
||||
<handlebars.version>4.0.6</handlebars.version>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.springframework</groupId>
|
||||
<artifactId>spring-core</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven</groupId>
|
||||
<artifactId>maven-resolver-provider</artifactId>
|
||||
<version>${maven.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven</groupId>
|
||||
<artifactId>maven-artifact</artifactId>
|
||||
<version>${maven.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven</groupId>
|
||||
<artifactId>maven-settings-builder</artifactId>
|
||||
<version>${maven.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.resolver</groupId>
|
||||
<artifactId>maven-resolver-api</artifactId>
|
||||
<version>${maven.resolver.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.resolver</groupId>
|
||||
<artifactId>maven-resolver-impl</artifactId>
|
||||
<version>${maven.resolver.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.resolver</groupId>
|
||||
<artifactId>maven-resolver-transport-file</artifactId>
|
||||
<version>${maven.resolver.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.resolver</groupId>
|
||||
<artifactId>maven-resolver-transport-http</artifactId>
|
||||
<version>${maven.resolver.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.maven.resolver</groupId>
|
||||
<artifactId>maven-resolver-connector-basic</artifactId>
|
||||
<version>${maven.resolver.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.jknack</groupId>
|
||||
<artifactId>handlebars</artifactId>
|
||||
<version>${handlebars.version}</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-starter-docs</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>docs</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>pl.project13.maven</groupId>
|
||||
<artifactId>git-commit-id-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-dependency-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>exec-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-antrun-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-deploy-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
@@ -0,0 +1,165 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.File;
|
||||
import java.net.URI;
|
||||
import java.util.Collections;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Properties;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.apache.maven.model.Model;
|
||||
import org.apache.maven.repository.internal.MavenRepositorySystemUtils;
|
||||
import org.apache.maven.settings.Settings;
|
||||
import org.apache.maven.settings.building.DefaultSettingsBuilderFactory;
|
||||
import org.apache.maven.settings.building.DefaultSettingsBuildingRequest;
|
||||
import org.apache.maven.settings.building.SettingsBuilder;
|
||||
import org.apache.maven.settings.building.SettingsBuildingException;
|
||||
import org.apache.maven.settings.building.SettingsBuildingRequest;
|
||||
import org.apache.maven.settings.building.SettingsBuildingResult;
|
||||
import org.eclipse.aether.DefaultRepositorySystemSession;
|
||||
import org.eclipse.aether.RepositorySystem;
|
||||
import org.eclipse.aether.RepositorySystemSession;
|
||||
import org.eclipse.aether.artifact.Artifact;
|
||||
import org.eclipse.aether.artifact.DefaultArtifact;
|
||||
import org.eclipse.aether.connector.basic.BasicRepositoryConnectorFactory;
|
||||
import org.eclipse.aether.impl.DefaultServiceLocator;
|
||||
import org.eclipse.aether.repository.LocalRepository;
|
||||
import org.eclipse.aether.repository.RemoteRepository;
|
||||
import org.eclipse.aether.repository.RepositoryPolicy;
|
||||
import org.eclipse.aether.resolution.ArtifactRequest;
|
||||
import org.eclipse.aether.resolution.ArtifactResult;
|
||||
import org.eclipse.aether.spi.connector.RepositoryConnectorFactory;
|
||||
import org.eclipse.aether.spi.connector.transport.TransporterFactory;
|
||||
import org.eclipse.aether.transport.file.FileTransporterFactory;
|
||||
import org.eclipse.aether.transport.http.HttpTransporterFactory;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
public class GenerateReleaseTrainDocs {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(GenerateReleaseTrainDocs.class);
|
||||
|
||||
List<Project> toDocsList(File file) {
|
||||
Model model = PomReader.readPom(file);
|
||||
Properties properties = model.getProperties();
|
||||
return properties.entrySet().stream().filter(e -> e.getKey().toString().endsWith(".version"))
|
||||
.map(e -> new Project(e.getKey().toString().replace(".version", "-docs"), e.getValue().toString()))
|
||||
.collect(Collectors.toCollection(LinkedList::new));
|
||||
}
|
||||
|
||||
List<File> downloadDocsModules(List<Project> projects, String repoUrl) {
|
||||
ArtifactFetcher fetcher = new ArtifactFetcher(repoUrl);
|
||||
return projects.stream().map(fetcher::unpackedDocs).collect(Collectors.toList());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
class ArtifactFetcher {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(ArtifactFetcher.class);
|
||||
|
||||
private final RepositorySystem repositorySystem;
|
||||
|
||||
private final RepositorySystemSession session;
|
||||
|
||||
private final List<RemoteRepository> remoteRepository;
|
||||
|
||||
ArtifactFetcher(String url) {
|
||||
this.repositorySystem = newRepositorySystem();
|
||||
this.session = newSession(this.repositorySystem);
|
||||
this.remoteRepository = Collections
|
||||
.singletonList(new RemoteRepository.Builder("remote", "default", url).build());
|
||||
}
|
||||
|
||||
File unpackedDocs(Project project) {
|
||||
String artifactName = project.name;
|
||||
String version = project.version;
|
||||
try {
|
||||
Artifact artifact = new DefaultArtifact("org.springframework.cloud", artifactName, "sources", "jar", version);
|
||||
ArtifactRequest request = new ArtifactRequest(artifact, this.remoteRepository, null);
|
||||
if (log.isDebugEnabled()) {
|
||||
log.debug("Resolving artifact [" + artifact + "] using remote repositories " + this.remoteRepository);
|
||||
}
|
||||
ArtifactResult result = this.repositorySystem.resolveArtifact(this.session, request);
|
||||
log.info("Resolved artifact [" + artifact + "] to " + result.getArtifact().getFile());
|
||||
File unpackedDoc = unpackDoc(artifactName, result.getArtifact().getFile().toURI());
|
||||
log.info("Unpacked file to [" + unpackedDoc.getAbsolutePath() + "]");
|
||||
return unpackedDoc;
|
||||
}
|
||||
catch (IllegalStateException ise) {
|
||||
throw ise;
|
||||
}
|
||||
catch (Exception e) {
|
||||
throw new IllegalStateException("Exception occurred while trying to download an artifact with name ["
|
||||
+ artifactName + "] and version [" + version + "] in remote repo [" + this.remoteRepository, e);
|
||||
}
|
||||
}
|
||||
|
||||
private File unpackDoc(String artifactName, URI stubJarUri) {
|
||||
File unzippedDocs = new File("target/unpacked-docs/" + artifactName);
|
||||
unzippedDocs.mkdirs();
|
||||
log.info("Unpacking stub from JAR [URI: " + stubJarUri + "]");
|
||||
ZipCategory.unzipTo(new File(stubJarUri), unzippedDocs);
|
||||
return unzippedDocs;
|
||||
}
|
||||
|
||||
private RepositorySystem newRepositorySystem() {
|
||||
DefaultServiceLocator locator = MavenRepositorySystemUtils.newServiceLocator();
|
||||
locator.addService(RepositoryConnectorFactory.class, BasicRepositoryConnectorFactory.class);
|
||||
locator.addService(TransporterFactory.class, FileTransporterFactory.class);
|
||||
locator.addService(TransporterFactory.class, HttpTransporterFactory.class);
|
||||
return locator.getService(RepositorySystem.class);
|
||||
}
|
||||
|
||||
private RepositorySystemSession newSession(RepositorySystem system) {
|
||||
DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession();
|
||||
session.setUpdatePolicy(RepositoryPolicy.UPDATE_POLICY_ALWAYS);
|
||||
session.setChecksumPolicy(RepositoryPolicy.CHECKSUM_POLICY_WARN);
|
||||
String localRepository = settings().getLocalRepository();
|
||||
localRepository = StringUtils.hasText(localRepository) ? localRepository
|
||||
: System.getProperty("user.home") + File.separator + ".m2"
|
||||
+ File.separator + "repository";
|
||||
LocalRepository localRepo = new LocalRepository(localRepository);
|
||||
session.setLocalRepositoryManager(system.newLocalRepositoryManager(session, localRepo));
|
||||
return session;
|
||||
}
|
||||
|
||||
private static Settings settings() {
|
||||
SettingsBuilder builder = new DefaultSettingsBuilderFactory().newInstance();
|
||||
SettingsBuildingRequest request = new DefaultSettingsBuildingRequest();
|
||||
request.setUserSettingsFile(userSettings());
|
||||
SettingsBuildingResult result;
|
||||
try {
|
||||
result = builder.build(request);
|
||||
}
|
||||
catch (SettingsBuildingException ex) {
|
||||
throw new IllegalStateException(ex);
|
||||
}
|
||||
return result.getEffectiveSettings();
|
||||
}
|
||||
|
||||
private static File userSettings() {
|
||||
return new File(new File(System.getProperty("user.home")).getAbsoluteFile(),
|
||||
File.separator + ".m2" + File.separator + "settings.xml");
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import com.github.jknack.handlebars.Handlebars;
|
||||
import com.github.jknack.handlebars.Template;
|
||||
import com.github.jknack.handlebars.helper.StringHelpers;
|
||||
import com.github.jknack.handlebars.io.ClassPathTemplateLoader;
|
||||
|
||||
/**
|
||||
* @author Marcin Grzejszczak
|
||||
*/
|
||||
final class HandlebarsHelper {
|
||||
|
||||
private HandlebarsHelper() {
|
||||
throw new IllegalStateException("Can't instantiate a utility class");
|
||||
}
|
||||
|
||||
public static Template template(String templateName) {
|
||||
try {
|
||||
Handlebars handlebars = new Handlebars(
|
||||
new ClassPathTemplateLoader("/templates/spring-cloud/"));
|
||||
handlebars.registerHelper("replace", StringHelpers.replace);
|
||||
handlebars.registerHelper("capitalizeFirst", StringHelpers.capitalizeFirst);
|
||||
return handlebars.compile(templateName);
|
||||
}
|
||||
catch (IOException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.FileNotFoundException;
|
||||
import java.io.FileReader;
|
||||
import java.io.IOException;
|
||||
import java.io.Reader;
|
||||
import java.nio.file.Files;
|
||||
|
||||
import org.apache.maven.model.Model;
|
||||
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
|
||||
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
|
||||
|
||||
/**
|
||||
* Class that reads poms as {@link Model}.
|
||||
*
|
||||
* @author Marcin Grzejszczak
|
||||
*/
|
||||
final class PomReader {
|
||||
|
||||
private PomReader() {
|
||||
throw new IllegalStateException("Shouldn't instantiate a utility class");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a parsed POM.
|
||||
* @param pom location to the pom
|
||||
* @return parsed model
|
||||
*/
|
||||
public static Model readPom(File pom) {
|
||||
if (!pom.exists()) {
|
||||
throw new IllegalStateException("File [" + pom.getAbsolutePath() + "] not found");
|
||||
}
|
||||
String fileText = "";
|
||||
try (Reader reader = new FileReader(pom)) {
|
||||
if (pom.isFile()) {
|
||||
fileText = new String(Files.readAllBytes(pom.toPath()));
|
||||
}
|
||||
MavenXpp3Reader xpp3Reader = new MavenXpp3Reader();
|
||||
return xpp3Reader.read(reader);
|
||||
}
|
||||
catch (XmlPullParserException | IOException e) {
|
||||
if (pom.isFile() && fileText.length() == 0) {
|
||||
throw new IllegalStateException(
|
||||
"File [" + pom.getAbsolutePath() + "] is empty", e);
|
||||
}
|
||||
throw new IllegalStateException(
|
||||
"Failed to read file: " + pom.getAbsolutePath(), e);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
class Project {
|
||||
|
||||
final String name;
|
||||
|
||||
final String version;
|
||||
|
||||
Project(String name, String version) {
|
||||
this.name = name;
|
||||
this.version = version;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(Object o) {
|
||||
if (this == o) {
|
||||
return true;
|
||||
}
|
||||
if (o == null || getClass() != o.getClass()) {
|
||||
return false;
|
||||
}
|
||||
Project project = (Project) o;
|
||||
return Objects.equals(name, project.name) && Objects.equals(version, project.version);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int hashCode() {
|
||||
return Objects.hash(name, version);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.nio.file.Files;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.github.jknack.handlebars.Template;
|
||||
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
|
||||
|
||||
/**
|
||||
* @author Marcin Grzejszczak
|
||||
*/
|
||||
class TemplateGenerator {
|
||||
|
||||
static final File OUTPUT_FOLDER = new File("target/train-docs");
|
||||
|
||||
TemplateGenerator() {
|
||||
OUTPUT_FOLDER.mkdirs();
|
||||
}
|
||||
|
||||
File generate(List<Project> projects) {
|
||||
PathMatchingResourcePatternResolver resourceLoader = new PathMatchingResourcePatternResolver();
|
||||
try {
|
||||
Resource[] resources = resourceLoader.getResources("templates/spring-cloud/*.hbs");
|
||||
for (Resource resource : resources) {
|
||||
File templateFile = resource.getFile();
|
||||
File outputFile = new File(OUTPUT_FOLDER, templateFile.getName().replace(".hbs", ".adoc"));
|
||||
Template template = template(templateFile.getName().replace(".hbs", ""));
|
||||
Map<String, Object> map = new HashMap<>();
|
||||
map.put("projects", projects);
|
||||
map.put("properties", new HashMap<>());
|
||||
String applied = template.apply(map);
|
||||
Files.write(outputFile.toPath(), applied.getBytes());
|
||||
}
|
||||
}
|
||||
catch (IOException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
return this.OUTPUT_FOLDER;
|
||||
}
|
||||
|
||||
|
||||
private Template template(String template) {
|
||||
return HandlebarsHelper.template(template);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
/*
|
||||
* Copyright 2013-2020 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
import java.nio.file.Files;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
import java.util.zip.ZipEntry;
|
||||
import java.util.zip.ZipInputStream;
|
||||
|
||||
import org.springframework.util.StreamUtils;
|
||||
|
||||
/**
|
||||
* Based on
|
||||
* <a href="https://github.com/timyates/groovy-common-extensions">https://github.com/
|
||||
* timyates/groovy-common-extensions</a>.
|
||||
*
|
||||
* Category for {@link File} that adds a method that allows you to unzip a given file to a
|
||||
* specified location
|
||||
*
|
||||
* @author Marcin Grzejszczak
|
||||
*/
|
||||
final class ZipCategory {
|
||||
|
||||
private ZipCategory() {
|
||||
throw new IllegalStateException("Can't instantiate a utility class");
|
||||
}
|
||||
|
||||
/**
|
||||
* Unzips this file. If the <tt>destination</tt> directory is not provided, it will
|
||||
* fall back to this file's parent directory.
|
||||
* @param self file
|
||||
* @param destination (optional), the destination directory where this file's content
|
||||
* will be unzipped to.
|
||||
* @return a {@link Collection} of unzipped {@link File} objects.
|
||||
*/
|
||||
public static Collection<File> unzipTo(File self, File destination) {
|
||||
checkUnzipDestination(destination);
|
||||
// if destination directory is not given, we'll fall back to the parent directory
|
||||
// of 'self'
|
||||
if (destination == null) {
|
||||
destination = new File(self.getParent());
|
||||
}
|
||||
List<File> unzippedFiles = new ArrayList<>();
|
||||
try (InputStream fileInputStream = Files.newInputStream(self.toPath())) {
|
||||
try (ZipInputStream zipInput = new ZipInputStream(fileInputStream)) {
|
||||
for (ZipEntry entry = zipInput
|
||||
.getNextEntry(); entry != null; entry = zipInput.getNextEntry()) {
|
||||
if (!entry.isDirectory()) {
|
||||
final File file = new File(destination, entry.getName());
|
||||
if (file.getParentFile() != null) {
|
||||
file.getParentFile().mkdirs();
|
||||
}
|
||||
try (OutputStream output = Files.newOutputStream(file.toPath())) {
|
||||
StreamUtils.copy(zipInput, output);
|
||||
}
|
||||
unzippedFiles.add(file);
|
||||
}
|
||||
else {
|
||||
final File dir = new File(destination, entry.getName());
|
||||
dir.mkdirs();
|
||||
unzippedFiles.add(dir);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (IOException e) {
|
||||
throw new IllegalStateException("Cannot unzip archive", e);
|
||||
}
|
||||
return unzippedFiles;
|
||||
}
|
||||
|
||||
private static void checkUnzipDestination(File file) {
|
||||
if (file != null && !file.isDirectory()) {
|
||||
throw new IllegalArgumentException("'destination' has to be a directory.");
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
:doctype: book
|
||||
:idprefix:
|
||||
:idseparator: -
|
||||
:toc: left
|
||||
:toclevels: 4
|
||||
:tabsize: 4
|
||||
:numbered:
|
||||
:sectanchors:
|
||||
:sectnums:
|
||||
:icons: font
|
||||
:hide-uri-scheme:
|
||||
:docinfo: shared,private
|
||||
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
@@ -0,0 +1,2 @@
|
||||
{{#each projects}} :{{name}}-version: {{version}}
|
||||
{{/each}}
|
||||
@@ -0,0 +1,2 @@
|
||||
{{#each projects}} https://docs.spring.io/{{name}}/docs/{{version}}/reference/html/[{{name}}] :: {{name}} Reference Documentation, version {{version}}
|
||||
{{/each}}
|
||||
@@ -0,0 +1,56 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
[[cloud-documentation-versions]]
|
||||
== Release Train Versions
|
||||
|
||||
.Release Train Project Versions
|
||||
|===
|
||||
|Project Name| Project Version
|
||||
|
||||
include::_spring-cloud-versions.adoc[]
|
||||
|===
|
||||
|
||||
{{#each projects}}
|
||||
:project-root: {basedir}/{{name}}-docs
|
||||
:project-version: { {{name}}-version }
|
||||
include::{basedir}/{{name}}-docs/{{name}}.adoc[leveloffset=+1]
|
||||
{{/each}}
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
include::configprops.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,56 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
[[cloud-documentation-versions]]
|
||||
== Release Train Versions
|
||||
|
||||
.Release Train Project Versions
|
||||
|===
|
||||
|Project Name| Project Version
|
||||
|
||||
include::_spring-cloud-versions.adoc[]
|
||||
|===
|
||||
|
||||
{{#each projects}}
|
||||
:project-root: {basedir}/{{name}}-docs
|
||||
:project-version: { {{name}}-version }
|
||||
include::{basedir}/{{name}}-docs/{{name}}.adoc[leveloffset=+1]
|
||||
{{/each}}
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
include::configprops.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,2 @@
|
||||
{{#each projects}} |{{name}}|{{version}}
|
||||
{{/each}}
|
||||
@@ -0,0 +1,46 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
The reference documentation consists of the following sections:
|
||||
|
||||
[horizontal]
|
||||
<<legal.adoc#legal-information,Legal>> :: Legal information.
|
||||
<<documentation-overview.adoc,Documentation Overview>> :: About the Documentation, Getting Help, First Steps, and more.
|
||||
include::_spring-cloud-links.adoc[]
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
// need to combine all configprops from all files into a single table
|
||||
link:configprops.html[Spring Cloud configuration properties]
|
||||
@@ -0,0 +1,7 @@
|
||||
|===
|
||||
|Name | Default | Description
|
||||
|
||||
{{#each properties}} |{{name}} | {{default}} | {{description}}
|
||||
{{/each}}
|
||||
|
||||
|===
|
||||
@@ -0,0 +1,38 @@
|
||||
[[documentation]]
|
||||
= Spring Cloud Documentation
|
||||
include::_attributes.hbs[]
|
||||
|
||||
:docs-url: https://docs.spring.io/spring-cloud/docs/{spring-cloud-version}
|
||||
|
||||
This section provides a brief overview of Spring Cloud reference documentation. It serves
|
||||
as a map for the rest of the document.
|
||||
|
||||
|
||||
|
||||
[[documentation-about]]
|
||||
== About the Documentation
|
||||
|
||||
The {project-full-name} reference guide is available as
|
||||
|
||||
* {docs-url}/reference/html[Multi-page HTML]
|
||||
* {docs-url}/reference/htmlsingle[Single-page HTML]
|
||||
* {docs-url}/reference/pdf/{project-name}.pdf[PDF]
|
||||
|
||||
Copies of this document may be made for your own use and for distribution to others,
|
||||
provided that you do not charge any fee for such copies and further provided that each
|
||||
copy contains this Copyright Notice, whether distributed in print or electronically.
|
||||
|
||||
|
||||
|
||||
[[documentation-getting-help]]
|
||||
== Getting Help
|
||||
If you have trouble with {project-full-name}, we would like to help.
|
||||
|
||||
* Learn the {project-full-name} basics. If you are
|
||||
starting out with {project-full-name}, try one of the https://spring.io/guides[guides].
|
||||
* Ask a question. We monitor https://stackoverflow.com[stackoverflow.com] for questions
|
||||
tagged with https://stackoverflow.com/tags/spring-cloud[`spring-cloud`].
|
||||
* Chat with us at https://gitter.im/spring-cloud/spring-cloud[{project-full-name} Gitter]
|
||||
|
||||
NOTE: All of {project-full-name} is open source, including the documentation. If you find
|
||||
problems with the docs or if you want to improve them, please get involved.
|
||||
@@ -0,0 +1,11 @@
|
||||
[legal]
|
||||
= Legal
|
||||
|
||||
{spring-cloud-version}
|
||||
|
||||
Copyright © 2012-2020
|
||||
|
||||
Copies of this document may be made for your own use and for distribution to
|
||||
others, provided that you do not charge any fee for such copies and further
|
||||
provided that each copy contains this Copyright Notice, whether distributed in
|
||||
print or electronically.
|
||||
@@ -0,0 +1,76 @@
|
||||
/*
|
||||
* Copyright 2013-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.internal;
|
||||
|
||||
import java.io.File;
|
||||
import java.net.URISyntaxException;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
|
||||
import org.assertj.core.api.BDDAssertions;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.util.FileSystemUtils;
|
||||
|
||||
public class SomethingTest {
|
||||
|
||||
@Test
|
||||
void should_return_a_list_of_docs_modules_to_download() throws URISyntaxException {
|
||||
File testPom = new File(SomethingTest.class.getResource("/test/pom.xml").toURI());
|
||||
|
||||
List<Project> projects = new GenerateReleaseTrainDocs().toDocsList(testPom);
|
||||
|
||||
BDDAssertions.then(projects)
|
||||
.extracting("name")
|
||||
.containsOnly("spring-cloud-bus-docs", "spring-cloud-build-docs",
|
||||
"spring-cloud-cloudfoundry-docs", "spring-cloud-commons-docs", "spring-cloud-circuitbreaker-docs",
|
||||
"spring-cloud-config-docs", "spring-cloud-consul-docs", "spring-cloud-contract-docs",
|
||||
"spring-cloud-function-docs", "spring-cloud-gateway-docs", "spring-cloud-kubernetes-docs",
|
||||
"spring-cloud-netflix-docs", "spring-cloud-openfeign-docs", "spring-cloud-security-docs",
|
||||
"spring-cloud-sleuth-docs", "spring-cloud-stream-docs", "spring-cloud-task-docs",
|
||||
"spring-cloud-vault-docs", "spring-cloud-zookeeper-docs", "spring-cloud-cli-docs");
|
||||
BDDAssertions.then(projects).contains(new Project("spring-cloud-bus-docs", "1.2.3-SNAPSHOT"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_unpack_starters_docs() throws URISyntaxException {
|
||||
File testPom = new File(SomethingTest.class.getResource("/test/sleuth-only.xml").toURI());
|
||||
String remoteRepo = "https://repo.spring.io/libs-snapshot-local/";
|
||||
List<Project> projects = new GenerateReleaseTrainDocs().toDocsList(testPom);
|
||||
|
||||
List<File> files = new GenerateReleaseTrainDocs().downloadDocsModules(projects, "https://repo.spring.io/libs-snapshot-local/");
|
||||
|
||||
BDDAssertions.then(files)
|
||||
.isNotEmpty();
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_generate_the_single_pdf_multi_adoc_pages() {
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
void should_generate_adocs_from_templates() {
|
||||
FileSystemUtils.deleteRecursively(TemplateGenerator.OUTPUT_FOLDER);
|
||||
List<Project> projects = Arrays.asList(new Project("spring-cloud-foo", "1.0.0"), new Project("spring-cloud-bar", "2.0.0"));
|
||||
|
||||
File outputFolder = new TemplateGenerator().generate(projects);
|
||||
|
||||
BDDAssertions.then(outputFolder).isNotEmptyDirectory();
|
||||
}
|
||||
|
||||
}
|
||||
15
train-docs/src/test/resources/adocs/_attributes.adoc
Normal file
15
train-docs/src/test/resources/adocs/_attributes.adoc
Normal file
@@ -0,0 +1,15 @@
|
||||
:doctype: book
|
||||
:idprefix:
|
||||
:idseparator: -
|
||||
:toc: left
|
||||
:toclevels: 4
|
||||
:tabsize: 4
|
||||
:numbered:
|
||||
:sectanchors:
|
||||
:sectnums:
|
||||
:icons: font
|
||||
:hide-uri-scheme:
|
||||
:docinfo: shared,private
|
||||
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
@@ -0,0 +1,23 @@
|
||||
:spring-boot-version: 2.3.0.RELEASE
|
||||
:spring-cloud-build-version: 3.0.0-M2
|
||||
:spring-cloud-commons-version: 3.0.0-M2
|
||||
:spring-cloud-function-version: 3.1.0.M1
|
||||
:spring-cloud-stream-core-version: 3.1.0.M1
|
||||
:spring-cloud-stream-binder-rabbit-version: 3.1.0.M1
|
||||
:spring-cloud-stream-binder-kafka-version: 3.1.0.M1
|
||||
:spring-cloud-bus-version: 3.0.0-M2
|
||||
:spring-cloud-task-version: 2.3.0-M1
|
||||
:spring-cloud-config-version: 3.0.0-M2
|
||||
:spring-cloud-netflix-version: 3.0.0-M2
|
||||
:spring-cloud-cloudfoundry-version: 3.0.0-M2
|
||||
:spring-cloud-kubernetes-version: 2.0.0-M2
|
||||
:spring-cloud-openfeign-version: 3.0.0-M2
|
||||
:spring-cloud-consul-version: 3.0.0-M2
|
||||
:spring-cloud-gateway-version: 3.0.0-M2
|
||||
:spring-cloud-security-version: 3.0.0-M2
|
||||
:spring-cloud-sleuth-version: 3.0.0-M2
|
||||
:spring-cloud-zookeeper-version: 3.0.0-M2
|
||||
:spring-cloud-contract-version: 3.0.0-M2
|
||||
:spring-cloud-vault-version: 3.0.0-M2
|
||||
:spring-cloud-circuitbreaker-version: 2.0.0-M2
|
||||
:spring-cloud-cli-version: 3.0.0-M2
|
||||
@@ -0,0 +1,839 @@
|
||||
|===
|
||||
|Name | Default | Description
|
||||
|
||||
|encrypt.fail-on-error | true | Flag to say that a process should fail if there is an encryption or decryption error.
|
||||
|encrypt.key | | A symmetric key. As a stronger alternative, consider using a keystore.
|
||||
|encrypt.key-store.alias | | Alias for a key in the store.
|
||||
|encrypt.key-store.location | | Location of the key store file, e.g. classpath:/keystore.jks.
|
||||
|encrypt.key-store.password | | Password that locks the keystore.
|
||||
|encrypt.key-store.secret | | Secret protecting the key (defaults to the same as the password).
|
||||
|encrypt.key-store.type | jks | The KeyStore type. Defaults to jks.
|
||||
|encrypt.rsa.algorithm | | The RSA algorithm to use (DEFAULT or OEAP). Once it is set, do not change it (or existing ciphers will not be decryptable).
|
||||
|encrypt.rsa.salt | deadbeef | Salt for the random secret used to encrypt cipher text. Once it is set, do not change it (or existing ciphers will not be decryptable).
|
||||
|encrypt.rsa.strong | false | Flag to indicate that "strong" AES encryption should be used internally. If true, then the GCM algorithm is applied to the AES encrypted bytes. Default is false (in which case "standard" CBC is used instead). Once it is set, do not change it (or existing ciphers will not be decryptable).
|
||||
|encrypt.salt | deadbeef | A salt for the symmetric key, in the form of a hex-encoded byte array. As a stronger alternative, consider using a keystore.
|
||||
|endpoints.zookeeper.enabled | true | Enable the /zookeeper endpoint to inspect the state of zookeeper.
|
||||
|health.config.enabled | false | Flag to indicate that the config server health indicator should be installed.
|
||||
|health.config.time-to-live | 0 | Time to live for cached result, in milliseconds. Default 300000 (5 min).
|
||||
|management.endpoint.bindings.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.bindings.enabled | true | Whether to enable the bindings endpoint.
|
||||
|management.endpoint.bus-env.enabled | true | Whether to enable the bus-env endpoint.
|
||||
|management.endpoint.bus-refresh.enabled | true | Whether to enable the bus-refresh endpoint.
|
||||
|management.endpoint.channels.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.channels.enabled | true | Whether to enable the channels endpoint.
|
||||
|management.endpoint.consul.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.consul.enabled | true | Whether to enable the consul endpoint.
|
||||
|management.endpoint.env.post.enabled | false | Enables writable environment endpoint.
|
||||
|management.endpoint.features.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.features.enabled | true | Whether to enable the features endpoint.
|
||||
|management.endpoint.gateway.enabled | true | Whether to enable the gateway endpoint.
|
||||
|management.endpoint.pause.enabled | true | Enable the /pause endpoint (to send Lifecycle.stop()).
|
||||
|management.endpoint.refresh.enabled | true | Enable the /refresh endpoint to refresh configuration and re-initialize refresh scoped beans.
|
||||
|management.endpoint.restart.enabled | true | Enable the /restart endpoint to restart the application context.
|
||||
|management.endpoint.resume.enabled | true | Enable the /resume endpoint (to send Lifecycle.start()).
|
||||
|management.endpoint.serviceregistry.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.serviceregistry.enabled | true | Whether to enable the serviceregistry endpoint.
|
||||
|management.endpoint.topology.cache.time-to-live | 0ms | Maximum time that a response can be cached.
|
||||
|management.endpoint.topology.enabled | true | Whether to enable the topology endpoint.
|
||||
|management.health.binders.enabled | true | Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.
|
||||
|management.health.refresh.enabled | true | Enable the health endpoint for the refresh scope.
|
||||
|management.health.zookeeper.enabled | true | Enable the health endpoint for zookeeper.
|
||||
|spring.cloud.bus.ack.destination-service | | Service that wants to listen to acks. By default null (meaning all services).
|
||||
|spring.cloud.bus.ack.enabled | true | Flag to switch off acks (default on).
|
||||
|spring.cloud.bus.destination | springCloudBus | Name of Spring Cloud Stream destination for messages.
|
||||
|spring.cloud.bus.enabled | true | Flag to indicate that the bus is enabled.
|
||||
|spring.cloud.bus.env.enabled | true | Flag to switch off environment change events (default on).
|
||||
|spring.cloud.bus.id | application | The identifier for this application instance.
|
||||
|spring.cloud.bus.refresh.enabled | true | Flag to switch off refresh events (default on).
|
||||
|spring.cloud.bus.trace.enabled | false | Flag to switch on tracing of acks (default off).
|
||||
|spring.cloud.cloudfoundry.discovery.default-server-port | 80 | Port to use when no port is defined by service discovery.
|
||||
|spring.cloud.cloudfoundry.discovery.enabled | true | Flag to indicate that discovery is enabled.
|
||||
|spring.cloud.cloudfoundry.discovery.heartbeat-frequency | 5000 | Frequency in milliseconds of poll for heart beat. The client will poll on this frequency and broadcast a list of service ids.
|
||||
|spring.cloud.cloudfoundry.discovery.internal-domain | apps.internal | Default internal domain when configured to use Native DNS service discovery.
|
||||
|spring.cloud.cloudfoundry.discovery.order | 0 | Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
|
||||
|spring.cloud.cloudfoundry.discovery.use-container-ip | false | Whether to resolve hostname when BOSH DNS is used. In order to use this feature, spring.cloud.cloudfoundry.discovery.use-dns must be true.
|
||||
|spring.cloud.cloudfoundry.discovery.use-dns | false | Whether to use BOSH DNS for the discovery. In order to use this feature, your Cloud Foundry installation must support Service Discovery.
|
||||
|spring.cloud.cloudfoundry.org | | Organization name to initially target.
|
||||
|spring.cloud.cloudfoundry.password | | Password for user to authenticate and obtain token.
|
||||
|spring.cloud.cloudfoundry.skip-ssl-validation | false | null
|
||||
|spring.cloud.cloudfoundry.space | | Space name to initially target.
|
||||
|spring.cloud.cloudfoundry.url | | URL of Cloud Foundry API (Cloud Controller).
|
||||
|spring.cloud.cloudfoundry.username | | Username to authenticate (usually an email address).
|
||||
|spring.cloud.compatibility-verifier.compatible-boot-versions | | Default accepted versions for the Spring Boot dependency. You can set {@code x} for the patch version if you don't want to specify a concrete value. Example: {@code 3.4.x}
|
||||
|spring.cloud.compatibility-verifier.enabled | false | Enables creation of Spring Cloud compatibility verification.
|
||||
|spring.cloud.config.allow-override | true | Flag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true.
|
||||
|spring.cloud.config.discovery.enabled | false | Flag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).
|
||||
|spring.cloud.config.discovery.service-id | configserver | Service id to locate config server.
|
||||
|spring.cloud.config.enabled | true | Flag to say that remote configuration is enabled. Default true;
|
||||
|spring.cloud.config.fail-fast | false | Flag to indicate that failure to connect to the server is fatal (default false).
|
||||
|spring.cloud.config.headers | | Additional headers used to create the client request.
|
||||
|spring.cloud.config.label | | The label name to use to pull remote configuration properties. The default is set on the server (generally "master" for a git based server).
|
||||
|spring.cloud.config.name | | Name of application used to fetch remote properties.
|
||||
|spring.cloud.config.override-none | false | Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false.
|
||||
|spring.cloud.config.override-system-properties | true | Flag to indicate that the external properties should override system properties. Default true.
|
||||
|spring.cloud.config.password | | The password to use (HTTP Basic) when contacting the remote server.
|
||||
|spring.cloud.config.profile | default | The default profile to use when fetching remote configuration (comma-separated). Default is "default".
|
||||
|spring.cloud.config.request-connect-timeout | 0 | timeout on waiting to connect to the Config Server.
|
||||
|spring.cloud.config.request-read-timeout | 0 | timeout on waiting to read data from the Config Server.
|
||||
|spring.cloud.config.retry.initial-interval | 1000 | Initial retry interval in milliseconds.
|
||||
|spring.cloud.config.retry.max-attempts | 6 | Maximum number of attempts.
|
||||
|spring.cloud.config.retry.max-interval | 2000 | Maximum interval for backoff.
|
||||
|spring.cloud.config.retry.multiplier | 1.1 | Multiplier for next interval.
|
||||
|spring.cloud.config.send-state | true | Flag to indicate whether to send state. Default true.
|
||||
|spring.cloud.config.server.accept-empty | true | Flag to indicate that If HTTP 404 needs to be sent if Application is not Found.
|
||||
|spring.cloud.config.server.awss3.bucket | | Name of the S3 bucket that contains config.
|
||||
|spring.cloud.config.server.awss3.order | 0 | null
|
||||
|spring.cloud.config.server.awss3.region | | AWS region that contains config.
|
||||
|spring.cloud.config.server.bootstrap | false | Flag indicating that the config server should initialize its own Environment with properties from the remote repository. Off by default because it delays startup but can be useful when embedding the server in another application.
|
||||
|spring.cloud.config.server.credhub.ca-cert-files | | null
|
||||
|spring.cloud.config.server.credhub.connection-timeout | | null
|
||||
|spring.cloud.config.server.credhub.oauth2.registration-id | | null
|
||||
|spring.cloud.config.server.credhub.order | | null
|
||||
|spring.cloud.config.server.credhub.read-timeout | | null
|
||||
|spring.cloud.config.server.credhub.url | | null
|
||||
|spring.cloud.config.server.default-application-name | application | Default application name when incoming requests do not have a specific one.
|
||||
|spring.cloud.config.server.default-label | | Default repository label when incoming requests do not have a specific label.
|
||||
|spring.cloud.config.server.default-profile | default | Default application profile when incoming requests do not have a specific one.
|
||||
|spring.cloud.config.server.encrypt.enabled | true | Enable decryption of environment properties before sending to client.
|
||||
|spring.cloud.config.server.encrypt.plain-text-encrypt | false | Enable decryption of environment properties served by plain text endpoint {@link org.springframework.cloud.config.server.resource.ResourceController}.
|
||||
|spring.cloud.config.server.git.basedir | | Base directory for local working copy of repository.
|
||||
|spring.cloud.config.server.git.clone-on-start | false | Flag to indicate that the repository should be cloned on startup (not on demand). Generally leads to slower startup but faster first query.
|
||||
|spring.cloud.config.server.git.default-label | | The default label to be used with the remote repository.
|
||||
|spring.cloud.config.server.git.delete-untracked-branches | false | Flag to indicate that the branch should be deleted locally if it's origin tracked branch was removed.
|
||||
|spring.cloud.config.server.git.force-pull | false | Flag to indicate that the repository should force pull. If true discard any local changes and take from remote repository.
|
||||
|spring.cloud.config.server.git.host-key | | Valid SSH host key. Must be set if hostKeyAlgorithm is also set.
|
||||
|spring.cloud.config.server.git.host-key-algorithm | | One of ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Must be set if hostKey is also set.
|
||||
|spring.cloud.config.server.git.ignore-local-ssh-settings | false | If true, use property-based instead of file-based SSH config.
|
||||
|spring.cloud.config.server.git.known-hosts-file | | Location of custom .known_hosts file.
|
||||
|spring.cloud.config.server.git.order | | The order of the environment repository.
|
||||
|spring.cloud.config.server.git.passphrase | | Passphrase for unlocking your ssh private key.
|
||||
|spring.cloud.config.server.git.password | | Password for authentication with remote repository.
|
||||
|spring.cloud.config.server.git.preferred-authentications | | Override server authentication method order. This should allow for evading login prompts if server has keyboard-interactive authentication before the publickey method.
|
||||
|spring.cloud.config.server.git.private-key | | Valid SSH private key. Must be set if ignoreLocalSshSettings is true and Git URI is SSH format.
|
||||
|spring.cloud.config.server.git.proxy | | HTTP proxy configuration.
|
||||
|spring.cloud.config.server.git.refresh-rate | 0 | Time (in seconds) between refresh of the git repository.
|
||||
|spring.cloud.config.server.git.repos | | Map of repository identifier to location and other properties.
|
||||
|spring.cloud.config.server.git.search-paths | | Search paths to use within local working copy. By default searches only the root.
|
||||
|spring.cloud.config.server.git.skip-ssl-validation | false | Flag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.
|
||||
|spring.cloud.config.server.git.strict-host-key-checking | true | If false, ignore errors with host key.
|
||||
|spring.cloud.config.server.git.timeout | 5 | Timeout (in seconds) for obtaining HTTP or SSH connection (if applicable), defaults to 5 seconds.
|
||||
|spring.cloud.config.server.git.uri | | URI of remote repository.
|
||||
|spring.cloud.config.server.git.username | | Username for authentication with remote repository.
|
||||
|spring.cloud.config.server.health.repositories | | null
|
||||
|spring.cloud.config.server.jdbc.order | 0 | null
|
||||
|spring.cloud.config.server.jdbc.sql | SELECT KEY, VALUE from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=? | SQL used to query database for keys and values.
|
||||
|spring.cloud.config.server.native.add-label-locations | true | Flag to determine whether label locations should be added.
|
||||
|spring.cloud.config.server.native.default-label | master | null
|
||||
|spring.cloud.config.server.native.fail-on-error | false | Flag to determine how to handle exceptions during decryption (default false).
|
||||
|spring.cloud.config.server.native.order | | null
|
||||
|spring.cloud.config.server.native.search-locations | [] | Locations to search for configuration files. Defaults to the same as a Spring Boot app so [classpath:/,classpath:/config/,file:./,file:./config/].
|
||||
|spring.cloud.config.server.native.version | | Version string to be reported for native repository.
|
||||
|spring.cloud.config.server.overrides | | Extra map for a property source to be sent to all clients unconditionally.
|
||||
|spring.cloud.config.server.prefix | | Prefix for configuration resource paths (default is empty). Useful when embedding in another application when you don't want to change the context path or servlet path.
|
||||
|spring.cloud.config.server.redis.order | | null
|
||||
|spring.cloud.config.server.strip-document-from-yaml | true | Flag to indicate that YAML documents that are text or collections (not a map) should be returned in "native" form.
|
||||
|spring.cloud.config.server.svn.basedir | | Base directory for local working copy of repository.
|
||||
|spring.cloud.config.server.svn.default-label | | The default label to be used with the remote repository.
|
||||
|spring.cloud.config.server.svn.order | | The order of the environment repository.
|
||||
|spring.cloud.config.server.svn.passphrase | | Passphrase for unlocking your ssh private key.
|
||||
|spring.cloud.config.server.svn.password | | Password for authentication with remote repository.
|
||||
|spring.cloud.config.server.svn.search-paths | | Search paths to use within local working copy. By default searches only the root.
|
||||
|spring.cloud.config.server.svn.strict-host-key-checking | true | Reject incoming SSH host keys from remote servers not in the known host list.
|
||||
|spring.cloud.config.server.svn.uri | | URI of remote repository.
|
||||
|spring.cloud.config.server.svn.username | | Username for authentication with remote repository.
|
||||
|spring.cloud.config.server.vault.app-role.app-role-path | approle | Mount path of the AppRole authentication backend.
|
||||
|spring.cloud.config.server.vault.app-role.role | | Name of the role, optional, used for pull-mode.
|
||||
|spring.cloud.config.server.vault.app-role.role-id | | The RoleId.
|
||||
|spring.cloud.config.server.vault.app-role.secret-id | | The SecretId.
|
||||
|spring.cloud.config.server.vault.authentication | | null
|
||||
|spring.cloud.config.server.vault.aws-ec2.aws-ec2-path | aws-ec2 | Mount path of the AWS-EC2 authentication backend.
|
||||
|spring.cloud.config.server.vault.aws-ec2.identity-document | http://169.254.169.254/latest/dynamic/instance-identity/pkcs7 | URL of the AWS-EC2 PKCS7 identity document.
|
||||
|spring.cloud.config.server.vault.aws-ec2.nonce | | Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation.
|
||||
|spring.cloud.config.server.vault.aws-ec2.role | | Name of the role, optional.
|
||||
|spring.cloud.config.server.vault.aws-iam.aws-path | aws | Mount path of the AWS authentication backend.
|
||||
|spring.cloud.config.server.vault.aws-iam.endpoint-uri | | STS server URI. @since 2.2
|
||||
|spring.cloud.config.server.vault.aws-iam.role | | Name of the role, optional. Defaults to the friendly IAM name if not set.
|
||||
|spring.cloud.config.server.vault.aws-iam.server-name | | Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests.
|
||||
|spring.cloud.config.server.vault.azure-msi.azure-path | azure | Mount path of the Azure MSI authentication backend.
|
||||
|spring.cloud.config.server.vault.azure-msi.identity-token-service | | URI to the Azure MSI Identity Service.
|
||||
|spring.cloud.config.server.vault.azure-msi.metadata-service | | URI to the Azure MSI Metadata Service.
|
||||
|spring.cloud.config.server.vault.azure-msi.role | | Name of the role.
|
||||
|spring.cloud.config.server.vault.backend | secret | Vault backend. Defaults to secret.
|
||||
|spring.cloud.config.server.vault.default-key | application | The key in vault shared by all applications. Defaults to application. Set to empty to disable.
|
||||
|spring.cloud.config.server.vault.gcp-gce.gcp-path | gcp | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.config.server.vault.gcp-gce.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.config.server.vault.gcp-gce.service-account | | Optional service account id. Using the default id if left unconfigured.
|
||||
|spring.cloud.config.server.vault.gcp-iam.credentials.encoded-key | | The base64 encoded contents of an OAuth2 account private key in JSON format.
|
||||
|spring.cloud.config.server.vault.gcp-iam.credentials.location | | Location of the OAuth2 credentials private key. <p> Since this is a Resource, the private key can be in a multitude of locations, such as a local file system, classpath, URL, etc.
|
||||
|spring.cloud.config.server.vault.gcp-iam.gcp-path | gcp | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.config.server.vault.gcp-iam.jwt-validity | 15m | Validity of the JWT token.
|
||||
|spring.cloud.config.server.vault.gcp-iam.project-id | | Overrides the GCP project Id.
|
||||
|spring.cloud.config.server.vault.gcp-iam.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.config.server.vault.gcp-iam.service-account-id | | Overrides the GCP service account Id.
|
||||
|spring.cloud.config.server.vault.host | 127.0.0.1 | Vault host. Defaults to 127.0.0.1.
|
||||
|spring.cloud.config.server.vault.kubernetes.kubernetes-path | kubernetes | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.config.server.vault.kubernetes.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.config.server.vault.kubernetes.service-account-token-file | /var/run/secrets/kubernetes.io/serviceaccount/token | Path to the service account token file.
|
||||
|spring.cloud.config.server.vault.kv-version | 1 | Value to indicate which version of Vault kv backend is used. Defaults to 1.
|
||||
|spring.cloud.config.server.vault.namespace | | The value of the Vault X-Vault-Namespace header. Defaults to null. This a Vault Enterprise feature only.
|
||||
|spring.cloud.config.server.vault.order | | null
|
||||
|spring.cloud.config.server.vault.pcf.instance-certificate | | Path to the instance certificate (PEM). Defaults to {@code CF_INSTANCE_CERT} env variable.
|
||||
|spring.cloud.config.server.vault.pcf.instance-key | | Path to the instance key (PEM). Defaults to {@code CF_INSTANCE_KEY} env variable.
|
||||
|spring.cloud.config.server.vault.pcf.pcf-path | pcf | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.config.server.vault.pcf.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.config.server.vault.port | 8200 | Vault port. Defaults to 8200.
|
||||
|spring.cloud.config.server.vault.profile-separator | , | Vault profile separator. Defaults to comma.
|
||||
|spring.cloud.config.server.vault.proxy | | HTTP proxy configuration.
|
||||
|spring.cloud.config.server.vault.scheme | http | Vault scheme. Defaults to http.
|
||||
|spring.cloud.config.server.vault.skip-ssl-validation | false | Flag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.
|
||||
|spring.cloud.config.server.vault.ssl.cert-auth-path | cert | Mount path of the TLS cert authentication backend.
|
||||
|spring.cloud.config.server.vault.ssl.key-store | | Trust store that holds certificates and private keys.
|
||||
|spring.cloud.config.server.vault.ssl.key-store-password | | Password used to access the key store.
|
||||
|spring.cloud.config.server.vault.ssl.trust-store | | Trust store that holds SSL certificates.
|
||||
|spring.cloud.config.server.vault.ssl.trust-store-password | | Password used to access the trust store.
|
||||
|spring.cloud.config.server.vault.timeout | 5 | Timeout (in seconds) for obtaining HTTP connection, defaults to 5 seconds.
|
||||
|spring.cloud.config.server.vault.token | | Static vault token. Required if {@link #authentication} is {@code TOKEN}.
|
||||
|spring.cloud.config.token | | Security Token passed thru to underlying environment repository.
|
||||
|spring.cloud.config.uri | [http://localhost:8888] | The URI of the remote server (default http://localhost:8888).
|
||||
|spring.cloud.config.username | | The username to use (HTTP Basic) when contacting the remote server.
|
||||
|spring.cloud.consul.config.acl-token | | null
|
||||
|spring.cloud.consul.config.data-key | data | If format is Format.PROPERTIES or Format.YAML then the following field is used as key to look up consul for configuration.
|
||||
|spring.cloud.consul.config.default-context | application | null
|
||||
|spring.cloud.consul.config.enabled | true | null
|
||||
|spring.cloud.consul.config.fail-fast | true | Throw exceptions during config lookup if true, otherwise, log warnings.
|
||||
|spring.cloud.consul.config.format | | null
|
||||
|spring.cloud.consul.config.name | | Alternative to spring.application.name to use in looking up values in consul KV.
|
||||
|spring.cloud.consul.config.prefix | config | null
|
||||
|spring.cloud.consul.config.profile-separator | , | null
|
||||
|spring.cloud.consul.config.watch.delay | 1000 | The value of the fixed delay for the watch in millis. Defaults to 1000.
|
||||
|spring.cloud.consul.config.watch.enabled | true | If the watch is enabled. Defaults to true.
|
||||
|spring.cloud.consul.config.watch.wait-time | 55 | The number of seconds to wait (or block) for watch query, defaults to 55. Needs to be less than default ConsulClient (defaults to 60). To increase ConsulClient timeout create a ConsulClient bean with a custom ConsulRawClient with a custom HttpClient.
|
||||
|spring.cloud.consul.discovery.acl-token | | null
|
||||
|spring.cloud.consul.discovery.catalog-services-watch-delay | 1000 | The delay between calls to watch consul catalog in millis, default is 1000.
|
||||
|spring.cloud.consul.discovery.catalog-services-watch-timeout | 2 | The number of seconds to block while watching consul catalog, default is 2.
|
||||
|spring.cloud.consul.discovery.consistency-mode | | Consistency mode for health service request.
|
||||
|spring.cloud.consul.discovery.datacenters | | Map of serviceId's -> datacenter to query for in server list. This allows looking up services in another datacenters.
|
||||
|spring.cloud.consul.discovery.default-query-tag | | Tag to query for in service list if one is not listed in serverListQueryTags.
|
||||
|spring.cloud.consul.discovery.default-zone-metadata-name | zone | Service instance zone comes from metadata. This allows changing the metadata tag name.
|
||||
|spring.cloud.consul.discovery.deregister | true | Disable automatic de-registration of service in consul.
|
||||
|spring.cloud.consul.discovery.enable-tag-override | | Enable tag override for the registered service.
|
||||
|spring.cloud.consul.discovery.enabled | true | Is service discovery enabled?
|
||||
|spring.cloud.consul.discovery.fail-fast | true | Throw exceptions during service registration if true, otherwise, log warnings (defaults to true).
|
||||
|spring.cloud.consul.discovery.health-check-critical-timeout | | Timeout to deregister services critical for longer than timeout (e.g. 30m). Requires consul version 7.x or higher.
|
||||
|spring.cloud.consul.discovery.health-check-headers | | Headers to be applied to the Health Check calls.
|
||||
|spring.cloud.consul.discovery.health-check-interval | 10s | How often to perform the health check (e.g. 10s), defaults to 10s.
|
||||
|spring.cloud.consul.discovery.health-check-path | /actuator/health | Alternate server path to invoke for health checking.
|
||||
|spring.cloud.consul.discovery.health-check-timeout | | Timeout for health check (e.g. 10s).
|
||||
|spring.cloud.consul.discovery.health-check-tls-skip-verify | | Skips certificate verification during service checks if true, otherwise runs certificate verification.
|
||||
|spring.cloud.consul.discovery.health-check-url | | Custom health check url to override default.
|
||||
|spring.cloud.consul.discovery.heartbeat.enabled | false | null
|
||||
|spring.cloud.consul.discovery.heartbeat.interval-ratio | | null
|
||||
|spring.cloud.consul.discovery.heartbeat.ttl | 30s | null
|
||||
|spring.cloud.consul.discovery.hostname | | Hostname to use when accessing server.
|
||||
|spring.cloud.consul.discovery.include-hostname-in-instance-id | false | Whether hostname is included into the default instance id when registering service.
|
||||
|spring.cloud.consul.discovery.instance-group | | Service instance group.
|
||||
|spring.cloud.consul.discovery.instance-id | | Unique service instance id.
|
||||
|spring.cloud.consul.discovery.instance-zone | | Service instance zone.
|
||||
|spring.cloud.consul.discovery.ip-address | | IP address to use when accessing service (must also set preferIpAddress to use).
|
||||
|spring.cloud.consul.discovery.lifecycle.enabled | true | null
|
||||
|spring.cloud.consul.discovery.management-enable-tag-override | | Enable tag override for the registered management service.
|
||||
|spring.cloud.consul.discovery.management-metadata | | Metadata to use when registering management service.
|
||||
|spring.cloud.consul.discovery.management-port | | Port to register the management service under (defaults to management port).
|
||||
|spring.cloud.consul.discovery.management-suffix | management | Suffix to use when registering management service.
|
||||
|spring.cloud.consul.discovery.management-tags | | Tags to use when registering management service.
|
||||
|spring.cloud.consul.discovery.metadata | | Metadata to use when registering service.
|
||||
|spring.cloud.consul.discovery.order | 0 | Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
|
||||
|spring.cloud.consul.discovery.port | | Port to register the service under (defaults to listening port).
|
||||
|spring.cloud.consul.discovery.prefer-agent-address | false | Source of how we will determine the address to use.
|
||||
|spring.cloud.consul.discovery.prefer-ip-address | false | Use ip address rather than hostname during registration.
|
||||
|spring.cloud.consul.discovery.query-passing | false | Add the 'passing` parameter to /v1/health/service/serviceName. This pushes health check passing to the server.
|
||||
|spring.cloud.consul.discovery.register | true | Register as a service in consul.
|
||||
|spring.cloud.consul.discovery.register-health-check | true | Register health check in consul. Useful during development of a service.
|
||||
|spring.cloud.consul.discovery.scheme | http | Whether to register an http or https service.
|
||||
|spring.cloud.consul.discovery.server-list-query-tags | | Map of serviceId's -> tag to query for in server list. This allows filtering services by a single tag.
|
||||
|spring.cloud.consul.discovery.service-name | | Service name.
|
||||
|spring.cloud.consul.discovery.tags | | Tags to use when registering service.
|
||||
|spring.cloud.consul.enabled | true | Is spring cloud consul enabled.
|
||||
|spring.cloud.consul.host | localhost | Consul agent hostname. Defaults to 'localhost'.
|
||||
|spring.cloud.consul.port | 8500 | Consul agent port. Defaults to '8500'.
|
||||
|spring.cloud.consul.retry.enabled | true | If consul retry is enabled.
|
||||
|spring.cloud.consul.retry.initial-interval | 1000 | Initial retry interval in milliseconds.
|
||||
|spring.cloud.consul.retry.max-attempts | 6 | Maximum number of attempts.
|
||||
|spring.cloud.consul.retry.max-interval | 2000 | Maximum interval for backoff.
|
||||
|spring.cloud.consul.retry.multiplier | 1.1 | Multiplier for next interval.
|
||||
|spring.cloud.consul.scheme | | Consul agent scheme (HTTP/HTTPS). If there is no scheme in address - client will use HTTP.
|
||||
|spring.cloud.consul.service-registry.auto-registration.enabled | true | Enables Consul Service Registry Auto-registration.
|
||||
|spring.cloud.consul.service-registry.enabled | true | Enables Consul Service Registry functionality.
|
||||
|spring.cloud.consul.tls.certificate-password | | Password to open the certificate.
|
||||
|spring.cloud.consul.tls.certificate-path | | File path to the certificate.
|
||||
|spring.cloud.consul.tls.key-store-instance-type | | Type of key framework to use.
|
||||
|spring.cloud.consul.tls.key-store-password | | Password to an external keystore.
|
||||
|spring.cloud.consul.tls.key-store-path | | Path to an external keystore.
|
||||
|spring.cloud.discovery.client.cloudfoundry.order | | null
|
||||
|spring.cloud.discovery.client.composite-indicator.enabled | true | Enables discovery client composite health indicator.
|
||||
|spring.cloud.discovery.client.health-indicator.enabled | true | null
|
||||
|spring.cloud.discovery.client.health-indicator.include-description | false | null
|
||||
|spring.cloud.discovery.client.simple.instances | | null
|
||||
|spring.cloud.discovery.client.simple.local.instance-id | | The unique identifier or name for the service instance.
|
||||
|spring.cloud.discovery.client.simple.local.metadata | | Metadata for the service instance. Can be used by discovery clients to modify their behaviour per instance, e.g. when load balancing.
|
||||
|spring.cloud.discovery.client.simple.local.service-id | | The identifier or name for the service. Multiple instances might share the same service ID.
|
||||
|spring.cloud.discovery.client.simple.local.uri | | The URI of the service instance. Will be parsed to extract the scheme, host, and port.
|
||||
|spring.cloud.discovery.client.simple.order | | null
|
||||
|spring.cloud.discovery.enabled | true | Enables discovery client health indicators.
|
||||
|spring.cloud.features.enabled | true | Enables the features endpoint.
|
||||
|spring.cloud.function.compile | | Configuration for function bodies, which will be compiled. The key in the map is the function name and the value is a map containing a key "lambda" which is the body to compile, and optionally a "type" (defaults to "function"). Can also contain "inputType" and "outputType" in case it is ambiguous.
|
||||
|spring.cloud.function.definition | | Definition of the function to be used. This could be function name (e.g., 'myFunction') or function composition definition (e.g., 'myFunction\|yourFunction')
|
||||
|spring.cloud.function.imports | | Configuration for a set of files containing function bodies, which will be imported and compiled. The key in the map is the function name and the value is another map, containing a "location" of the file to compile and (optionally) a "type" (defaults to "function").
|
||||
|spring.cloud.function.routing-expression | | SpEL expression which should result in function definition (e.g., function name or composition instruction). NOTE: SpEL evaluation context's root object is the input argument (e.g., Message).
|
||||
|spring.cloud.function.web.export.auto-startup | true | Flag to indicate that the supplier emits HTTP requests automatically on startup.
|
||||
|spring.cloud.function.web.export.debug | true | Flag to indicate that extra logging is required for the supplier.
|
||||
|spring.cloud.function.web.export.enabled | false | Flag to enable the export of a supplier.
|
||||
|spring.cloud.function.web.export.sink.content-type | application/json | Content type to use when serializing source's output for transport (default 'application/json`).
|
||||
|spring.cloud.function.web.export.sink.headers | | Additional headers to append to the outgoing HTTP requests.
|
||||
|spring.cloud.function.web.export.sink.name | | The name of a specific existing Supplier to export from the function catalog.
|
||||
|spring.cloud.function.web.export.sink.url | | URL template for outgoing HTTP requests. Each item from the supplier is POSTed to this target.
|
||||
|spring.cloud.function.web.export.source.include-headers | true | Include the incoming headers in the outgoing Supplier. If true the supplier will be of generic type Message of T equal to the source type.
|
||||
|spring.cloud.function.web.export.source.type | | If the origin url is set, the type of content expected (e.g. a POJO class). Defaults to String.
|
||||
|spring.cloud.function.web.export.source.url | | URL template for creating a virtual Supplier from HTTP GET.
|
||||
|spring.cloud.function.web.path | | Path to web resources for functions (should start with / if not empty).
|
||||
|spring.cloud.function.web.supplier.auto-startup | true | null
|
||||
|spring.cloud.function.web.supplier.debug | true | null
|
||||
|spring.cloud.function.web.supplier.enabled | false | null
|
||||
|spring.cloud.function.web.supplier.headers | | null
|
||||
|spring.cloud.function.web.supplier.name | | null
|
||||
|spring.cloud.function.web.supplier.template-url | | null
|
||||
|spring.cloud.gateway.default-filters | | List of filter definitions that are applied to every route.
|
||||
|spring.cloud.gateway.discovery.locator.enabled | false | Flag that enables DiscoveryClient gateway integration.
|
||||
|spring.cloud.gateway.discovery.locator.filters | | null
|
||||
|spring.cloud.gateway.discovery.locator.include-expression | true | SpEL expression that will evaluate whether to include a service in gateway integration or not, defaults to: true.
|
||||
|spring.cloud.gateway.discovery.locator.lower-case-service-id | false | Option to lower case serviceId in predicates and filters, defaults to false. Useful with eureka when it automatically uppercases serviceId. so MYSERIVCE, would match /myservice/**
|
||||
|spring.cloud.gateway.discovery.locator.predicates | | null
|
||||
|spring.cloud.gateway.discovery.locator.route-id-prefix | | The prefix for the routeId, defaults to discoveryClient.getClass().getSimpleName() + "_". Service Id will be appended to create the routeId.
|
||||
|spring.cloud.gateway.discovery.locator.url-expression | 'lb://'+serviceId | SpEL expression that create the uri for each route, defaults to: 'lb://'+serviceId.
|
||||
|spring.cloud.gateway.enabled | true | Enables gateway functionality.
|
||||
|spring.cloud.gateway.fail-on-route-definition-error | true | Option to fail on route definition errors, defaults to true. Otherwise, a warning is logged.
|
||||
|spring.cloud.gateway.filter.remove-hop-by-hop.headers | | null
|
||||
|spring.cloud.gateway.filter.remove-hop-by-hop.order | | null
|
||||
|spring.cloud.gateway.filter.request-rate-limiter.deny-empty-key | true | Switch to deny requests if the Key Resolver returns an empty key, defaults to true.
|
||||
|spring.cloud.gateway.filter.request-rate-limiter.empty-key-status-code | | HttpStatus to return when denyEmptyKey is true, defaults to FORBIDDEN.
|
||||
|spring.cloud.gateway.filter.secure-headers.content-security-policy | default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src https:; style-src 'self' https: 'unsafe-inline' | null
|
||||
|spring.cloud.gateway.filter.secure-headers.content-type-options | nosniff | null
|
||||
|spring.cloud.gateway.filter.secure-headers.disable | | null
|
||||
|spring.cloud.gateway.filter.secure-headers.download-options | noopen | null
|
||||
|spring.cloud.gateway.filter.secure-headers.frame-options | DENY | null
|
||||
|spring.cloud.gateway.filter.secure-headers.permitted-cross-domain-policies | none | null
|
||||
|spring.cloud.gateway.filter.secure-headers.referrer-policy | no-referrer | null
|
||||
|spring.cloud.gateway.filter.secure-headers.strict-transport-security | max-age=631138519 | null
|
||||
|spring.cloud.gateway.filter.secure-headers.xss-protection-header | 1 ; mode=block | null
|
||||
|spring.cloud.gateway.forwarded.enabled | true | Enables the ForwardedHeadersFilter.
|
||||
|spring.cloud.gateway.globalcors.add-to-simple-url-handler-mapping | false | If global CORS config should be added to the URL handler.
|
||||
|spring.cloud.gateway.globalcors.cors-configurations | | null
|
||||
|spring.cloud.gateway.httpclient.connect-timeout | | The connect timeout in millis, the default is 45s.
|
||||
|spring.cloud.gateway.httpclient.max-header-size | | The max response header size.
|
||||
|spring.cloud.gateway.httpclient.max-initial-line-length | | The max initial line length.
|
||||
|spring.cloud.gateway.httpclient.pool.acquire-timeout | | Only for type FIXED, the maximum time in millis to wait for aquiring.
|
||||
|spring.cloud.gateway.httpclient.pool.max-connections | | Only for type FIXED, the maximum number of connections before starting pending acquisition on existing ones.
|
||||
|spring.cloud.gateway.httpclient.pool.max-idle-time | | Time in millis after which the channel will be closed. If NULL, there is no max idle time.
|
||||
|spring.cloud.gateway.httpclient.pool.max-life-time | | Duration after which the channel will be closed. If NULL, there is no max life time.
|
||||
|spring.cloud.gateway.httpclient.pool.name | proxy | The channel pool map name, defaults to proxy.
|
||||
|spring.cloud.gateway.httpclient.pool.type | | Type of pool for HttpClient to use, defaults to ELASTIC.
|
||||
|spring.cloud.gateway.httpclient.proxy.host | | Hostname for proxy configuration of Netty HttpClient.
|
||||
|spring.cloud.gateway.httpclient.proxy.non-proxy-hosts-pattern | | Regular expression (Java) for a configured list of hosts. that should be reached directly, bypassing the proxy
|
||||
|spring.cloud.gateway.httpclient.proxy.password | | Password for proxy configuration of Netty HttpClient.
|
||||
|spring.cloud.gateway.httpclient.proxy.port | | Port for proxy configuration of Netty HttpClient.
|
||||
|spring.cloud.gateway.httpclient.proxy.username | | Username for proxy configuration of Netty HttpClient.
|
||||
|spring.cloud.gateway.httpclient.response-timeout | | The response timeout.
|
||||
|spring.cloud.gateway.httpclient.ssl.close-notify-flush-timeout | 3000ms | SSL close_notify flush timeout. Default to 3000 ms.
|
||||
|spring.cloud.gateway.httpclient.ssl.close-notify-read-timeout | | SSL close_notify read timeout. Default to 0 ms.
|
||||
|spring.cloud.gateway.httpclient.ssl.default-configuration-type | | The default ssl configuration type. Defaults to TCP.
|
||||
|spring.cloud.gateway.httpclient.ssl.handshake-timeout | 10000ms | SSL handshake timeout. Default to 10000 ms
|
||||
|spring.cloud.gateway.httpclient.ssl.key-password | | Key password, default is same as keyStorePassword.
|
||||
|spring.cloud.gateway.httpclient.ssl.key-store | | Keystore path for Netty HttpClient.
|
||||
|spring.cloud.gateway.httpclient.ssl.key-store-password | | Keystore password.
|
||||
|spring.cloud.gateway.httpclient.ssl.key-store-provider | | Keystore provider for Netty HttpClient, optional field.
|
||||
|spring.cloud.gateway.httpclient.ssl.key-store-type | JKS | Keystore type for Netty HttpClient, default is JKS.
|
||||
|spring.cloud.gateway.httpclient.ssl.trusted-x509-certificates | | Trusted certificates for verifying the remote endpoint's certificate.
|
||||
|spring.cloud.gateway.httpclient.ssl.use-insecure-trust-manager | false | Installs the netty InsecureTrustManagerFactory. This is insecure and not suitable for production.
|
||||
|spring.cloud.gateway.httpclient.websocket.max-frame-payload-length | | Max frame payload length.
|
||||
|spring.cloud.gateway.httpclient.websocket.proxy-ping | true | Proxy ping frames to downstream services, defaults to true.
|
||||
|spring.cloud.gateway.httpclient.wiretap | false | Enables wiretap debugging for Netty HttpClient.
|
||||
|spring.cloud.gateway.httpserver.wiretap | false | Enables wiretap debugging for Netty HttpServer.
|
||||
|spring.cloud.gateway.loadbalancer.use404 | false | null
|
||||
|spring.cloud.gateway.metrics.enabled | true | Enables the collection of metrics data.
|
||||
|spring.cloud.gateway.metrics.tags | | Tags map that added to metrics.
|
||||
|spring.cloud.gateway.proxy.auto-forward | | A set of header names that should be send downstream by default.
|
||||
|spring.cloud.gateway.proxy.headers | | Fixed header values that will be added to all downstream requests.
|
||||
|spring.cloud.gateway.proxy.sensitive | | A set of sensitive header names that will not be sent downstream by default.
|
||||
|spring.cloud.gateway.redis-rate-limiter.burst-capacity-header | X-RateLimit-Burst-Capacity | The name of the header that returns the burst capacity configuration.
|
||||
|spring.cloud.gateway.redis-rate-limiter.config | | null
|
||||
|spring.cloud.gateway.redis-rate-limiter.include-headers | true | Whether or not to include headers containing rate limiter information, defaults to true.
|
||||
|spring.cloud.gateway.redis-rate-limiter.remaining-header | X-RateLimit-Remaining | The name of the header that returns number of remaining requests during the current second.
|
||||
|spring.cloud.gateway.redis-rate-limiter.replenish-rate-header | X-RateLimit-Replenish-Rate | The name of the header that returns the replenish rate configuration.
|
||||
|spring.cloud.gateway.redis-rate-limiter.requested-tokens-header | X-RateLimit-Requested-Tokens | The name of the header that returns the requested tokens configuration.
|
||||
|spring.cloud.gateway.routes | | List of Routes.
|
||||
|spring.cloud.gateway.set-status.original-status-header-name | | The name of the header which contains http code of the proxied request.
|
||||
|spring.cloud.gateway.streaming-media-types | | null
|
||||
|spring.cloud.gateway.x-forwarded.enabled | true | If the XForwardedHeadersFilter is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.for-append | true | If appending X-Forwarded-For as a list is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.for-enabled | true | If X-Forwarded-For is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.host-append | true | If appending X-Forwarded-Host as a list is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.host-enabled | true | If X-Forwarded-Host is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.order | 0 | The order of the XForwardedHeadersFilter.
|
||||
|spring.cloud.gateway.x-forwarded.port-append | true | If appending X-Forwarded-Port as a list is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.port-enabled | true | If X-Forwarded-Port is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.prefix-append | true | If appending X-Forwarded-Prefix as a list is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.prefix-enabled | true | If X-Forwarded-Prefix is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.proto-append | true | If appending X-Forwarded-Proto as a list is enabled.
|
||||
|spring.cloud.gateway.x-forwarded.proto-enabled | true | If X-Forwarded-Proto is enabled.
|
||||
|spring.cloud.httpclientfactories.apache.enabled | true | Enables creation of Apache Http Client factory beans.
|
||||
|spring.cloud.httpclientfactories.ok.enabled | true | Enables creation of OK Http Client factory beans.
|
||||
|spring.cloud.hypermedia.refresh.fixed-delay | 5000 | null
|
||||
|spring.cloud.hypermedia.refresh.initial-delay | 10000 | null
|
||||
|spring.cloud.inetutils.default-hostname | localhost | The default hostname. Used in case of errors.
|
||||
|spring.cloud.inetutils.default-ip-address | 127.0.0.1 | The default IP address. Used in case of errors.
|
||||
|spring.cloud.inetutils.ignored-interfaces | | List of Java regular expressions for network interfaces that will be ignored.
|
||||
|spring.cloud.inetutils.preferred-networks | | List of Java regular expressions for network addresses that will be preferred.
|
||||
|spring.cloud.inetutils.timeout-seconds | 1 | Timeout, in seconds, for calculating hostname.
|
||||
|spring.cloud.inetutils.use-only-site-local-interfaces | false | Whether to use only interfaces with site local addresses. See {@link InetAddress#isSiteLocalAddress()} for more details.
|
||||
|spring.cloud.kubernetes.client.api-version | | null
|
||||
|spring.cloud.kubernetes.client.apiVersion | v1 | Kubernetes API Version
|
||||
|spring.cloud.kubernetes.client.ca-cert-data | | null
|
||||
|spring.cloud.kubernetes.client.ca-cert-file | | null
|
||||
|spring.cloud.kubernetes.client.caCertData | | Kubernetes API CACertData
|
||||
|spring.cloud.kubernetes.client.caCertFile | | Kubernetes API CACertFile
|
||||
|spring.cloud.kubernetes.client.client-cert-data | | null
|
||||
|spring.cloud.kubernetes.client.client-cert-file | | null
|
||||
|spring.cloud.kubernetes.client.client-key-algo | | null
|
||||
|spring.cloud.kubernetes.client.client-key-data | | null
|
||||
|spring.cloud.kubernetes.client.client-key-file | | null
|
||||
|spring.cloud.kubernetes.client.client-key-passphrase | | null
|
||||
|spring.cloud.kubernetes.client.clientCertData | | Kubernetes API ClientCertData
|
||||
|spring.cloud.kubernetes.client.clientCertFile | | Kubernetes API ClientCertFile
|
||||
|spring.cloud.kubernetes.client.clientKeyAlgo | RSA | Kubernetes API ClientKeyAlgo
|
||||
|spring.cloud.kubernetes.client.clientKeyData | | Kubernetes API ClientKeyData
|
||||
|spring.cloud.kubernetes.client.clientKeyFile | | Kubernetes API ClientKeyFile
|
||||
|spring.cloud.kubernetes.client.clientKeyPassphrase | changeit | Kubernetes API ClientKeyPassphrase
|
||||
|spring.cloud.kubernetes.client.connection-timeout | | null
|
||||
|spring.cloud.kubernetes.client.connectionTimeout | 10s | Connection timeout
|
||||
|spring.cloud.kubernetes.client.http-proxy | | null
|
||||
|spring.cloud.kubernetes.client.https-proxy | | null
|
||||
|spring.cloud.kubernetes.client.logging-interval | | null
|
||||
|spring.cloud.kubernetes.client.loggingInterval | 20s | Logging interval
|
||||
|spring.cloud.kubernetes.client.master-url | | null
|
||||
|spring.cloud.kubernetes.client.masterUrl | https://kubernetes.default.svc | Kubernetes API Master Node URL
|
||||
|spring.cloud.kubernetes.client.namespace | true | Kubernetes Namespace
|
||||
|spring.cloud.kubernetes.client.no-proxy | | null
|
||||
|spring.cloud.kubernetes.client.password | | Kubernetes API Password
|
||||
|spring.cloud.kubernetes.client.proxy-password | | null
|
||||
|spring.cloud.kubernetes.client.proxy-username | | null
|
||||
|spring.cloud.kubernetes.client.request-timeout | | null
|
||||
|spring.cloud.kubernetes.client.requestTimeout | 10s | Request timeout
|
||||
|spring.cloud.kubernetes.client.rolling-timeout | | null
|
||||
|spring.cloud.kubernetes.client.rollingTimeout | 900s | Rolling timeout
|
||||
|spring.cloud.kubernetes.client.trust-certs | | null
|
||||
|spring.cloud.kubernetes.client.trustCerts | false | Kubernetes API Trust Certificates
|
||||
|spring.cloud.kubernetes.client.username | | Kubernetes API Username
|
||||
|spring.cloud.kubernetes.client.watch-reconnect-interval | | null
|
||||
|spring.cloud.kubernetes.client.watch-reconnect-limit | | null
|
||||
|spring.cloud.kubernetes.client.watchReconnectInterval | 1s | Reconnect Interval
|
||||
|spring.cloud.kubernetes.client.watchReconnectLimit | -1 | Reconnect Interval limit retries
|
||||
|spring.cloud.kubernetes.config.enable-api | true | null
|
||||
|spring.cloud.kubernetes.config.enabled | true | Enable the ConfigMap property source locator.
|
||||
|spring.cloud.kubernetes.config.name | | null
|
||||
|spring.cloud.kubernetes.config.namespace | | null
|
||||
|spring.cloud.kubernetes.config.paths | | null
|
||||
|spring.cloud.kubernetes.config.sources | | null
|
||||
|spring.cloud.kubernetes.discovery.all-namespaces | false | If discovering all namespaces.
|
||||
|spring.cloud.kubernetes.discovery.enabled | true | If Kubernetes Discovery is enabled.
|
||||
|spring.cloud.kubernetes.discovery.filter | | SpEL expression to filter services AFTER they have been retrieved from the Kubernetes API server.
|
||||
|spring.cloud.kubernetes.discovery.known-secure-ports | | Set the port numbers that are considered secure and use HTTPS.
|
||||
|spring.cloud.kubernetes.discovery.metadata.add-annotations | true | When set, the Kubernetes annotations of the services will be included as metadata of the returned ServiceInstance.
|
||||
|spring.cloud.kubernetes.discovery.metadata.add-labels | true | When set, the Kubernetes labels of the services will be included as metadata of the returned ServiceInstance.
|
||||
|spring.cloud.kubernetes.discovery.metadata.add-ports | true | When set, any named Kubernetes service ports will be included as metadata of the returned ServiceInstance.
|
||||
|spring.cloud.kubernetes.discovery.metadata.annotations-prefix | | When addAnnotations is set, then this will be used as a prefix to the key names in the metadata map.
|
||||
|spring.cloud.kubernetes.discovery.metadata.labels-prefix | | When addLabels is set, then this will be used as a prefix to the key names in the metadata map.
|
||||
|spring.cloud.kubernetes.discovery.metadata.ports-prefix | port. | When addPorts is set, then this will be used as a prefix to the key names in the metadata map.
|
||||
|spring.cloud.kubernetes.discovery.order | | null
|
||||
|spring.cloud.kubernetes.discovery.primary-port-name | | If set then the port with a given name is used as primary when multiple ports are defined for a service.
|
||||
|spring.cloud.kubernetes.discovery.service-labels | | If set, then only the services matching these labels will be fetched from the Kubernetes API server.
|
||||
|spring.cloud.kubernetes.discovery.service-name | unknown | The service name of the local instance.
|
||||
|spring.cloud.kubernetes.enabled | true | Whether to enable Kubernetes integration.
|
||||
|spring.cloud.kubernetes.reload.enabled | false | Enables the Kubernetes configuration reload on change.
|
||||
|spring.cloud.kubernetes.reload.max-wait-for-restart | 2s | If Restart or Shutdown strategies are used, Spring Cloud Kubernetes waits a random amount of time before restarting. This is done in order to avoid having all instances of the same application restart at the same time. This property configures the maximum of amount of wait time from the moment the signal is received that a restart is needed until the moment the restart is actually triggered
|
||||
|spring.cloud.kubernetes.reload.mode | | Sets the detection mode for Kubernetes configuration reload.
|
||||
|spring.cloud.kubernetes.reload.monitoring-config-maps | true | Enables monitoring on config maps to detect changes.
|
||||
|spring.cloud.kubernetes.reload.monitoring-secrets | false | Enables monitoring on secrets to detect changes.
|
||||
|spring.cloud.kubernetes.reload.period | 15000ms | Sets the polling period to use when the detection mode is POLLING.
|
||||
|spring.cloud.kubernetes.reload.strategy | | Sets the reload strategy for Kubernetes configuration reload on change.
|
||||
|spring.cloud.kubernetes.secrets.enable-api | false | null
|
||||
|spring.cloud.kubernetes.secrets.enabled | true | Enable the Secrets property source locator.
|
||||
|spring.cloud.kubernetes.secrets.labels | | null
|
||||
|spring.cloud.kubernetes.secrets.name | | null
|
||||
|spring.cloud.kubernetes.secrets.namespace | | null
|
||||
|spring.cloud.kubernetes.secrets.paths | | null
|
||||
|spring.cloud.kubernetes.secrets.sources | | null
|
||||
|spring.cloud.loadbalancer.cache.caffeine.spec | | The spec to use to create caches. See CaffeineSpec for more details on the spec format.
|
||||
|spring.cloud.loadbalancer.cache.capacity | 256 | Initial cache capacity expressed as int.
|
||||
|spring.cloud.loadbalancer.cache.enabled | true | Enables Spring Cloud LoadBalancer caching mechanism.
|
||||
|spring.cloud.loadbalancer.cache.ttl | 35s | Time To Live - time counted from writing of the record, after which cache entries are expired, expressed as a {@link Duration}. The property {@link String} has to be in keeping with the appropriate syntax as specified in Spring Boot <code>StringToDurationConverter</code>. @see <a href= "https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/StringToDurationConverter.java">StringToDurationConverter.java</a>
|
||||
|spring.cloud.loadbalancer.health-check.initial-delay | | Initial delay value for the HealthCheck scheduler.
|
||||
|spring.cloud.loadbalancer.health-check.interval | 25s | Interval for rerunning the HealthCheck scheduler.
|
||||
|spring.cloud.loadbalancer.health-check.path | | null
|
||||
|spring.cloud.loadbalancer.retry.enabled | true | null
|
||||
|spring.cloud.loadbalancer.ribbon.enabled | true | Causes `RibbonLoadBalancerClient` to be used by default.
|
||||
|spring.cloud.loadbalancer.service-discovery.timeout | | String representation of Duration of the timeout for calls to service discovery.
|
||||
|spring.cloud.loadbalancer.zone | | Spring Cloud LoadBalancer zone.
|
||||
|spring.cloud.refresh.enabled | true | Enables autoconfiguration for the refresh scope and associated features.
|
||||
|spring.cloud.refresh.extra-refreshable | true | Additional class names for beans to post process into refresh scope.
|
||||
|spring.cloud.refresh.never-refreshable | true | Comma separated list of class names for beans to never be refreshed or rebound.
|
||||
|spring.cloud.service-registry.auto-registration.enabled | true | Whether service auto-registration is enabled. Defaults to true.
|
||||
|spring.cloud.service-registry.auto-registration.fail-fast | false | Whether startup fails if there is no AutoServiceRegistration. Defaults to false.
|
||||
|spring.cloud.service-registry.auto-registration.register-management | true | Whether to register the management as a service. Defaults to true.
|
||||
|spring.cloud.service-registry.enabled | true | Enables Service Registry functionality.
|
||||
|spring.cloud.stream.binders | | Additional per-binder properties (see {@link BinderProperties}) if more then one binder of the same type is used (i.e., connect to multiple instances of RabbitMq). Here you can specify multiple binder configurations, each with different environment settings. For example; spring.cloud.stream.binders.rabbit1.environment. . . , spring.cloud.stream.binders.rabbit2.environment. . .
|
||||
|spring.cloud.stream.binding-retry-interval | 30 | Retry interval (in seconds) used to schedule binding attempts. Default: 30 sec.
|
||||
|spring.cloud.stream.bindings | | Additional binding properties (see {@link BinderProperties}) per binding name (e.g., 'input`). For example; This sets the content-type for the 'input' binding of a Sink application: 'spring.cloud.stream.bindings.input.contentType=text/plain'
|
||||
|spring.cloud.stream.consul.binder.event-timeout | 5 | null
|
||||
|spring.cloud.stream.default-binder | | The name of the binder to use by all bindings in the event multiple binders available (e.g., 'rabbit').
|
||||
|spring.cloud.stream.dynamic-destination-cache-size | 10 | The maximum size of Least Recently Used (LRU) cache of dynamic destinations. Once this size is reached, new destinations will trigger the removal of old destinations. Default: 10
|
||||
|spring.cloud.stream.dynamic-destinations | [] | A list of destinations that can be bound dynamically. If set, only listed destinations can be bound.
|
||||
|spring.cloud.stream.function.batch-mode | false | null
|
||||
|spring.cloud.stream.function.bindings | | null
|
||||
|spring.cloud.stream.function.definition | | Definition of functions to bind. If several functions need to be composed into one, use pipes (e.g., 'fooFunc\|barFunc')
|
||||
|spring.cloud.stream.instance-count | 1 | The number of deployed instances of an application. Default: 1. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-count" where 'foo' is the name of the binding.
|
||||
|spring.cloud.stream.instance-index | 0 | The instance id of the application: a number from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index" where 'foo' is the name of the binding.
|
||||
|spring.cloud.stream.instance-index-list | | A list of instance id's from 0 to instanceCount-1. Used for partitioning and with Kafka. NOTE: Could also be managed per individual binding "spring.cloud.stream.bindings.foo.consumer.instance-index-list" where 'foo' is the name of the binding. This setting will override the one set in 'spring.cloud.stream.instance-index'
|
||||
|spring.cloud.stream.integration.message-handler-not-propagated-headers | | Message header names that will NOT be copied from the inbound message.
|
||||
|spring.cloud.stream.kafka.binder.authorization-exception-retry-interval | | Time between retries after AuthorizationException is caught in the ListenerContainer; defalt is null which disables retries. For more info see: {@link org.springframework.kafka.listener.ConsumerProperties#setAuthorizationExceptionRetryInterval(java.time.Duration)}
|
||||
|spring.cloud.stream.kafka.binder.auto-add-partitions | false | null
|
||||
|spring.cloud.stream.kafka.binder.auto-create-topics | true | null
|
||||
|spring.cloud.stream.kafka.binder.brokers | [localhost] | null
|
||||
|spring.cloud.stream.kafka.binder.configuration | | Arbitrary kafka properties that apply to both producers and consumers.
|
||||
|spring.cloud.stream.kafka.binder.consumer-properties | | Arbitrary kafka consumer properties.
|
||||
|spring.cloud.stream.kafka.binder.header-mapper-bean-name | | The bean name of a custom header mapper to use instead of a {@link org.springframework.kafka.support.DefaultKafkaHeaderMapper}.
|
||||
|spring.cloud.stream.kafka.binder.headers | [] | null
|
||||
|spring.cloud.stream.kafka.binder.health-timeout | 60 | Time to wait to get partition information in seconds; default 60.
|
||||
|spring.cloud.stream.kafka.binder.jaas | | null
|
||||
|spring.cloud.stream.kafka.binder.min-partition-count | 1 | null
|
||||
|spring.cloud.stream.kafka.binder.producer-properties | | Arbitrary kafka producer properties.
|
||||
|spring.cloud.stream.kafka.binder.replication-factor | 1 | null
|
||||
|spring.cloud.stream.kafka.binder.required-acks | 1 | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.batch-timeout | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.buffer-size | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.compression-type | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.configuration | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.error-channel-enabled | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.header-mode | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.header-patterns | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.message-key-expression | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.partition-count | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.partition-key-expression | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.partition-key-extractor-name | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.partition-selector-expression | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.partition-selector-name | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.required-groups | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.sync | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.topic | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.producer.use-native-encoding | | null
|
||||
|spring.cloud.stream.kafka.binder.transaction.transaction-id-prefix | | null
|
||||
|spring.cloud.stream.kafka.bindings | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.application-id | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.authorization-exception-retry-interval | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.auto-add-partitions | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.auto-create-topics | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.brokers | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.configuration | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.consumer-properties | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.deserialization-exception-handler | | {@link org.apache.kafka.streams.errors.DeserializationExceptionHandler} to use when there is a deserialization exception. This handler will be applied against all input bindings unless overridden at the consumer binding.
|
||||
|spring.cloud.stream.kafka.streams.binder.functions | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.header-mapper-bean-name | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.headers | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.health-timeout | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.jaas | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.min-partition-count | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.producer-properties | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.replication-factor | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.required-acks | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.serde-error | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.state-store-retry.backoff-period | 1000 | null
|
||||
|spring.cloud.stream.kafka.streams.binder.state-store-retry.max-attempts | 1 | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.batch-timeout | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.buffer-size | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.compression-type | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.configuration | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.error-channel-enabled | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.header-mode | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.header-patterns | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.message-key-expression | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.partition-count | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.partition-key-expression | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.partition-key-extractor-name | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.partition-selector-expression | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.partition-selector-name | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.required-groups | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.sync | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.topic | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.producer.use-native-encoding | | null
|
||||
|spring.cloud.stream.kafka.streams.binder.transaction.transaction-id-prefix | | null
|
||||
|spring.cloud.stream.kafka.streams.bindings | | null
|
||||
|spring.cloud.stream.metrics.export-properties | | List of properties that are going to be appended to each message. This gets populate by onApplicationEvent, once the context refreshes to avoid overhead of doing per message basis.
|
||||
|spring.cloud.stream.metrics.key | | The name of the metric being emitted. Should be an unique value per application. Defaults to: ${spring.application.name:${vcap.application.name:${spring.config.name:application}}}.
|
||||
|spring.cloud.stream.metrics.meter-filter | | Pattern to control the 'meters' one wants to capture. By default all 'meters' will be captured. For example, 'spring.integration.*' will only capture metric information for meters whose name starts with 'spring.integration'.
|
||||
|spring.cloud.stream.metrics.properties | | Application properties that should be added to the metrics payload For example: `spring.application**`.
|
||||
|spring.cloud.stream.metrics.schedule-interval | 60s | Interval expressed as Duration for scheduling metrics snapshots publishing. Defaults to 60 seconds
|
||||
|spring.cloud.stream.override-cloud-connectors | false | This property is only applicable when the cloud profile is active and Spring Cloud Connectors are provided with the application. If the property is false (the default), the binder detects a suitable bound service (for example, a RabbitMQ service bound in Cloud Foundry for the RabbitMQ binder) and uses it for creating connections (usually through Spring Cloud Connectors). When set to true, this property instructs binders to completely ignore the bound services and rely on Spring Boot properties (for example, relying on the spring.rabbitmq.* properties provided in the environment for the RabbitMQ binder). The typical usage of this property is to be nested in a customized environment when connecting to multiple systems.
|
||||
|spring.cloud.stream.poller.cron | | Cron expression value for the Cron Trigger.
|
||||
|spring.cloud.stream.poller.fixed-delay | 1000 | Fixed delay for default poller.
|
||||
|spring.cloud.stream.poller.initial-delay | 0 | Initial delay for periodic triggers.
|
||||
|spring.cloud.stream.poller.max-messages-per-poll | 1 | Maximum messages per poll for the default poller.
|
||||
|spring.cloud.stream.rabbit.binder.admin-addresses | [] | Urls for management plugins; only needed for queue affinity.
|
||||
|spring.cloud.stream.rabbit.binder.admin-adresses | | null
|
||||
|spring.cloud.stream.rabbit.binder.compression-level | 0 | Compression level for compressed bindings; see 'java.util.zip.Deflator'.
|
||||
|spring.cloud.stream.rabbit.binder.connection-name-prefix | | Prefix for connection names from this binder.
|
||||
|spring.cloud.stream.rabbit.binder.nodes | [] | Cluster member node names; only needed for queue affinity.
|
||||
|spring.cloud.stream.rabbit.bindings | | null
|
||||
|spring.cloud.stream.sendto.destination | none | The name of the header used to determine the name of the output destination
|
||||
|spring.cloud.stream.source | | A colon delimited string representing the names of the sources based on which source bindings will be created. This is primarily to support cases where source binding may be required without providing a corresponding Supplier. (e.g., for cases where the actual source of data is outside of scope of spring-cloud-stream - HTTP -> Stream)
|
||||
|spring.cloud.util.enabled | true | Enables creation of Spring Cloud utility beans.
|
||||
|spring.cloud.vault.app-id.app-id-path | app-id | Mount path of the AppId authentication backend.
|
||||
|spring.cloud.vault.app-id.network-interface | | Network interface hint for the "MAC_ADDRESS" UserId mechanism.
|
||||
|spring.cloud.vault.app-id.user-id | MAC_ADDRESS | UserId mechanism. Can be either "MAC_ADDRESS", "IP_ADDRESS", a string or a class name.
|
||||
|spring.cloud.vault.app-role.app-role-path | approle | Mount path of the AppRole authentication backend.
|
||||
|spring.cloud.vault.app-role.role | | Name of the role, optional, used for pull-mode.
|
||||
|spring.cloud.vault.app-role.role-id | | The RoleId.
|
||||
|spring.cloud.vault.app-role.secret-id | | The SecretId.
|
||||
|spring.cloud.vault.application-name | application | Application name for AppId authentication.
|
||||
|spring.cloud.vault.authentication | | null
|
||||
|spring.cloud.vault.aws-ec2.aws-ec2-path | aws-ec2 | Mount path of the AWS-EC2 authentication backend.
|
||||
|spring.cloud.vault.aws-ec2.identity-document | http://169.254.169.254/latest/dynamic/instance-identity/pkcs7 | URL of the AWS-EC2 PKCS7 identity document.
|
||||
|spring.cloud.vault.aws-ec2.nonce | | Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation.
|
||||
|spring.cloud.vault.aws-ec2.role | | Name of the role, optional.
|
||||
|spring.cloud.vault.aws-iam.aws-path | aws | Mount path of the AWS authentication backend.
|
||||
|spring.cloud.vault.aws-iam.endpoint-uri | | STS server URI. @since 2.2
|
||||
|spring.cloud.vault.aws-iam.role | | Name of the role, optional. Defaults to the friendly IAM name if not set.
|
||||
|spring.cloud.vault.aws-iam.server-name | | Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests.
|
||||
|spring.cloud.vault.aws.access-key-property | cloud.aws.credentials.accessKey | Target property for the obtained access key.
|
||||
|spring.cloud.vault.aws.backend | aws | aws backend path.
|
||||
|spring.cloud.vault.aws.enabled | false | Enable aws backend usage.
|
||||
|spring.cloud.vault.aws.role | | Role name for credentials.
|
||||
|spring.cloud.vault.aws.secret-key-property | cloud.aws.credentials.secretKey | Target property for the obtained secret key.
|
||||
|spring.cloud.vault.azure-msi.azure-path | azure | Mount path of the Azure MSI authentication backend.
|
||||
|spring.cloud.vault.azure-msi.role | | Name of the role.
|
||||
|spring.cloud.vault.cassandra.backend | cassandra | Cassandra backend path.
|
||||
|spring.cloud.vault.cassandra.enabled | false | Enable cassandra backend usage.
|
||||
|spring.cloud.vault.cassandra.password-property | spring.data.cassandra.password | Target property for the obtained password.
|
||||
|spring.cloud.vault.cassandra.role | | Role name for credentials.
|
||||
|spring.cloud.vault.cassandra.static-role | false | Enable static role usage. @since 2.2
|
||||
|spring.cloud.vault.cassandra.username-property | spring.data.cassandra.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.config.lifecycle.enabled | true | Enable lifecycle management.
|
||||
|spring.cloud.vault.config.lifecycle.expiry-threshold | | The expiry threshold. {@link Lease} is renewed the given {@link Duration} before it expires. @since 2.2
|
||||
|spring.cloud.vault.config.lifecycle.lease-endpoints | | Set the {@link LeaseEndpoints} to delegate renewal/revocation calls to. {@link LeaseEndpoints} encapsulates differences between Vault versions that affect the location of renewal/revocation endpoints. Can be {@link LeaseEndpoints#SysLeases} for version 0.8 or above of Vault or {@link LeaseEndpoints#Legacy} for older versions (the default). @since 2.2
|
||||
|spring.cloud.vault.config.lifecycle.min-renewal | | The time period that is at least required before renewing a lease. @since 2.2
|
||||
|spring.cloud.vault.config.order | 0 | Used to set a {@link org.springframework.core.env.PropertySource} priority. This is useful to use Vault as an override on other property sources. @see org.springframework.core.PriorityOrdered
|
||||
|spring.cloud.vault.connection-timeout | 5000 | Connection timeout.
|
||||
|spring.cloud.vault.consul.backend | consul | Consul backend path.
|
||||
|spring.cloud.vault.consul.enabled | false | Enable consul backend usage.
|
||||
|spring.cloud.vault.consul.role | | Role name for credentials.
|
||||
|spring.cloud.vault.consul.token-property | spring.cloud.consul.token | Target property for the obtained token.
|
||||
|spring.cloud.vault.database.backend | database | Database backend path.
|
||||
|spring.cloud.vault.database.enabled | false | Enable database backend usage.
|
||||
|spring.cloud.vault.database.password-property | spring.datasource.password | Target property for the obtained password.
|
||||
|spring.cloud.vault.database.role | | Role name for credentials.
|
||||
|spring.cloud.vault.database.static-role | false | Enable static role usage.
|
||||
|spring.cloud.vault.database.username-property | spring.datasource.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.discovery.enabled | false | Flag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery).
|
||||
|spring.cloud.vault.discovery.service-id | vault | Service id to locate Vault.
|
||||
|spring.cloud.vault.elasticsearch.backend | database | Database backend path.
|
||||
|spring.cloud.vault.elasticsearch.enabled | false | Enable elasticsearch backend usage.
|
||||
|spring.cloud.vault.elasticsearch.password-property | spring.elasticsearch.rest.password | Target property for the obtained password.
|
||||
|spring.cloud.vault.elasticsearch.role | | Role name for credentials.
|
||||
|spring.cloud.vault.elasticsearch.static-role | false | Enable static role usage.
|
||||
|spring.cloud.vault.elasticsearch.username-property | spring.elasticsearch.rest.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.enabled | true | Enable Vault config server.
|
||||
|spring.cloud.vault.fail-fast | false | Fail fast if data cannot be obtained from Vault.
|
||||
|spring.cloud.vault.gcp-gce.gcp-path | gcp | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.vault.gcp-gce.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.vault.gcp-gce.service-account | | Optional service account id. Using the default id if left unconfigured.
|
||||
|spring.cloud.vault.gcp-iam.credentials.encoded-key | | The base64 encoded contents of an OAuth2 account private key in JSON format.
|
||||
|spring.cloud.vault.gcp-iam.credentials.location | | Location of the OAuth2 credentials private key. <p> Since this is a Resource, the private key can be in a multitude of locations, such as a local file system, classpath, URL, etc.
|
||||
|spring.cloud.vault.gcp-iam.gcp-path | gcp | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.vault.gcp-iam.jwt-validity | 15m | Validity of the JWT token.
|
||||
|spring.cloud.vault.gcp-iam.project-id | | Overrides the GCP project Id.
|
||||
|spring.cloud.vault.gcp-iam.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.vault.gcp-iam.service-account-id | | Overrides the GCP service account Id.
|
||||
|spring.cloud.vault.host | localhost | Vault server host.
|
||||
|spring.cloud.vault.kubernetes.kubernetes-path | kubernetes | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.vault.kubernetes.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.vault.kubernetes.service-account-token-file | /var/run/secrets/kubernetes.io/serviceaccount/token | Path to the service account token file.
|
||||
|spring.cloud.vault.kv.application-name | application | Application name to be used for the context.
|
||||
|spring.cloud.vault.kv.backend | secret | Name of the default backend.
|
||||
|spring.cloud.vault.kv.backend-version | 2 | Key-Value backend version. Currently supported versions are: <ul> <li>Version 1 (unversioned key-value backend).</li> <li>Version 2 (versioned key-value backend).</li> </ul>
|
||||
|spring.cloud.vault.kv.default-context | application | Name of the default context.
|
||||
|spring.cloud.vault.kv.enabled | true | Enable the kev-value backend.
|
||||
|spring.cloud.vault.kv.profile-separator | / | Profile-separator to combine application name and profile.
|
||||
|spring.cloud.vault.kv.profiles | | List of active profiles. @since 3.0
|
||||
|spring.cloud.vault.mongodb.backend | mongodb | MongoDB backend path.
|
||||
|spring.cloud.vault.mongodb.enabled | false | Enable mongodb backend usage.
|
||||
|spring.cloud.vault.mongodb.password-property | spring.data.mongodb.password | Target property for the obtained password.
|
||||
|spring.cloud.vault.mongodb.role | | Role name for credentials.
|
||||
|spring.cloud.vault.mongodb.static-role | false | Enable static role usage. @since 2.2
|
||||
|spring.cloud.vault.mongodb.username-property | spring.data.mongodb.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.mysql.backend | mysql | mysql backend path.
|
||||
|spring.cloud.vault.mysql.enabled | false | Enable mysql backend usage.
|
||||
|spring.cloud.vault.mysql.password-property | spring.datasource.password | Target property for the obtained username.
|
||||
|spring.cloud.vault.mysql.role | | Role name for credentials.
|
||||
|spring.cloud.vault.mysql.username-property | spring.datasource.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.namespace | | Vault namespace (requires Vault Enterprise).
|
||||
|spring.cloud.vault.pcf.instance-certificate | | Path to the instance certificate (PEM). Defaults to {@code CF_INSTANCE_CERT} env variable.
|
||||
|spring.cloud.vault.pcf.instance-key | | Path to the instance key (PEM). Defaults to {@code CF_INSTANCE_KEY} env variable.
|
||||
|spring.cloud.vault.pcf.pcf-path | pcf | Mount path of the Kubernetes authentication backend.
|
||||
|spring.cloud.vault.pcf.role | | Name of the role against which the login is being attempted.
|
||||
|spring.cloud.vault.port | 8200 | Vault server port.
|
||||
|spring.cloud.vault.postgresql.backend | postgresql | postgresql backend path.
|
||||
|spring.cloud.vault.postgresql.enabled | false | Enable postgresql backend usage.
|
||||
|spring.cloud.vault.postgresql.password-property | spring.datasource.password | Target property for the obtained username.
|
||||
|spring.cloud.vault.postgresql.role | | Role name for credentials.
|
||||
|spring.cloud.vault.postgresql.username-property | spring.datasource.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.rabbitmq.backend | rabbitmq | rabbitmq backend path.
|
||||
|spring.cloud.vault.rabbitmq.enabled | false | Enable rabbitmq backend usage.
|
||||
|spring.cloud.vault.rabbitmq.password-property | spring.rabbitmq.password | Target property for the obtained password.
|
||||
|spring.cloud.vault.rabbitmq.role | | Role name for credentials.
|
||||
|spring.cloud.vault.rabbitmq.username-property | spring.rabbitmq.username | Target property for the obtained username.
|
||||
|spring.cloud.vault.read-timeout | 15000 | Read timeout.
|
||||
|spring.cloud.vault.scheme | https | Protocol scheme. Can be either "http" or "https".
|
||||
|spring.cloud.vault.ssl.cert-auth-path | cert | Mount path of the TLS cert authentication backend.
|
||||
|spring.cloud.vault.ssl.key-store | | Trust store that holds certificates and private keys.
|
||||
|spring.cloud.vault.ssl.key-store-password | | Password used to access the key store.
|
||||
|spring.cloud.vault.ssl.trust-store | | Trust store that holds SSL certificates.
|
||||
|spring.cloud.vault.ssl.trust-store-password | | Password used to access the trust store.
|
||||
|spring.cloud.vault.token | | Static vault token. Required if {@link #authentication} is {@code TOKEN}.
|
||||
|spring.cloud.vault.uri | | Vault URI. Can be set with scheme, host and port.
|
||||
|spring.cloud.zookeeper.base-sleep-time-ms | 50 | Initial amount of time to wait between retries.
|
||||
|spring.cloud.zookeeper.block-until-connected-unit | | The unit of time related to blocking on connection to Zookeeper.
|
||||
|spring.cloud.zookeeper.block-until-connected-wait | 10 | Wait time to block on connection to Zookeeper.
|
||||
|spring.cloud.zookeeper.connect-string | localhost:2181 | Connection string to the Zookeeper cluster.
|
||||
|spring.cloud.zookeeper.connection-timeout | | The configured connection timeout in milliseconds.
|
||||
|spring.cloud.zookeeper.dependencies | | Mapping of alias to ZookeeperDependency. From LoadBalancer perspective the alias is actually serviceID since SC LoadBalancer can't accept nested structures in serviceID.
|
||||
|spring.cloud.zookeeper.dependency-configurations | | null
|
||||
|spring.cloud.zookeeper.dependency-names | | null
|
||||
|spring.cloud.zookeeper.discovery.enabled | true | null
|
||||
|spring.cloud.zookeeper.discovery.initial-status | | The initial status of this instance (defaults to {@link StatusConstants#STATUS_UP}).
|
||||
|spring.cloud.zookeeper.discovery.instance-host | | Predefined host with which a service can register itself in Zookeeper. Corresponds to the {code address} from the URI spec.
|
||||
|spring.cloud.zookeeper.discovery.instance-id | | Id used to register with zookeeper. Defaults to a random UUID.
|
||||
|spring.cloud.zookeeper.discovery.instance-port | | Port to register the service under (defaults to listening port).
|
||||
|spring.cloud.zookeeper.discovery.instance-ssl-port | | Ssl port of the registered service.
|
||||
|spring.cloud.zookeeper.discovery.metadata | | Gets the metadata name/value pairs associated with this instance. This information is sent to zookeeper and can be used by other instances.
|
||||
|spring.cloud.zookeeper.discovery.order | 0 | Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
|
||||
|spring.cloud.zookeeper.discovery.register | true | Register as a service in zookeeper.
|
||||
|spring.cloud.zookeeper.discovery.root | /services | Root Zookeeper folder in which all instances are registered.
|
||||
|spring.cloud.zookeeper.discovery.uri-spec | {scheme}://{address}:{port} | The URI specification to resolve during service registration in Zookeeper.
|
||||
|spring.cloud.zookeeper.enabled | true | Is Zookeeper enabled.
|
||||
|spring.cloud.zookeeper.max-retries | 10 | Max number of times to retry.
|
||||
|spring.cloud.zookeeper.max-sleep-ms | 500 | Max time in ms to sleep on each retry.
|
||||
|spring.cloud.zookeeper.prefix | | Common prefix that will be applied to all Zookeeper dependencies' paths.
|
||||
|spring.cloud.zookeeper.session-timeout | | The configured/negotiated session timeout in milliseconds. Please refer to <a href='https://cwiki.apache.org/confluence/display/CURATOR/TN14'>Curator's Tech Note 14</a> to understand how Curator implements connection sessions. @see <a href='https://cwiki.apache.org/confluence/display/CURATOR/TN14'>Curator's Tech Note 14</a>
|
||||
|spring.sleuth.async.configurer.enabled | true | Enable default AsyncConfigurer.
|
||||
|spring.sleuth.async.enabled | true | Enable instrumenting async related components so that the tracing information is passed between threads.
|
||||
|spring.sleuth.async.ignored-beans | | List of {@link java.util.concurrent.Executor} bean names that should be ignored and not wrapped in a trace representation.
|
||||
|spring.sleuth.baggage.correlation-enabled | true | Adds a {@link CorrelationScopeDecorator} to put baggage values into the correlation context.
|
||||
|spring.sleuth.baggage.correlation-fields | | A list of {@link BaggageField#name() fields} to add to correlation (MDC) context. @see CorrelationScopeConfig.SingleCorrelationField#create(BaggageField)
|
||||
|spring.sleuth.baggage.local-fields | | Same as {@link #remoteFields} except that this field is not propagated to remote services. @see BaggagePropagationConfig.SingleBaggageField#local(BaggageField)
|
||||
|spring.sleuth.baggage.remote-fields | | List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix. @see BaggagePropagationConfig.SingleBaggageField#remote(BaggageField) @see BaggagePropagationConfig.SingleBaggageField.Builder#addKeyName(String)
|
||||
|spring.sleuth.baggage.tag-fields | | A list of {@link BaggageField#name() fields} to tag into the span. @see Tags#BAGGAGE_FIELD
|
||||
|spring.sleuth.circuitbreaker.enabled | true | Enable Spring Cloud CircuitBreaker instrumentation.
|
||||
|spring.sleuth.enabled | true | null
|
||||
|spring.sleuth.feign.enabled | true | Enable span information propagation when using Feign.
|
||||
|spring.sleuth.feign.processor.enabled | true | Enable post processor that wraps Feign Context in its tracing representations.
|
||||
|spring.sleuth.grpc.enabled | true | Enable span information propagation when using GRPC.
|
||||
|spring.sleuth.http.enabled | true | null
|
||||
|spring.sleuth.http.legacy.enabled | false | null
|
||||
|spring.sleuth.integration.enabled | true | Enable Spring Integration sleuth instrumentation.
|
||||
|spring.sleuth.integration.patterns | [!hystrixStreamOutput*, *, !channel*] | An array of patterns against which channel names will be matched. @see org.springframework.integration.config.GlobalChannelInterceptor#patterns() Defaults to any channel name not matching the Hystrix Stream and functional Stream channel names.
|
||||
|spring.sleuth.integration.websockets.enabled | true | Enable tracing for WebSockets.
|
||||
|spring.sleuth.messaging.enabled | false | Should messaging be turned on.
|
||||
|spring.sleuth.messaging.jms.enabled | true | Enable tracing of JMS.
|
||||
|spring.sleuth.messaging.jms.remote-service-name | jms | null
|
||||
|spring.sleuth.messaging.kafka.enabled | true | Enable tracing of Kafka.
|
||||
|spring.sleuth.messaging.kafka.mapper.enabled | true | Enable DefaultKafkaHeaderMapper tracing for Kafka.
|
||||
|spring.sleuth.messaging.kafka.remote-service-name | kafka | null
|
||||
|spring.sleuth.messaging.rabbit.enabled | true | Enable tracing of RabbitMQ.
|
||||
|spring.sleuth.messaging.rabbit.remote-service-name | rabbitmq | null
|
||||
|spring.sleuth.opentracing.enabled | true | null
|
||||
|spring.sleuth.reactor.decorate-on-each | true | When true decorates on each operator, will be less performing, but logging will always contain the tracing entries in each operator. When false decorates on last operator, will be more performing, but logging might not always contain the tracing entries.
|
||||
|spring.sleuth.reactor.enabled | true | When true enables instrumentation for reactor.
|
||||
|spring.sleuth.redis.enabled | true | Enable span information propagation when using Redis.
|
||||
|spring.sleuth.redis.remote-service-name | redis | Service name for the remote Redis endpoint.
|
||||
|spring.sleuth.rpc.enabled | true | Enable tracing of RPC.
|
||||
|spring.sleuth.rxjava.schedulers.hook.enabled | true | Enable support for RxJava via RxJavaSchedulersHook.
|
||||
|spring.sleuth.rxjava.schedulers.ignoredthreads | [HystrixMetricPoller, ^RxComputation.*$] | Thread names for which spans will not be sampled.
|
||||
|spring.sleuth.sampler.probability | | Probability of requests that should be sampled. E.g. 1.0 - 100% requests should be sampled. The precision is whole-numbers only (i.e. there's no support for 0.1% of the traces).
|
||||
|spring.sleuth.sampler.rate | 10 | A rate per second can be a nice choice for low-traffic endpoints as it allows you surge protection. For example, you may never expect the endpoint to get more than 50 requests per second. If there was a sudden surge of traffic, to 5000 requests per second, you would still end up with 50 traces per second. Conversely, if you had a percentage, like 10%, the same surge would end up with 500 traces per second, possibly overloading your storage. Amazon X-Ray includes a rate-limited sampler (named Reservoir) for this purpose. Brave has taken the same approach via the {@link brave.sampler.RateLimitingSampler}.
|
||||
|spring.sleuth.scheduled.enabled | true | Enable tracing for {@link org.springframework.scheduling.annotation.Scheduled}.
|
||||
|spring.sleuth.scheduled.skip-pattern | | Pattern for the fully qualified name of a class that should be skipped.
|
||||
|spring.sleuth.supports-join | true | True means the tracing system supports sharing a span ID between a client and server.
|
||||
|spring.sleuth.trace-id128 | false | When true, generate 128-bit trace IDs instead of 64-bit ones.
|
||||
|spring.sleuth.web.additional-skip-pattern | | Additional pattern for URLs that should be skipped in tracing. This will be appended to the {@link SleuthWebProperties#skipPattern}.
|
||||
|spring.sleuth.web.client.enabled | true | Enable interceptor injecting into {@link org.springframework.web.client.RestTemplate}.
|
||||
|spring.sleuth.web.client.skip-pattern | | Pattern for URLs that should be skipped in client side tracing.
|
||||
|spring.sleuth.web.enabled | true | When true enables instrumentation for web applications.
|
||||
|spring.sleuth.web.filter-order | | Order in which the tracing filters should be registered. Defaults to {@link TraceHttpAutoConfiguration#TRACING_FILTER_ORDER}.
|
||||
|spring.sleuth.web.ignore-auto-configured-skip-patterns | false | If set to true, auto-configured skip patterns will be ignored. @see SkipPatternConfiguration
|
||||
|spring.sleuth.web.skip-pattern | /api-docs.*\|/swagger.*\|.*\.png\|.*\.css\|.*\.js\|.*\.html\|/favicon.ico\|/hystrix.stream | Pattern for URLs that should be skipped in tracing.
|
||||
|spring.zipkin.activemq.message-max-bytes | 100000 | Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.
|
||||
|spring.zipkin.activemq.queue | zipkin | Name of the ActiveMQ queue where spans should be sent to Zipkin.
|
||||
|spring.zipkin.base-url | http://localhost:9411/ | URL of the zipkin query server instance. You can also provide the service id of the Zipkin server if Zipkin's registered in service discovery (e.g. https://zipkinserver/).
|
||||
|spring.zipkin.compression.enabled | false | null
|
||||
|spring.zipkin.discovery-client-enabled | | If set to {@code false}, will treat the {@link ZipkinProperties#baseUrl} as a URL always.
|
||||
|spring.zipkin.enabled | true | Enables sending spans to Zipkin.
|
||||
|spring.zipkin.encoder | | Encoding type of spans sent to Zipkin. Set to {@link SpanBytesEncoder#JSON_V1} if your server is not recent.
|
||||
|spring.zipkin.kafka.topic | zipkin | Name of the Kafka topic where spans should be sent to Zipkin.
|
||||
|spring.zipkin.locator.discovery.enabled | false | Enabling of locating the host name via service discovery.
|
||||
|spring.zipkin.message-timeout | 1 | Timeout in seconds before pending spans will be sent in batches to Zipkin.
|
||||
|spring.zipkin.rabbitmq.addresses | | Addresses of the RabbitMQ brokers used to send spans to Zipkin
|
||||
|spring.zipkin.rabbitmq.queue | zipkin | Name of the RabbitMQ queue where spans should be sent to Zipkin.
|
||||
|spring.zipkin.sender.type | | Means of sending spans to Zipkin.
|
||||
|spring.zipkin.service.name | | The name of the service, from which the Span was sent via HTTP, that should appear in Zipkin.
|
||||
|stubrunner.amqp.enabled | false | Whether to enable support for Stub Runner and AMQP.
|
||||
|stubrunner.amqp.mockCOnnection | true | Whether to enable support for Stub Runner and AMQP mocked connection factory.
|
||||
|stubrunner.classifier | stubs | The classifier to use by default in ivy co-ordinates for a stub.
|
||||
|stubrunner.cloud.consul.enabled | true | Whether to enable stubs registration in Consul.
|
||||
|stubrunner.cloud.delegate.enabled | true | Whether to enable DiscoveryClient's Stub Runner implementation.
|
||||
|stubrunner.cloud.enabled | true | Whether to enable Spring Cloud support for Stub Runner.
|
||||
|stubrunner.cloud.eureka.enabled | true | Whether to enable stubs registration in Eureka.
|
||||
|stubrunner.cloud.loadbalancer.enabled | true | Whether to enable Stub Runner's Spring Cloud Load Balancer integration.
|
||||
|stubrunner.cloud.stubbed.discovery.enabled | true | Whether Service Discovery should be stubbed for Stub Runner. If set to false, stubs will get registered in real service discovery.
|
||||
|stubrunner.cloud.zookeeper.enabled | true | Whether to enable stubs registration in Zookeeper.
|
||||
|stubrunner.consumer-name | | You can override the default {@code spring.application.name} of this field by setting a value to this parameter.
|
||||
|stubrunner.delete-stubs-after-test | true | If set to {@code false} will NOT delete stubs from a temporary folder after running tests.
|
||||
|stubrunner.fail-on-no-stubs | true | When enabled, this flag will tell stub runner to throw an exception when no stubs / contracts were found.
|
||||
|stubrunner.generate-stubs | false | When enabled, this flag will tell stub runner to not load the generated stubs, but convert the found contracts at runtime to a stub format and run those stubs.
|
||||
|stubrunner.http-server-stub-configurer | | Configuration for an HTTP server stub.
|
||||
|stubrunner.ids | [] | The ids of the stubs to run in "ivy" notation ([groupId]:artifactId:[version]:[classifier][:port]). {@code groupId}, {@code classifier}, {@code version} and {@code port} can be optional.
|
||||
|stubrunner.ids-to-service-ids | | Mapping of Ivy notation based ids to serviceIds inside your application. Example "a:b" -> "myService" "artifactId" -> "myOtherService"
|
||||
|stubrunner.integration.enabled | true | Whether to enable Stub Runner integration with Spring Integration.
|
||||
|stubrunner.jms.enabled | true | Whether to enable Stub Runner integration with Spring JMS.
|
||||
|stubrunner.kafka.enabled | true | Whether to enable Stub Runner integration with Spring Kafka.
|
||||
|stubrunner.kafka.initializer.enabled | true | Whether to allow Stub Runner to take care of polling for messages instead of the KafkaStubMessages component. The latter should be used only on the producer side.
|
||||
|stubrunner.mappings-output-folder | | Dumps the mappings of each HTTP server to the selected folder.
|
||||
|stubrunner.max-port | 15000 | Max value of a port for the automatically started WireMock server.
|
||||
|stubrunner.min-port | 10000 | Min value of a port for the automatically started WireMock server.
|
||||
|stubrunner.password | | Repository password.
|
||||
|stubrunner.properties | | Map of properties that can be passed to custom {@link org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder}.
|
||||
|stubrunner.proxy-host | | Repository proxy host.
|
||||
|stubrunner.proxy-port | | Repository proxy port.
|
||||
|stubrunner.server-id | | null
|
||||
|stubrunner.stream.enabled | true | Whether to enable Stub Runner integration with Spring Cloud Stream.
|
||||
|stubrunner.stubs-mode | | Pick where the stubs should come from.
|
||||
|stubrunner.stubs-per-consumer | false | Should only stubs for this particular consumer get registered in HTTP server stub.
|
||||
|stubrunner.username | | Repository username.
|
||||
|wiremock.placeholders.enabled | true | Flag to indicate that http URLs in generated wiremock stubs should be filtered to add or resolve a placeholder for a dynamic port.
|
||||
|wiremock.reset-mappings-after-each-test | false | null
|
||||
|wiremock.rest-template-ssl-enabled | false | null
|
||||
|wiremock.server.files | [] | null
|
||||
|wiremock.server.https-port | -1 | null
|
||||
|wiremock.server.https-port-dynamic | false | null
|
||||
|wiremock.server.port | 8080 | null
|
||||
|wiremock.server.port-dynamic | false | null
|
||||
|wiremock.server.stubs | [] | null
|
||||
|
||||
|===
|
||||
@@ -0,0 +1,22 @@
|
||||
https://docs.spring.io/spring-cloud-build/docs/3.0.0-M2/reference/html/[spring-cloud-build] :: spring-cloud-build Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-commons/docs/3.0.0-M2/reference/html/[spring-cloud-commons] :: spring-cloud-commons Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-function/docs/3.1.0.M1/reference/html/[spring-cloud-function] :: spring-cloud-function Reference Documentation, version 3.1.0.M1
|
||||
https://docs.spring.io/spring-cloud-stream-core/docs/3.1.0.M1/reference/html/[spring-cloud-stream-core] :: spring-cloud-stream-core Reference Documentation, version 3.1.0.M1
|
||||
https://docs.spring.io/spring-cloud-stream-binder-rabbit/docs/3.1.0.M1/reference/html/[spring-cloud-stream-binder-rabbit] :: spring-cloud-stream-binder-rabbit Reference Documentation, version 3.1.0.M1
|
||||
https://docs.spring.io/spring-cloud-stream-binder-kafka/docs/3.1.0.M1/reference/html/[spring-cloud-stream-binder-kafka] :: spring-cloud-stream-binder-kafka Reference Documentation, version 3.1.0.M1
|
||||
https://docs.spring.io/spring-cloud-bus/docs/3.0.0-M2/reference/html/[spring-cloud-bus] :: spring-cloud-bus Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-task/docs/2.3.0-M1/reference/[spring-cloud-task] :: spring-cloud-task Reference Documentation, version 2.3.0-M1
|
||||
https://docs.spring.io/spring-cloud-config/docs/3.0.0-M2/reference/html/[spring-cloud-config] :: spring-cloud-config Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-netflix/docs/3.0.0-M2/reference/html/[spring-cloud-netflix] :: spring-cloud-netflix Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-cloudfoundry/docs/3.0.0-M2/reference/html/[spring-cloud-cloudfoundry] :: spring-cloud-cloudfoundry Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-kubernetes/docs/2.0.0-M2/reference/html/[spring-cloud-kubernetes] :: spring-cloud-kubernetes Reference Documentation, version 2.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-openfeign/docs/3.0.0-M2/reference/html/[spring-cloud-openfeign] :: spring-cloud-openfeign Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-consul/docs/3.0.0-M2/reference/html/[spring-cloud-consul] :: spring-cloud-consul Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-gateway/docs/3.0.0-M2/reference/html/[spring-cloud-gateway] :: spring-cloud-gateway Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-security/docs/3.0.0-M2/reference/html/[spring-cloud-security] :: spring-cloud-security Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-sleuth/docs/3.0.0-M2/reference/html/[spring-cloud-sleuth] :: spring-cloud-sleuth Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-zookeeper/docs/3.0.0-M2/reference/html/[spring-cloud-zookeeper] :: spring-cloud-zookeeper Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-contract/docs/3.0.0-M2/reference/html/[spring-cloud-contract] :: spring-cloud-contract Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-vault/docs/3.0.0-M2/reference/html/[spring-cloud-vault] :: spring-cloud-vault Reference Documentation, version 3.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-circuitbreaker/docs/2.0.0-M2/reference/html/[spring-cloud-circuitbreaker] :: spring-cloud-circuitbreaker Reference Documentation, version 2.0.0-M2
|
||||
https://docs.spring.io/spring-cloud-cli/docs/3.0.0-M2/reference/html/[spring-cloud-cli] :: spring-cloud-cli Reference Documentation, version 3.0.0-M2
|
||||
@@ -0,0 +1,134 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-2020-0-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
[[cloud-documentation-versions]]
|
||||
== Release Train Versions
|
||||
|
||||
.Release Train Project Versions
|
||||
|===
|
||||
|Project Name| Project Version
|
||||
|
||||
include::_spring-cloud-2020-0-versions.adoc[]
|
||||
|===
|
||||
|
||||
:project-root: {basedir}/commons
|
||||
:project-version: {spring-cloud-commons-version}
|
||||
include::{basedir}/commons/docs/src/main/asciidoc/spring-cloud-commons.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/config
|
||||
:project-version: {spring-cloud-config-version}
|
||||
include::{basedir}/config/docs/src/main/asciidoc/spring-cloud-config.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/netflix
|
||||
:project-version: {spring-cloud-netflix-version}
|
||||
include::{basedir}/netflix/docs/src/main/asciidoc/spring-cloud-netflix.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/openfeign
|
||||
:project-version: {spring-cloud-openfeign-version}
|
||||
include::{basedir}/openfeign/docs/src/main/asciidoc/spring-cloud-openfeign.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/bus
|
||||
:project-version: {spring-cloud-bus-version}
|
||||
include::{basedir}/bus/docs/src/main/asciidoc/spring-cloud-bus.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/sleuth
|
||||
:project-version: {spring-cloud-sleuth-version}
|
||||
include::{basedir}/sleuth/docs/src/main/asciidoc/spring-cloud-sleuth.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/consul
|
||||
:project-version: {spring-cloud-consul-version}
|
||||
include::{basedir}/consul/docs/src/main/asciidoc/spring-cloud-consul.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/zookeeper
|
||||
:project-version: {spring-cloud-zookeeper-version}
|
||||
include::{basedir}/zookeeper/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/cli
|
||||
:project-version: {spring-cloud-cli-version}
|
||||
include::{basedir}/cli/docs/src/main/asciidoc/spring-cloud-cli.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/security
|
||||
:project-version: {spring-cloud-security-version}
|
||||
include::{basedir}/security/docs/src/main/asciidoc/spring-cloud-security.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/cloudfoundry
|
||||
:project-version: {spring-cloud-cloudfoundry-version}
|
||||
include::{basedir}/cloudfoundry/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/contract
|
||||
:project-version: {spring-cloud-contract-version}
|
||||
include::{basedir}/contract/docs/src/main/asciidoc/_index_pdf.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/vault
|
||||
:project-version: {spring-cloud-vault-version}
|
||||
include::{basedir}/vault/docs/src/main/asciidoc/spring-cloud-vault.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/gateway
|
||||
:project-version: {spring-cloud-gateway-version}
|
||||
include::{basedir}/gateway/docs/src/main/asciidoc/spring-cloud-gateway.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/function
|
||||
:project-version: {spring-cloud-function-version}
|
||||
include::{basedir}/function/docs/src/main/asciidoc/spring-cloud-function.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/kubernetes
|
||||
:project-version: {spring-cloud-kubernetes-version}
|
||||
include::{basedir}/kubernetes/docs/src/main/asciidoc/spring-cloud-kubernetes.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/gcp
|
||||
:project-version: {spring-cloud-gcp-version}
|
||||
include::{basedir}/gcp/docs/src/main/asciidoc/spring-cloud-gcp.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/circuitbreaker
|
||||
:project-version: {spring-cloud-circuitbreaker-version}
|
||||
include::{basedir}/circuitbreaker/docs/src/main/asciidoc/spring-cloud-circuitbreaker.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-core
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-core/docs/src/main/asciidoc/spring-cloud-stream.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-binder-rabbit
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-binder-rabbit/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-binder-kafka
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-binder-kafka/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc[leveloffset=+1]
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
include::configprops.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,134 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-2020-0-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
:project-full-name: Spring Cloud
|
||||
:project-name: spring-cloud
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
[[cloud-documentation-versions]]
|
||||
== Release Train Versions
|
||||
|
||||
.Release Train Project Versions
|
||||
|===
|
||||
|Project Name| Project Version
|
||||
|
||||
include::_spring-cloud-2020-0-versions.adoc[]
|
||||
|===
|
||||
|
||||
:project-root: {basedir}/commons
|
||||
:project-version: {spring-cloud-commons-version}
|
||||
include::{basedir}/commons/docs/src/main/asciidoc/spring-cloud-commons.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/config
|
||||
:project-version: {spring-cloud-config-version}
|
||||
include::{basedir}/config/docs/src/main/asciidoc/spring-cloud-config.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/netflix
|
||||
:project-version: {spring-cloud-netflix-version}
|
||||
include::{basedir}/netflix/docs/src/main/asciidoc/spring-cloud-netflix.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/openfeign
|
||||
:project-version: {spring-cloud-openfeign-version}
|
||||
include::{basedir}/openfeign/docs/src/main/asciidoc/spring-cloud-openfeign.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/bus
|
||||
:project-version: {spring-cloud-bus-version}
|
||||
include::{basedir}/bus/docs/src/main/asciidoc/spring-cloud-bus.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/sleuth
|
||||
:project-version: {spring-cloud-sleuth-version}
|
||||
include::{basedir}/sleuth/docs/src/main/asciidoc/spring-cloud-sleuth.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/consul
|
||||
:project-version: {spring-cloud-consul-version}
|
||||
include::{basedir}/consul/docs/src/main/asciidoc/spring-cloud-consul.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/zookeeper
|
||||
:project-version: {spring-cloud-zookeeper-version}
|
||||
include::{basedir}/zookeeper/docs/src/main/asciidoc/spring-cloud-zookeeper.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/cli
|
||||
:project-version: {spring-cloud-cli-version}
|
||||
include::{basedir}/cli/docs/src/main/asciidoc/spring-cloud-cli.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/security
|
||||
:project-version: {spring-cloud-security-version}
|
||||
include::{basedir}/security/docs/src/main/asciidoc/spring-cloud-security.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/cloudfoundry
|
||||
:project-version: {spring-cloud-cloudfoundry-version}
|
||||
include::{basedir}/cloudfoundry/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/contract
|
||||
:project-version: {spring-cloud-contract-version}
|
||||
include::{basedir}/contract/docs/src/main/asciidoc/_index_single.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/vault
|
||||
:project-version: {spring-cloud-vault-version}
|
||||
include::{basedir}/vault/docs/src/main/asciidoc/spring-cloud-vault.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/gateway
|
||||
:project-version: {spring-cloud-gateway-version}
|
||||
include::{basedir}/gateway/docs/src/main/asciidoc/spring-cloud-gateway.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/function
|
||||
:project-version: {spring-cloud-function-version}
|
||||
include::{basedir}/function/docs/src/main/asciidoc/spring-cloud-function.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/kubernetes
|
||||
:project-version: {spring-cloud-kubernetes-version}
|
||||
include::{basedir}/kubernetes/docs/src/main/asciidoc/spring-cloud-kubernetes.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/gcp
|
||||
:project-version: {spring-cloud-gcp-version}
|
||||
include::{basedir}/gcp/docs/src/main/asciidoc/spring-cloud-gcp.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/circuitbreaker
|
||||
:project-version: {spring-cloud-circuitbreaker-version}
|
||||
include::{basedir}/circuitbreaker/docs/src/main/asciidoc/spring-cloud-circuitbreaker.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-core
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-core/docs/src/main/asciidoc/spring-cloud-stream.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-binder-rabbit
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-binder-rabbit/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc[leveloffset=+1]
|
||||
|
||||
:project-root: {basedir}/stream-binder-kafka
|
||||
:project-version: {spring-cloud-stream-version}
|
||||
include::{basedir}/stream-binder-kafka/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc[leveloffset=+1]
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
include::configprops.adoc[leveloffset=+1]
|
||||
@@ -0,0 +1,22 @@
|
||||
|spring-cloud-build|3.0.0-M2
|
||||
|spring-cloud-commons|3.0.0-M2
|
||||
|spring-cloud-function|3.1.0.M1
|
||||
|spring-cloud-stream-core|3.1.0.M1
|
||||
|spring-cloud-stream-binder-rabbit|3.1.0.M1
|
||||
|spring-cloud-stream-binder-kafka|3.1.0.M1
|
||||
|spring-cloud-bus|3.0.0-M2
|
||||
|spring-cloud-task|2.3.0-M1
|
||||
|spring-cloud-config|3.0.0-M2
|
||||
|spring-cloud-netflix|3.0.0-M2
|
||||
|spring-cloud-cloudfoundry|3.0.0-M2
|
||||
|spring-cloud-kubernetes|2.0.0-M2
|
||||
|spring-cloud-openfeign|3.0.0-M2
|
||||
|spring-cloud-consul|3.0.0-M2
|
||||
|spring-cloud-gateway|3.0.0-M2
|
||||
|spring-cloud-security|3.0.0-M2
|
||||
|spring-cloud-sleuth|3.0.0-M2
|
||||
|spring-cloud-zookeeper|3.0.0-M2
|
||||
|spring-cloud-contract|3.0.0-M2
|
||||
|spring-cloud-vault|3.0.0-M2
|
||||
|spring-cloud-circuitbreaker|2.0.0-M2
|
||||
|spring-cloud-cli|3.0.0-M2
|
||||
@@ -0,0 +1,45 @@
|
||||
= Spring Cloud
|
||||
|
||||
include::_attributes.adoc[]
|
||||
include::_spring-cloud-2020-0-attributes.adoc[]
|
||||
|
||||
:basedir: {project-root}
|
||||
:stream_basedir: {basedir}
|
||||
|
||||
Spring Cloud provides tools for developers to quickly build some of
|
||||
the common patterns in distributed systems (e.g. configuration
|
||||
management, service discovery, circuit breakers, intelligent routing,
|
||||
micro-proxy, control bus). Coordination of
|
||||
distributed systems leads to boiler plate patterns, and using Spring
|
||||
Cloud developers can quickly stand up services and applications that
|
||||
implement those patterns. They will work well in any distributed
|
||||
environment, including the developer's own laptop, bare metal data
|
||||
centres, and managed platforms such as Cloud Foundry.
|
||||
|
||||
Release Train Version: *{spring-cloud-version}*
|
||||
|
||||
Supported Boot Version: *{spring-boot-version}*
|
||||
|
||||
== Features
|
||||
|
||||
Spring Cloud focuses on providing good out of box experience for typical use cases
|
||||
and extensibility mechanism to cover others.
|
||||
|
||||
* Distributed/versioned configuration
|
||||
* Service registration and discovery
|
||||
* Routing
|
||||
* Service-to-service calls
|
||||
* Load balancing
|
||||
* Circuit Breakers
|
||||
* Distributed messaging
|
||||
|
||||
The reference documentation consists of the following sections:
|
||||
|
||||
[horizontal]
|
||||
<<legal.adoc#legal-information,Legal>> :: Legal information.
|
||||
<<documentation-overview.adoc,Documentation Overview>> :: About the Documentation, Getting Help, First Steps, and more.
|
||||
include::_spring-cloud-2020-0-links.adoc[]
|
||||
|
||||
= Appendix: Compendium of Configuration Properties
|
||||
|
||||
link:configprops.html[Spring Cloud configuration properties]
|
||||
11
train-docs/src/test/resources/adocs/legal.adoc
Normal file
11
train-docs/src/test/resources/adocs/legal.adoc
Normal file
@@ -0,0 +1,11 @@
|
||||
[legal]
|
||||
= Legal
|
||||
|
||||
{spring-cloud-version}
|
||||
|
||||
Copyright © 2012-2019
|
||||
|
||||
Copies of this document may be made for your own use and for distribution to
|
||||
others, provided that you do not charge any fee for such copies and further
|
||||
provided that each copy contains this Copyright Notice, whether distributed in
|
||||
print or electronically.
|
||||
25
train-docs/src/test/resources/logback.xml
Normal file
25
train-docs/src/test/resources/logback.xml
Normal file
@@ -0,0 +1,25 @@
|
||||
<!--
|
||||
~ Copyright 2013-2019 the original author or authors.
|
||||
~
|
||||
~ Licensed under the Apache License, Version 2.0 (the "License");
|
||||
~ you may not use this file except in compliance with the License.
|
||||
~ You may obtain a copy of the License at
|
||||
~
|
||||
~ https://www.apache.org/licenses/LICENSE-2.0
|
||||
~
|
||||
~ Unless required by applicable law or agreed to in writing, software
|
||||
~ distributed under the License is distributed on an "AS IS" BASIS,
|
||||
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
~ See the License for the specific language governing permissions and
|
||||
~ limitations under the License.
|
||||
-->
|
||||
|
||||
<configuration>
|
||||
|
||||
<include resource="org/springframework/boot/logging/logback/base.xml"/>
|
||||
<logger name="org.springframework.cloud" level="DEBUG"/>
|
||||
|
||||
<root level="INFO">
|
||||
<appender-ref ref="CONSOLE"/>
|
||||
</root>
|
||||
</configuration>
|
||||
255
train-docs/src/test/resources/test/pom.xml
Normal file
255
train-docs/src/test/resources/test/pom.xml
Normal file
@@ -0,0 +1,255 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-dependencies-parent</artifactId>
|
||||
<version>3.0.0-SNAPSHOT</version>
|
||||
<relativePath/>
|
||||
</parent>
|
||||
<artifactId>spring-cloud-dependencies</artifactId>
|
||||
<version>2020.0.0-SNAPSHOT</version>
|
||||
<name>spring-cloud-dependencies</name>
|
||||
<description>Spring Cloud Dependencies</description>
|
||||
<packaging>pom</packaging>
|
||||
<properties>
|
||||
<main.basedir>${basedir}/../..</main.basedir>
|
||||
<spring-cloud-bus.version>1.2.3-SNAPSHOT</spring-cloud-bus.version>
|
||||
<spring-cloud-build.version>3.0.0-SNAPSHOT</spring-cloud-build.version>
|
||||
<spring-cloud-cloudfoundry.version>3.0.0-SNAPSHOT</spring-cloud-cloudfoundry.version>
|
||||
<spring-cloud-commons.version>3.0.0-SNAPSHOT</spring-cloud-commons.version>
|
||||
<spring-cloud-circuitbreaker.version>2.0.0-SNAPSHOT</spring-cloud-circuitbreaker.version>
|
||||
<spring-cloud-config.version>3.0.0-SNAPSHOT</spring-cloud-config.version>
|
||||
<spring-cloud-consul.version>3.0.0-SNAPSHOT</spring-cloud-consul.version>
|
||||
<spring-cloud-contract.version>3.0.0-SNAPSHOT</spring-cloud-contract.version>
|
||||
<spring-cloud-function.version>3.1.0-SNAPSHOT</spring-cloud-function.version>
|
||||
<spring-cloud-gateway.version>3.0.0-SNAPSHOT</spring-cloud-gateway.version>
|
||||
<spring-cloud-kubernetes.version>2.0.0-SNAPSHOT</spring-cloud-kubernetes.version>
|
||||
<spring-cloud-netflix.version>3.0.0-SNAPSHOT</spring-cloud-netflix.version>
|
||||
<spring-cloud-openfeign.version>3.0.0-SNAPSHOT</spring-cloud-openfeign.version>
|
||||
<spring-cloud-security.version>3.0.0-SNAPSHOT</spring-cloud-security.version>
|
||||
<spring-cloud-sleuth.version>3.0.0-SNAPSHOT</spring-cloud-sleuth.version>
|
||||
<spring-cloud-stream.version>3.1.0-SNAPSHOT</spring-cloud-stream.version>
|
||||
<spring-cloud-task.version>2.3.0-SNAPSHOT</spring-cloud-task.version>
|
||||
<spring-cloud-vault.version>3.0.0-SNAPSHOT</spring-cloud-vault.version>
|
||||
<spring-cloud-zookeeper.version>3.0.0-SNAPSHOT</spring-cloud-zookeeper.version>
|
||||
<spring-cloud-cli.version>3.0.0-SNAPSHOT</spring-cloud-cli.version>
|
||||
</properties>
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<!-- bom dependencies at the bottom so they can be overridden above -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-commons-dependencies</artifactId>
|
||||
<version>${spring-cloud-commons.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-netflix-dependencies</artifactId>
|
||||
<version>${spring-cloud-netflix.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-stream-dependencies</artifactId>
|
||||
<version>${spring-cloud-stream.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-task-dependencies</artifactId>
|
||||
<version>${spring-cloud-task.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-circuitbreaker-dependencies</artifactId>
|
||||
<version>${spring-cloud-circuitbreaker.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-config-dependencies</artifactId>
|
||||
<version>${spring-cloud-config.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-function-dependencies</artifactId>
|
||||
<version>${spring-cloud-function.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-gateway-dependencies</artifactId>
|
||||
<version>${spring-cloud-gateway.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-consul-dependencies</artifactId>
|
||||
<version>${spring-cloud-consul.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-sleuth-dependencies</artifactId>
|
||||
<version>${spring-cloud-sleuth.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-vault-dependencies</artifactId>
|
||||
<version>${spring-cloud-vault.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-zookeeper-dependencies</artifactId>
|
||||
<version>${spring-cloud-zookeeper.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-security-dependencies</artifactId>
|
||||
<version>${spring-cloud-security.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-cloudfoundry-dependencies</artifactId>
|
||||
<version>${spring-cloud-cloudfoundry.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-bus-dependencies</artifactId>
|
||||
<version>${spring-cloud-bus.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-contract-dependencies</artifactId>
|
||||
<version>${spring-cloud-contract.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-openfeign-dependencies</artifactId>
|
||||
<version>${spring-cloud-openfeign.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-kubernetes-dependencies</artifactId>
|
||||
<version>${spring-cloud-kubernetes.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>flatten-maven-plugin</artifactId>
|
||||
<inherited>false</inherited>
|
||||
<executions>
|
||||
<execution>
|
||||
<!-- Flatten and simplify our own POM for install/deploy -->
|
||||
<id>flatten</id>
|
||||
<phase>process-resources</phase>
|
||||
<goals>
|
||||
<goal>flatten</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<updatePomFile>true</updatePomFile>
|
||||
<flattenMode>bom</flattenMode>
|
||||
<pomElements>
|
||||
<parent>expand</parent>
|
||||
<pluginManagement>keep</pluginManagement>
|
||||
<properties>keep</properties>
|
||||
<repositories>remove</repositories>
|
||||
</pomElements>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>flatten-clean</id>
|
||||
<phase>clean</phase>
|
||||
<goals>
|
||||
<goal>clean</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>spring</id>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
<pluginRepositories>
|
||||
<pluginRepository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
<pluginRepository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
236
train-docs/src/test/resources/test/sleuth-only.xml
Normal file
236
train-docs/src/test/resources/test/sleuth-only.xml
Normal file
@@ -0,0 +1,236 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-dependencies-parent</artifactId>
|
||||
<version>3.0.0-SNAPSHOT</version>
|
||||
<relativePath/>
|
||||
</parent>
|
||||
<artifactId>spring-cloud-dependencies</artifactId>
|
||||
<version>2020.0.0-SNAPSHOT</version>
|
||||
<name>spring-cloud-dependencies</name>
|
||||
<description>Spring Cloud Dependencies</description>
|
||||
<packaging>pom</packaging>
|
||||
<properties>
|
||||
<main.basedir>${basedir}/../..</main.basedir>
|
||||
<spring-cloud-sleuth.version>3.0.0-SNAPSHOT</spring-cloud-sleuth.version>
|
||||
</properties>
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<!-- bom dependencies at the bottom so they can be overridden above -->
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-commons-dependencies</artifactId>
|
||||
<version>${spring-cloud-commons.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-netflix-dependencies</artifactId>
|
||||
<version>${spring-cloud-netflix.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-stream-dependencies</artifactId>
|
||||
<version>${spring-cloud-stream.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-task-dependencies</artifactId>
|
||||
<version>${spring-cloud-task.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-circuitbreaker-dependencies</artifactId>
|
||||
<version>${spring-cloud-circuitbreaker.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-config-dependencies</artifactId>
|
||||
<version>${spring-cloud-config.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-function-dependencies</artifactId>
|
||||
<version>${spring-cloud-function.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-gateway-dependencies</artifactId>
|
||||
<version>${spring-cloud-gateway.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-consul-dependencies</artifactId>
|
||||
<version>${spring-cloud-consul.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-sleuth-dependencies</artifactId>
|
||||
<version>${spring-cloud-sleuth.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-vault-dependencies</artifactId>
|
||||
<version>${spring-cloud-vault.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-zookeeper-dependencies</artifactId>
|
||||
<version>${spring-cloud-zookeeper.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-security-dependencies</artifactId>
|
||||
<version>${spring-cloud-security.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-cloudfoundry-dependencies</artifactId>
|
||||
<version>${spring-cloud-cloudfoundry.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-bus-dependencies</artifactId>
|
||||
<version>${spring-cloud-bus.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-contract-dependencies</artifactId>
|
||||
<version>${spring-cloud-contract.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-openfeign-dependencies</artifactId>
|
||||
<version>${spring-cloud-openfeign.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-kubernetes-dependencies</artifactId>
|
||||
<version>${spring-cloud-kubernetes.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>flatten-maven-plugin</artifactId>
|
||||
<inherited>false</inherited>
|
||||
<executions>
|
||||
<execution>
|
||||
<!-- Flatten and simplify our own POM for install/deploy -->
|
||||
<id>flatten</id>
|
||||
<phase>process-resources</phase>
|
||||
<goals>
|
||||
<goal>flatten</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<updatePomFile>true</updatePomFile>
|
||||
<flattenMode>bom</flattenMode>
|
||||
<pomElements>
|
||||
<parent>expand</parent>
|
||||
<pluginManagement>keep</pluginManagement>
|
||||
<properties>keep</properties>
|
||||
<repositories>remove</repositories>
|
||||
</pomElements>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>flatten-clean</id>
|
||||
<phase>clean</phase>
|
||||
<goals>
|
||||
<goal>clean</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>spring</id>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>spring-releases</id>
|
||||
<name>Spring Releases</name>
|
||||
<url>https://repo.spring.io/release</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
<pluginRepositories>
|
||||
<pluginRepository>
|
||||
<id>spring-snapshots</id>
|
||||
<name>Spring Snapshots</name>
|
||||
<url>https://repo.spring.io/libs-snapshot-local</url>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
<pluginRepository>
|
||||
<id>spring-milestones</id>
|
||||
<name>Spring Milestones</name>
|
||||
<url>https://repo.spring.io/libs-milestone-local</url>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
</pluginRepository>
|
||||
</pluginRepositories>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
Reference in New Issue
Block a user