Skip to content

cluster: fix Grafana VM datasource replacement #2732

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
bb7133 merged 1 commit into from
Aug 27, 2026
Merged

cluster: fix Grafana VM datasource replacement #2732

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
7 changes: 5 additions & 2 deletions pkg/cluster/spec/grafana.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,13 +374,16 @@ func (i *GrafanaInstance) initDashboards(ctx context.Context, e ctxt.Executor, s
}

// Deal with the cluster name and datasource
// Replace literal dashboard placeholders first. The datasource name can contain
// "test-cluster" (for example, "test-cluster-vm"), so replacing these literals
// after datasource placeholders would rewrite the generated name a second time.
for _, cmd := range []string{
`find %s -type f -exec sed -i 's/test-cluster/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/Test-Cluster/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/\${DS_.*-CLUSTER}/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/DS_.*-CLUSTER/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/\${DS_LIGHTNING}/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/DS_LIGHTNING/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/test-cluster/%s/g' {} \;`,
`find %s -type f -exec sed -i 's/Test-Cluster/%s/g' {} \;`,
} {
cmd := fmt.Sprintf(cmd, dashboardsDir, datasourceName)
_, stderr, err := e.Execute(ctx, cmd, false)
Expand Down
55 changes: 38 additions & 17 deletions pkg/cluster/spec/grafana_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,18 @@ func TestVictoriaMetricsDefaultDatasource(t *testing.T) {
err = os.MkdirAll(binDir, 0755)
require.NoError(t, err)

datasourceName := "test-cluster-vm"
dashboardReplacements := []struct {
commandPattern string
placeholder string
}{
{`s/test-cluster/`, "test-cluster"},
{`s/Test-Cluster/`, "Test-Cluster"},
{`s/\${DS_.*-CLUSTER}/`, "${DS_TEST-CLUSTER}"},
{`s/DS_.*-CLUSTER/`, "DS_TEST-CLUSTER"},
{`s/\${DS_LIGHTNING}/`, "${DS_LIGHTNING}"},
{`s/DS_LIGHTNING/`, "DS_LIGHTNING"},
}
// Create a mock for the execute function to handle the dashboard copy command
origExecutor := &mockExecutor{
executeFunc: func(ctx context.Context, cmd string, sudo bool, timeouts ...time.Duration) ([]byte, []byte, error) {
Expand All @@ -297,31 +309,29 @@ func TestVictoriaMetricsDefaultDatasource(t *testing.T) {
return nil, nil, err
}
} else if strings.Contains(cmd, "sed") {
// Handle the sed command to replace datasource references
// Handle each sed command using the same replacement order as initDashboards.
files, err := os.ReadDir(dashboardsDir)
if err != nil {
return nil, nil, err
}

for _, file := range files {
if strings.HasSuffix(file.Name(), ".json") {
content, err := os.ReadFile(filepath.Join(dashboardsDir, file.Name()))
filePath := filepath.Join(dashboardsDir, file.Name())
content, err := os.ReadFile(filePath)
if err != nil {
return nil, nil, err
}

// Replace datasource references - simulating what sed would do
modifiedContent := strings.ReplaceAll(string(content),
`"DS_TEST-CLUSTER"`,
fmt.Sprintf(`"DS_%s-VM"`, strings.ToUpper("test-cluster")))
modifiedContent = strings.ReplaceAll(modifiedContent,
`"text": "test-cluster"`,
fmt.Sprintf(`"text": "%s-vm"`, "test-cluster"))
modifiedContent = strings.ReplaceAll(modifiedContent,
`"value": "test-cluster"`,
fmt.Sprintf(`"value": "%s-vm"`, "test-cluster"))

err = os.WriteFile(filepath.Join(dashboardsDir, file.Name()), []byte(modifiedContent), 0644)
modifiedContent := string(content)
for _, replacement := range dashboardReplacements {
if strings.Contains(cmd, replacement.commandPattern) {
modifiedContent = strings.ReplaceAll(modifiedContent, replacement.placeholder, datasourceName)
break
}
}

err = os.WriteFile(filePath, []byte(modifiedContent), 0644)
if err != nil {
return nil, nil, err
}
Expand All @@ -335,7 +345,11 @@ func TestVictoriaMetricsDefaultDatasource(t *testing.T) {
// Create a sample dashboard file with datasource references
dashboardContent := `{
"annotations": {
"list": []
"list": [
{
"datasource": "${DS_TEST-CLUSTER}"
}
]
},
"editable": true,
"fiscalYearStartMonth": 0,
Expand Down Expand Up @@ -408,8 +422,15 @@ func TestVictoriaMetricsDefaultDatasource(t *testing.T) {
content, err := os.ReadFile(dashboardFile)
require.NoError(t, err)

// Verify VM datasource was used
assert.Contains(t, string(content), `"DS_TEST-CLUSTER-VM"`)
// Verify every dashboard reference uses the provisioned VM datasource name
// without rewriting it to test-cluster-vm-vm.
assert.Contains(t, string(content), `"datasource": "test-cluster-vm"`)
assert.Contains(t, string(content), `"name": "test-cluster-vm"`)
assert.Contains(t, string(content), `"text": "test-cluster-vm"`)
assert.Contains(t, string(content), `"value": "test-cluster-vm"`)
assert.NotContains(t, string(content), "test-cluster-vm-vm")

dsContent, err := os.ReadFile(filepath.Join(deployDir, "provisioning", "datasources", "datasource.yml"))
require.NoError(t, err)
assert.Contains(t, string(dsContent), "name: test-cluster-vm")
}
Loading