From 4c4c89748623ddea17a1f501ae6d60df851bde29 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Thu, 4 Jun 2020 13:40:17 +0200 Subject: [PATCH] Migrated to docs.spring.io & updated sc-build --- README.adoc | 8 +++++++- docs/pom.xml | 5 ++++- docs/src/main/asciidoc/_configprops.adoc | 10 +++++++++- pom.xml | 2 +- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index df459c27..23c73f27 100644 --- a/README.adoc +++ b/README.adoc @@ -4,6 +4,7 @@ Manual changes to this file will be lost when it is generated again. Edit the files in the src/main/asciidoc/ directory instead. //// + image::https://circleci.com/gh/spring-cloud/spring-cloud-consul/tree/master.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-consul/tree/master"] image::https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/master/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/master"] @@ -111,6 +112,11 @@ https://eclipse.org[Eclipse] when working with the code. We use the https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better. +==== Activate the Spring Maven profile +Spring Cloud projects require the 'spring' Maven profile to be activated to resolve +the spring milestone and snapshot repositories. Use your preferred IDE to set this +profile to be active, or you may experience build errors. + ==== Importing into eclipse with m2eclipse We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with eclipse. If you don't already have m2eclipse installed it is available from the "eclipse @@ -319,4 +325,4 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t - `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. \ No newline at end of file +IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. diff --git a/docs/pom.xml b/docs/pom.xml index 6ec402a5..6fb84383 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -15,8 +15,8 @@ spring-cloud-consul ${basedir}/.. - 2.1.x,2.2.x spring.cloud.consul.* + deploy @@ -57,6 +57,9 @@ org.apache.maven.plugins maven-antrun-plugin + + maven-deploy-plugin + diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc index 57be0be4..58b353ba 100644 --- a/docs/src/main/asciidoc/_configprops.adoc +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -21,6 +21,7 @@ |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. @@ -41,9 +42,12 @@ |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 | +|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. @@ -55,18 +59,22 @@ |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.discovery.tags-as-metadata | true | Use tags as metadata, defaults to true. |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. -|=== +|=== \ No newline at end of file diff --git a/pom.xml b/pom.xml index 795f8617..f5dac05a 100644 --- a/pom.xml +++ b/pom.xml @@ -14,7 +14,7 @@ org.springframework.cloud spring-cloud-build - 2.3.0.RELEASE + 2.3.1.BUILD-SNAPSHOT