Add maven processor for docs
This commit is contained in:
37
README.adoc
37
README.adoc
@@ -2,28 +2,21 @@
|
||||
|
||||
|
||||
This project provides Netflix OSS integrations for Spring Boot apps through autoconfiguration
|
||||
and binding to the Spring Environment and other Spring programming model idioms.
|
||||
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 battle-tested Netflix components. The
|
||||
patterns provided include Service Discovery (Eureka), Circuit Breaker (Hystrix),
|
||||
Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
|
||||
|
||||
|
||||
== TODO List
|
||||
== Features
|
||||
|
||||
* Service Discovery: Eureka instances can be registered and clients can discover the instances using Spring-managed beans
|
||||
* Service Discovery: an embedded Eureka server can be created with declarative Java configuration
|
||||
* Circuit Breaker: Hystrix clients can be built with a simple annotation-driven method decorator
|
||||
* Circuit Breaker: embedded Hystrix dashboard with declarative Java configuration
|
||||
* Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations
|
||||
* Client Side Load Balancer: Ribbon
|
||||
* External Configuration: a bridge from the Sprnig Environment to Archaius (enabls native configuration of Netflix components using Spring Boot conventions)
|
||||
* Router and Filter: automatic regsitration of Zuul filters,a nd a simple convention over configuration approach to reverse proxy creation
|
||||
|
||||
- [x] Example front end app (currently in sandbox)
|
||||
- [x] Example back end service (currently in sandbox)
|
||||
- [x] Use platform config
|
||||
- [x] Hystrix integration (hystrix-javanica)
|
||||
- [x] Feign use spring message converters
|
||||
- [x] Ribbon (static server list)
|
||||
- [x] Eureka boot app (Service registration)
|
||||
- [x] Eureka (apache -> tomcat) see https://github.com/cfregly/fluxcapacitor/wiki/NetflixOSS-FAQ#eureka-service-discovery-load-balancer and https://groups.google.com/forum/?fromgroups#!topic/eureka_netflix/g3p2r7gHnN0
|
||||
- [x] Archaius bridge to spring environment
|
||||
- [x] Ribbon (Client side load balancing) (Eureka integration)
|
||||
- [x] Remove need for *-eureka.properties
|
||||
- [ ] Use spring boot values as defaults where appropriate
|
||||
- [x] Synchronous removal of service from eureka on shutdown
|
||||
- [x] Refresh log levels dynamically
|
||||
- [x] Router (Zuul) integrated using hystrix/ribbon/eureka
|
||||
- [ ] Better observable example
|
||||
- [ ] Distributed refresh environment via platform bus
|
||||
- [x] Metrics aggregation (turbine)
|
||||
- [x] Use Eureka for instance discovery rather than static list see https://github.com/Netflix/Turbine/blob/master/turbine-contrib/src/main/java/com/netflix/turbine/discovery/EurekaInstanceDiscovery.java
|
||||
- [ ] Configure InstanceDiscovery.impl using auto config/config props
|
||||
|
||||
25
pom.xml
25
pom.xml
@@ -238,6 +238,7 @@
|
||||
<tasks>
|
||||
<java classname="org.jruby.Main" failonerror="yes">
|
||||
<arg value="${basedir}/src/main/ruby/generate_readme.sh" />
|
||||
<arg value="-o" />
|
||||
<arg value="${basedir}/README.adoc" />
|
||||
</java>
|
||||
</tasks>
|
||||
@@ -245,6 +246,30 @@
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
<version>1.5.0</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-</id>
|
||||
<phase>process-resources</phase>
|
||||
<goals>
|
||||
<goal>process-asciidoc</goal>
|
||||
</goals>
|
||||
<inherited>false</inherited>
|
||||
<configuration>
|
||||
<sourceDocumentName>${project.artifactId}.adoc</sourceDocumentName>
|
||||
<backend>html</backend>
|
||||
<doctype>article</doctype>
|
||||
<attributes>
|
||||
<docinfo>true</docinfo>
|
||||
<spring-cloud-version>${project.version}</spring-cloud-version>
|
||||
</attributes>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user