forked from polarismesh/polaris
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.go
151 lines (137 loc) · 7.92 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/**
* Tencent is pleased to support the open source community by making Polaris available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package config
import (
"context"
apiconfig "github.com/polarismesh/specification/source/go/api/v1/config_manage"
"github.com/polarismesh/polaris/common/model"
)
type (
// WatchCallback 监听回调函数
WatchCallback func() *apiconfig.ConfigClientResponse
)
const (
// MaxPageSize 最大分页大小
MaxPageSize = 100
)
// ConfigFileGroupOperate 配置文件组接口
type ConfigFileGroupOperate interface {
// CreateConfigFileGroup 创建配置文件组
CreateConfigFileGroup(ctx context.Context, configFileGroup *apiconfig.ConfigFileGroup) *apiconfig.ConfigResponse
// QueryConfigFileGroups 查询配置文件组
QueryConfigFileGroups(ctx context.Context, filter map[string]string) *apiconfig.ConfigBatchQueryResponse
// DeleteConfigFileGroup 删除配置文件组
DeleteConfigFileGroup(ctx context.Context, namespace, name string) *apiconfig.ConfigResponse
// UpdateConfigFileGroup 更新配置文件组
UpdateConfigFileGroup(ctx context.Context, configFileGroup *apiconfig.ConfigFileGroup) *apiconfig.ConfigResponse
}
// ConfigFileOperate 配置文件接口
type ConfigFileOperate interface {
// CreateConfigFile 创建配置文件
CreateConfigFile(ctx context.Context, configFile *apiconfig.ConfigFile) *apiconfig.ConfigResponse
// GetConfigFileRichInfo 获取单个配置文件基础信息，包含发布状态等信息
GetConfigFileRichInfo(ctx context.Context, req *apiconfig.ConfigFile) *apiconfig.ConfigResponse
// SearchConfigFile 按 group 和 name 模糊搜索配置文件
SearchConfigFile(ctx context.Context, filter map[string]string) *apiconfig.ConfigBatchQueryResponse
// UpdateConfigFile 更新配置文件
UpdateConfigFile(ctx context.Context, configFile *apiconfig.ConfigFile) *apiconfig.ConfigResponse
// DeleteConfigFile 删除配置文件
DeleteConfigFile(ctx context.Context, req *apiconfig.ConfigFile) *apiconfig.ConfigResponse
// BatchDeleteConfigFile 批量删除配置文件
BatchDeleteConfigFile(ctx context.Context, req []*apiconfig.ConfigFile) *apiconfig.ConfigResponse
// ExportConfigFile 导出配置文件
ExportConfigFile(ctx context.Context,
configFileExport *apiconfig.ConfigFileExportRequest) *apiconfig.ConfigExportResponse
// ImportConfigFile 导入配置文件
ImportConfigFile(ctx context.Context,
configFiles []*apiconfig.ConfigFile, conflictHandling string) *apiconfig.ConfigImportResponse
// GetAllConfigEncryptAlgorithms 获取配置加密算法
GetAllConfigEncryptAlgorithms(ctx context.Context) *apiconfig.ConfigEncryptAlgorithmResponse
}
// ConfigFileReleaseOperate 配置文件发布接口
type ConfigFileReleaseOperate interface {
// PublishConfigFile 发布配置文件
PublishConfigFile(ctx context.Context, configFileRelease *apiconfig.ConfigFileRelease) *apiconfig.ConfigResponse
// GetConfigFileRelease 获取配置文件发布
GetConfigFileRelease(ctx context.Context, req *apiconfig.ConfigFileRelease) *apiconfig.ConfigResponse
// DeleteConfigFileReleases 批量删除配置文件发布内容
DeleteConfigFileReleases(ctx context.Context, reqs []*apiconfig.ConfigFileRelease) *apiconfig.ConfigBatchWriteResponse
// RollbackConfigFileReleases 批量回滚配置到指定版本
RollbackConfigFileReleases(ctx context.Context, releases []*apiconfig.ConfigFileRelease) *apiconfig.ConfigBatchWriteResponse
// GetConfigFileReleases 查询所有的配置发布版本信息
GetConfigFileReleases(ctx context.Context, filters map[string]string) *apiconfig.ConfigBatchQueryResponse
// GetConfigFileReleaseVersions 查询所有的配置发布版本信息
GetConfigFileReleaseVersions(ctx context.Context, filters map[string]string) *apiconfig.ConfigBatchQueryResponse
// GetConfigFileReleaseHistories 获取配置文件的发布历史
GetConfigFileReleaseHistories(ctx context.Context, filter map[string]string) *apiconfig.ConfigBatchQueryResponse
// UpsertAndReleaseConfigFile 创建/更新配置文件并发布
UpsertAndReleaseConfigFile(ctx context.Context, req *apiconfig.ConfigFilePublishInfo) *apiconfig.ConfigResponse
// StopGrayConfigFileReleases 停止所有的灰度发布配置
StopGrayConfigFileReleases(ctx context.Context, reqs []*apiconfig.ConfigFileRelease) *apiconfig.ConfigBatchWriteResponse
}
// ConfigFileClientOperate 给客户端提供服务接口，不同的上层协议抽象的公共服务逻辑
type ConfigFileClientOperate interface {
// CreateConfigFileFromClient 调用config_file的方法创建配置文件
CreateConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFile) *apiconfig.ConfigClientResponse
// UpdateConfigFileFromClient 调用config_file的方法更新配置文件
UpdateConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFile) *apiconfig.ConfigClientResponse
// DeleteConfigFileFromClient 调用config_file的方法更新配置文件
DeleteConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFile) *apiconfig.ConfigResponse
// PublishConfigFileFromClient 调用config_file_release的方法发布配置文件
PublishConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFileRelease) *apiconfig.ConfigClientResponse
// UpsertAndReleaseConfigFile 创建/更新配置文件并发布
UpsertAndReleaseConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFilePublishInfo) *apiconfig.ConfigResponse
// CasUpsertAndReleaseConfigFileFromClient 创建/更新配置文件并发布
CasUpsertAndReleaseConfigFileFromClient(ctx context.Context, req *apiconfig.ConfigFilePublishInfo) *apiconfig.ConfigResponse
// LongPullWatchFile 客户端监听配置文件
LongPullWatchFile(ctx context.Context, req *apiconfig.ClientWatchConfigFileRequest) (WatchCallback, error)
// GetConfigFileNamesWithCache 获取某个配置分组下的配置文件
GetConfigFileNamesWithCache(ctx context.Context,
req *apiconfig.ConfigFileGroupRequest) *apiconfig.ConfigClientListResponse
// GetConfigFileWithCache 获取配置文件
GetConfigFileWithCache(ctx context.Context, req *apiconfig.ClientConfigFileInfo) *apiconfig.ConfigClientResponse
// GetConfigGroupsWithCache 获取某个命名空间下的配置分组列表
GetConfigGroupsWithCache(ctx context.Context, req *apiconfig.ClientConfigFileInfo) *apiconfig.ConfigDiscoverResponse
}
// ConfigFileTemplateOperate config file template operate
type ConfigFileTemplateOperate interface {
// GetAllConfigFileTemplates get all config file templates
GetAllConfigFileTemplates(ctx context.Context) *apiconfig.ConfigBatchQueryResponse
// CreateConfigFileTemplate create config file template
CreateConfigFileTemplate(ctx context.Context, template *apiconfig.ConfigFileTemplate) *apiconfig.ConfigResponse
// GetConfigFileTemplate get config file template
GetConfigFileTemplate(ctx context.Context, name string) *apiconfig.ConfigResponse
}
// ConfigCenterServer 配置中心server
type ConfigCenterServer interface {
ConfigFileGroupOperate
ConfigFileOperate
ConfigFileReleaseOperate
ConfigFileClientOperate
ConfigFileTemplateOperate
}
// ResourceHook The listener is placed before and after the resource operation, only normal flow
type ResourceHook interface {
// Before
Before(ctx context.Context, resourceType model.Resource)
// After
After(ctx context.Context, resourceType model.Resource, res *ResourceEvent) error
}
// ResourceEvent 资源事件
type ResourceEvent struct {
ConfigGroup *apiconfig.ConfigFileGroup
}