-
Notifications
You must be signed in to change notification settings - Fork 79
/
cluster.ts
1491 lines (1356 loc) · 59.9 KB
/
cluster.ts
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016-2019, Pulumi Corporation.
//
// 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.
import * as aws from "@pulumi/aws";
import * as k8s from "@pulumi/kubernetes";
import * as pulumi from "@pulumi/pulumi";
import * as childProcess from "child_process";
import * as fs from "fs";
import * as http from "http";
import * as https from "https";
import * as HttpsProxyAgent from "https-proxy-agent";
import * as jsyaml from "js-yaml";
import * as process from "process";
import * as tmp from "tmp";
import * as url from "url";
import * as which from "which";
import { getIssuerCAThumbprint } from "./cert-thumprint";
import { VpcCni, VpcCniOptions } from "./cni";
import { createDashboard } from "./dashboard";
import { computeWorkerSubnets, createNodeGroup, NodeGroup, NodeGroupBaseOptions, NodeGroupData } from "./nodegroup";
import { createNodeGroupSecurityGroup } from "./securitygroup";
import { ServiceRole } from "./servicerole";
import { createStorageClass, EBSVolumeType, StorageClass } from "./storageclass";
import { InputTags, UserStorageClasses } from "./utils";
/**
* RoleMapping describes a mapping from an AWS IAM role to a Kubernetes user and groups.
*/
export interface RoleMapping {
/**
* The ARN of the IAM role to add.
*/
roleArn: pulumi.Input<aws.ARN>;
/**
* The user name within Kubernetes to map to the IAM role. By default, the user name is the ARN of the IAM role.
*/
username: pulumi.Input<string>;
/**
* A list of groups within Kubernetes to which the role is mapped.
*/
groups: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* UserMapping describes a mapping from an AWS IAM user to a Kubernetes user and groups.
*/
export interface UserMapping {
/**
* The ARN of the IAM user to add.
*/
userArn: pulumi.Input<aws.ARN>;
/**
* The user name within Kubernetes to map to the IAM user. By default, the user name is the ARN of the IAM user.
*/
username: pulumi.Input<string>;
/**
* A list of groups within Kubernetes to which the user is mapped to.
*/
groups: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* CreationRoleProvider is a component containing the AWS Role and Provider necessary to override the `[system:master]`
* entity ARN. This is an optional argument used in `ClusterOptions`. Read more: https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html
*/
export interface CreationRoleProvider {
role: aws.iam.Role;
provider: pulumi.ProviderResource;
}
/**
* KubeconfigOptions represents the AWS credentials to scope a given kubeconfig
* when using a non-default credential chain.
*
* The options can be used independently, or additively.
*
* A scoped kubeconfig is necessary for certain auth scenarios. For example:
* 1. Assume a role on the default account caller,
* 2. Use an AWS creds profile instead of the default account caller,
* 3. Use an AWS creds creds profile instead of the default account caller,
* and then assume a given role on the profile. This scenario is also
* possible by only using a profile, iff the profile includes a role to
* assume in its settings.
*
* See for more details:
* - https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html
* - https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html
* - https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
*/
export interface KubeconfigOptions {
/**
* Role ARN to assume instead of the default AWS credential provider chain.
*
* The role is passed to kubeconfig as an authentication exec argument.
*/
roleArn?: pulumi.Input<aws.ARN>;
/**
* AWS credential profile name to always use instead of the
* default AWS credential provider chain.
*
* The profile is passed to kubeconfig as an authentication environment
* setting.
*/
profileName?: pulumi.Input<string>;
}
/**
* CoreData defines the core set of data associated with an EKS cluster, including the network in which it runs.
*/
export interface CoreData {
cluster: aws.eks.Cluster;
vpcId: pulumi.Output<string>;
subnetIds: pulumi.Output<string[]>;
endpoint: pulumi.Output<string>;
clusterSecurityGroup: aws.ec2.SecurityGroup;
provider: k8s.Provider;
instanceRoles: pulumi.Output<aws.iam.Role[]>;
nodeGroupOptions: ClusterNodeGroupOptions;
awsProvider?: pulumi.ProviderResource;
publicSubnetIds?: pulumi.Output<string[]>;
privateSubnetIds?: pulumi.Output<string[]>;
eksNodeAccess?: k8s.core.v1.ConfigMap;
storageClasses?: UserStorageClasses;
kubeconfig?: pulumi.Output<any>;
vpcCni?: VpcCni;
tags?: InputTags;
nodeSecurityGroupTags?: InputTags;
fargateProfile: pulumi.Output<aws.eks.FargateProfile | undefined>;
oidcProvider?: aws.iam.OpenIdConnectProvider;
encryptionConfig?: pulumi.Output<aws.types.output.eks.ClusterEncryptionConfig>;
}
function createOrGetInstanceProfile(
name: string,
parent: pulumi.ComponentResource,
instanceRoleName?: pulumi.Input<aws.iam.Role>,
instanceProfileName?: pulumi.Input<string>,
provider?: pulumi.ProviderResource,
): aws.iam.InstanceProfile {
let instanceProfile: aws.iam.InstanceProfile;
if (instanceProfileName) {
instanceProfile = aws.iam.InstanceProfile.get(`${name}-instanceProfile`,
instanceProfileName, undefined, { parent, provider });
} else {
instanceProfile = new aws.iam.InstanceProfile(`${name}-instanceProfile`, {
role: instanceRoleName,
}, { parent, provider });
}
return instanceProfile;
}
// ExecEnvVar sets the environment variables using an exec-based auth plugin.
interface ExecEnvVar {
/**
* Name of the auth exec environment variable.
*/
name: pulumi.Input<string>;
/**
* Value of the auth exec environment variable.
*/
value: pulumi.Input<string>;
}
function generateKubeconfig(
clusterName: pulumi.Input<string>,
clusterEndpoint: pulumi.Input<string>,
certData: pulumi.Input<string>,
opts?: KubeconfigOptions) {
let args = ["eks", "get-token", "--cluster-name", clusterName];
let env: ExecEnvVar[] | undefined;
if (opts?.roleArn) {
args = [...args, "--role", opts.roleArn];
}
if (opts?.profileName) {
env = [{
"name": "AWS_PROFILE",
"value": opts.profileName,
}];
}
return pulumi.all([
args,
env,
]).apply(([tokenArgs, envvars]) => ({
apiVersion: "v1",
clusters: [{
cluster: {
server: clusterEndpoint,
"certificate-authority-data": certData,
},
name: "kubernetes",
}],
contexts: [{
context: {
cluster: "kubernetes",
user: "aws",
},
name: "aws",
}],
"current-context": "aws",
kind: "Config",
users: [{
name: "aws",
user: {
exec: {
apiVersion: "client.authentication.k8s.io/v1alpha1",
command: "aws",
args: tokenArgs,
env: envvars,
},
},
}],
}));
}
export interface ClusterCreationRoleProviderOptions {
region?: aws.Region;
profile?: string;
}
/**
* ClusterCreationRoleProvider is a component that wraps creating a role provider that can be passed to
* `new eks.Cluster("test", { creationRoleProvider: ... })`. This can be used to provide a
* specific role to use for the creation of the EKS cluster different from the role being used
* to run the Pulumi deployment.
*/
export class ClusterCreationRoleProvider extends pulumi.ComponentResource implements CreationRoleProvider {
public readonly role: aws.iam.Role;
public readonly provider: pulumi.ProviderResource;
/**
* Creates a role provider that can be passed to `new eks.Cluster("test", { creationRoleProvider: ... })`.
* This can be used to provide a specific role to use for the creation of the EKS cluster different from
* the role being used to run the Pulumi deployment.
*
* @param name The _unique_ name of this component.
* @param args The arguments for this component.
* @param opts A bag of options that control this component's behavior.
*/
constructor(name: string, args: ClusterCreationRoleProviderOptions, opts?: pulumi.ComponentResourceOptions) {
super("eks:index:ClusterCreationRoleProvider", name, args, opts);
const result = getRoleProvider(name, args?.region, args?.profile, this, opts?.provider);
this.role = result.role;
this.provider = result.provider;
this.registerOutputs(undefined);
}
}
/**
* getRoleProvider creates a role provider that can be passed to `new eks.Cluster("test", {
* creationRoleProvider: ... })`. This can be used to provide a specific role to use for the
* creation of the EKS cluster different from the role being used to run the Pulumi deployment.
*/
export function getRoleProvider(
name: string,
region?: aws.Region,
profile?: string,
parent?: pulumi.ComponentResource,
provider?: pulumi.ProviderResource,
): CreationRoleProvider {
const iamRole = new aws.iam.Role(`${name}-eksClusterCreatorRole`, {
assumeRolePolicy: aws.getCallerIdentity({ parent, async: true }).then(id => `{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::${id.accountId}:root"
},
"Action": "sts:AssumeRole"
}
]
}`,
),
description: `Admin access to eks-${name}`,
}, {parent, provider});
// `eks:*` is needed to create/read/update/delete the EKS cluster, `iam:PassRole` is needed to pass the EKS service role to the cluster
// https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html
const rolePolicy = new aws.iam.RolePolicy(`${name}-eksClusterCreatorPolicy`, {
role: iamRole,
policy: {
Version: "2012-10-17",
Statement: [
{
Effect: "Allow",
Action: "eks:*",
Resource: "*",
},
{
Effect: "Allow",
Action: "iam:PassRole",
Resource: "*",
},
],
},
},
{ parent: iamRole, provider },
);
const creatorProvider = new aws.Provider(`${name}-eksClusterCreatorEntity`, {
region: region,
profile: profile,
assumeRole: {
roleArn: iamRole.arn.apply(async (arn) => {
// wait 30 seconds to assume the IAM Role https://github.com/pulumi/pulumi-aws/issues/673
if (!pulumi.runtime.isDryRun()) {
await new Promise(resolve => setTimeout(resolve, 30 * 1000));
}
return arn;
}),
},
}, { parent: iamRole, provider });
return {
role: iamRole,
provider: creatorProvider,
};
}
/**
* Create the core components and settings required for the EKS cluster.
*/
export function createCore(name: string, args: ClusterOptions, parent: pulumi.ComponentResource, provider?: pulumi.ProviderResource): CoreData {
// Check to ensure that aws CLI is installed, as we'll need it in order to deploy k8s resources
// to the EKS cluster.
try {
which.sync("aws");
} catch (err) {
throw new Error("Could not find aws CLI for EKS. See https://github.com/pulumi/pulumi-eks for installation instructions.");
}
if (args.instanceRole && args.instanceRoles) {
throw new Error("instanceRole and instanceRoles are mutually exclusive, and cannot both be set.");
}
if (args.subnetIds && (args.publicSubnetIds || args.privateSubnetIds)) {
throw new Error("subnetIds, and the use of publicSubnetIds and/or privateSubnetIds are mutually exclusive. Choose a single approach.");
}
if (args.nodeGroupOptions && (
args.nodeSubnetIds ||
args.nodeAssociatePublicIpAddress ||
args.instanceType ||
args.instanceProfileName ||
args.nodePublicKey ||
args.nodeRootVolumeSize ||
args.nodeUserData ||
args.minSize ||
args.maxSize ||
args.desiredCapacity ||
args.nodeAmiId ||
args.gpu)) {
throw new Error("Setting nodeGroupOptions, and any set of singular node group option(s) on the cluster, is mutually exclusive. Choose a single approach.");
}
// Configure the node group options.
const nodeGroupOptions: ClusterNodeGroupOptions = args.nodeGroupOptions || {
nodeSubnetIds: args.nodeSubnetIds,
nodeAssociatePublicIpAddress: args.nodeAssociatePublicIpAddress,
instanceType: args.instanceType,
nodePublicKey: args.nodePublicKey,
encryptRootBlockDevice: args.encryptRootBlockDevice || args.encryptRootBockDevice,
nodeRootVolumeSize: args.nodeRootVolumeSize,
nodeUserData: args.nodeUserData,
minSize: args.minSize,
maxSize: args.maxSize,
desiredCapacity: args.desiredCapacity,
amiId: args.nodeAmiId,
gpu: args.gpu,
version: args.version,
};
// Configure default networking architecture.
let vpcId: pulumi.Input<string> = args.vpcId!;
let clusterSubnetIds: pulumi.Input<pulumi.Input<string>[]> = [];
// If no VPC is set, use the default VPC's subnets.
if (!args.vpcId) {
const invokeOpts = { parent, async: true };
const vpc = aws.ec2.getVpc({ default: true }, invokeOpts);
vpcId = vpc.then(v => v.id);
clusterSubnetIds = vpc.then(v => aws.ec2.getSubnetIds({ vpcId: v.id }, invokeOpts)).then(subnets => subnets.ids);
}
// Form the subnetIds to use on the cluster from either:
// - subnetIds
// - A combination of privateSubnetIds and/or publicSubnetIds.
if (args.subnetIds !== undefined) {
clusterSubnetIds = args.subnetIds;
} else if (args.publicSubnetIds !== undefined || args.privateSubnetIds !== undefined) {
clusterSubnetIds = pulumi.all([
args.publicSubnetIds || [],
args.privateSubnetIds || [],
]).apply(([publicIds, privateIds]) => {
return [...publicIds, ...privateIds];
});
}
// Create the EKS service role
let eksRole: pulumi.Output<aws.iam.Role>;
if (args.serviceRole) {
eksRole = pulumi.output(args.serviceRole);
} else {
eksRole = (new ServiceRole(`${name}-eksRole`, {
service: "eks.amazonaws.com",
description: "Allows EKS to manage clusters on your behalf.",
managedPolicyArns: [
"arn:aws:iam::aws:policy/AmazonEKSClusterPolicy",
"arn:aws:iam::aws:policy/AmazonEKSServicePolicy",
],
}, { parent, provider })).role;
}
// Create the EKS cluster security group
let eksClusterSecurityGroup: aws.ec2.SecurityGroup;
if (args.clusterSecurityGroup) {
eksClusterSecurityGroup = args.clusterSecurityGroup;
} else {
eksClusterSecurityGroup = new aws.ec2.SecurityGroup(`${name}-eksClusterSecurityGroup`, {
vpcId: vpcId,
revokeRulesOnDelete: true,
tags: pulumi.all([
args.tags,
args.clusterSecurityGroupTags,
]).apply(([tags, clusterSecurityGroupTags]) => (<aws.Tags>{
"Name": `${name}-eksClusterSecurityGroup`,
...clusterSecurityGroupTags,
...tags,
})),
}, { parent, provider });
const eksClusterInternetEgressRule = new aws.ec2.SecurityGroupRule(`${name}-eksClusterInternetEgressRule`, {
description: "Allow internet access.",
type: "egress",
fromPort: 0,
toPort: 0,
protocol: "-1", // all
cidrBlocks: ["0.0.0.0/0"],
securityGroupId: eksClusterSecurityGroup.id,
}, { parent, provider });
}
// Create the cluster encryption provider for using envelope encryption on
// Kubernetes secrets.
let encryptionProvider: pulumi.Output<aws.types.output.eks.ClusterEncryptionConfigProvider> | undefined;
let encryptionConfig: pulumi.Output<aws.types.output.eks.ClusterEncryptionConfig> | undefined;
if (args.encryptionConfigKeyArn) {
encryptionProvider = pulumi.output(args.encryptionConfigKeyArn).apply(
keyArn => <aws.types.output.eks.ClusterEncryptionConfigProvider>({keyArn}),
);
encryptionConfig = encryptionProvider.apply(ep => (<aws.types.output.eks.ClusterEncryptionConfig>{
provider: ep,
resources: ["secrets"], // Only valid values are: "secrets"
}));
}
let kubernetesNetworkConfig: pulumi.Output<aws.types.input.eks.ClusterKubernetesNetworkConfig> | undefined;
if (args.kubernetesServiceIpAddressRange) {
kubernetesNetworkConfig = pulumi.output(args.kubernetesServiceIpAddressRange).apply(
serviceIpv4Cidr => ({ serviceIpv4Cidr }),
);
}
// Create the EKS cluster
const eksCluster = new aws.eks.Cluster(`${name}-eksCluster`, {
name: args.name,
roleArn: eksRole.apply(r => r.arn),
vpcConfig: {
securityGroupIds: [eksClusterSecurityGroup.id],
subnetIds: clusterSubnetIds,
endpointPrivateAccess: args.endpointPrivateAccess,
endpointPublicAccess: args.endpointPublicAccess,
publicAccessCidrs: args.publicAccessCidrs,
},
version: args.version,
enabledClusterLogTypes: args.enabledClusterLogTypes,
tags: pulumi.all([
args.tags,
args.clusterTags,
]).apply(([tags, clusterTags]) => (<aws.Tags>{
"Name": `${name}-eksCluster`,
...clusterTags,
...tags,
})),
encryptionConfig,
kubernetesNetworkConfig,
}, {
parent,
provider: args.creationRoleProvider ? args.creationRoleProvider.provider : provider,
});
// Instead of using the kubeconfig directly, we also add a wait of up to 5 minutes or until we
// can reach the API server for the Output that provides access to the kubeconfig string so that
// there is time for the cluster API server to become completely available. Ideally we
// would rely on the EKS API only returning once this was available, but we have seen frequent
// cases where it is not yet available immediately after provisioning - possibly due to DNS
// propagation delay or other non-deterministic factors.
const endpoint = eksCluster.endpoint.apply(async (clusterEndpoint) => {
if (!pulumi.runtime.isDryRun()) {
// For up to 300 seconds, try to contact the API cluster healthz
// endpoint, and verify that it is reachable.
const healthz = `${clusterEndpoint}/healthz`;
const agent = createHttpAgent(args.proxy);
const maxRetries = 60;
const reqTimeoutMilliseconds = 1000; // HTTPS request timeout
const timeoutMilliseconds = 5000; // Retry timeout
for (let i = 0; i < maxRetries; i++) {
try {
await new Promise((resolve, reject) => {
const options = {
...url.parse(healthz),
rejectUnauthorized: false, // EKS API server uses self-signed cert
agent: agent,
timeout: reqTimeoutMilliseconds,
};
const req = https
.request(options, res => {
res.statusCode === 200 ? resolve() : reject(); // Verify healthz returns 200
});
req.on("timeout", reject);
req.on("error", reject);
req.end();
});
pulumi.log.info(`Cluster is ready`, eksCluster, undefined, true);
break;
} catch (e) {
const retrySecondsLeft = (maxRetries - i) * timeoutMilliseconds / 1000;
pulumi.log.info(`Waiting up to (${retrySecondsLeft}) more seconds for cluster readiness...`, eksCluster, undefined, true);
}
await new Promise(resolve => setTimeout(resolve, timeoutMilliseconds));
}
}
return clusterEndpoint;
});
// Compute the required kubeconfig. Note that we do not export this value: we want the exported config to
// depend on the autoscaling group we'll create later so that nothing attempts to use the EKS cluster before
// its worker nodes have come up.
const kubeconfig = pulumi.all([eksCluster.name, endpoint, eksCluster.certificateAuthority, args.providerCredentialOpts])
.apply(([clusterName, clusterEndpoint, clusterCertificateAuthority, providerCredentialOpts]) => {
let config = {};
if (args.creationRoleProvider) {
config = args.creationRoleProvider.role.arn.apply(arn => {
const opts: KubeconfigOptions = {roleArn: arn};
return generateKubeconfig(clusterName, clusterEndpoint, clusterCertificateAuthority.data, opts);
});
} else if (providerCredentialOpts) {
config = generateKubeconfig(clusterName, clusterEndpoint, clusterCertificateAuthority.data, providerCredentialOpts);
} else {
config = generateKubeconfig(clusterName, clusterEndpoint, clusterCertificateAuthority.data);
}
return config;
});
const k8sProvider = new k8s.Provider(`${name}-eks-k8s`, {
kubeconfig: kubeconfig.apply(JSON.stringify),
}, { parent });
// Add any requested StorageClasses.
const storageClasses = args.storageClasses || {};
const userStorageClasses = {} as UserStorageClasses;
if (typeof storageClasses === "string") {
const storageClass = { type: storageClasses, default: true };
userStorageClasses[storageClasses] = pulumi.output(
createStorageClass(`${name.toLowerCase()}-${storageClasses}`, storageClass, { parent, provider: k8sProvider }));
} else {
for (const key of Object.keys(storageClasses)) {
userStorageClasses[key] = pulumi.output(createStorageClass(`${name.toLowerCase()}-${key}`, storageClasses[key], { parent, provider: k8sProvider }));
}
}
const skipDefaultNodeGroup = args.skipDefaultNodeGroup || args.fargate;
// Create the VPC CNI management resource.
let vpcCni: VpcCni | undefined;
if (!args.useDefaultVpcCni) {
vpcCni = new VpcCni(`${name}-vpc-cni`, kubeconfig, args.vpcCniOptions, { parent });
}
let instanceRoleMappings: pulumi.Output<RoleMapping[]>;
let instanceRoles: pulumi.Output<aws.iam.Role[]>;
// Create role mappings of the instance roles specified for aws-auth.
if (args.instanceRoles) {
instanceRoleMappings = pulumi.output(args.instanceRoles).apply(roles =>
roles.map(role => createInstanceRoleMapping(role.arn)),
);
instanceRoles = pulumi.output(args.instanceRoles);
} else if (args.instanceRole) {
// Create an instance profile if using a default node group
if (!skipDefaultNodeGroup) {
nodeGroupOptions.instanceProfile = createOrGetInstanceProfile(name, parent, args.instanceRole, args.instanceProfileName);
}
instanceRoleMappings = pulumi.output(args.instanceRole).apply(instanceRole =>
[createInstanceRoleMapping(instanceRole.arn)],
);
instanceRoles = pulumi.output([args.instanceRole]);
} else {
const instanceRole = (new ServiceRole(`${name}-instanceRole`, {
service: "ec2.amazonaws.com",
managedPolicyArns: [
"arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy",
"arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy",
"arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly",
],
}, { parent, provider })).role;
instanceRoles = pulumi.output([instanceRole]);
// Create a new policy for the role, if specified.
if (args.customInstanceRolePolicy) {
pulumi.log.warn("Option `customInstanceRolePolicy` has been deprecated. Please use `instanceRole` or `instanceRoles`. The role provided to either option should already include all required policies.", eksCluster);
const customRolePolicy = new aws.iam.RolePolicy(`${name}-EKSWorkerCustomPolicy`, {
role: instanceRole,
policy: args.customInstanceRolePolicy,
}, {parent, provider});
}
// Create an instance profile if using a default node group
if (!skipDefaultNodeGroup) {
nodeGroupOptions.instanceProfile = createOrGetInstanceProfile(name, parent, instanceRole, args.instanceProfileName);
}
instanceRoleMappings = pulumi.output(instanceRole).apply(role =>
[createInstanceRoleMapping(role.arn)],
);
}
const roleMappings = pulumi.all([pulumi.output(args.roleMappings || []), instanceRoleMappings])
.apply(([mappings, instanceMappings]) => {
let mappingYaml = "";
try {
mappingYaml = jsyaml.safeDump([...mappings, ...instanceMappings].map(m => ({
rolearn: m.roleArn,
username: m.username,
groups: m.groups,
})));
} catch (e) {
throw new Error(`The IAM role mappings provided could not be properly serialized to YAML for the aws-auth ConfigMap`);
}
return mappingYaml;
});
const nodeAccessData: any = {
mapRoles: roleMappings,
};
if (args.userMappings) {
nodeAccessData.mapUsers = pulumi.output(args.userMappings).apply(mappings => {
let mappingYaml = "";
try {
mappingYaml = jsyaml.safeDump(mappings.map(m => ({
userarn: m.userArn,
username: m.username,
groups: m.groups,
})));
} catch (e) {
throw new Error(`The IAM user mappings provided could not be properly serialized to YAML for the aws-auth ConfigMap`);
}
return mappingYaml;
});
}
const eksNodeAccess = new k8s.core.v1.ConfigMap(`${name}-nodeAccess`, {
apiVersion: "v1",
metadata: {
name: `aws-auth`,
namespace: "kube-system",
},
data: nodeAccessData,
}, { parent, provider: k8sProvider });
const fargateProfile: pulumi.Output<aws.eks.FargateProfile | undefined> = pulumi.output(args.fargate).apply(argsFargate => {
let result: aws.eks.FargateProfile | undefined;
if (argsFargate) {
const fargate = argsFargate !== true ? argsFargate : {};
const podExecutionRoleArn = fargate.podExecutionRoleArn || (new ServiceRole(`${name}-podExecutionRole`, {
service: "eks-fargate-pods.amazonaws.com",
managedPolicyArns: [
"arn:aws:iam::aws:policy/AmazonEKSFargatePodExecutionRolePolicy",
],
}, { parent, provider })).role.apply(r => r.arn);
const selectors = fargate.selectors || [
// For `fargate: true`, default to including the `default` namespaces and
// `kube-system` namespaces so that all pods by default run in Fargate.
{ namespace: "default" },
{ namespace: "kube-system" },
];
const reservedAwsPrefix = "eks";
let fargateProfileName = name;
const profileNameRegex = new RegExp("^" + reservedAwsPrefix + "-", "i"); // starts with (^) 'eks-', (i)gnore casing
if (fargateProfileName === reservedAwsPrefix || profileNameRegex.test(name)) {
fargateProfileName = fargateProfileName.replace("-", "_");
fargateProfileName = `${fargateProfileName}fargateProfile`;
} else {
// default, and to maintain backwards compat for existing cluster fargate profiles.
fargateProfileName = `${fargateProfileName}-fargateProfile`;
}
result = new aws.eks.FargateProfile(fargateProfileName, {
clusterName: eksCluster.name,
podExecutionRoleArn: podExecutionRoleArn,
selectors: selectors,
subnetIds: pulumi.output(clusterSubnetIds).apply(subnets => computeWorkerSubnets(parent, subnets)),
}, { parent, dependsOn: [eksNodeAccess], provider});
// Once the FargateProfile has been created, try to patch CoreDNS if needed. See
// https://docs.aws.amazon.com/eks/latest/userguide/fargate-getting-started.html#fargate-gs-coredns.
pulumi.all([result.id, selectors, kubeconfig]).apply(([_, sels, kconfig]) => {
// Only patch CoreDNS if there is a selector in the FargateProfile which causes
// `kube-system` pods to launch in Fargate.
if (sels.findIndex(s => s.namespace === "kube-system") !== -1) {
// Only do the imperative patching during deployments, not previews.
if (!pulumi.runtime.isDryRun()) {
// Write the kubeconfig to a tmp file and use it to patch the `coredns`
// deployment that AWS deployed already as part of cluster creation.
const tmpKubeconfig = tmp.fileSync();
fs.writeFileSync(tmpKubeconfig.fd, JSON.stringify(kconfig));
const patch = [{
op: "replace",
path: "/spec/template/metadata/annotations/eks.amazonaws.com~1compute-type",
value: "fargate",
}];
const cmd = `kubectl patch deployment coredns -n kube-system --type json -p='${JSON.stringify(patch)}'`;
childProcess.execSync(cmd, {
env: { ...process.env, "KUBECONFIG": tmpKubeconfig.name },
});
}
}
});
}
return result;
});
// Setup OIDC provider to leverage IAM roles for k8s service accounts.
let oidcProvider: aws.iam.OpenIdConnectProvider | undefined;
if (args.createOidcProvider) {
// Retrieve the OIDC provider URL's intermediate root CA fingerprint.
const awsRegionName = pulumi.output(aws.getRegion({}, {parent, async: true })).name;
const eksOidcProviderUrl = pulumi.interpolate `https://oidc.eks.${awsRegionName}.amazonaws.com`;
const agent = createHttpAgent(args.proxy);
const fingerprint = getIssuerCAThumbprint(eksOidcProviderUrl, agent);
// Create the OIDC provider for the cluster.
oidcProvider = new aws.iam.OpenIdConnectProvider(`${name}-oidcProvider`, {
clientIdLists: ["sts.amazonaws.com"],
url: eksCluster.identities[0].oidcs[0].issuer,
thumbprintLists: [fingerprint],
}, { parent, provider });
}
return {
vpcId: pulumi.output(vpcId),
subnetIds: args.subnetIds ? pulumi.output(args.subnetIds) : pulumi.output(clusterSubnetIds),
publicSubnetIds: args.publicSubnetIds ? pulumi.output(args.publicSubnetIds) : undefined,
privateSubnetIds: args.privateSubnetIds ? pulumi.output(args.privateSubnetIds) : undefined,
clusterSecurityGroup: eksClusterSecurityGroup,
cluster: eksCluster,
endpoint: endpoint,
nodeGroupOptions: nodeGroupOptions,
kubeconfig: kubeconfig,
provider: k8sProvider,
awsProvider: provider,
vpcCni: vpcCni,
instanceRoles: instanceRoles,
eksNodeAccess: eksNodeAccess,
tags: args.tags,
nodeSecurityGroupTags: args.nodeSecurityGroupTags,
storageClasses: userStorageClasses,
fargateProfile: fargateProfile,
oidcProvider: oidcProvider,
encryptionConfig: encryptionConfig,
};
}
/**
* Enable access to the EKS cluster for worker nodes, by creating an
* instance role mapping to the k8s username and groups of aws-auth.
*/
function createInstanceRoleMapping(arn: pulumi.Input<string>): RoleMapping {
return {
roleArn: arn,
username: "system:node:{{EC2PrivateDNSName}}",
groups: ["system:bootstrappers", "system:nodes"],
};
}
/**
* Create an HTTP Agent for use with HTTP(S) requests.
* Using a proxy is supported.
*/
function createHttpAgent(proxy?: string): http.Agent {
if (!proxy) {
// Attempt to default to the proxy env vars.
//
// Note: Envars used are a convention that were based on:
// - curl: https://curl.haxx.se/docs/manual.html
// - wget: https://www.gnu.org/software/wget/manual/html_node/Proxies.html
proxy = process.env.HTTPS_PROXY || process.env.https_proxy ||
process.env.HTTP_PROXY || process.env.http_proxy;
}
if (proxy) {
/**
* Create an HTTP(s) proxy agent with the given options.
*
* The agent connects to the proxy and issues a HTTP CONNECT
* method to the proxy, which connects to the dest.
*
* Note: CONNECT is not cacheable.
*
* See for more details:
* - https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT
* - https://www.npmjs.com/package/https-proxy-agent
*/
return HttpsProxyAgent({
...url.parse(proxy),
rejectUnauthorized: false, // allow proxy configured with self-signed cert
});
}
return new https.Agent({
// Cached sessions can result in the certificate not being
// available since its already been "accepted." Disable caching.
maxCachedSessions: 0,
});
}
/**
* ClusterOptions describes the configuration options accepted by an EKSCluster component.
*/
export interface ClusterOptions {
/**
* The VPC in which to create the cluster and its worker nodes. If unset, the cluster will be created in the
* default VPC.
*/
vpcId?: pulumi.Input<string>;
/**
* The set of all subnets, public and private, to use for the worker node
* groups on the EKS cluster. These subnets are automatically tagged by EKS
* for Kubernetes purposes.
*
* If `vpcId` is not set, the cluster will use the AWS account's default VPC subnets.
*
* If the list of subnets includes both public and private subnets, the worker
* nodes will only be attached to the private subnets, and the public
* subnets will be used for internet-facing load balancers.
*
* See for more details: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html.
*
* Note: The use of `subnetIds`, along with `publicSubnetIds`
* and/or `privateSubnetIds` is mutually exclusive. The use of
* `publicSubnetIds` and `privateSubnetIds` is encouraged.
*/
subnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The set of public subnets to use for the worker node groups on the EKS cluster.
* These subnets are automatically tagged by EKS for Kubernetes purposes.
*
* If `vpcId` is not set, the cluster will use the AWS account's default VPC subnets.
*
* Worker network architecture options:
* - Private-only: Only set `privateSubnetIds`.
* - Default workers to run in a private subnet. In this setting, Kubernetes
* cannot create public, internet-facing load balancers for your pods.
* - Public-only: Only set `publicSubnetIds`.
* - Default workers to run in a public subnet.
* - Mixed (recommended): Set both `privateSubnetIds` and `publicSubnetIds`.
* - Default all worker nodes to run in private subnets, and use the public subnets
* for internet-facing load balancers.
*
* See for more details: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html.
*
* Note: The use of `subnetIds`, along with `publicSubnetIds`
* and/or `privateSubnetIds` is mutually exclusive. The use of
* `publicSubnetIds` and `privateSubnetIds` is encouraged.
*/
publicSubnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The set of private subnets to use for the worker node groups on the EKS cluster.
* These subnets are automatically tagged by EKS for Kubernetes purposes.
*
* If `vpcId` is not set, the cluster will use the AWS account's default VPC subnets.
*
* Worker network architecture options:
* - Private-only: Only set `privateSubnetIds`.
* - Default workers to run in a private subnet. In this setting, Kubernetes
* cannot create public, internet-facing load balancers for your pods.
* - Public-only: Only set `publicSubnetIds`.
* - Default workers to run in a public subnet.
* - Mixed (recommended): Set both `privateSubnetIds` and `publicSubnetIds`.
* - Default all worker nodes to run in private subnets, and use the public subnets
* for internet-facing load balancers.
*
* See for more details: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html.
*
* Note: The use of `subnetIds`, along with `publicSubnetIds`
* and/or `privateSubnetIds` is mutually exclusive. The use of
* `publicSubnetIds` and `privateSubnetIds` is encouraged.
*
* Also consider setting `nodeAssociatePublicIpAddress: true` for
* fully private workers.
*/
privateSubnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The common configuration settings for NodeGroups.
*/
nodeGroupOptions?: ClusterNodeGroupOptions;
/**
* Whether or not to auto-assign the EKS worker nodes public IP addresses.
* If this toggle is set to true, the EKS workers will be
* auto-assigned public IPs. If false, they will not be auto-assigned
* public IPs.
*/
nodeAssociatePublicIpAddress?: boolean;
/**
* Optional mappings from AWS IAM roles to Kubernetes users and groups.
*/
roleMappings?: pulumi.Input<pulumi.Input<RoleMapping>[]>;
/**
* Optional mappings from AWS IAM users to Kubernetes users and groups.
*/
userMappings?: pulumi.Input<pulumi.Input<UserMapping>[]>;
/**
* The configuration of the Amazon VPC CNI plugin for this instance. Defaults are described in the documentation
* for the VpcCniOptions type.
*/
vpcCniOptions?: VpcCniOptions;
/**
* Use the default VPC CNI instead of creating a custom one. Should not be used in conjunction with `vpcCniOptions`.
*/
useDefaultVpcCni?: boolean;
/**
* The instance type to use for the cluster's nodes. Defaults to "t2.medium".
*/
instanceType?: pulumi.Input<aws.ec2.InstanceType>;
/**
* This enables the simple case of only registering a *single* IAM
* instance role with the cluster, that is required to be shared by
* *all* node groups in their instance profiles.
*
* Note: options `instanceRole` and `instanceRoles` are mutually exclusive.
*/
instanceRole?: pulumi.Input<aws.iam.Role>;
/**
* The default IAM InstanceProfile to use on the Worker NodeGroups, if one is not already set in the NodeGroup.
*/
instanceProfileName?: pulumi.Input<string>;
/**
* IAM Service Role for EKS to use to manage the cluster.
*/
serviceRole?: pulumi.Input<aws.iam.Role>;
/**
* The IAM Role Provider used to create & authenticate against the EKS cluster. This role is given `[system:masters]`
* permission in K8S, See: https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html
*/
creationRoleProvider?: CreationRoleProvider;
/**
* This enables the advanced case of registering *many* IAM instance roles
* with the cluster for per node group IAM, instead of the simpler, shared case of `instanceRole`.
*
* Note: options `instanceRole` and `instanceRoles` are mutually exclusive.
*/
instanceRoles?: pulumi.Input<pulumi.Input<aws.iam.Role>[]>;
/**
* Attach a custom role policy to worker node instance role
*