Skip to content

feat(resolver): implement system catalog smart defaulting #103

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
fernando-villalba merged 1 commit into from
Jan 3, 2026
Merged

feat(resolver): implement system catalog smart defaulting #103

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
24 changes: 23 additions & 1 deletion pkg/resolver/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,29 @@ func (r *Resolver) PopulateClusterDefaults(cluster *multigresv1alpha1.MultigresC
cluster.Spec.TemplateDefaults.ShardTemplate = FallbackShardTemplate
}

// 3. Default Inline Configs (Deep Defaulting)
// 3. Smart Defaulting: System Catalog
// If no databases are defined, inject the mandatory system database "postgres".
if len(cluster.Spec.Databases) == 0 {
cluster.Spec.Databases = append(cluster.Spec.Databases, multigresv1alpha1.DatabaseConfig{
Name: DefaultSystemDatabaseName,
Default: true,
})
}

// If any database has no tablegroups, inject the mandatory default tablegroup "default".
for i := range cluster.Spec.Databases {
if len(cluster.Spec.Databases[i].TableGroups) == 0 {
cluster.Spec.Databases[i].TableGroups = append(
cluster.Spec.Databases[i].TableGroups,
multigresv1alpha1.TableGroupConfig{
Name: DefaultSystemTableGroupName,
Default: true,
},
)
}
}

// 4. Default Inline Configs (Deep Defaulting)
// We ONLY default these if the user explicitly provided the block (Inline).
// We DO NOT fetch templates here, adhering to the "Non-Goal" of the design doc.

Expand Down
104 changes: 104 additions & 0 deletions pkg/resolver/cluster_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,19 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: FallbackCellTemplate,
ShardTemplate: FallbackShardTemplate,
},
// Expect Smart Defaulting: System Catalog
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: DefaultSystemDatabaseName,
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{
{
Name: DefaultSystemTableGroupName,
Default: true,
},
},
},
},
},
},
},
Expand All @@ -65,6 +78,13 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: "custom-cell",
ShardTemplate: "custom-shard",
},
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: "existing-db",
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{{Name: "tg1"}},
},
},
},
},
want: &multigresv1alpha1.MultigresCluster{
Expand All @@ -82,6 +102,13 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: "custom-cell",
ShardTemplate: "custom-shard",
},
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: "existing-db",
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{{Name: "tg1"}},
},
},
},
},
},
Expand Down Expand Up @@ -111,6 +138,19 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: FallbackCellTemplate,
ShardTemplate: FallbackShardTemplate,
},
// Expect Smart Defaulting for DBs
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: DefaultSystemDatabaseName,
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{
{
Name: DefaultSystemTableGroupName,
Default: true,
},
},
},
},
GlobalTopoServer: multigresv1alpha1.GlobalTopoServerSpec{
Etcd: &multigresv1alpha1.EtcdSpec{
Image: DefaultEtcdImage,
Expand Down Expand Up @@ -156,6 +196,19 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: FallbackCellTemplate,
ShardTemplate: FallbackShardTemplate,
},
// Expect Smart Defaulting for DBs
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: DefaultSystemDatabaseName,
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{
{
Name: DefaultSystemTableGroupName,
Default: true,
},
},
},
},
Cells: []multigresv1alpha1.CellConfig{
{
Name: "cell-1",
Expand Down Expand Up @@ -195,6 +248,19 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
CellTemplate: FallbackCellTemplate,
ShardTemplate: FallbackShardTemplate,
},
// Expect Smart Defaulting for DBs
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: DefaultSystemDatabaseName,
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{
{
Name: DefaultSystemTableGroupName,
Default: true,
},
},
},
},
GlobalTopoServer: multigresv1alpha1.GlobalTopoServerSpec{
Etcd: &multigresv1alpha1.EtcdSpec{
Image: "custom-etcd",
Expand All @@ -206,6 +272,44 @@ func TestResolver_PopulateClusterDefaults(t *testing.T) {
},
},
},
"Smart Defaulting: Inject TableGroup when DB exists": {
input: &multigresv1alpha1.MultigresCluster{
Spec: multigresv1alpha1.MultigresClusterSpec{
Databases: []multigresv1alpha1.DatabaseConfig{
{Name: "postgres", Default: true}, // No TableGroups
},
},
},
want: &multigresv1alpha1.MultigresCluster{
Spec: multigresv1alpha1.MultigresClusterSpec{
Images: multigresv1alpha1.ClusterImages{
Postgres: DefaultPostgresImage,
MultiAdmin: DefaultMultiAdminImage,
MultiOrch: DefaultMultiOrchImage,
MultiPooler: DefaultMultiPoolerImage,
MultiGateway: DefaultMultiGatewayImage,
ImagePullPolicy: DefaultImagePullPolicy,
},
TemplateDefaults: multigresv1alpha1.TemplateDefaults{
CoreTemplate: FallbackCoreTemplate,
CellTemplate: FallbackCellTemplate,
ShardTemplate: FallbackShardTemplate,
},
Databases: []multigresv1alpha1.DatabaseConfig{
{
Name: "postgres",
Default: true,
TableGroups: []multigresv1alpha1.TableGroupConfig{
{
Name: DefaultSystemTableGroupName,
Default: true,
},
},
},
},
},
},
},
}

