-
Notifications
You must be signed in to change notification settings - Fork 1k
/
openstack_swift_scaler.go
412 lines (329 loc) · 12.8 KB
/
openstack_swift_scaler.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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
package scalers
import (
"context"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"path"
"strconv"
"strings"
"github.com/kedacore/keda/v2/pkg/scalers/openstack"
kedautil "github.com/kedacore/keda/v2/pkg/util"
v2beta2 "k8s.io/api/autoscaling/v2beta2"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/metrics/pkg/apis/external_metrics"
logf "sigs.k8s.io/controller-runtime/pkg/log"
)
const (
defaultOnlyFiles = false
defaultObjectCount = 2
defaultObjectLimit = ""
defaultObjectPrefix = ""
defaultObjectDelimiter = ""
defaultHTTPClientTimeout = 30
)
type openstackSwiftMetadata struct {
swiftURL string
containerName string
objectCount int
objectPrefix string
objectDelimiter string
objectLimit string
httpClientTimeout int
onlyFiles bool
scalerIndex int
}
type openstackSwiftAuthenticationMetadata struct {
userID string
password string
projectID string
authURL string
appCredentialID string
appCredentialSecret string
regionName string
}
type openstackSwiftScaler struct {
metadata *openstackSwiftMetadata
swiftClient openstack.Client
}
var openstackSwiftLog = logf.Log.WithName("openstack_swift_scaler")
func (s *openstackSwiftScaler) getOpenstackSwiftContainerObjectCount(ctx context.Context) (int, error) {
var containerName = s.metadata.containerName
var swiftURL = s.metadata.swiftURL
isValid, err := s.swiftClient.IsTokenValid(ctx)
if err != nil {
openstackSwiftLog.Error(err, "scaler could not validate the token for authentication")
return 0, err
}
if !isValid {
err := s.swiftClient.RenewToken(ctx)
if err != nil {
openstackSwiftLog.Error(err, "error requesting token for authentication")
return 0, err
}
}
token := s.swiftClient.Token
swiftContainerURL, err := url.Parse(swiftURL)
if err != nil {
openstackSwiftLog.Error(err, fmt.Sprintf("the swiftURL is invalid: %s. You might have forgotten to provide the either 'http' or 'https' in the URL. Check our documentation to see if you missed something", swiftURL))
return 0, fmt.Errorf("the swiftURL is invalid: %s", err.Error())
}
swiftContainerURL.Path = path.Join(swiftContainerURL.Path, containerName)
swiftRequest, _ := http.NewRequestWithContext(ctx, "GET", swiftContainerURL.String(), nil)
swiftRequest.Header.Set("X-Auth-Token", token)
query := swiftRequest.URL.Query()
query.Add("prefix", s.metadata.objectPrefix)
query.Add("delimiter", s.metadata.objectDelimiter)
// If scaler wants to scale based on only files, we first need to query all objects, then filter files and finally limit the result to the specified query limit
if !s.metadata.onlyFiles {
query.Add("limit", s.metadata.objectLimit)
}
swiftRequest.URL.RawQuery = query.Encode()
resp, requestError := s.swiftClient.HTTPClient.Do(swiftRequest)
if requestError != nil {
openstackSwiftLog.Error(requestError, fmt.Sprintf("error getting metrics for container '%s'. You probably specified the wrong swift URL or the URL is not reachable", containerName))
return 0, requestError
}
defer resp.Body.Close()
body, readError := ioutil.ReadAll(resp.Body)
if readError != nil {
openstackSwiftLog.Error(readError, "could not read response body from Swift API")
return 0, readError
}
if resp.StatusCode >= http.StatusOK && resp.StatusCode < http.StatusMultipleChoices {
var objectsList = strings.Split(strings.TrimSpace(string(body)), "\n")
// If onlyFiles is set to "true", return the total amount of files (excluding empty objects/folders)
if s.metadata.onlyFiles {
var count = 0
for i := 0; i < len(objectsList); i++ {
if !strings.HasSuffix(objectsList[i], "/") {
count++
}
}
if s.metadata.objectLimit != defaultObjectLimit {
objectLimit, conversionError := strconv.Atoi(s.metadata.objectLimit)
if conversionError != nil {
openstackSwiftLog.Error(err, fmt.Sprintf("the objectLimit value provided is invalid: %v", s.metadata.objectLimit))
return 0, conversionError
}
if objectLimit <= count && s.metadata.objectLimit != defaultObjectLimit {
return objectLimit, nil
}
}
return count, nil
}
// Otherwise, if either prefix and/or delimiter are provided, return the total amount of objects
if s.metadata.objectPrefix != defaultObjectPrefix || s.metadata.objectDelimiter != defaultObjectDelimiter {
return len(objectsList), nil
}
// Finally, if nothing is set, return the standard total amount of objects inside the container
objectCount, conversionError := strconv.Atoi(resp.Header["X-Container-Object-Count"][0])
return objectCount, conversionError
}
if resp.StatusCode == http.StatusUnauthorized {
openstackSwiftLog.Error(nil, "the retrieved token is not a valid token. Provide the correct auth credentials so the scaler can retrieve a valid access token (Unauthorized)")
return 0, fmt.Errorf("the retrieved token is not a valid token. Provide the correct auth credentials so the scaler can retrieve a valid access token (Unauthorized)")
}
if resp.StatusCode == http.StatusForbidden {
openstackSwiftLog.Error(nil, "the retrieved token is a valid token, but it does not have sufficient permission to retrieve Swift and/or container metadata (Forbidden)")
return 0, fmt.Errorf("the retrieved token is a valid token, but it does not have sufficient permission to retrieve Swift and/or container metadata (Forbidden)")
}
if resp.StatusCode == http.StatusNotFound {
openstackSwiftLog.Error(nil, fmt.Sprintf("the container '%s' does not exist (Not Found)", containerName))
return 0, fmt.Errorf("the container '%s' does not exist (Not Found)", containerName)
}
return 0, fmt.Errorf(string(body))
}
// NewOpenstackSwiftScaler creates a new OpenStack Swift scaler
func NewOpenstackSwiftScaler(ctx context.Context, config *ScalerConfig) (Scaler, error) {
var authRequest *openstack.KeystoneAuthRequest
var swiftClient openstack.Client
openstackSwiftMetadata, err := parseOpenstackSwiftMetadata(config)
if err != nil {
return nil, fmt.Errorf("error parsing swift metadata: %s", err)
}
authMetadata, err := parseOpenstackSwiftAuthenticationMetadata(config)
if err != nil {
return nil, fmt.Errorf("error parsing swift authentication metadata: %s", err)
}
// User chose the "application_credentials" authentication method
if authMetadata.appCredentialID != "" {
authRequest, err = openstack.NewAppCredentialsAuth(authMetadata.authURL, authMetadata.appCredentialID, authMetadata.appCredentialSecret, openstackSwiftMetadata.httpClientTimeout)
if err != nil {
return nil, fmt.Errorf("error getting openstack credentials for application credentials method: %s", err)
}
} else {
// User chose the "password" authentication method
if authMetadata.userID != "" {
authRequest, err = openstack.NewPasswordAuth(authMetadata.authURL, authMetadata.userID, authMetadata.password, authMetadata.projectID, openstackSwiftMetadata.httpClientTimeout)
if err != nil {
return nil, fmt.Errorf("error getting openstack credentials for password method: %s", err)
}
} else {
return nil, fmt.Errorf("no authentication method was provided for OpenStack")
}
}
if openstackSwiftMetadata.swiftURL == "" {
// Request a Client with a token and the Swift API endpoint
swiftClient, err = authRequest.RequestClient(ctx, "swift", authMetadata.regionName)
if err != nil {
return nil, fmt.Errorf("swiftURL was not provided and the scaler could not retrieve it dinamically using the OpenStack catalog: %s", err.Error())
}
openstackSwiftMetadata.swiftURL = swiftClient.URL
} else {
// Request a Client with a token, but not the Swift API endpoint
swiftClient, err = authRequest.RequestClient(ctx)
if err != nil {
return nil, err
}
swiftClient.URL = openstackSwiftMetadata.swiftURL
}
return &openstackSwiftScaler{
metadata: openstackSwiftMetadata,
swiftClient: swiftClient,
}, nil
}
func parseOpenstackSwiftMetadata(config *ScalerConfig) (*openstackSwiftMetadata, error) {
meta := openstackSwiftMetadata{}
if val, ok := config.TriggerMetadata["swiftURL"]; ok {
meta.swiftURL = val
} else {
meta.swiftURL = ""
}
if val, ok := config.TriggerMetadata["containerName"]; ok {
meta.containerName = val
} else {
return nil, fmt.Errorf("no containerName was provided")
}
if val, ok := config.TriggerMetadata["objectCount"]; ok {
targetObjectCount, err := strconv.Atoi(val)
if err != nil {
return nil, fmt.Errorf("objectCount parsing error: %s", err.Error())
}
meta.objectCount = targetObjectCount
} else {
meta.objectCount = defaultObjectCount
}
if val, ok := config.TriggerMetadata["objectPrefix"]; ok {
meta.objectPrefix = val
} else {
meta.objectPrefix = defaultObjectPrefix
}
if val, ok := config.TriggerMetadata["objectDelimiter"]; ok {
meta.objectDelimiter = val
} else {
meta.objectDelimiter = defaultObjectDelimiter
}
if val, ok := config.TriggerMetadata["timeout"]; ok {
httpClientTimeout, err := strconv.Atoi(val)
if err != nil {
return nil, fmt.Errorf("httpClientTimeout parsing error: %s", err.Error())
}
meta.httpClientTimeout = httpClientTimeout
} else {
meta.httpClientTimeout = defaultHTTPClientTimeout
}
if val, ok := config.TriggerMetadata["onlyFiles"]; ok {
isOnlyFiles, conversionError := strconv.ParseBool(val)
if conversionError != nil {
return nil, fmt.Errorf("onlyFiles parsing error: %s", conversionError.Error())
}
meta.onlyFiles = isOnlyFiles
} else {
meta.onlyFiles = defaultOnlyFiles
}
if val, ok := config.TriggerMetadata["objectLimit"]; ok {
meta.objectLimit = val
} else {
meta.objectLimit = defaultObjectLimit
}
meta.scalerIndex = config.ScalerIndex
return &meta, nil
}
func parseOpenstackSwiftAuthenticationMetadata(config *ScalerConfig) (*openstackSwiftAuthenticationMetadata, error) {
authMeta := openstackSwiftAuthenticationMetadata{}
if config.AuthParams["authURL"] != "" {
authMeta.authURL = config.AuthParams["authURL"]
} else {
return nil, fmt.Errorf("authURL doesn't exist in the authParams")
}
if config.AuthParams["regionName"] != "" {
authMeta.regionName = config.AuthParams["regionName"]
} else {
authMeta.regionName = ""
}
if config.AuthParams["userID"] != "" {
authMeta.userID = config.AuthParams["userID"]
if config.AuthParams["password"] != "" {
authMeta.password = config.AuthParams["password"]
} else {
return nil, fmt.Errorf("password doesn't exist in the authParams")
}
if config.AuthParams["projectID"] != "" {
authMeta.projectID = config.AuthParams["projectID"]
} else {
return nil, fmt.Errorf("projectID doesn't exist in the authParams")
}
} else {
if config.AuthParams["appCredentialID"] != "" {
authMeta.appCredentialID = config.AuthParams["appCredentialID"]
if config.AuthParams["appCredentialSecret"] != "" {
authMeta.appCredentialSecret = config.AuthParams["appCredentialSecret"]
} else {
return nil, fmt.Errorf("appCredentialSecret doesn't exist in the authParams")
}
} else {
return nil, fmt.Errorf("neither userID or appCredentialID exist in the authParams")
}
}
return &authMeta, nil
}
func (s *openstackSwiftScaler) IsActive(ctx context.Context) (bool, error) {
objectCount, err := s.getOpenstackSwiftContainerObjectCount(ctx)
if err != nil {
return false, err
}
return objectCount > 0, nil
}
func (s *openstackSwiftScaler) Close(context.Context) error {
return nil
}
func (s *openstackSwiftScaler) GetMetrics(ctx context.Context, metricName string, metricSelector labels.Selector) ([]external_metrics.ExternalMetricValue, error) {
objectCount, err := s.getOpenstackSwiftContainerObjectCount(ctx)
if err != nil {
openstackSwiftLog.Error(err, "error getting objectCount")
return []external_metrics.ExternalMetricValue{}, err
}
metric := external_metrics.ExternalMetricValue{
MetricName: metricName,
Value: *resource.NewQuantity(int64(objectCount), resource.DecimalSI),
Timestamp: metav1.Now(),
}
return append([]external_metrics.ExternalMetricValue{}, metric), nil
}
func (s *openstackSwiftScaler) GetMetricSpecForScaling(context.Context) []v2beta2.MetricSpec {
targetObjectCount := resource.NewQuantity(int64(s.metadata.objectCount), resource.DecimalSI)
var metricName string
if s.metadata.objectPrefix != "" {
metricName = fmt.Sprintf("%s-%s", s.metadata.containerName, s.metadata.objectPrefix)
} else {
metricName = s.metadata.containerName
}
metricName = kedautil.NormalizeString(fmt.Sprintf("openstack-swift-%s", metricName))
externalMetric := &v2beta2.ExternalMetricSource{
Metric: v2beta2.MetricIdentifier{
Name: GenerateMetricNameWithIndex(s.metadata.scalerIndex, metricName),
},
Target: v2beta2.MetricTarget{
Type: v2beta2.AverageValueMetricType,
AverageValue: targetObjectCount,
},
}
metricSpec := v2beta2.MetricSpec{
External: externalMetric, Type: externalMetricType,
}
return []v2beta2.MetricSpec{metricSpec}
}