-
Notifications
You must be signed in to change notification settings - Fork 134
/
block_fastly_service_v1_s3logging.go
348 lines (312 loc) · 10.8 KB
/
block_fastly_service_v1_s3logging.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
package fastly
import (
"fmt"
"log"
"strings"
gofastly "github.com/fastly/go-fastly/v2/fastly"
"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
)
type S3LoggingServiceAttributeHandler struct {
*DefaultServiceAttributeHandler
}
func NewServiceS3Logging(sa ServiceMetadata) ServiceAttributeDefinition {
return &S3LoggingServiceAttributeHandler{
&DefaultServiceAttributeHandler{
key: "s3logging",
serviceMetadata: sa,
},
}
}
func (h *S3LoggingServiceAttributeHandler) 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)
}
oss := os.(*schema.Set)
nss := ns.(*schema.Set)
removeS3Logging := oss.Difference(nss).List()
addS3Logging := nss.Difference(oss).List()
// DELETE old S3 Log configurations.
for _, sRaw := range removeS3Logging {
opts := h.buildDelete(sRaw, serviceID, latestVersion)
err := deleteS3(conn, opts)
if err != nil {
return err
}
}
// POST new/updated S3 Logging.
for _, sRaw := range addS3Logging {
opts, err := h.buildCreate(sRaw, d.Id(), latestVersion)
if err != nil {
return err
}
// @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("s3logging")` in this case.
if opts.Name == "" {
continue
}
err = createS3(conn, opts)
if err != nil {
return err
}
}
return nil
}
func (h *S3LoggingServiceAttributeHandler) Read(d *schema.ResourceData, s *gofastly.ServiceDetail, conn *gofastly.Client) error {
// Refresh S3.
log.Printf("[DEBUG] Refreshing S3 Logging for (%s)", d.Id())
s3List, err := conn.ListS3s(&gofastly.ListS3sInput{
Service: d.Id(),
Version: s.ActiveVersion.Number,
})
if err != nil {
return fmt.Errorf("[ERR] Error looking up S3 Logging for (%s), version (%v): %s", d.Id(), s.ActiveVersion.Number, err)
}
sl := flattenS3s(s3List)
if err := d.Set(h.GetKey(), sl); err != nil {
log.Printf("[WARN] Error setting S3 Logging for (%s): %s", d.Id(), err)
}
return nil
}
func (h *S3LoggingServiceAttributeHandler) 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 S3 logging endpoint.",
},
"bucket_name": {
Type: schema.TypeString,
Required: true,
Description: "S3 Bucket name to store logs in.",
},
"s3_access_key": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("FASTLY_S3_ACCESS_KEY", ""),
Description: "AWS Access Key.",
Sensitive: true,
},
"s3_secret_key": {
Type: schema.TypeString,
Optional: true,
DefaultFunc: schema.EnvDefaultFunc("FASTLY_S3_SECRET_KEY", ""),
Description: "AWS Secret Key",
Sensitive: true,
},
// Optional fields
"path": {
Type: schema.TypeString,
Optional: true,
Description: "Path to store the files. Must end with blockAttributes trailing slash.",
},
"domain": {
Type: schema.TypeString,
Optional: true,
Description: "Bucket endpoint.",
Default: "s3.amazonaws.com",
},
"gzip_level": {
Type: schema.TypeInt,
Optional: true,
Default: 0,
Description: "Gzip Compression level.",
},
"period": {
Type: schema.TypeInt,
Optional: true,
Default: 3600,
Description: "How frequently the logs should be transferred, in seconds (Default 3600).",
},
"timestamp_format": {
Type: schema.TypeString,
Optional: true,
Default: "%Y-%m-%dT%H:%M:%S.000",
Description: "specified timestamp formatting (default `%Y-%m-%dT%H:%M:%S.000`).",
},
"redundancy": {
Type: schema.TypeString,
Optional: true,
Description: "The S3 redundancy level.",
},
"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,
},
"message_type": {
Type: schema.TypeString,
Optional: true,
Default: "classic",
Description: "How the message should be formatted.",
ValidateFunc: validateLoggingMessageType(),
},
"server_side_encryption": {
Type: schema.TypeString,
Optional: true,
Description: "Specify what type of server side encryption should be used. Can be either `AES256` or `aws:kms`.",
ValidateFunc: validateLoggingServerSideEncryption(),
},
"server_side_encryption_kms_key_id": {
Type: schema.TypeString,
Optional: true,
Description: "Optional server-side KMS Key Id. Must be set if server_side_encryption is set to `aws:kms`.",
},
}
if h.GetServiceMetadata().serviceType == ServiceTypeVCL {
blockAttributes["format"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "%h %l %u %t %r %>s",
Description: "Apache-style string or VCL variables to use for log formatting.",
}
blockAttributes["format_version"] = &schema.Schema{
Type: schema.TypeInt,
Optional: true,
Default: 1,
Description: "The version of the custom logging format used for the configured endpoint. Can be either 1 or 2. (Default: 1).",
ValidateFunc: validateLoggingFormatVersion(),
}
blockAttributes["response_condition"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "",
Description: "Name of blockAttributes condition to apply this logging.",
}
blockAttributes["placement"] = &schema.Schema{
Type: schema.TypeString,
Optional: true,
Description: "Where in the generated VCL the logging call should be placed.",
ValidateFunc: validateLoggingPlacement(),
}
}
s.Schema[h.GetKey()] = &schema.Schema{
Type: schema.TypeSet,
Optional: true,
Elem: &schema.Resource{
Schema: blockAttributes,
},
}
return nil
}
func createS3(conn *gofastly.Client, i *gofastly.CreateS3Input) error {
_, err := conn.CreateS3(i)
return err
}
func deleteS3(conn *gofastly.Client, i *gofastly.DeleteS3Input) error {
log.Printf("[DEBUG] Fastly S3 Logging removal opts: %#v", i)
err := conn.DeleteS3(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 flattenS3s(s3List []*gofastly.S3) []map[string]interface{} {
var sl []map[string]interface{}
for _, s := range s3List {
// Convert S3s to a map for saving to state.
ns := map[string]interface{}{
"name": s.Name,
"bucket_name": s.BucketName,
"s3_access_key": s.AccessKey,
"s3_secret_key": s.SecretKey,
"path": s.Path,
"period": s.Period,
"domain": s.Domain,
"gzip_level": s.GzipLevel,
"format": s.Format,
"format_version": s.FormatVersion,
"timestamp_format": s.TimestampFormat,
"redundancy": s.Redundancy,
"response_condition": s.ResponseCondition,
"message_type": s.MessageType,
"public_key": s.PublicKey,
"placement": s.Placement,
"server_side_encryption": s.ServerSideEncryption,
"server_side_encryption_kms_key_id": s.ServerSideEncryptionKMSKeyID,
}
// Prune any empty values that come from the default string value in structs.
for k, v := range ns {
if v == "" {
delete(ns, k)
}
}
sl = append(sl, ns)
}
return sl
}
func (h *S3LoggingServiceAttributeHandler) buildCreate(s3Map interface{}, serviceID string, serviceVersion int) (*gofastly.CreateS3Input, error) {
df := s3Map.(map[string]interface{})
// The Fastly API will not error if these are omitted, so we throw an error
// if any of these are empty.
for _, sk := range []string{"s3_access_key", "s3_secret_key"} {
if df[sk].(string) == "" {
return nil, fmt.Errorf("[ERR] No %s found for S3 Log stream setup for Service (%s)", sk, serviceID)
}
}
var vla = h.getVCLLoggingAttributes(df)
opts := gofastly.CreateS3Input{
Service: serviceID,
Version: serviceVersion,
Name: df["name"].(string),
BucketName: df["bucket_name"].(string),
AccessKey: df["s3_access_key"].(string),
SecretKey: df["s3_secret_key"].(string),
Period: uint(df["period"].(int)),
GzipLevel: uint(df["gzip_level"].(int)),
Domain: df["domain"].(string),
Path: df["path"].(string),
TimestampFormat: df["timestamp_format"].(string),
MessageType: df["message_type"].(string),
PublicKey: df["public_key"].(string),
ServerSideEncryptionKMSKeyID: df["server_side_encryption_kms_key_id"].(string),
Format: vla.format,
FormatVersion: uintOrDefault(vla.formatVersion),
ResponseCondition: vla.responseCondition,
Placement: vla.placement,
}
redundancy := strings.ToLower(df["redundancy"].(string))
switch redundancy {
case "standard":
opts.Redundancy = gofastly.S3RedundancyStandard
case "reduced_redundancy":
opts.Redundancy = gofastly.S3RedundancyReduced
}
encryption := df["server_side_encryption"].(string)
switch encryption {
case string(gofastly.S3ServerSideEncryptionAES):
opts.ServerSideEncryption = gofastly.S3ServerSideEncryptionAES
case string(gofastly.S3ServerSideEncryptionKMS):
opts.ServerSideEncryption = gofastly.S3ServerSideEncryptionKMS
}
return &opts, nil
}
func (h *S3LoggingServiceAttributeHandler) buildDelete(s3Map interface{}, serviceID string, serviceVersion int) *gofastly.DeleteS3Input {
df := s3Map.(map[string]interface{})
return &gofastly.DeleteS3Input{
Service: serviceID,
Version: serviceVersion,
Name: df["name"].(string),
}
}