for name, tc := range tests {
Expand Down
6 changes: 6 additions & 0 deletions pkg/resolver/defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ const (
// FallbackShardTemplate is the name of the template to look for if no specific ShardTemplate is referenced.
FallbackShardTemplate = "default"

// DefaultSystemDatabaseName is the name of the mandatory system database.
DefaultSystemDatabaseName = "postgres"

// DefaultSystemTableGroupName is the name of the mandatory default table group.
DefaultSystemTableGroupName = "default"

// DefaultPostgresImage is the default container image used for PostgreSQL instances.
DefaultPostgresImage = "postgres:15-alpine"

Expand Down
2 changes: 1 addition & 1 deletion pkg/resolver/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ go 1.25.0

require (
github.com/google/go-cmp v0.7.0
github.com/numtide/multigres-operator/api v0.0.0-20251224124005-355869230728
github.com/numtide/multigres-operator/api v0.0.0-20260103121224-057738b43b3b
k8s.io/api v0.34.3
k8s.io/apimachinery v0.34.3
k8s.io/utils v0.0.0-20251002143259-bc988d571ff4
Expand Down
2 changes: 2 additions & 0 deletions pkg/resolver/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
github.com/numtide/multigres-operator/api v0.0.0-20251224124005-355869230728 h1:a+iM4L0nC7kUgcAD1P+wuNJg4x0rjcy6rVZ3+vF52Cc=
github.com/numtide/multigres-operator/api v0.0.0-20251224124005-355869230728/go.mod h1:A1bBmTxHr+362dGZ5G6u2S4xsP6enbgdUS/UJUOmKbc=
github.com/numtide/multigres-operator/api v0.0.0-20260103121224-057738b43b3b h1:twErev/AdyVQvlYa5vbo5wqq+NlexZJmIm0pwEQd5qI=
github.com/numtide/multigres-operator/api v0.0.0-20260103121224-057738b43b3b/go.mod h1:A1bBmTxHr+362dGZ5G6u2S4xsP6enbgdUS/UJUOmKbc=
github.com/onsi/ginkgo/v2 v2.25.3 h1:Ty8+Yi/ayDAGtk4XxmmfUy4GabvM+MegeB4cDLRi6nw=
github.com/onsi/ginkgo/v2 v2.25.3/go.mod h1:43uiyQC4Ed2tkOzLsEYm7hnrb7UJTWHYNsuy3bG/snE=
github.com/onsi/gomega v1.38.3 h1:eTX+W6dobAYfFeGC2PV6RwXRu/MyT+cQguijutvkpSM=
Expand Down