Skip to content

[UX-747] rpk shadow: enable --print-template for cloud #29098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
r-vasquez merged 1 commit into from
Dec 30, 2025
+33 −7
Merged

[UX-747] rpk shadow: enable --print-template for cloud #29098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions src/go/rpk/pkg/cli/shadow/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Save the template with documentation to a file:
Run: func(_ *cobra.Command, _ []string) {
var outputData, successMsg string
if printTemplate {
template := generateConfigTemplate()
template := generateConfigTemplate(cloud)
outputData = template
successMsg = "Template file generated successfully: %s\n"
} else {
Expand Down Expand Up @@ -225,10 +225,28 @@ func generateSampleConfig(cloud bool) *ShadowLinkConfig {
return slCfg
}

func generateConfigTemplate() string {
func generateConfigTemplate(cloud bool) string {
var sb strings.Builder

sb.WriteString("# Shadow Link Configuration Template\n")
if cloud {
sb.WriteString("# Shadow Link Configuration Template for Redpanda Cloud\n")
} else {
sb.WriteString("# Shadow Link Configuration Template\n")
}

// Manually add name field (not in ShadowLinkConfigurations proto, but in ShadowLink)
Copy link

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of 'Configuations' to 'Configurations' in comment.

Copilot uses AI. Check for mistakes.
sb.WriteString("# The name of the shadow link\n")
sb.WriteString("name: \"\"\n")

// Inject cloud_options manually (not in admin/v2 proto)
if cloud {
sb.WriteString("# Configurations for Shadow Link in Redpanda Cloud\n")
sb.WriteString("cloud_options:\n")
sb.WriteString(" # The ID of the source Redpanda Cloud cluster (optional)\n")
sb.WriteString(" source_redpanda_id: \"\"\n")
sb.WriteString(" # The ID of the shadow Redpanda Cloud cluster\n")
sb.WriteString(" shadow_redpanda_id: \"\"\n\n")
}

// Get the message descriptor from the global registry
cfg := &v2.ShadowLinkConfigurations{}
Expand All @@ -252,7 +270,7 @@ func generateConfigTemplate() string {
continue
}

writeFieldTemplate(&sb, field, 0)
writeFieldTemplate(&sb, field, 0, cloud)
}

return sb.String()
Expand Down Expand Up @@ -331,7 +349,12 @@ func toScreamingSnakeCase(s string) string {
return strings.ToUpper(result.String())
}

func writeFieldTemplate(sb *strings.Builder, field protoreflect.FieldDescriptor, indent int) {
func writeFieldTemplate(sb *strings.Builder, field protoreflect.FieldDescriptor, indent int, cloud bool) {
// Skip tls_file_settings for Cloud (only tls_pem_settings is valid)
if cloud && string(field.Name()) == "tls_file_settings" {
return
}

indentStr := strings.Repeat(" ", indent)

// Get field comment using the appropriate package registry
Expand Down Expand Up @@ -373,7 +396,7 @@ func writeFieldTemplate(sb *strings.Builder, field protoreflect.FieldDescriptor,
continue
}

writeFieldTemplate(sb, nestedField, indent+2)
writeFieldTemplate(sb, nestedField, indent+2, cloud)
}
} else {
// List of scalars
Expand Down Expand Up @@ -409,7 +432,7 @@ func writeFieldTemplate(sb *strings.Builder, field protoreflect.FieldDescriptor,
continue
}

writeFieldTemplate(sb, nestedField, indent+1)
writeFieldTemplate(sb, nestedField, indent+1, cloud)
}
}
} else {
Expand Down
3 changes: 3 additions & 0 deletions src/go/rpk/pkg/cli/shadow/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ type ShadowLinkConfig struct {
}

type CloudShadowLinkOptions struct {
// Source Redpanda cluster ID. This field is optional. If provided, fetches
// bootstrap server information.
SourceRedpandaID string `json:"source_redpanda_id,omitempty" yaml:"source_redpanda_id,omitempty"`
// Shadow Redpanda cluster ID where the shadow link will be created.
ShadowRedpandaID string `json:"shadow_redpanda_id,omitempty" yaml:"shadow_redpanda_id,omitempty"`
}

Expand Down
Loading