Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incorrect default values in docs (#4294) #4321

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ updates:
target-branch: "4.0.x" # oldest OSS supported branch
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
target-branch: "4.1.x"
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
target-branch: "main"
Expand Down Expand Up @@ -37,6 +42,17 @@ updates:
update-types:
- version-update:semver-major
- version-update:semver-minor
- package-ecosystem: maven
directory: /
schedule:
interval: daily
target-branch: 4.1.x
ignore:
# only upgrade patch versions for maintenance branch
- dependency-name: "*"
update-types:
- version-update:semver-major
- version-update:semver-minor
- package-ecosystem: maven
directory: /
schedule:
Expand All @@ -46,4 +62,19 @@ updates:
# only upgrade by minor or patch
- dependency-name: "*"
update-types:
- version-update:semver-major
- version-update:semver-major
- package-ecosystem: npm
target-branch: docs-build
directory: /
schedule:
interval: weekly
- package-ecosystem: npm
target-branch: main
directory: /docs
schedule:
interval: weekly
- package-ecosystem: npm
target-branch: 4.1.x
directory: /docs
schedule:
interval: weekly
4 changes: 2 additions & 2 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ name: Build

on:
push:
branches: [ main ]
branches: [ main, 4.1.x ]
pull_request:
branches: [ main ]
branches: [ main, 4.1.x ]

jobs:
build:
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/partials/_configprops.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
|eureka.instance.home-page-url | | Gets the absolute home page URL for this instance. The users can provide the homePageUrlPath if the home page resides in the same instance talking to eureka, else in the cases where the instance is a proxy for some other server, users can provide the full URL. If the full URL is provided it takes precedence. It is normally used for informational purposes for other services to use it as a landing page. The full URL should follow the format http://${eureka.hostname}:7001/ where the value ${eureka.hostname} is replaced at runtime.
|eureka.instance.home-page-url-path | `+++/+++` | Gets the relative home page URL Path for this instance. The home page URL is then constructed out of the hostName and the type of communication - secure or unsecure. It is normally used for informational purposes for other services to use it as a landing page.
|eureka.instance.hostname | | The hostname if it can be determined at configuration time (otherwise it will be guessed from OS primitives).
|eureka.instance.initial-status | | Initial status to register with remote Eureka server.
|eureka.instance.initial-status | `+++up+++` | Initial status to register with remote Eureka server.
|eureka.instance.instance-enabled-onit | `+++false+++` | Indicates whether the instance should be enabled for taking traffic as soon as it is registered with eureka. Sometimes the application might need to do some pre-processing before it is ready to take traffic.
|eureka.instance.instance-id | | Get the unique Id (within the scope of the appName) of this instance to be registered with eureka.
|eureka.instance.ip-address | | Get the IPAdress of the instance. This information is for academic purposes only as the communication from other instances primarily happen using the information supplied in {@link #getHostName(boolean)}.
Expand All @@ -104,7 +104,7 @@
|eureka.server.a-w-s-access-id | |
|eureka.server.a-w-s-secret-key | |
|eureka.server.batch-replication | `+++false+++` |
|eureka.server.binding-strategy | |
|eureka.server.binding-strategy | `+++eip+++` |
|eureka.server.delta-retention-timer-interval-in-ms | `+++0+++` |
|eureka.server.disable-delta | `+++false+++` |
|eureka.server.disable-delta-for-remote-regions | `+++false+++` |
Expand Down Expand Up @@ -175,7 +175,7 @@
|eureka.server.use-read-only-response-cache | `+++true+++` |
|eureka.server.wait-time-in-ms-when-sync-empty | `+++0+++` |
|eureka.server.xml-codec-name | |
|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.compatible-boot-versions | `+++3.4.x+++` | 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.initialize-on-context-refresh | `+++false+++` | Flag to initialize bootstrap configuration on context refresh event. Default false.
Expand Down
2 changes: 1 addition & 1 deletion docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath>..</relativePath>
</parent>
<packaging>jar</packaging>
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
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-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Spring Cloud Netflix</name>
<description>Spring Cloud Netflix</description>
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath />
</parent>
<scm>
Expand Down
4 changes: 2 additions & 2 deletions spring-cloud-netflix-dependencies/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<parent>
<artifactId>spring-cloud-dependencies-parent</artifactId>
<groupId>org.springframework.cloud</groupId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath/>
</parent>
<artifactId>spring-cloud-netflix-dependencies</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>spring-cloud-netflix-dependencies</name>
<description>Spring Cloud Netflix Dependencies</description>
Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-netflix-eureka-client-tls-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath>..</relativePath> <!-- lookup parent from repository -->
</parent>
<artifactId>spring-cloud-netflix-eureka-client-tls-tests</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-netflix-eureka-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath>..</relativePath> <!-- lookup parent from repository -->
</parent>
<artifactId>spring-cloud-netflix-eureka-client</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2022 the original author or authors.
* Copyright 2013-2024 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.
Expand Down Expand Up @@ -41,6 +41,7 @@
*
* @author Dave Syer
* @author Gregor Zurowski
* @author Mooyong Lee
*/
@ConfigurationProperties(EurekaClientConfigBean.PREFIX)
public class EurekaClientConfigBean implements EurekaClientConfig, Ordered {
Expand All @@ -60,8 +61,6 @@ public class EurekaClientConfigBean implements EurekaClientConfig, Ordered {
*/
public static final String DEFAULT_ZONE = "defaultZone";

private static final int MINUTES = 60;

@Autowired(required = false)
PropertyResolver propertyResolver;

Expand Down Expand Up @@ -96,7 +95,7 @@ public class EurekaClientConfigBean implements EurekaClientConfig, Ordered {
* Eureka servers could be added or removed and this setting controls how soon the
* eureka clients should know about it.
*/
private int eurekaServiceUrlPollIntervalSeconds = 5 * MINUTES;
private int eurekaServiceUrlPollIntervalSeconds = 300; // 5 * MINUTES

/**
* Gets the proxy port to eureka server if any.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2022 the original author or authors.
* Copyright 2013-2024 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.
Expand Down Expand Up @@ -30,6 +30,7 @@
* {@link RestTemplateEurekaHttpClient}.
*
* @author Jiwon Jeon
* @author Mooyong Lee
* @since 3.1.6
*/
@ConfigurationProperties("eureka.client.rest-template-timeout")
Expand All @@ -39,11 +40,11 @@ public class RestTemplateTimeoutProperties {
* Default values are set to 180000, in keeping with {@link RequestConfig} and
* {@link SocketConfig} defaults.
*/
private int connectTimeout = 3 * 60 * 1000;
private int connectTimeout = 180000; // 3 * MINUTES

private int connectRequestTimeout = 3 * 60 * 1000;
private int connectRequestTimeout = 180000; // 3 * MINUTES

private int socketTimeout = 3 * 60 * 1000;
private int socketTimeout = 180000; // 3 * MINUTES

public int getConnectTimeout() {
return connectTimeout;
Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-netflix-eureka-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
<relativePath>..</relativePath> <!-- lookup parent from repository -->
</parent>
<artifactId>spring-cloud-netflix-eureka-server</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2022 the original author or authors.
* Copyright 2013-2024 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.
Expand Down Expand Up @@ -34,6 +34,7 @@
/**
* @author Dave Syer
* @author Gregor Zurowski
* @author Mooyong Lee
*/
@ConfigurationProperties(EurekaServerConfigBean.PREFIX)
public class EurekaServerConfigBean implements EurekaServerConfig {
Expand All @@ -43,8 +44,6 @@ public class EurekaServerConfigBean implements EurekaServerConfig {
*/
public static final String PREFIX = "eureka.server";

private static final int MINUTES = 60 * 1000;

@Autowired(required = false)
PropertyResolver propertyResolver;

Expand All @@ -54,23 +53,23 @@ public class EurekaServerConfigBean implements EurekaServerConfig {

private int eIPBindRebindRetries = 3;

private int eIPBindingRetryIntervalMs = 5 * MINUTES;
private int eIPBindingRetryIntervalMs = 300000; // 5 * MINUTES

private int eIPBindingRetryIntervalMsWhenUnbound = 1 * MINUTES;
private int eIPBindingRetryIntervalMsWhenUnbound = 60000; // 1 * MINUTES

private boolean enableSelfPreservation = true;

private double renewalPercentThreshold = 0.85;

private int renewalThresholdUpdateIntervalMs = 15 * MINUTES;
private int renewalThresholdUpdateIntervalMs = 900000; // 15 * MINUTES

private int peerEurekaNodesUpdateIntervalMs = 10 * MINUTES;
private int peerEurekaNodesUpdateIntervalMs = 600000; // 10 * MINUTES

private int numberOfReplicationRetries = 5;

private int peerEurekaStatusRefreshTimeIntervalMs = 30 * 1000;

private int waitTimeInMsWhenSyncEmpty = 5 * MINUTES;
private int waitTimeInMsWhenSyncEmpty = 300000; // 5 * MINUTES

private int peerNodeConnectTimeoutMs = 200;

Expand All @@ -82,23 +81,24 @@ public class EurekaServerConfigBean implements EurekaServerConfig {

private int peerNodeConnectionIdleTimeoutSeconds = 30;

private long retentionTimeInMSInDeltaQueue = 3 * MINUTES;
private long retentionTimeInMSInDeltaQueue = 180000; // 3 * MINUTES

private long deltaRetentionTimerIntervalInMs = 30 * 1000;
private long deltaRetentionTimerIntervalInMs = 30000; // 30 * SECONDS

private long evictionIntervalTimerInMs = 60 * 1000;

private int aSGQueryTimeoutMs = 300;

private long aSGUpdateIntervalMs = 5 * MINUTES;
private long aSGUpdateIntervalMs = 300000; // 5 * MINUTES

private long aSGCacheExpiryTimeoutMs = 10 * MINUTES; // defaults to longer than the
private long aSGCacheExpiryTimeoutMs = 600000; // 10 * MINUTES // defaults to longer
// than the

// asg update interval

private long responseCacheAutoExpirationInSeconds = 180;

private long responseCacheUpdateIntervalMs = 30 * 1000;
private long responseCacheUpdateIntervalMs = 30000; // 30 * SECONDS

private boolean useReadOnlyResponseCache = true;

Expand Down Expand Up @@ -186,7 +186,7 @@ public class EurekaServerConfigBean implements EurekaServerConfig {

private int route53BindRebindRetries = 3;

private int route53BindingRetryIntervalMs = 5 * MINUTES;
private int route53BindingRetryIntervalMs = 300000; // 5 * MINUTES

private long route53DomainTTL = 30;

Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-starter-netflix-eureka-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
</parent>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
<name>Spring Cloud Starter Netflix Eureka Client</name>
Expand Down
2 changes: 1 addition & 1 deletion spring-cloud-starter-netflix-eureka-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix</artifactId>
<version>4.1.4-SNAPSHOT</version>
<version>4.2.0-SNAPSHOT</version>
</parent>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
<name>Spring Cloud Starter Netflix Eureka Server</name>
Expand Down