Docs: Genericize inventory examples and align USAGE.md #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- I've updated `cluster/inventory/hosts.example` to use generic placeholders (e.g., `kafka_cluster_nodes`, `kafka_node1`, `your_ssh_user`, example IPs) and removed host-specific variables like `static_ipv4`/`static_ipv6`. The `kraft_controller_quorum_voters` and `kraft_cluster_id` examples were also updated for generic consistency. - I've also updated `cluster/USAGE.md` to align all examples, code snippets, and explanations with the new generic placeholders in `hosts.example`. This includes SSH key paths, KRAFT node role examples, and Kafka cluster group variable examples.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've updated
cluster/inventory/hosts.exampleto use generic placeholders (e.g.,kafka_cluster_nodes,kafka_node1,your_ssh_user, example IPs) and removed host-specific variables likestatic_ipv4/static_ipv6. Thekraft_controller_quorum_votersandkraft_cluster_idexamples were also updated for generic consistency.I've also updated
cluster/USAGE.mdto align all examples, code snippets, and explanations with the new generic placeholders inhosts.example. This includes SSH key paths, KRAFT node role examples, and Kafka cluster group variable examples.