-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
databaseserver.go
388 lines (327 loc) · 11 KB
/
databaseserver.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
Copyright 2020-2021 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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 types
import (
"fmt"
"sort"
"time"
"github.com/gravitational/trace"
"golang.org/x/exp/maps"
"github.com/gravitational/teleport/api"
"github.com/gravitational/teleport/api/utils"
)
// DatabaseServer represents a database access server.
type DatabaseServer interface {
// ResourceWithLabels provides common resource methods.
ResourceWithLabels
// GetNamespace returns server namespace.
GetNamespace() string
// GetTeleportVersion returns the teleport version the server is running on.
GetTeleportVersion() string
// GetHostname returns the server hostname.
GetHostname() string
// GetHostID returns ID of the host the server is running on.
GetHostID() string
// GetRotation gets the state of certificate authority rotation.
GetRotation() Rotation
// SetRotation sets the state of certificate authority rotation.
SetRotation(Rotation)
// String returns string representation of the server.
String() string
// Copy returns a copy of this database server object.
Copy() DatabaseServer
// CloneResource returns a copy of the DatabaseServer as a ResourceWithLabels
CloneResource() ResourceWithLabels
// GetDatabase returns the database this database server proxies.
GetDatabase() Database
// SetDatabase sets the database this database server proxies.
SetDatabase(Database) error
// ProxiedService provides common methods for a proxied service.
ProxiedService
}
// NewDatabaseServerV3 creates a new database server instance.
func NewDatabaseServerV3(meta Metadata, spec DatabaseServerSpecV3) (*DatabaseServerV3, error) {
s := &DatabaseServerV3{
Metadata: meta,
Spec: spec,
}
if err := s.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
return s, nil
}
// GetVersion returns the database server resource version.
func (s *DatabaseServerV3) GetVersion() string {
return s.Version
}
// GetTeleportVersion returns the Teleport version the server is running.
func (s *DatabaseServerV3) GetTeleportVersion() string {
return s.Spec.Version
}
// GetHostname returns the database server hostname.
func (s *DatabaseServerV3) GetHostname() string {
return s.Spec.Hostname
}
// GetHostID returns ID of the host the server is running on.
func (s *DatabaseServerV3) GetHostID() string {
return s.Spec.HostID
}
// GetKind returns the resource kind.
func (s *DatabaseServerV3) GetKind() string {
return s.Kind
}
// GetSubKind returns the resource subkind.
func (s *DatabaseServerV3) GetSubKind() string {
return s.SubKind
}
// SetSubKind sets the resource subkind.
func (s *DatabaseServerV3) SetSubKind(sk string) {
s.SubKind = sk
}
// GetResourceID returns the resource ID.
func (s *DatabaseServerV3) GetResourceID() int64 {
return s.Metadata.ID
}
// SetResourceID sets the resource ID.
func (s *DatabaseServerV3) SetResourceID(id int64) {
s.Metadata.ID = id
}
// GetRevision returns the revision
func (s *DatabaseServerV3) GetRevision() string {
return s.Metadata.GetRevision()
}
// SetRevision sets the revision
func (s *DatabaseServerV3) SetRevision(rev string) {
s.Metadata.SetRevision(rev)
}
// GetMetadata returns the resource metadata.
func (s *DatabaseServerV3) GetMetadata() Metadata {
return s.Metadata
}
// GetNamespace returns the resource namespace.
func (s *DatabaseServerV3) GetNamespace() string {
return s.Metadata.Namespace
}
// SetExpiry sets the resource expiry time.
func (s *DatabaseServerV3) SetExpiry(expiry time.Time) {
s.Metadata.SetExpiry(expiry)
}
// Expiry returns the resource expiry time.
func (s *DatabaseServerV3) Expiry() time.Time {
return s.Metadata.Expiry()
}
// GetName returns the resource name.
func (s *DatabaseServerV3) GetName() string {
return s.Metadata.Name
}
// SetName sets the resource name.
func (s *DatabaseServerV3) SetName(name string) {
s.Metadata.Name = name
}
// GetRotation returns the server CA rotation state.
func (s *DatabaseServerV3) GetRotation() Rotation {
return s.Spec.Rotation
}
// SetRotation sets the server CA rotation state.
func (s *DatabaseServerV3) SetRotation(r Rotation) {
s.Spec.Rotation = r
}
// GetDatabase returns the database this database server proxies.
func (s *DatabaseServerV3) GetDatabase() Database {
if s.Spec.Database == nil {
return nil
}
return s.Spec.Database
}
// SetDatabase sets the database this database server proxies.
func (s *DatabaseServerV3) SetDatabase(database Database) error {
databaseV3, ok := database.(*DatabaseV3)
if !ok {
return trace.BadParameter("expected *DatabaseV3, got %T", database)
}
s.Spec.Database = databaseV3
return nil
}
// GetProxyID returns a list of proxy ids this server is connected to.
func (s *DatabaseServerV3) GetProxyIDs() []string {
return s.Spec.ProxyIDs
}
// SetProxyID sets the proxy ids this server is connected to.
func (s *DatabaseServerV3) SetProxyIDs(proxyIDs []string) {
s.Spec.ProxyIDs = proxyIDs
}
// String returns the server string representation.
func (s *DatabaseServerV3) String() string {
return fmt.Sprintf("DatabaseServer(Name=%v, Version=%v, Hostname=%v, HostID=%v, Database=%v)",
s.GetName(), s.GetTeleportVersion(), s.GetHostname(), s.GetHostID(), s.GetDatabase())
}
// setStaticFields sets static resource header and metadata fields.
func (s *DatabaseServerV3) setStaticFields() {
s.Kind = KindDatabaseServer
s.Version = V3
}
// CheckAndSetDefaults checks and sets default values for any missing fields.
func (s *DatabaseServerV3) CheckAndSetDefaults() error {
s.setStaticFields()
if err := s.Metadata.CheckAndSetDefaults(); err != nil {
return trace.Wrap(err)
}
if s.Spec.HostID == "" {
return trace.BadParameter("missing database server HostID")
}
if s.Spec.Hostname == "" {
return trace.BadParameter("missing database server Hostname")
}
if s.Spec.Version == "" {
s.Spec.Version = api.Version
}
if s.Spec.Database == nil {
return trace.BadParameter("missing database server Database")
}
if err := s.Spec.Database.CheckAndSetDefaults(); err != nil {
return trace.Wrap(err)
}
return nil
}
// Origin returns the origin value of the resource.
func (s *DatabaseServerV3) Origin() string {
return s.Metadata.Origin()
}
// SetOrigin sets the origin value of the resource.
func (s *DatabaseServerV3) SetOrigin(origin string) {
s.Metadata.SetOrigin(origin)
}
// GetLabel retrieves the label with the provided key. If not found
// value will be empty and ok will be false.
func (s *DatabaseServerV3) GetLabel(key string) (value string, ok bool) {
if s.Spec.Database != nil {
if v, ok := s.Spec.Database.GetLabel(key); ok {
return v, ok
}
}
v, ok := s.Metadata.Labels[key]
return v, ok
}
// GetAllLabels returns all resource's labels. Considering:
// * Static labels from `Metadata.Labels` and `Spec.Database`.
// * Dynamic labels from `Spec.DynamicLabels`.
func (s *DatabaseServerV3) GetAllLabels() map[string]string {
staticLabels := map[string]string{}
maps.Copy(staticLabels, s.Metadata.Labels)
if s.Spec.Database != nil {
maps.Copy(staticLabels, s.Spec.Database.GetAllLabels())
}
return staticLabels
}
// GetStaticLabels returns the database server static labels.
func (s *DatabaseServerV3) GetStaticLabels() map[string]string {
return s.Metadata.Labels
}
// SetStaticLabels sets the database server static labels.
func (s *DatabaseServerV3) SetStaticLabels(sl map[string]string) {
s.Metadata.Labels = sl
}
// Copy returns a copy of this database server object.
func (s *DatabaseServerV3) Copy() DatabaseServer {
return utils.CloneProtoMsg(s)
}
// CloneResource returns a copy of this database server object.
func (s *DatabaseServerV3) CloneResource() ResourceWithLabels {
return s.Copy()
}
// MatchSearch goes through select field values and tries to
// match against the list of search values.
func (s *DatabaseServerV3) MatchSearch(values []string) bool {
return MatchSearch(nil, values, nil)
}
// DatabaseServers represents a list of database servers.
type DatabaseServers []DatabaseServer
// Len returns the slice length.
func (s DatabaseServers) Len() int { return len(s) }
// Less compares database servers by name and host ID.
func (s DatabaseServers) Less(i, j int) bool {
switch {
case s[i].GetName() < s[j].GetName():
return true
case s[i].GetName() > s[j].GetName():
return false
default:
return s[i].GetHostID() < s[j].GetHostID()
}
}
// Swap swaps two database servers.
func (s DatabaseServers) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
// SortByCustom custom sorts by given sort criteria.
func (s DatabaseServers) SortByCustom(sortBy SortBy) error {
if sortBy.Field == "" {
return nil
}
// We assume sorting by type DatabaseServer, we are really
// wanting to sort its contained resource Database.
isDesc := sortBy.IsDesc
switch sortBy.Field {
case ResourceMetadataName:
sort.SliceStable(s, func(i, j int) bool {
return stringCompare(s[i].GetDatabase().GetName(), s[j].GetDatabase().GetName(), isDesc)
})
case ResourceSpecDescription:
sort.SliceStable(s, func(i, j int) bool {
return stringCompare(s[i].GetDatabase().GetDescription(), s[j].GetDatabase().GetDescription(), isDesc)
})
case ResourceSpecType:
sort.SliceStable(s, func(i, j int) bool {
return stringCompare(s[i].GetDatabase().GetType(), s[j].GetDatabase().GetType(), isDesc)
})
default:
return trace.NotImplemented("sorting by field %q for resource %q is not supported", sortBy.Field, KindDatabaseServer)
}
return nil
}
// AsResources returns db servers as type resources with labels.
func (s DatabaseServers) AsResources() []ResourceWithLabels {
resources := make([]ResourceWithLabels, 0, len(s))
for _, server := range s {
resources = append(resources, ResourceWithLabels(server))
}
return resources
}
// GetFieldVals returns list of select field values.
func (s DatabaseServers) GetFieldVals(field string) ([]string, error) {
vals := make([]string, 0, len(s))
switch field {
case ResourceMetadataName:
for _, server := range s {
vals = append(vals, server.GetDatabase().GetName())
}
case ResourceSpecDescription:
for _, server := range s {
vals = append(vals, server.GetDatabase().GetDescription())
}
case ResourceSpecType:
for _, server := range s {
vals = append(vals, server.GetDatabase().GetType())
}
default:
return nil, trace.NotImplemented("getting field %q for resource %q is not supported", field, KindDatabaseServer)
}
return vals, nil
}
// ToDatabases converts database servers to a list of databases and
// deduplicates the databases by name.
func (s DatabaseServers) ToDatabases() []Database {
databases := make([]Database, 0, len(s))
for _, server := range s {
databases = append(databases, server.GetDatabase())
}
return DeduplicateDatabases(databases)
}