-
Notifications
You must be signed in to change notification settings - Fork 132
/
block_fastly_service_v1_logging_sftp.go
428 lines (370 loc) · 12.9 KB
/
block_fastly_service_v1_logging_sftp.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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
package fastly
import (
"fmt"
"log"
gofastly "github.com/fastly/go-fastly/v3/fastly"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)
type SFTPServiceAttributeHandler struct {
*DefaultServiceAttributeHandler
}
func NewServiceLoggingSFTP(sa ServiceMetadata) ServiceAttributeDefinition {
return &SFTPServiceAttributeHandler{
&DefaultServiceAttributeHandler{
key: "logging_sftp",
serviceMetadata: sa,
},
}
}
func (h *SFTPServiceAttributeHandler) Register(s *schema.Resource) error {
var blockAttributes = map[string]*schema.Schema{
// Required fields
"name": {
Type: schema.TypeString,
Required: true,
Description: "The unique name of the SFTP logging endpoint. It is important to note that changing this attribute will delete and recreate the resource",
},
"address": {
Type: schema.TypeString,
Required: true,
Description: "The SFTP address to stream logs to",
},
"user": {
Type: schema.TypeString,
Required: true,
Description: "The username for the server",
},
"path": {
Type: schema.TypeString,
Required: true,
Description: "The path to upload log files to. If the path ends in `/` then it is treated as a directory",
},
"ssh_known_hosts": {
Type: schema.TypeString,
Required: true,
Description: "A list of host keys for all hosts we can connect to over SFTP",
},
// Optional fields
"port": {
Type: schema.TypeInt,
Optional: true,
Default: 22,
Description: "The port the SFTP service listens on. (Default: `22`)",
},
"password": {
Type: schema.TypeString,
Optional: true,
Description: "The password for the server. If both `password` and `secret_key` are passed, `secret_key` will be preferred",
Sensitive: true,
},
"secret_key": {
Type: schema.TypeString,
Optional: true,
Description: "The SSH private key for the server. If both `password` and `secret_key` are passed, `secret_key` will be preferred",
Sensitive: true,
// Related issue for weird behavior - https://github.com/hashicorp/terraform-plugin-sdk/issues/160
StateFunc: trimSpaceStateFunc,
},
"public_key": {
Type: schema.TypeString,
Optional: true,
Description: "A PGP public key that Fastly will use to encrypt your log files before writing them to disk",
// Related issue for weird behavior - https://github.com/hashicorp/terraform-plugin-sdk/issues/160
StateFunc: trimSpaceStateFunc,
},
"period": {
Type: schema.TypeInt,
Optional: true,
Default: 3600,
Description: "How frequently log files are finalized so they can be available for reading (in seconds, default `3600`)",
},
"gzip_level": {
Type: schema.TypeInt,
Optional: true,
Default: 0,
Description: "What level of Gzip encoding to have when dumping logs (default `0`, no compression)",
},
"timestamp_format": {
Type: schema.TypeString,
Optional: true,
Default: "%Y-%m-%dT%H:%M:%S.000",
Description: "The `strftime` specified timestamp formatting (default `%Y-%m-%dT%H:%M:%S.000`)",
},
"message_type": {
Type: schema.TypeString,
Optional: true,
Default: "classic",
Description: "How the message should be formatted. One of: `classic` (default), `loggly`, `logplex` or `blank`",
ValidateDiagFunc: validateLoggingMessageType(),
},
}
if h.GetServiceMetadata().serviceType == ServiceTypeVCL {
blockAttributes["format"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "%h %l %u %t \"%r\" %>s %b",
Description: "Apache-style string or VCL variables to use for log formatting.",
}
blockAttributes["format_version"] = &schema.Schema{
Type: schema.TypeInt,
Optional: true,
Default: 2,
Description: "The version of the custom logging format used for the configured endpoint. Can be either 1 or 2. (default: 2).",
ValidateDiagFunc: validateLoggingFormatVersion(),
}
blockAttributes["placement"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Description: "Where in the generated VCL the logging call should be placed.",
ValidateDiagFunc: validateLoggingPlacement(),
}
blockAttributes["response_condition"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Description: "The name of the condition to apply.",
}
}
s.Schema[h.GetKey()] = &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: blockAttributes,
},
}
return nil
}
func (h *SFTPServiceAttributeHandler) Process(d *schema.ResourceData, latestVersion int, conn *gofastly.Client) error {
serviceID := d.Id()
os, ns := d.GetChange(h.GetKey())
if os == nil {
os = new(schema.Set)
}
if ns == nil {
ns = new(schema.Set)
}
oldSet := os.(*schema.Set)
newSet := ns.(*schema.Set)
setDiff := NewSetDiff(func(resource interface{}) (interface{}, error) {
t, ok := resource.(map[string]interface{})
if !ok {
return nil, fmt.Errorf("resource failed to be type asserted: %+v", resource)
}
return t["name"], nil
})
diffResult, err := setDiff.Diff(oldSet, newSet)
if err != nil {
return err
}
// DELETE removed resources
for _, resource := range diffResult.Deleted {
resource := resource.(map[string]interface{})
opts := h.buildDelete(resource, serviceID, latestVersion)
log.Printf("[DEBUG] Fastly SFTP logging endpoint removal opts: %#v", opts)
if err := deleteSFTP(conn, opts); err != nil {
return err
}
}
// CREATE new resources
for _, resource := range diffResult.Added {
resource := resource.(map[string]interface{})
// @HACK for a TF SDK Issue.
//
// This ensures that the required, `name`, field is present.
//
// If we have made it this far and `name` is not present, it is most-likely due
// to a defunct diff as noted here - https://github.com/hashicorp/terraform-plugin-sdk/issues/160#issuecomment-522935697.
//
// This is caused by using a StateFunc in a nested TypeSet. While the StateFunc
// properly handles setting state with the StateFunc, it returns extra entries
// during state Gets, specifically `GetChange("logging_sftp")` in this case.
if v, ok := resource["name"]; !ok || v.(string) == "" {
continue
}
opts := h.buildCreate(resource, serviceID, latestVersion)
if opts.Password == "" && opts.SecretKey == "" {
return fmt.Errorf("[ERR] Either password or secret_key must be set")
}
log.Printf("[DEBUG] Fastly SFTP logging addition opts: %#v", opts)
if err := createSFTP(conn, opts); err != nil {
return err
}
}
// UPDATE modified resources
//
// NOTE: although the go-fastly API client enables updating of a resource by
// its 'name' attribute, this isn't possible within terraform due to
// constraints in the data model/schema of the resources not having a uid.
for _, resource := range diffResult.Modified {
resource := resource.(map[string]interface{})
opts := gofastly.UpdateSFTPInput{
ServiceID: d.Id(),
ServiceVersion: latestVersion,
Name: resource["name"].(string),
}
// only attempt to update attributes that have changed
modified := setDiff.Filter(resource, oldSet)
// NOTE: where we transition between interface{} we lose the ability to
// infer the underlying type being either a uint vs an int. This
// materializes as a panic (yay) and so it's only at runtime we discover
// this and so we've updated the below code to convert the type asserted
// int into a uint before passing the value to gofastly.Uint().
if v, ok := modified["address"]; ok {
opts.Address = gofastly.String(v.(string))
}
if v, ok := modified["port"]; ok {
opts.Port = gofastly.Uint(uint(v.(int)))
}
if v, ok := modified["public_key"]; ok {
opts.PublicKey = gofastly.String(v.(string))
}
if v, ok := modified["secret_key"]; ok {
opts.SecretKey = gofastly.String(v.(string))
}
if v, ok := modified["ssh_known_hosts"]; ok {
opts.SSHKnownHosts = gofastly.String(v.(string))
}
if v, ok := modified["user"]; ok {
opts.User = gofastly.String(v.(string))
}
if v, ok := modified["password"]; ok {
opts.Password = gofastly.String(v.(string))
}
if v, ok := modified["path"]; ok {
opts.Path = gofastly.String(v.(string))
}
if v, ok := modified["period"]; ok {
opts.Period = gofastly.Uint(uint(v.(int)))
}
if v, ok := modified["format_version"]; ok {
opts.FormatVersion = gofastly.Uint(uint(v.(int)))
}
if v, ok := modified["compression_codec"]; ok {
opts.CompressionCodec = gofastly.String(v.(string))
}
if v, ok := modified["gzip_level"]; ok {
opts.GzipLevel = gofastly.Uint(uint(v.(int)))
}
if v, ok := modified["format"]; ok {
opts.Format = gofastly.String(v.(string))
}
if v, ok := modified["response_condition"]; ok {
opts.ResponseCondition = gofastly.String(v.(string))
}
if v, ok := modified["timestamp_format"]; ok {
opts.TimestampFormat = gofastly.String(v.(string))
}
if v, ok := modified["message_type"]; ok {
opts.MessageType = gofastly.String(v.(string))
}
if v, ok := modified["placement"]; ok {
opts.Placement = gofastly.String(v.(string))
}
log.Printf("[DEBUG] Update SFTP Opts: %#v", opts)
_, err := conn.UpdateSFTP(&opts)
if err != nil {
return err
}
}
return nil
}
func (h *SFTPServiceAttributeHandler) Read(d *schema.ResourceData, s *gofastly.ServiceDetail, conn *gofastly.Client) error {
// Refresh SFTP.
log.Printf("[DEBUG] Refreshing SFTP logging endpoints for (%s)", d.Id())
sftpList, err := conn.ListSFTPs(&gofastly.ListSFTPsInput{
ServiceID: d.Id(),
ServiceVersion: s.ActiveVersion.Number,
})
if err != nil {
return fmt.Errorf("[ERR] Error looking up SFTP logging endpoints for (%s), version (%v): %s", d.Id(), s.ActiveVersion.Number, err)
}
ell := flattenSFTP(sftpList)
for _, element := range ell {
element = h.pruneVCLLoggingAttributes(element)
}
if err := d.Set(h.GetKey(), ell); err != nil {
log.Printf("[WARN] Error setting SFTP logging endpoints for (%s): %s", d.Id(), err)
}
return nil
}
func createSFTP(conn *gofastly.Client, i *gofastly.CreateSFTPInput) error {
_, err := conn.CreateSFTP(i)
return err
}
func deleteSFTP(conn *gofastly.Client, i *gofastly.DeleteSFTPInput) error {
err := conn.DeleteSFTP(i)
errRes, ok := err.(*gofastly.HTTPError)
if !ok {
return err
}
// 404 response codes don't result in an error propagating because a 404 could
// indicate that a resource was deleted elsewhere.
if !errRes.IsNotFound() {
return err
}
return nil
}
func flattenSFTP(sftpList []*gofastly.SFTP) []map[string]interface{} {
var ssl []map[string]interface{}
for _, sl := range sftpList {
// Convert SFTP logging to a map for saving to state.
nsl := map[string]interface{}{
"name": sl.Name,
"address": sl.Address,
"user": sl.User,
"path": sl.Path,
"ssh_known_hosts": sl.SSHKnownHosts,
"port": sl.Port,
"password": sl.Password,
"secret_key": sl.SecretKey,
"public_key": sl.PublicKey,
"period": sl.Period,
"gzip_level": sl.GzipLevel,
"timestamp_format": sl.TimestampFormat,
"message_type": sl.MessageType,
"format": sl.Format,
"format_version": sl.FormatVersion,
"response_condition": sl.ResponseCondition,
"placement": sl.Placement,
}
// prune any empty values that come from the default string value in structs
for k, v := range nsl {
if v == "" {
delete(nsl, k)
}
}
ssl = append(ssl, nsl)
}
return ssl
}
func (h *SFTPServiceAttributeHandler) buildCreate(sftpMap interface{}, serviceID string, serviceVersion int) *gofastly.CreateSFTPInput {
df := sftpMap.(map[string]interface{})
var vla = h.getVCLLoggingAttributes(df)
return &gofastly.CreateSFTPInput{
ServiceID: serviceID,
ServiceVersion: serviceVersion,
Address: df["address"].(string),
Name: df["name"].(string),
User: df["user"].(string),
Path: df["path"].(string),
PublicKey: df["public_key"].(string),
SecretKey: df["secret_key"].(string),
SSHKnownHosts: df["ssh_known_hosts"].(string),
Port: uint(df["port"].(int)),
Password: df["password"].(string),
GzipLevel: uint(df["gzip_level"].(int)),
TimestampFormat: df["timestamp_format"].(string),
MessageType: df["message_type"].(string),
Format: vla.format,
FormatVersion: uintOrDefault(vla.formatVersion),
Placement: vla.placement,
ResponseCondition: vla.responseCondition,
}
}
func (h *SFTPServiceAttributeHandler) buildDelete(sftpMap interface{}, serviceID string, serviceVersion int) *gofastly.DeleteSFTPInput {
df := sftpMap.(map[string]interface{})
return &gofastly.DeleteSFTPInput{
ServiceID: serviceID,
ServiceVersion: serviceVersion,
Name: df["name"].(string),
}
}