forked from juju/juju
-
Notifications
You must be signed in to change notification settings - Fork 0
/
environ_vpc.go
561 lines (468 loc) · 19 KB
/
environ_vpc.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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
// Copyright 2016 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package ec2
import (
"fmt"
"strings"
"github.com/juju/errors"
"github.com/juju/utils/set"
"gopkg.in/amz.v3/ec2"
"github.com/juju/juju/environs"
"github.com/juju/juju/network"
)
const (
activeState = "active"
availableState = "available"
localRouteGatewayID = "local"
defaultRouteCIDRBlock = "0.0.0.0/0"
vpcIDNone = "none"
)
var (
vpcNotUsableForBootstrapErrorPrefix = `
Juju cannot use the given vpc-id for bootstrapping a controller
instance. Please, double check the given VPC ID is correct, and that
the VPC contains at least one subnet.
Error details`[1:]
vpcNotUsableForModelErrorPrefix = `
Juju cannot use the given vpc-id for the model being added.
Please double check the given VPC ID is correct, and that
the VPC contains at least one subnet.
Error details`[1:]
vpcNotRecommendedErrorPrefix = `
The given vpc-id does not meet one or more of the following minimum
Juju requirements:
1. VPC should be in "available" state and contain one or more subnets.
2. An Internet Gateway (IGW) should be attached to the VPC.
3. The main route table of the VPC should have both a default route
to the attached IGW and a local route matching the VPC CIDR block.
4. At least one of the VPC subnets should have MapPublicIPOnLaunch
attribute enabled (i.e. at least one subnet needs to be 'public').
5. All subnets should be implicitly associated to the VPC main route
table, rather than explicitly to per-subnet route tables.
A default VPC already satisfies all of the requirements above. If you
still want to use the VPC, try running 'juju bootstrap' again with:
--config vpc-id=%s --config vpc-id-force=true
to force Juju to bypass the requirements check (NOT recommended unless
you understand the implications: most importantly, not being able to
access the Juju controller, likely causing bootstrap to fail, or trying
to deploy exposed workloads on instances started in private or isolated
subnets).
Error details`[1:]
cannotValidateVPCErrorPrefix = `
Juju could not verify whether the given vpc-id meets the minumum Juju
connectivity requirements. Please, double check the VPC ID is correct,
you have a working connection to the Internet, your AWS credentials are
sufficient to access VPC features, or simply retry bootstrapping again.
Error details`[1:]
vpcNotRecommendedButForcedWarning = `
WARNING! The specified vpc-id does not satisfy the minimum Juju requirements,
but will be used anyway because vpc-id-force=true is also specified.
`[1:]
)
// vpcNotUsableError indicates a user-specified VPC cannot be used either
// because it is missing or because it contains no subnets.
type vpcNotUsableError struct {
errors.Err
}
// vpcNotUsablef returns an error which satisfies isVPCNotUsableError().
func vpcNotUsablef(optionalCause error, format string, args ...interface{}) error {
outerErr := errors.Errorf(format, args...)
if optionalCause != nil {
outerErr = errors.Maskf(optionalCause, format, args...)
}
innerErr, _ := outerErr.(*errors.Err) // cannot fail.
return &vpcNotUsableError{*innerErr}
}
// isVPCNotUsableError reports whether err was created with vpcNotUsablef().
func isVPCNotUsableError(err error) bool {
err = errors.Cause(err)
_, ok := err.(*vpcNotUsableError)
return ok
}
// vpcNotRecommendedError indicates a user-specified VPC is unlikely to be
// suitable for hosting a Juju controller instance and/or exposed workloads, due
// to not satisfying the mininum requirements described in validateVPC()'s doc
// comment. Users can still force Juju to use such a VPC by passing
// 'vpc-id-force=true' setting.
type vpcNotRecommendedError struct {
errors.Err
}
// vpcNotRecommendedf returns an error which satisfies isVPCNotRecommendedError().
func vpcNotRecommendedf(format string, args ...interface{}) error {
outerErr := errors.Errorf(format, args...)
innerErr, _ := outerErr.(*errors.Err) // cannot fail.
return &vpcNotRecommendedError{*innerErr}
}
// isVPCNotRecommendedError reports whether err was created with vpcNotRecommendedf().
func isVPCNotRecommendedError(err error) bool {
err = errors.Cause(err)
_, ok := err.(*vpcNotRecommendedError)
return ok
}
// vpcAPIClient defines a subset of the goamz API calls needed to validate a VPC.
type vpcAPIClient interface {
// AccountAttributes, called with the "default-vpc" attribute. is used to
// find the ID of the region's default VPC (if any).
AccountAttributes(attributeNames ...string) (*ec2.AccountAttributesResp, error)
// VPCs is used to get details for the VPC being validated, including
// whether it exists, is available, and its CIDRBlock and IsDefault fields.
VPCs(ids []string, filter *ec2.Filter) (*ec2.VPCsResp, error)
// Subnets is used to get a list of all subnets of the validated VPC (if
// any),including their Id, AvailZone, and MapPublicIPOnLaunch fields.
Subnets(ids []string, filter *ec2.Filter) (*ec2.SubnetsResp, error)
// InternetGateways is used to get details of the Internet Gateway (IGW)
// attached to the validated VPC (if any), its Id to check against routes,
// and whether it's available.
InternetGateways(ids []string, filter *ec2.Filter) (*ec2.InternetGatewaysResp, error)
// RouteTables is used to find the main route table of the VPC (if any),
// whether it includes a default route to the attached IGW, a local route to
// the VPC CIDRBlock, and any per-subnet route tables.
RouteTables(ids []string, filter *ec2.Filter) (*ec2.RouteTablesResp, error)
}
// validateVPC requires both arguments to be set and validates that vpcID refers
// to an existing AWS VPC (default or non-default) for the current region.
// Returns an error satifying isVPCNotUsableError() when the VPC with the given
// vpcID cannot be found, or when the VPC exists but contains no subnets.
// Returns an error satisfying isVPCNotRecommendedError() in the following
// cases:
//
// 1. The VPC's state is not "available".
// 2. The VPC does not have an Internet Gateway (IGW) attached.
// 3. A main route table is not associated with the VPC.
// 4. The main route table lacks both a default route via the IGW and a local
// route matching the VPC's CIDR block.
// 5. One or more of the VPC's subnets are not associated with the main route
// table of the VPC.
// 6. None of the the VPC's subnets have the MapPublicIPOnLaunch attribute set.
//
// With the vpc-id-force config setting set to true, the provider can ignore a
// vpcNotRecommendedError. A vpcNotUsableError cannot be ignored, while
// unexpected API responses and errors could be retried.
//
// The above minimal requirements allow Juju to work out-of-the-box with most
// common (and officially documented by AWS) VPC setups, easy try out with AWS
// Console / VPC Wizard / CLI. Detecting VPC setups indicating intentional
// customization by experienced users, protecting beginners from bad Juju-UX due
// to broken VPC setup, while still allowing power users to override that and
// continue (but knowing what that implies).
func validateVPC(apiClient vpcAPIClient, vpcID string) error {
if vpcID == "" || apiClient == nil {
return errors.Errorf("invalid arguments: empty VPC ID or nil client")
}
vpc, err := getVPCByID(apiClient, vpcID)
if err != nil {
return errors.Trace(err)
}
if err := checkVPCIsAvailable(vpc); err != nil {
return errors.Trace(err)
}
subnets, err := getVPCSubnets(apiClient, vpc)
if err != nil {
return errors.Trace(err)
}
publicSubnet, err := findFirstPublicSubnet(subnets)
if err != nil {
return errors.Trace(err)
}
// TODO(dimitern): Rather than just logging that, use publicSubnet.Id or
// even publicSubnet.AvailZone as default bootstrap placement directive, so
// the controller would be reachable.
logger.Infof(
"found subnet %q (%s) in AZ %q, suitable for a Juju controller instance",
publicSubnet.Id, publicSubnet.CIDRBlock, publicSubnet.AvailZone,
)
gateway, err := getVPCInternetGateway(apiClient, vpc)
if err != nil {
return errors.Trace(err)
}
if err := checkInternetGatewayIsAvailable(gateway); err != nil {
return errors.Trace(err)
}
routeTables, err := getVPCRouteTables(apiClient, vpc)
if err != nil {
return errors.Trace(err)
}
mainRouteTable, err := findVPCMainRouteTable(routeTables)
if err != nil {
return errors.Trace(err)
}
if err := checkVPCRouteTableRoutes(vpc, mainRouteTable, gateway); err != nil {
return errors.Annotatef(err, "VPC %q main route table %q", vpcID, mainRouteTable.Id)
}
logger.Infof("VPC %q is suitable for Juju controllers and expose-able workloads", vpc.Id)
return nil
}
func getVPCByID(apiClient vpcAPIClient, vpcID string) (*ec2.VPC, error) {
response, err := apiClient.VPCs([]string{vpcID}, nil)
if isVPCNotFoundError(err) {
return nil, vpcNotUsablef(err, "")
} else if err != nil {
return nil, errors.Annotatef(err, "unexpected AWS response getting VPC %q", vpcID)
}
if numResults := len(response.VPCs); numResults == 0 {
return nil, vpcNotUsablef(nil, "VPC %q not found", vpcID)
} else if numResults > 1 {
logger.Debugf("VPCs() returned %#v", response)
return nil, errors.Errorf("expected 1 result from AWS, got %d", numResults)
}
vpc := response.VPCs[0]
return &vpc, nil
}
func isVPCNotFoundError(err error) bool {
return err != nil && ec2ErrCode(err) == "InvalidVpcID.NotFound"
}
func checkVPCIsAvailable(vpc *ec2.VPC) error {
if vpc.State != availableState {
return vpcNotRecommendedf("VPC has unexpected state %q", vpc.State)
}
if vpc.IsDefault {
logger.Infof("VPC %q is the default VPC for the region", vpc.Id)
}
return nil
}
func getVPCSubnets(apiClient vpcAPIClient, vpc *ec2.VPC) ([]ec2.Subnet, error) {
filter := ec2.NewFilter()
filter.Add("vpc-id", vpc.Id)
response, err := apiClient.Subnets(nil, filter)
if err != nil {
return nil, errors.Annotatef(err, "unexpected AWS response getting subnets of VPC %q", vpc.Id)
}
if len(response.Subnets) == 0 {
return nil, vpcNotUsablef(nil, "no subnets found for VPC %q", vpc.Id)
}
return response.Subnets, nil
}
func findFirstPublicSubnet(subnets []ec2.Subnet) (*ec2.Subnet, error) {
for _, subnet := range subnets {
// TODO(dimitern): goamz's AddDefaultVPCAndSubnets() does not set
// MapPublicIPOnLaunch only DefaultForAZ, but in reality the former is
// always set when the latter is. Until this is fixed in goamz, we check
// for both below to allow testing the behavior.
if subnet.MapPublicIPOnLaunch || subnet.DefaultForAZ {
logger.Debugf(
"VPC %q subnet %q has MapPublicIPOnLaunch=%v, DefaultForAZ=%v",
subnet.VPCId, subnet.Id, subnet.MapPublicIPOnLaunch, subnet.DefaultForAZ,
)
return &subnet, nil
}
}
return nil, vpcNotRecommendedf("VPC contains no public subnets")
}
func getVPCInternetGateway(apiClient vpcAPIClient, vpc *ec2.VPC) (*ec2.InternetGateway, error) {
filter := ec2.NewFilter()
filter.Add("attachment.vpc-id", vpc.Id)
response, err := apiClient.InternetGateways(nil, filter)
if err != nil {
return nil, errors.Annotatef(err, "unexpected AWS response getting Internet Gateway of VPC %q", vpc.Id)
}
if numResults := len(response.InternetGateways); numResults == 0 {
return nil, vpcNotRecommendedf("VPC has no Internet Gateway attached")
} else if numResults > 1 {
logger.Debugf("InternetGateways() returned %#v", response)
return nil, errors.Errorf("expected 1 result from AWS, got %d", numResults)
}
gateway := response.InternetGateways[0]
return &gateway, nil
}
func checkInternetGatewayIsAvailable(gateway *ec2.InternetGateway) error {
if state := gateway.AttachmentState; state != availableState {
return vpcNotRecommendedf("VPC has Internet Gateway %q in unexpected state %q", gateway.Id, state)
}
return nil
}
func getVPCRouteTables(apiClient vpcAPIClient, vpc *ec2.VPC) ([]ec2.RouteTable, error) {
filter := ec2.NewFilter()
filter.Add("vpc-id", vpc.Id)
response, err := apiClient.RouteTables(nil, filter)
if err != nil {
return nil, errors.Annotatef(err, "unexpected AWS response getting route tables of VPC %q", vpc.Id)
}
if len(response.Tables) == 0 {
return nil, vpcNotRecommendedf("VPC has no route tables")
}
logger.Tracef("RouteTables() returned %#v", response)
return response.Tables, nil
}
func findVPCMainRouteTable(routeTables []ec2.RouteTable) (*ec2.RouteTable, error) {
var mainTable *ec2.RouteTable
for i, table := range routeTables {
if len(table.Associations) < 1 {
logger.Tracef("ignoring VPC %q route table %q with no associations", table.VPCId, table.Id)
continue
}
for _, association := range table.Associations {
// TODO(dimitern): Of all the requirements, this seems like the most
// strict and likely to push users to use vpc-id-force=true. On the
// other hand, having to deal with more than the main route table's
// routes will likely overcomplicate the routes checks that follow.
if subnetID := association.SubnetId; subnetID != "" {
return nil, vpcNotRecommendedf("subnet %q not associated with VPC %q main route table", subnetID, table.VPCId)
}
if association.IsMain && mainTable == nil {
logger.Tracef("main route table of VPC %q has ID %q", table.VPCId, table.Id)
mainTable = &routeTables[i]
}
}
}
if mainTable == nil {
return nil, vpcNotRecommendedf("VPC has no associated main route table")
}
return mainTable, nil
}
func checkVPCRouteTableRoutes(vpc *ec2.VPC, routeTable *ec2.RouteTable, gateway *ec2.InternetGateway) error {
hasDefaultRoute := false
hasLocalRoute := false
logger.Tracef("checking route table %+v routes", routeTable)
for _, route := range routeTable.Routes {
if route.State != activeState {
logger.Tracef("skipping inactive route %+v", route)
continue
}
switch route.DestinationCIDRBlock {
case defaultRouteCIDRBlock:
if route.GatewayId == gateway.Id {
logger.Tracef("default route uses expected gateway %q", gateway.Id)
hasDefaultRoute = true
}
case vpc.CIDRBlock:
if route.GatewayId == localRouteGatewayID {
logger.Tracef("local route uses expected CIDR %q", vpc.CIDRBlock)
hasLocalRoute = true
}
default:
logger.Tracef("route %+v is neither local nor default (skipping)", route)
}
}
if hasDefaultRoute && hasLocalRoute {
return nil
}
if !hasDefaultRoute {
return vpcNotRecommendedf("missing default route via gateway %q", gateway.Id)
}
return vpcNotRecommendedf("missing local route with destination %q", vpc.CIDRBlock)
}
func findDefaultVPCID(apiClient vpcAPIClient) (string, error) {
response, err := apiClient.AccountAttributes("default-vpc")
if err != nil {
return "", errors.Annotate(err, "unexpected AWS response getting default-vpc account attribute")
}
if len(response.Attributes) == 0 ||
len(response.Attributes[0].Values) == 0 ||
response.Attributes[0].Name != "default-vpc" {
// No value for the requested "default-vpc" attribute, all bets are off.
return "", errors.NotFoundf("default-vpc account attribute")
}
firstAttributeValue := response.Attributes[0].Values[0]
if firstAttributeValue == vpcIDNone {
return "", errors.NotFoundf("default VPC")
}
return firstAttributeValue, nil
}
// getVPCSubnetIDsForAvailabilityZone returns a sorted list of subnet IDs, which
// are both in the given vpcID and the given zoneName. If allowedSubnetIDs is
// not empty, the returned list will only contain IDs present there. Returns an
// error satisfying errors.IsNotFound() when no results match.
func getVPCSubnetIDsForAvailabilityZone(
apiClient vpcAPIClient,
vpcID, zoneName string,
allowedSubnetIDs []string,
) ([]string, error) {
allowedSubnets := set.NewStrings(allowedSubnetIDs...)
vpc := &ec2.VPC{Id: vpcID}
subnets, err := getVPCSubnets(apiClient, vpc)
if err != nil && !isVPCNotUsableError(err) {
return nil, errors.Annotatef(err, "cannot get VPC %q subnets", vpcID)
} else if isVPCNotUsableError(err) {
// We're reusing getVPCSubnets(), but not while validating a VPC
// pre-bootstrap, so we should change vpcNotUsableError to a simple
// NotFoundError.
message := fmt.Sprintf("VPC %q has no subnets in AZ %q", vpcID, zoneName)
return nil, errors.NewNotFound(err, message)
}
matchingSubnetIDs := set.NewStrings()
for _, subnet := range subnets {
if subnet.AvailZone != zoneName {
logger.Infof("skipping subnet %q (in VPC %q): not in the chosen AZ %q", subnet.Id, vpcID, zoneName)
continue
}
if !allowedSubnets.IsEmpty() && !allowedSubnets.Contains(subnet.Id) {
logger.Infof("skipping subnet %q (in VPC %q, AZ %q): not matching spaces constraints", subnet.Id, vpcID, zoneName)
continue
}
matchingSubnetIDs.Add(subnet.Id)
}
if matchingSubnetIDs.IsEmpty() {
message := fmt.Sprintf("VPC %q has no subnets in AZ %q", vpcID, zoneName)
return nil, errors.NewNotFound(nil, message)
}
sortedIDs := matchingSubnetIDs.SortedValues()
logger.Infof("found %d subnets in VPC %q matching AZ %q and constraints: %v", len(sortedIDs), vpcID, zoneName, sortedIDs)
return sortedIDs, nil
}
func findSubnetIDsForAvailabilityZone(zoneName string, subnetsToZones map[network.Id][]string) ([]string, error) {
matchingSubnetIDs := set.NewStrings()
for subnetID, zones := range subnetsToZones {
zonesSet := set.NewStrings(zones...)
if zonesSet.Contains(zoneName) {
matchingSubnetIDs.Add(string(subnetID))
}
}
if matchingSubnetIDs.IsEmpty() {
return nil, errors.NotFoundf("subnets in AZ %q", zoneName)
}
return matchingSubnetIDs.SortedValues(), nil
}
func isVPCIDSetButInvalid(vpcID string) bool {
return isVPCIDSet(vpcID) && !strings.HasPrefix(vpcID, "vpc-")
}
func isVPCIDSet(vpcID string) bool {
return vpcID != "" && vpcID != vpcIDNone
}
func validateBootstrapVPC(apiClient vpcAPIClient, region, vpcID string, forceVPCID bool, ctx environs.BootstrapContext) error {
if vpcID == vpcIDNone {
ctx.Infof("Using EC2-classic features or default VPC in region %q", region)
}
if !isVPCIDSet(vpcID) {
return nil
}
err := validateVPC(apiClient, vpcID)
switch {
case isVPCNotUsableError(err):
// VPC missing or has no subnets at all.
return errors.Annotate(err, vpcNotUsableForBootstrapErrorPrefix)
case isVPCNotRecommendedError(err):
// VPC does not meet minumum validation criteria.
if !forceVPCID {
return errors.Annotatef(err, vpcNotRecommendedErrorPrefix, vpcID)
}
ctx.Infof(vpcNotRecommendedButForcedWarning)
case err != nil:
// Anything else unexpected while validating the VPC.
return errors.Annotate(err, cannotValidateVPCErrorPrefix)
}
ctx.Infof("Using VPC %q in region %q", vpcID, region)
return nil
}
func validateModelVPC(apiClient vpcAPIClient, modelName, vpcID string) error {
if !isVPCIDSet(vpcID) {
return nil
}
err := validateVPC(apiClient, vpcID)
switch {
case isVPCNotUsableError(err):
// VPC missing or has no subnets at all.
return errors.Annotate(err, vpcNotUsableForModelErrorPrefix)
case isVPCNotRecommendedError(err):
// VPC does not meet minumum validation criteria, but that's less
// important for hosted models, as the controller is already accessible.
logger.Infof(
"Juju will use, but does not recommend using VPC %q: %v",
vpcID, err.Error(),
)
case err != nil:
// Anything else unexpected while validating the VPC.
return errors.Annotate(err, cannotValidateVPCErrorPrefix)
}
logger.Infof("Using VPC %q for model %q", vpcID, modelName)
return nil
}