From bc6fab5966474602c95f5c8f35f405643e025b9a Mon Sep 17 00:00:00 2001 From: spencergibb Date: Wed, 13 Sep 2023 17:16:43 -0400 Subject: [PATCH] Antora migration --- .../workflows/deploy-docs.yml | 0 .gitignore | 6 + README.adoc | 572 +----------------- docs/antora-playbook.yml | 11 +- docs/antora.yml | 4 +- docs/modules/ROOT/nav.adoc | 22 +- docs/modules/ROOT/pages/appendix.adoc | 3 +- .../pages/{spring-cloud-consul => }/bus.adoc | 1 - .../{spring-cloud-consul => }/config.adoc | 2 +- .../{spring-cloud-consul => }/discovery.adoc | 6 +- docs/modules/ROOT/pages/index.adoc | 1 + .../agent.adoc => install.adoc} | 16 +- docs/modules/ROOT/pages/intro.adoc | 3 + docs/modules/ROOT/pages/quickstart.adoc | 9 +- .../{spring-cloud-consul => }/retry.adoc | 1 - .../ROOT/pages/spring-cloud-consul.adoc | 7 - .../configuration-properties.adoc | 5 - .../pages/spring-cloud-consul/hystrix.adoc | 7 - .../pages/spring-cloud-consul/install.adoc | 6 - .../spring-cloud-consul/quick-start.adoc | 6 - .../pages/spring-cloud-consul/turbine.adoc | 42 -- .../{pages => partials}/_configprops.adoc | 2 +- docs/modules/ROOT/partials/_conventions.adoc | 6 + docs/modules/ROOT/partials/_metrics.adoc | 6 + docs/modules/ROOT/partials/_spans.adoc | 6 + docs/pom.xml | 32 +- .../resources/antora-resources/antora.yml | 20 + .../pages => src/main/asciidoc}/README.adoc | 8 +- .../main/asciidoc}/sagan-boot.adoc | 0 .../main/asciidoc}/sagan-index.adoc | 0 30 files changed, 126 insertions(+), 684 deletions(-) rename {docs/.github => .github}/workflows/deploy-docs.yml (100%) rename docs/modules/ROOT/pages/{spring-cloud-consul => }/bus.adoc (95%) rename docs/modules/ROOT/pages/{spring-cloud-consul => }/config.adoc (97%) rename docs/modules/ROOT/pages/{spring-cloud-consul => }/discovery.adoc (95%) rename docs/modules/ROOT/pages/{spring-cloud-consul/agent.adoc => install.adoc} (56%) rename docs/modules/ROOT/pages/{spring-cloud-consul => }/retry.adoc (96%) delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul.adoc delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul/install.adoc delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc delete mode 100644 docs/modules/ROOT/pages/spring-cloud-consul/turbine.adoc rename docs/modules/ROOT/{pages => partials}/_configprops.adoc (99%) create mode 100644 docs/modules/ROOT/partials/_conventions.adoc create mode 100644 docs/modules/ROOT/partials/_metrics.adoc create mode 100644 docs/modules/ROOT/partials/_spans.adoc create mode 100644 docs/src/main/antora/resources/antora-resources/antora.yml rename docs/{modules/ROOT/pages => src/main/asciidoc}/README.adoc (80%) rename docs/{modules/ROOT/pages => src/main/asciidoc}/sagan-boot.adoc (100%) rename docs/{modules/ROOT/pages => src/main/asciidoc}/sagan-index.adoc (100%) diff --git a/docs/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml similarity index 100% rename from docs/.github/workflows/deploy-docs.yml rename to .github/workflows/deploy-docs.yml diff --git a/.gitignore b/.gitignore index 7acf4f8a..d0e84b87 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,9 @@ consul_*.zip consul_*.zip.* .vscode/ .flattened-pom.xml + +node +node_modules +build +package.json +package-lock.json diff --git a/README.adoc b/README.adoc index 2b22b5f3..2b392884 100644 --- a/README.adoc +++ b/README.adoc @@ -5,249 +5,16 @@ 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"] - -This project provides Consul integrations for Spring Boot apps through autoconfiguration -and binding to the Spring Environment and other Spring programming model idioms. With a few -simple annotations you can quickly enable and configure the common patterns inside your -application and build large distributed systems with Consul based components. The -patterns provided include Service Discovery, Control Bus and Configuration. -Intelligent Routing and Client Side Load Balancing, Circuit Breaker -are provided by integration with other Spring Cloud projects. +image::https://github.com/spring-cloud/spring-cloud-consul/workflows/Build/badge.svg?style=svg["Actions Status", link="https://github.com/spring-cloud/spring-cloud-consul/actions"] +image::https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main"] -== Quick Start +[[quick-start]] += Quick Start -This quick start walks through using Spring Cloud Consul for Service Discovery and Distributed Configuration. -First, run Consul Agent on your machine. Then you can access it and use it as a Service Registry and Configuration source with Spring Cloud Consul. - -=== Discovery Client Usage - -To use these features in an application, you can build it as a Spring Boot application that depends on `spring-cloud-consul-core`. -The most convenient way to add the dependency is with a Spring Boot starter: `org.springframework.cloud:spring-cloud-starter-consul-discovery`. -We recommend using dependency management and `spring-boot-starter-parent`. -The following example shows a typical Maven configuration: - -[source,xml,indent=0] -.pom.xml ----- - - - org.springframework.boot - spring-boot-starter-parent - {spring-boot-version} - - - - - - org.springframework.cloud - spring-cloud-starter-consul-discovery - - - org.springframework.boot - spring-boot-starter-test - test - - - - - - org.springframework.cloud - spring-cloud-dependencies - ${spring-cloud.version} - pom - import - - - - - - - org.springframework.boot - spring-boot-maven-plugin - - - - ----- - -The following example shows a typical Gradle setup: - -[source,groovy,indent=0] -.build.gradle ----- -plugins { - id 'org.springframework.boot' version ${spring-boot-version} - id 'io.spring.dependency-management' version ${spring-dependency-management-version} - id 'java' -} - -repositories { - mavenCentral() -} - -dependencies { - implementation 'org.springframework.cloud:spring-cloud-starter-consul-discovery' - testImplementation 'org.springframework.boot:spring-boot-starter-test' -} -dependencyManagement { - imports { - mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" - } -} ----- - -Now you can create a standard Spring Boot application, such as the following HTTP server: - ----- -@SpringBootApplication -@RestController -public class Application { - - @GetMapping("/") - public String home() { - return "Hello World!"; - } - - public static void main(String[] args) { - SpringApplication.run(Application.class, args); - } - -} ----- - -When this HTTP server runs, it connects to Consul Agent running at the default local 8500 port. -To modify the startup behavior, you can change the location of Consul Agent by using `application.properties`, as shown in the following example: - ----- -spring: - cloud: - consul: - host: localhost - port: 8500 ----- - -You can now use `DiscoveryClient`, `@LoadBalanced RestTemplate`, or `@LoadBalanced WebClient.Builder` to retrieve services and instances data from Consul, as shown in the following example: - -[source,java,indent=0] ----- -@Autowired -private DiscoveryClient discoveryClient; - -public String serviceUrl() { - List list = discoveryClient.getInstances("STORES"); - if (list != null && list.size() > 0 ) { - return list.get(0).getUri().toString(); - } - return null; -} ----- - -=== Distributed Configuration Usage - -To use these features in an application, you can build it as a Spring Boot application that depends on `spring-cloud-consul-core` and `spring-cloud-consul-config`. -The most convenient way to add the dependency is with a Spring Boot starter: `org.springframework.cloud:spring-cloud-starter-consul-config`. -We recommend using dependency management and `spring-boot-starter-parent`. -The following example shows a typical Maven configuration: - -[source,xml,indent=0] -.pom.xml ----- - - - org.springframework.boot - spring-boot-starter-parent - {spring-boot-version} - - - - - - org.springframework.cloud - spring-cloud-starter-consul-config - - - org.springframework.boot - spring-boot-starter-test - test - - - - - - org.springframework.cloud - spring-cloud-dependencies - ${spring-cloud.version} - pom - import - - - - - - - org.springframework.boot - spring-boot-maven-plugin - - - - ----- - -The following example shows a typical Gradle setup: - -[source,groovy,indent=0] -.build.gradle ----- -plugins { - id 'org.springframework.boot' version ${spring-boot-version} - id 'io.spring.dependency-management' version ${spring-dependency-management-version} - id 'java' -} - -repositories { - mavenCentral() -} - -dependencies { - implementation 'org.springframework.cloud:spring-cloud-starter-consul-config' - testImplementation 'org.springframework.boot:spring-boot-starter-test' -} -dependencyManagement { - imports { - mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" - } -} ----- - -Now you can create a standard Spring Boot application, such as the following HTTP server: - ----- -@SpringBootApplication -@RestController -public class Application { - - @GetMapping("/") - public String home() { - return "Hello World!"; - } - - public static void main(String[] args) { - SpringApplication.run(Application.class, args); - } - -} ----- - -The application retrieves configuration data from Consul. - -WARNING: If you use Spring Cloud Consul Config, you need to set the `spring.config.import` property in order to bind to Consul. -You can read more about it in the <>. - -== Consul overview +[[consul-overview]] += Consul overview Features of Consul @@ -260,7 +27,8 @@ Features of Consul See the https://consul.io/intro/index.html[intro] for more information. -== Spring Cloud Consul Features +[[spring-cloud-consul-features]] += Spring Cloud Consul Features * Spring Cloud `DiscoveryClient` implementation ** supports Spring Cloud Gateway @@ -268,7 +36,8 @@ See the https://consul.io/intro/index.html[intro] for more information. * Consul based `PropertySource` loaded during the 'bootstrap' phase. * Spring Cloud Bus implementation based on Consul https://www.consul.io/docs/agent/http/event.html[events] -== Running the sample +[[running-the-sample]] += Running the sample 1. Run `docker-compose up` 2. Verify consul is running by visiting http://localhost:8500 @@ -278,319 +47,18 @@ See the https://consul.io/intro/index.html[intro] for more information. 6. run `java -jar spring-cloud-consul-sample/target/spring-cloud-consul-sample-${VERSION}.jar --server.port=8081` 7. visit http://localhost:8080 again, verify that `{"serviceId":":8081","host":"","port":8081}` eventually shows up in the results in a round robbin fashion (may take a minute or so). -== Building +[[building]] += Building +[[building]] += Building -:jdkversion: 17 +Unresolved directive in https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/building.adoc - include::partial$building.adoc[] -=== Basic Compile and Test +[[contributing]] += Contributing -To build the source you will need to install JDK {jdkversion}. - -Spring Cloud uses Maven for most build-related activities, and you -should be able to get off the ground quite quickly by cloning the -project you are interested in and typing - ----- -$ ./mvnw install ----- - -NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command -in place of `./mvnw` in the examples below. If you do that you also -might need to add `-P spring` if your local Maven settings do not -contain repository declarations for spring pre-release artifacts. - -NOTE: Be aware that you might need to increase the amount of memory -available to Maven by setting a `MAVEN_OPTS` environment variable with -a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in -the `.mvn` configuration, so if you find you have to do it to make a -build succeed, please raise a ticket to get the settings added to -source control. - -The projects that require middleware (i.e. Redis) for testing generally -require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running. - - -=== Documentation - -The spring-cloud-build module has a "docs" profile, and if you switch -that on it will try to build asciidoc sources from -`src/main/asciidoc`. As part of that process it will look for a -`README.adoc` and process it by loading all the includes, but not -parsing or rendering it, just copying it to `${main.basedir}` -(defaults to `${basedir}`, i.e. the root of the project). If there are -any changes in the README it will then show up after a Maven build as -a modified file in the correct place. Just commit it and push the change. - -=== Working with the code -If you don't have an IDE preference we would recommend that you use -https://www.springsource.com/developer/sts[Spring Tools Suite] or -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 -marketplace". - -NOTE: Older versions of m2e do not support Maven 3.3, so once the -projects are imported into Eclipse you will also need to tell -m2eclipse to use the right profile for the projects. If you -see many different errors related to the POMs in the projects, check -that you have an up to date installation. If you can't upgrade m2e, -add the "spring" profile to your `settings.xml`. Alternatively you can -copy the repository settings from the "spring" profile of the parent -pom into your `settings.xml`. - -==== Importing into eclipse without m2eclipse -If you prefer not to use m2eclipse you can generate eclipse project metadata using the -following command: - -[indent=0] ----- - $ ./mvnw eclipse:eclipse ----- - -The generated eclipse projects can be imported by selecting `import existing projects` -from the `file` menu. - - - -== 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 -to contribute even something trivial please do not hesitate, but -follow the guidelines below. - -=== Sign the Contributor License Agreement -Before we accept a non-trivial patch or pull request we will need you to sign the -https://cla.pivotal.io/sign/spring[Contributor License Agreement]. -Signing the contributor's agreement does not grant anyone commit rights to the main -repository, but it does mean that we can accept your contributions, and you will get an -author credit if we do. Active contributors might be asked to join the core team, and -given the ability to merge pull requests. - -=== Code of Conduct -This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of -conduct]. By participating, you are expected to uphold this code. Please report -unacceptable behavior to spring-code-of-conduct@pivotal.io. - -=== Code Conventions and Housekeeping -None of these is essential for a pull request, but they will all help. They can also be -added after the original pull request but before a merge. - -* Use the Spring Framework code format conventions. If you use Eclipse - you can import formatter settings using the - `eclipse-code-formatter.xml` file from the - https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring - Cloud Build] project. If using IntelliJ, you can use the - https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter - Plugin] to import the same file. -* Make sure all new `.java` files to have a simple Javadoc class comment with at least an - `@author` tag identifying you, and preferably at least a paragraph on what the class is - for. -* Add the ASF license header comment to all new `.java` files (copy from existing files - in the project) -* Add yourself as an `@author` to the .java files that you modify substantially (more - than cosmetic changes). -* Add some Javadocs and, if you change the namespace, some XSD doc elements. -* A few unit tests would help a lot as well -- someone has to do it. -* If no-one else is using your branch, please rebase it against the current master (or - other target branch in the main project). -* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], - 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 ----- - -true <1> - true - <2> - true - <3> - - - - - <4> - io.spring.javaformat - spring-javaformat-maven-plugin - - <5> - org.apache.maven.plugins - maven-checkstyle-plugin - - - - - - <5> - org.apache.maven.plugins - maven-checkstyle-plugin - - - - ----- -<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 ----- - - - - - - ----- - -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. - -=== Duplicate Finder - -Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath. - -==== Duplicate Finder configuration - -Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`. - -.pom.xml -[source,xml] ----- - - - - org.basepom.maven - duplicate-finder-maven-plugin - - - ----- - -For other properties, we have set defaults as listed in the https://github.com/basepom/duplicate-finder-maven-plugin/wiki[plugin documentation]. - -You can easily override them but setting the value of the selected property prefixed with `duplicate-finder-maven-plugin`. For example, set `duplicate-finder-maven-plugin.skip` to `true` in order to skip duplicates check in your build. - -If you need to add `ignoredClassPatterns` or `ignoredResourcePatterns` to your setup, make sure to add them in the plugin configuration section of your project: - -[source,xml] ----- - - - - org.basepom.maven - duplicate-finder-maven-plugin - - - org.joda.time.base.BaseDateTime - .*module-info - - - changelog.txt - - - - - - - ----- +[[contributing]] += Contributing +Unresolved directive in https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/contributing.adoc - include::partial$contributing.adoc[] diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml index 9a70e676..82fbf49f 100644 --- a/docs/antora-playbook.yml +++ b/docs/antora-playbook.yml @@ -6,15 +6,10 @@ antora: - '@antora/collector-extension' - '@antora/atlas-extension' - require: '@springio/antora-extensions/root-component-extension' - root_component_name: 'PROJECT_WITHOUT_SPRING' - # FIXME: Run antora once using this extension to migrate to the Asciidoc Tabs syntax - # and then remove this extension - - require: '@springio/antora-extensions/tabs-migration-extension' - unwrap_example_block: always - save_result: true + root_component_name: 'cloud-consul' site: - title: PROJECT_FULL_NAME - url: https://docs.spring.io/PROJECT_NAME/reference/ + title: Spring Cloud Consul + url: https://docs.spring.io/spring-cloud-consul/reference/ content: sources: - url: ./.. diff --git a/docs/antora.yml b/docs/antora.yml index 15b346da..cf6397b2 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -1,6 +1,6 @@ -name: PROJECT_WITHOUT_SPRING +name: cloud-consul version: true -title: PROJECT_NAME +title: spring-cloud-consul nav: - modules/ROOT/nav.adoc ext: diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index bf8091f1..228e285f 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,20 +1,8 @@ * xref:index.adoc[] -* xref:spring-cloud-consul.adoc[] -** xref:spring-cloud-consul/quick-start.adoc[] -** xref:spring-cloud-consul/install.adoc[] -** xref:spring-cloud-consul/agent.adoc[] -** xref:spring-cloud-consul/discovery.adoc[] -** xref:spring-cloud-consul/config.adoc[] -** xref:spring-cloud-consul/retry.adoc[] -** xref:spring-cloud-consul/bus.adoc[] -** xref:spring-cloud-consul/hystrix.adoc[] -** xref:spring-cloud-consul/turbine.adoc[] -** xref:spring-cloud-consul/configuration-properties.adoc[] -* xref:_attributes.adoc[] -* xref:intro.adoc[] * xref:quickstart.adoc[] -* xref:README.adoc[] -* xref:_configprops.adoc[] +* xref:install.adoc[] +* xref:discovery.adoc[] +* xref:config.adoc[] +* xref:retry.adoc[] +* xref:bus.adoc[] * xref:appendix.adoc[] -* xref:sagan-boot.adoc[] -* xref:sagan-index.adoc[] diff --git a/docs/modules/ROOT/pages/appendix.adoc b/docs/modules/ROOT/pages/appendix.adoc index eef1c905..a2131bc9 100644 --- a/docs/modules/ROOT/pages/appendix.adoc +++ b/docs/modules/ROOT/pages/appendix.adoc @@ -6,8 +6,9 @@ Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches. -This appendix provides a list of common {project-full-name} properties and references to the underlying classes that consume them. +This appendix provides a list of common Spring Cloud Consul properties and references to the underlying classes that consume them. NOTE: Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. Also, you can define your own properties. +include::partial$_configprops.adoc[] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc b/docs/modules/ROOT/pages/bus.adoc similarity index 95% rename from docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc rename to docs/modules/ROOT/pages/bus.adoc index 964e3175..1c40d16a 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc +++ b/docs/modules/ROOT/pages/bus.adoc @@ -1,6 +1,5 @@ [[spring-cloud-consul-bus]] = Spring Cloud Bus with Consul -:page-section-summary-toc: 1 [[how-to-activate]] == How to activate diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/config.adoc b/docs/modules/ROOT/pages/config.adoc similarity index 97% rename from docs/modules/ROOT/pages/spring-cloud-consul/config.adoc rename to docs/modules/ROOT/pages/config.adoc index c8774023..b354d11d 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/config.adoc +++ b/docs/modules/ROOT/pages/config.adoc @@ -12,7 +12,7 @@ config/application/ The most specific property source is at the top, with the least specific at the bottom. Properties in the `config/application` folder are applicable to all applications using consul for configuration. Properties in the `config/testApp` folder are only available to the instances of the service named "testApp". -Configuration is currently read on startup of the application. Sending a HTTP POST to `/refresh` will cause the configuration to be reloaded. xref:spring-cloud-consul/config.adoc#spring-cloud-consul-config-watch[Config Watch] will also automatically detect changes and reload the application context. +Configuration is currently read on startup of the application. Sending a HTTP POST to `/refresh` will cause the configuration to be reloaded. xref:config.adoc#spring-cloud-consul-config-watch[Config Watch] will also automatically detect changes and reload the application context. [[how-to-activate]] == How to activate diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/discovery.adoc b/docs/modules/ROOT/pages/discovery.adoc similarity index 95% rename from docs/modules/ROOT/pages/spring-cloud-consul/discovery.adoc rename to docs/modules/ROOT/pages/discovery.adoc index 38558ebe..5663c04e 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/discovery.adoc +++ b/docs/modules/ROOT/pages/discovery.adoc @@ -44,7 +44,7 @@ spring: port: 8500 ---- -CAUTION: If you use xref:spring-cloud-consul/config.adoc[Spring Cloud Consul Config], and you have set `spring.cloud.bootstrap.enabled=true` or `spring.config.use-legacy-processing=true` or use `spring-cloud-starter-bootstrap`, then the above values will need to be placed in `bootstrap.yml` instead of `application.yml`. +CAUTION: If you use xref:config.adoc[Spring Cloud Consul Config], and you have set `spring.cloud.bootstrap.enabled=true` or `spring.config.use-legacy-processing=true` or use `spring-cloud-starter-bootstrap`, then the above values will need to be placed in `bootstrap.yml` instead of `application.yml`. The default service name, instance id and port, taken from the `Environment`, are `${spring.application.name}`, the Spring Context ID and `${server.port}` respectively. @@ -153,7 +153,7 @@ You can disable the HTTP health check entirely by setting `spring.cloud.consul.d [[applying-headers]] ==== Applying Headers -Headers can be applied to health check requests. For example, if you're trying to register a https://cloud.spring.io/spring-cloud-config/[Spring Cloud Config] server that uses https://github.com/spring-cloud/spring-cloud-config/blob/master/docs/src/main/asciidoc/spring-cloud-config.adoc#vault-backend[Vault Backend]: +Headers can be applied to health check requests. For example, if you're trying to register a https://cloud.spring.io/spring-cloud-config/[Spring Cloud Config] server that uses https://github.com/spring-cloud/spring-cloud-config/blob/main/docs/src/main/asciidoc/spring-cloud-config.adoc#vault-backend[Vault Backend]: .application.yml ---- @@ -338,7 +338,7 @@ With this metadata, and multiple service instances deployed on localhost, the ra [[using-load-balancer]] === Using Load-balancer -Spring Cloud has support for https://github.com/spring-cloud/spring-cloud-netflix/blob/master/docs/src/main/asciidoc/spring-cloud-netflix.adoc#spring-cloud-feign[Feign] (a REST client builder) and also https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#rest-template-loadbalancer-client[Spring `RestTemplate`] +Spring Cloud has support for https://docs.spring.io/spring-cloud-openfeign/docs/current/reference/html/[Feign] (a REST client builder) and also https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#rest-template-loadbalancer-client[Spring `RestTemplate`] for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#spring-cloud-loadbalancer[Spring Cloud LoadBalancer] for client-side load balancing. If you want to access service STORES using the RestTemplate simply declare: diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index e69de29b..58168dfb 100755 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -0,0 +1 @@ +include::intro.adoc[] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc b/docs/modules/ROOT/pages/install.adoc similarity index 56% rename from docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc rename to docs/modules/ROOT/pages/install.adoc index d7fec47c..07e68e76 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc +++ b/docs/modules/ROOT/pages/install.adoc @@ -1,12 +1,14 @@ +[[spring-cloud-consul-install]] += Install Consul + +// TODO: document using Testcontainers and SpringApplication.from() + +Please see the https://www.consul.io/intro/getting-started/install.html[installation documentation] for instructions on how to install Consul. + [[spring-cloud-consul-agent]] -= Consul Agent -:page-section-summary-toc: 1 +== Consul Agent -A Consul Agent client must be available to all Spring Cloud Consul applications. By default, the Agent client is expected to be at `localhost:8500`. See the https://consul.io/docs/agent/basics.html[Agent documentation] for specifics on how to start an Agent client and how to connect to a cluster of Consul Agent Servers. For development, after you have installed consul, you may start a Consul Agent using the following command: - ----- -./src/main/bash/local_run_consul.sh ----- +A Consul Agent client must be available to all Spring Cloud Consul applications. By default, the Agent client is expected to be at `localhost:8500`. See the https://consul.io/docs/agent/basics.html[Agent documentation] for specifics on how to start an Agent client and how to connect to a cluster of Consul Agent Servers. Start a development agent according to the documentation above. This will start an agent in server mode on port 8500, with the ui available at http://localhost:8500 diff --git a/docs/modules/ROOT/pages/intro.adoc b/docs/modules/ROOT/pages/intro.adoc index da721758..3d38b2bd 100644 --- a/docs/modules/ROOT/pages/intro.adoc +++ b/docs/modules/ROOT/pages/intro.adoc @@ -1,3 +1,6 @@ +[[spring-cloud-gateway-intro]] += Introduction + This project provides Consul integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc index 3cee3161..c9fe9fba 100644 --- a/docs/modules/ROOT/pages/quickstart.adoc +++ b/docs/modules/ROOT/pages/quickstart.adoc @@ -1,9 +1,12 @@ +[[quickstart]] += Quick Start + This quick start walks through using Spring Cloud Consul for Service Discovery and Distributed Configuration. First, run Consul Agent on your machine. Then you can access it and use it as a Service Registry and Configuration source with Spring Cloud Consul. [[discovery-client-usage]] -= Discovery Client Usage +== Discovery Client Usage To use these features in an application, you can build it as a Spring Boot application that depends on `spring-cloud-consul-core`. The most convenient way to add the dependency is with a Spring Boot starter: `org.springframework.cloud:spring-cloud-starter-consul-discovery`. @@ -127,7 +130,7 @@ public String serviceUrl() { ---- [[distributed-configuration-usage]] -= Distributed Configuration Usage +== Distributed Configuration Usage To use these features in an application, you can build it as a Spring Boot application that depends on `spring-cloud-consul-core` and `spring-cloud-consul-config`. The most convenient way to add the dependency is with a Spring Boot starter: `org.springframework.cloud:spring-cloud-starter-consul-config`. @@ -226,4 +229,4 @@ public class Application { The application retrieves configuration data from Consul. WARNING: If you use Spring Cloud Consul Config, you need to set the `spring.config.import` property in order to bind to Consul. -You can read more about it in the xref:spring-cloud-consul/config.adoc#config-data-import[Spring Boot Config Data Import section]. +You can read more about it in the xref:config.adoc#config-data-import[Spring Boot Config Data Import section]. diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc b/docs/modules/ROOT/pages/retry.adoc similarity index 96% rename from docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc rename to docs/modules/ROOT/pages/retry.adoc index 8de49a4e..3bd928f3 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc +++ b/docs/modules/ROOT/pages/retry.adoc @@ -1,6 +1,5 @@ [[spring-cloud-consul-retry]] = Consul Retry -:page-section-summary-toc: 1 If you expect that the consul agent may occasionally be unavailable when your app starts, you can ask it to keep trying after a failure. You need to add diff --git a/docs/modules/ROOT/pages/spring-cloud-consul.adoc b/docs/modules/ROOT/pages/spring-cloud-consul.adoc deleted file mode 100644 index 0f725839..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[[spring-cloud-consul]] -= Spring Cloud Consul -:page-section-summary-toc: 1 - -*{spring-cloud-version}* - - diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc deleted file mode 100644 index a3a01e7a..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc +++ /dev/null @@ -1,5 +0,0 @@ -[[configuration-properties]] -= Configuration Properties -:page-section-summary-toc: 1 - -To see the list of all Consul related configuration properties please check link:appendix.html[the Appendix page]. diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc deleted file mode 100644 index b7696493..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[[spring-cloud-consul-hystrix]] -= Circuit Breaker with Hystrix -:page-section-summary-toc: 1 - -Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: `spring-cloud-starter-hystrix`. Hystrix doesn't depend on the Netflix Discovery Client. The `@EnableHystrix` annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with `@HystrixCommand` to be protected by a circuit breaker. See https://projects.spring.io/spring-cloud/spring-cloud.html#_circuit_breaker_hystrix_clients[the documentation] for more details. - - diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc deleted file mode 100644 index 04978a07..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[[spring-cloud-consul-install]] -= Install Consul -:page-section-summary-toc: 1 - -Please see the https://www.consul.io/intro/getting-started/install.html[installation documentation] for instructions on how to install Consul. - diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc deleted file mode 100644 index 59e05139..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[[quick-start]] -= Quick Start -:page-section-summary-toc: 1 - -include:../:quickstart.adoc[] - diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/turbine.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/turbine.adoc deleted file mode 100644 index fe3168dd..00000000 --- a/docs/modules/ROOT/pages/spring-cloud-consul/turbine.adoc +++ /dev/null @@ -1,42 +0,0 @@ -[[spring-cloud-consul-turbine]] -= Hystrix metrics aggregation with Turbine and Consul - -Turbine (provided by the Spring Cloud Netflix project), aggregates multiple instances Hystrix metrics streams, so the dashboard can display an aggregate view. Turbine uses the `DiscoveryClient` interface to lookup relevant instances. To use Turbine with Spring Cloud Consul, configure the Turbine application in a manner similar to the following examples: - -.pom.xml ----- - - org.springframework.cloud - spring-cloud-netflix-turbine - - - org.springframework.cloud - spring-cloud-starter-consul-discovery - ----- - -Notice that the Turbine dependency is not a starter. The turbine starter includes support for Netflix Eureka. - -.application.yml ----- -spring.application.name: turbine -applications: consulhystrixclient -turbine: - aggregator: - clusterConfig: ${applications} - appConfig: ${applications} ----- - -The `clusterConfig` and `appConfig` sections must match, so it's useful to put the comma-separated list of service ID's into a separate configuration property. - -.Turbine.java ----- -@EnableTurbine -@SpringBootApplication -public class Turbine { - public static void main(String[] args) { - SpringApplication.run(DemoturbinecommonsApplication.class, args); - } -} ----- - diff --git a/docs/modules/ROOT/pages/_configprops.adoc b/docs/modules/ROOT/partials/_configprops.adoc similarity index 99% rename from docs/modules/ROOT/pages/_configprops.adoc rename to docs/modules/ROOT/partials/_configprops.adoc index f38fe13c..b7bb7245 100644 --- a/docs/modules/ROOT/pages/_configprops.adoc +++ b/docs/modules/ROOT/partials/_configprops.adoc @@ -81,4 +81,4 @@ |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/docs/modules/ROOT/partials/_conventions.adoc b/docs/modules/ROOT/partials/_conventions.adoc new file mode 100644 index 00000000..b56efa4a --- /dev/null +++ b/docs/modules/ROOT/partials/_conventions.adoc @@ -0,0 +1,6 @@ +[[observability-conventions]] +=== Observability - Conventions + +Below you can find a list of all `GlobalObservationConvention` and `ObservationConvention` declared by this project. + + diff --git a/docs/modules/ROOT/partials/_metrics.adoc b/docs/modules/ROOT/partials/_metrics.adoc new file mode 100644 index 00000000..413db90e --- /dev/null +++ b/docs/modules/ROOT/partials/_metrics.adoc @@ -0,0 +1,6 @@ +[[observability-metrics]] +=== Observability - Metrics + +Below you can find a list of all metrics declared by this project. + + diff --git a/docs/modules/ROOT/partials/_spans.adoc b/docs/modules/ROOT/partials/_spans.adoc new file mode 100644 index 00000000..59ad43a5 --- /dev/null +++ b/docs/modules/ROOT/partials/_spans.adoc @@ -0,0 +1,6 @@ +[[observability-spans]] +=== Observability - Spans + +Below you can find a list of all spans declared by this project. + + diff --git a/docs/pom.xml b/docs/pom.xml index 81de2496..93ec31b8 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -7,18 +7,24 @@ org.springframework.cloud spring-cloud-consul 4.1.0-SNAPSHOT + .. spring-cloud-consul-docs jar Spring Cloud Consul Docs - Spring Cloud Docs + Spring Cloud Consul Docs spring-cloud-consul ${basedir}/.. spring.cloud.consul.* - deploy none + + + 1.0.2 + ${maven.multiModuleProjectDirectory}/ + .* + ${maven.multiModuleProjectDirectory}/docs/modules/ROOT/partials/ @@ -37,26 +43,32 @@ docs + + + src/main/antora/resources/antora-resources + true + + pl.project13.maven git-commit-id-plugin - - org.codehaus.mojo - exec-maven-plugin - org.apache.maven.plugins maven-dependency-plugin - org.apache.maven.plugins - maven-resources-plugin + org.codehaus.mojo + exec-maven-plugin - org.asciidoctor - asciidoctor-maven-plugin + io.spring.maven.antora + antora-component-version-maven-plugin + + + io.spring.maven.antora + antora-maven-plugin org.apache.maven.plugins diff --git a/docs/src/main/antora/resources/antora-resources/antora.yml b/docs/src/main/antora/resources/antora-resources/antora.yml new file mode 100644 index 00000000..9148923f --- /dev/null +++ b/docs/src/main/antora/resources/antora-resources/antora.yml @@ -0,0 +1,20 @@ +version: @antora-component.version@ +prerelease: @antora-component.prerelease@ + +asciidoc: + attributes: + attribute-missing: 'warn' + chomp: 'all' + project-root: @maven.multiModuleProjectDirectory@ + github-repo: @docs.main@ + github-raw: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@ + github-code: https://github.com/spring-cloud/@docs.main@/tree/@github-tag@ + github-issues: https://github.com/spring-cloud/@docs.main@/issues/ + github-wiki: https://github.com/spring-cloud/@docs.main@/wiki + spring-cloud-version: @project.version@ + github-tag: @github-tag@ + version-type: @version-type@ + docs-url: https://docs.spring.io/@docs.main@/docs/@project.version@ + raw-docs-url: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@ + project-version: @project.version@ + project-name: @docs.main@ diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/src/main/asciidoc/README.adoc similarity index 80% rename from docs/modules/ROOT/pages/README.adoc rename to docs/src/main/asciidoc/README.adoc index df51815c..e09e44a7 100644 --- a/docs/modules/ROOT/pages/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -1,5 +1,5 @@ -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"] +image::https://github.com/spring-cloud/spring-cloud-consul/workflows/Build/badge.svg?style=svg["Actions Status", link="https://github.com/spring-cloud/spring-cloud-consul/actions"] +image::https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main"] [[quick-start]] @@ -43,9 +43,9 @@ See the https://consul.io/intro/index.html[intro] for more information. [[building]] = Building -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-jdk8.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/building.adoc[] [[contributing]] = Contributing -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/contributing.adoc[] diff --git a/docs/modules/ROOT/pages/sagan-boot.adoc b/docs/src/main/asciidoc/sagan-boot.adoc similarity index 100% rename from docs/modules/ROOT/pages/sagan-boot.adoc rename to docs/src/main/asciidoc/sagan-boot.adoc diff --git a/docs/modules/ROOT/pages/sagan-index.adoc b/docs/src/main/asciidoc/sagan-index.adoc similarity index 100% rename from docs/modules/ROOT/pages/sagan-index.adoc rename to docs/src/main/asciidoc/sagan-index.adoc