Skip to content

Conversation

@GaneshPatil7517
Copy link
Contributor

Fixes apache/camel-website#978

Summary

This PR adds documentation support for cluster service infrastructure starters that were causing build warnings because they don't have corresponding Camel component documentation.

Problem

The cluster service starters (consul, file, infinispan, jgroups-raft, kubernetes, zookeeper) are infrastructure starters that don't directly use a Camel component. The existing documentation mechanism in list.adoc counts JSON files and compares them against pages with :camel-spring-boot-name: attributes, causing a mismatch and build warnings.

Solution

  1. Modified list.adoc: Added exclude='*-cluster-service.json' to the indexcount macro to exclude cluster service JSON files from the validation count
  2. Created dedicated documentation pages for each cluster service:
    • consul-cluster-service.adoc
    • file-cluster-service.adoc
    • infinispan-cluster-service.adoc
    • jgroups-raft-cluster-service.adoc
    • kubernetes-cluster-service.adoc
    • zookeeper-cluster-service.adoc
  3. Added Cluster Services section in list.adoc with a table linking to the new pages
  4. Updated nav.adoc with Cluster Services navigation entries

Changes

  • docs/spring-boot/modules/ROOT/pages/list.adoc - Added exclusion pattern and Cluster Services section
  • docs/spring-boot/modules/ROOT/nav.adoc - Added Cluster Services navigation
  • docs/spring-boot/modules/ROOT/pages/consul-cluster-service.adoc - New
  • docs/spring-boot/modules/ROOT/pages/file-cluster-service.adoc - New
  • docs/spring-boot/modules/ROOT/pages/infinispan-cluster-service.adoc - New
  • docs/spring-boot/modules/ROOT/pages/jgroups-raft-cluster-service.adoc - New
  • docs/spring-boot/modules/ROOT/pages/kubernetes-cluster-service.adoc - New
  • docs/spring-boot/modules/ROOT/pages/zookeeper-cluster-service.adoc - New

This commit fixes the spring boot starter documentation issue apache#978.

The cluster service starters (consul, file, infinispan, jgroups-raft,
kubernetes, zookeeper) are infrastructure starters that do not directly
map to a Camel component, causing unused JSON file warnings in the
documentation build.

Changes:
- Added dedicated documentation pages for each cluster service starter
- Added Cluster Services section to list.adoc
- Modified indexcount to exclude cluster service JSON files from the
  mismatch count check
- Updated nav.adoc with cluster service navigation entries
@jamesnetherton
Copy link
Contributor

@Croway
Copy link
Contributor

Croway commented Jan 14, 2026

@GaneshPatil7517 given @jamesnetherton comment, I think you need to build https://github.com/apache/camel locally, and rebuild camel-spring-boot, this way the configuration options will be synced. Once pushed the synced configurations, the PR can be merged.

EDIT: the configuration options are not generated, then you need to add those https://github.com/apache/camel-spring-boot/blob/main/components-starter/camel-file-cluster-service-starter/src/main/java/org/apache/camel/component/file/springboot/cluster/FileLockClusterServiceConfiguration.java#L58-L81 to the file cluster service documentation. Thanks

@GaneshPatil7517
Copy link
Contributor Author

@GaneshPatil7517 given @jamesnetherton comment, I think you need to build https://github.com/apache/camel locally, and rebuild camel-spring-boot, this way the configuration options will be synced. Once pushed the synced configurations, the PR can be merged.

EDIT: the configuration options are not generated, then you need to add those https://github.com/apache/camel-spring-boot/blob/main/components-starter/camel-file-cluster-service-starter/src/main/java/org/apache/camel/component/file/springboot/cluster/FileLockClusterServiceConfiguration.java#L58-L81 to the file cluster service documentation. Thanks

ok ill give you good update soon...

Added missing configuration options:
- heartbeat-timeout-multiplier
- cluster-data-task-max-attempts
- cluster-data-task-timeout

Updated descriptions to match the Java source code (L58-L81).
@GaneshPatil7517
Copy link
Contributor Author

Screenshot 2026-01-14 222516 Screenshot 2026-01-14 222532 Screenshot 2026-01-14 222546

@Croway Croway merged commit fca9fcc into apache:main Jan 14, 2026
3 checks passed
@GaneshPatil7517
Copy link
Contributor Author

thank you so much @Croway for boosting my confidence feel free assign more issues....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

spring boot starter documentation

3 participants