Skip to content

Commit 9f9794a

Browse files
committed
move tip next to sample config file
1 parent a68335b commit 9f9794a

File tree

1 file changed

+17
-17
lines changed
  • modules/manage/pages/disaster-recovery/shadowing

1 file changed

+17
-17
lines changed

modules/manage/pages/disaster-recovery/shadowing/setup.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,23 @@ endif::[]
114114

115115
== Create a shadow link
116116

117-
Any cluster can create a shadow link to a source cluster. When you create a shadow link with `rpk` or the API, you provide a YAML configuration file that defines connection settings, filters, and synchronization options.
117+
Any cluster can create a shadow link to a source cluster. When you create a shadow link with `rpk` or the API, you need to provide a YAML configuration file that defines connection settings, filters, and synchronization options.
118+
119+
[TIP]
120+
====
121+
You can use `rpk` to generate a configuration template:
122+
123+
[,bash]
124+
----
125+
# Generate a sample configuration file with placeholder values
126+
rpk shadow config generate -o shadow-config.yaml
127+
128+
# Or generate a template with detailed field documentation
129+
rpk shadow config generate --print-template -o shadow-config-template.yaml
130+
----
131+
132+
This creates a complete YAML configuration file that you can customize for your environment. The template includes all available fields with comments explaining their purpose.
133+
====
118134

119135
.Explore the configuration file
120136
[%collapsible]
@@ -214,22 +230,6 @@ Topic filters select which topics Shadowing automatically creates as shadow topi
214230

215231
Consumer group and ACL filters control which groups and security policies replicate to maintain application functionality.
216232

217-
[TIP]
218-
====
219-
You can use `rpk` to generate a configuration template:
220-
221-
[,bash]
222-
----
223-
# Generate a sample configuration file with placeholder values
224-
rpk shadow config generate -o shadow-config.yaml
225-
226-
# Or generate a template with detailed field documentation
227-
rpk shadow config generate --print-template -o shadow-config-template.yaml
228-
----
229-
230-
This creates a complete YAML configuration file that you can customize for your environment. The template includes all available fields with comments explaining their purpose.
231-
====
232-
233233
=== Filter types and patterns
234234

235235
Each filter uses two key settings:

0 commit comments

Comments
 (0)