Skip to content

Commit b6836a3

Browse files
author
calvin
committed
support split table for internal storage
Signed-off-by: calvin <[email protected]>
1 parent 29c0306 commit b6836a3

File tree

6 files changed

+165
-87
lines changed

6 files changed

+165
-87
lines changed

‎pkg/storage/internalstorage/config.go

+5-25
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ import (
1515
"gopkg.in/natefinch/lumberjack.v2"
1616
"gorm.io/gorm/logger"
1717
"k8s.io/klog/v2"
18-
19-
clusterv1alpha2 "github.com/clusterpedia-io/api/cluster/v1alpha2"
2018
)
2119

2220
const (
@@ -29,9 +27,9 @@ const (
2927
type DivisionPolicy string
3028

3129
const (
32-
DivisionPolicyNone DivisionPolicy = "None"
33-
DivisionPolicyGroupResource DivisionPolicy = "GroupResource"
34-
DivisionPolicyCustom DivisionPolicy = "Custom"
30+
DivisionPolicyNone DivisionPolicy = "None"
31+
DivisionPolicyGroupVersionResource DivisionPolicy = "GVR"
32+
DivisionPolicyCustom DivisionPolicy = "Custom"
3533
)
3634

3735
type Config struct {
@@ -58,30 +56,12 @@ type Config struct {
5856

5957
Params map[string]string `yaml:"params"`
6058

61-
AutoMigration *bool `yaml:"autoMigration"` // If set to false, no tables will be created
62-
DivisionPolicy DivisionPolicy `yaml:"divisionPolicy"`
63-
Mapper []ResourceMapper `yaml:"mapper"` // Only DivisionPolicy is DivisionPolicyCustom it need to specify the mapping between resource and table
59+
SkipAutoMigration bool `yaml:"skipAutoMigration"` // If set to false, no tables will be created
60+
DivisionPolicy DivisionPolicy `yaml:"divisionPolicy"`
6461

6562
Log *LogConfig `yaml:"log"`
6663
}
6764

68-
type ResourceMapper struct {
69-
Table *Table `yaml:"table"`
70-
Resources []clusterv1alpha2.ClusterGroupResources `yaml:"resources"`
71-
}
72-
73-
type Table struct {
74-
Name string `yaml:"name"`
75-
ExtraFields []ExtraField `yaml:"extraFields"`
76-
}
77-
78-
type ExtraField struct {
79-
Name string `yaml:"name"`
80-
PlainPath string `yaml:"plainPath"`
81-
Type string `yaml:"type"`
82-
Index string `yaml:"index"`
83-
}
84-
8565
type LogConfig struct {
8666
Stdout bool `yaml:"stdout"`
8767
Level string `yaml:"level"`

‎pkg/storage/internalstorage/register.go

+14-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,20 @@ func NewStorageFactory(configPath string) (storage.StorageFactory, error) {
9393
sqlDB.SetMaxOpenConns(connPool.MaxOpenConns)
9494
sqlDB.SetConnMaxLifetime(connPool.ConnMaxLifetime)
9595

96-
return &StorageFactory{db}, nil
96+
if cfg.DivisionPolicy == DivisionPolicyNone || cfg.DivisionPolicy == "" {
97+
if !cfg.SkipAutoMigration {
98+
exist := db.Migrator().HasTable("resources")
99+
if !exist {
100+
return nil, db.AutoMigrate(&Resource{})
101+
}
102+
}
103+
}
104+
105+
return &StorageFactory{
106+
db: db,
107+
SkipAutoMigration: cfg.SkipAutoMigration,
108+
DivisionPolicy: cfg.DivisionPolicy,
109+
}, nil
97110
}
98111

99112
func newLogger(cfg *Config) (logger.Interface, error) {

‎pkg/storage/internalstorage/resource_storage.go

+24-21
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@ import (
2727
)
2828

2929
type ResourceStorage struct {
30-
db *gorm.DB
31-
codec runtime.Codec
32-
30+
db *gorm.DB
31+
codec runtime.Codec
3332
storageGroupResource schema.GroupResource
3433
storageVersion schema.GroupVersion
3534
memoryVersion schema.GroupVersion
@@ -116,14 +115,17 @@ func (s *ResourceStorage) Update(ctx context.Context, cluster string, obj runtim
116115
updatedResource["deleted_at"] = sql.NullTime{Time: deletedAt.Time, Valid: true}
117116
}
118117

119-
result := s.db.WithContext(ctx).Model(&Resource{}).Where(map[string]interface{}{
120-
"cluster": cluster,
121-
"group": s.storageGroupResource.Group,
122-
"version": s.storageVersion.Version,
123-
"resource": s.storageGroupResource.Resource,
124-
"namespace": metaobj.GetNamespace(),
125-
"name": metaobj.GetName(),
126-
}).Updates(updatedResource)
118+
result := s.db.WithContext(ctx).
119+
Where(map[string]interface{}{
120+
"cluster": cluster,
121+
"group": s.storageGroupResource.Group,
122+
"version": s.storageVersion.Version,
123+
"resource": s.storageGroupResource.Resource,
124+
"namespace": metaobj.GetNamespace(),
125+
"name": metaobj.GetName(),
126+
}).
127+
Updates(updatedResource)
128+
127129
return InterpretResourceDBError(cluster, metaobj.GetName(), result.Error)
128130
}
129131

@@ -144,7 +146,7 @@ func (s *ResourceStorage) ConvertDeletedObject(obj interface{}) (runtime.Object,
144146
}
145147

146148
func (s *ResourceStorage) deleteObject(cluster, namespace, name string) *gorm.DB {
147-
return s.db.Model(&Resource{}).Where(map[string]interface{}{
149+
return s.db.Where(map[string]interface{}{
148150
"cluster": cluster,
149151
"group": s.storageGroupResource.Group,
150152
"version": s.storageVersion.Version,
@@ -167,14 +169,15 @@ func (s *ResourceStorage) Delete(ctx context.Context, cluster string, obj runtim
167169
}
168170

169171
func (s *ResourceStorage) genGetObjectQuery(ctx context.Context, cluster, namespace, name string) *gorm.DB {
170-
return s.db.WithContext(ctx).Model(&Resource{}).Select("object").Where(map[string]interface{}{
171-
"cluster": cluster,
172-
"group": s.storageGroupResource.Group,
173-
"version": s.storageVersion.Version,
174-
"resource": s.storageGroupResource.Resource,
175-
"namespace": namespace,
176-
"name": name,
177-
})
172+
return s.db.WithContext(ctx).Select("object").
173+
Where(map[string]interface{}{
174+
"cluster": cluster,
175+
"group": s.storageGroupResource.Group,
176+
"version": s.storageVersion.Version,
177+
"resource": s.storageGroupResource.Resource,
178+
"namespace": namespace,
179+
"name": name,
180+
})
178181
}
179182

180183
func (s *ResourceStorage) Get(ctx context.Context, cluster, namespace, name string, into runtime.Object) error {
@@ -199,7 +202,7 @@ func (s *ResourceStorage) genListObjectsQuery(ctx context.Context, opts *interna
199202
result = &ResourceMetadataList{}
200203
}
201204

202-
query := s.db.WithContext(ctx).Model(&Resource{})
205+
query := s.db.WithContext(ctx)
203206
query = query.Where(map[string]interface{}{
204207
"group": s.storageGroupResource.Group,
205208
"version": s.storageVersion.Version,

‎pkg/storage/internalstorage/resource_storage_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ func TestResourceStorage_Update(t *testing.T) {
465465

466466
func newTestResourceStorage(db *gorm.DB, storageGVK schema.GroupVersionResource) *ResourceStorage {
467467
return &ResourceStorage{
468-
db: db,
468+
db: db.Table("resources").Model(&Resource{}),
469469
storageGroupResource: storageGVK.GroupResource(),
470470
storageVersion: storageGVK.GroupVersion(),
471471
}

‎pkg/storage/internalstorage/storage.go

+98-38
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package internalstorage
33
import (
44
"context"
55
"fmt"
6+
"strings"
67

78
"gorm.io/gorm"
89
"k8s.io/apimachinery/pkg/runtime/schema"
@@ -12,30 +13,12 @@ import (
1213
)
1314

1415
type StorageFactory struct {
15-
db *gorm.DB
16-
AutoMigration *bool
17-
DivisionPolicy DivisionPolicy
18-
Mapper []ResourceMapper
16+
db *gorm.DB
17+
SkipAutoMigration bool
18+
DivisionPolicy DivisionPolicy
1919
}
2020

2121
func (s *StorageFactory) AutoMigrate() error {
22-
if s.AutoMigration != nil && *s.AutoMigration {
23-
switch s.DivisionPolicy {
24-
if err := s.db.AutoMigrate(&Resource{}); err != nil {
25-
return err
26-
}
27-
case "", DivisionPolicyNone:
28-
case DivisionPolicyGroupResource:
29-
30-
}
31-
32-
if s.DivisionPolicy == "" || s.DivisionPolicy == DivisionPolicyNone {
33-
if err := s.db.AutoMigrate(&Resource{}); err != nil {
34-
return err
35-
}
36-
}
37-
}
38-
3922
return nil
4023
}
4124

@@ -44,10 +27,36 @@ func (s *StorageFactory) GetSupportedRequestVerbs() []string {
4427
}
4528

4629
func (s *StorageFactory) NewResourceStorage(config *storage.ResourceStorageConfig) (storage.ResourceStorage, error) {
47-
return &ResourceStorage{
48-
db: s.db,
49-
codec: config.Codec,
30+
gvr := schema.GroupVersionResource{
31+
Group: config.StorageGroupResource.Group,
32+
Version: config.StorageVersion.Version,
33+
Resource: config.StorageGroupResource.Resource,
34+
}
35+
table := s.tableName(gvr)
36+
37+
var model interface{}
38+
switch s.DivisionPolicy {
39+
case DivisionPolicyGroupVersionResource:
40+
model = &GroupVersionResource{}
41+
if !s.SkipAutoMigration {
42+
if exist := s.db.Migrator().HasTable(table); !exist {
43+
if err := s.db.AutoMigrate(&GroupVersionResource{}); err != nil {
44+
return nil, err
45+
}
46+
47+
err := s.db.Migrator().RenameTable("groupversionresources", table)
48+
if err != nil {
49+
return nil, err
50+
}
51+
}
52+
}
53+
case "", DivisionPolicyNone:
54+
model = &Resource{}
55+
}
5056

57+
return &ResourceStorage{
58+
db: s.db.Table(table).Model(model),
59+
codec: config.Codec,
5160
storageGroupResource: config.StorageGroupResource,
5261
storageVersion: config.StorageVersion,
5362
memoryVersion: config.MemoryVersion,
@@ -64,12 +73,21 @@ func (s *StorageFactory) NewCollectionResourceStorage(cr *internal.CollectionRes
6473
}
6574

6675
func (s *StorageFactory) GetResourceVersions(ctx context.Context, cluster string) (map[schema.GroupVersionResource]map[string]interface{}, error) {
76+
tables, err := s.db.Migrator().GetTables()
77+
if err != nil {
78+
return nil, err
79+
}
80+
6781
var resources []Resource
68-
result := s.db.WithContext(ctx).Select("group", "version", "resource", "namespace", "name", "resource_version").
69-
Where(map[string]interface{}{"cluster": cluster}).
70-
Find(&resources)
71-
if result.Error != nil {
72-
return nil, InterpretDBError(cluster, result.Error)
82+
for _, table := range tables {
83+
result := s.db.WithContext(ctx).
84+
Table(table).
85+
Select("group", "version", "resource", "namespace", "name", "resource_version").
86+
Where(map[string]interface{}{"cluster": cluster}).
87+
Find(&resources)
88+
if result.Error != nil {
89+
return nil, InterpretDBError(cluster, result.Error)
90+
}
7391
}
7492

7593
resourceversions := make(map[schema.GroupVersionResource]map[string]interface{})
@@ -91,18 +109,41 @@ func (s *StorageFactory) GetResourceVersions(ctx context.Context, cluster string
91109
}
92110

93111
func (s *StorageFactory) CleanCluster(ctx context.Context, cluster string) error {
94-
result := s.db.WithContext(ctx).Where(map[string]interface{}{"cluster": cluster}).Delete(&Resource{})
95-
return InterpretDBError(cluster, result.Error)
112+
tables, err := s.db.Migrator().GetTables()
113+
if err != nil {
114+
return err
115+
}
116+
117+
for _, table := range tables {
118+
result := s.db.WithContext(ctx).Table(table).Where(map[string]interface{}{"cluster": cluster}).Delete(&Resource{})
119+
if result.Error != nil {
120+
return InterpretDBError(cluster, result.Error)
121+
}
122+
}
123+
124+
return nil
96125
}
97126

98127
func (s *StorageFactory) CleanClusterResource(ctx context.Context, cluster string, gvr schema.GroupVersionResource) error {
99-
result := s.db.WithContext(ctx).Where(map[string]interface{}{
100-
"cluster": cluster,
101-
"group": gvr.Group,
102-
"version": gvr.Version,
103-
"resource": gvr.Resource,
104-
}).Delete(&Resource{})
105-
return InterpretDBError(fmt.Sprintf("%s/%s", cluster, gvr), result.Error)
128+
err := s.db.Transaction(func(db *gorm.DB) error {
129+
result := s.db.WithContext(ctx).
130+
Table(s.tableName(gvr)).
131+
Where(map[string]interface{}{
132+
"cluster": cluster,
133+
"group": gvr.Group,
134+
"version": gvr.Version,
135+
"resource": gvr.Resource,
136+
}).
137+
Delete(&Resource{})
138+
139+
if result.Error != nil {
140+
return result.Error
141+
}
142+
143+
return nil
144+
})
145+
146+
return InterpretDBError(fmt.Sprintf("%s/%s", cluster, gvr), err)
106147
}
107148

108149
func (s *StorageFactory) GetCollectionResources(ctx context.Context) ([]*internal.CollectionResource, error) {
@@ -116,3 +157,22 @@ func (s *StorageFactory) GetCollectionResources(ctx context.Context) ([]*interna
116157
func (s *StorageFactory) PrepareCluster(cluster string) error {
117158
return nil
118159
}
160+
161+
// GenerateTableFor return table name using gvr string
162+
func GenerateTableFor(gvr schema.GroupVersionResource) string {
163+
if gvr.Group == "" {
164+
return fmt.Sprintf("%s_%s", gvr.Version, gvr.Resource)
165+
}
166+
167+
group := strings.ReplaceAll(gvr.Group, ".", "_")
168+
return fmt.Sprintf("%s_%s_%s", group, gvr.Version, gvr.Resource)
169+
}
170+
171+
func (s *StorageFactory) tableName(gvr schema.GroupVersionResource) string {
172+
table := "resources"
173+
if s.DivisionPolicy == DivisionPolicyGroupVersionResource {
174+
table = GenerateTableFor(gvr)
175+
}
176+
177+
return table
178+
}

‎pkg/storage/internalstorage/types.go

+23-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ type Resource struct {
5151
ID uint `gorm:"primaryKey"`
5252

5353
Group string `gorm:"size:63;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name;index:idx_group_version_resource_namespace_name;index:idx_group_version_resource_name"`
54-
Version string `gorm:"size:15;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name;index:idx_group_version_resource_namespace_name;index:idx_group_version_resource_name"`
54+
Version string `gorm:"size:14;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name;index:idx_group_version_resource_namespace_name;index:idx_group_version_resource_name"`
5555
Resource string `gorm:"size:63;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name;index:idx_group_version_resource_namespace_name;index:idx_group_version_resource_name"`
5656
Kind string `gorm:"size:63;not null"`
5757

@@ -99,6 +99,28 @@ func (res Resource) ConvertTo(codec runtime.Codec, object runtime.Object) (runti
9999
return obj, err
100100
}
101101

102+
type GroupVersionResource struct {
103+
ID uint `gorm:"primaryKey"`
104+
105+
Group string `gorm:"size:63;not null"`
106+
Version string `gorm:"size:14;not null"`
107+
Resource string `gorm:"size:63;not null"`
108+
Kind string `gorm:"size:63;not null"`
109+
110+
Cluster string `gorm:"size:253;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name,length:100;index:idx_cluster"`
111+
Namespace string `gorm:"size:253;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name,length:50;index:idx_group_version_resource_namespace_name"`
112+
Name string `gorm:"size:253;not null;uniqueIndex:uni_group_version_resource_cluster_namespace_name,length:100;index:idx_group_version_resource_namespace_name;index:idx_group_version_resource_name"`
113+
OwnerUID types.UID `gorm:"column:owner_uid;size:36;not null;default:''"`
114+
UID types.UID `gorm:"size:36;not null"`
115+
ResourceVersion string `gorm:"size:30;not null"`
116+
117+
Object datatypes.JSON `gorm:"not null"`
118+
119+
CreatedAt time.Time `gorm:"not null"`
120+
SyncedAt time.Time `gorm:"not null;autoUpdateTime"`
121+
DeletedAt sql.NullTime
122+
}
123+
102124
type ResourceMetadata struct {
103125
ResourceType `gorm:"embedded"`
104126

0 commit comments

Comments
 (0)