@paulo_raca/cdk-skylight 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,181 @@
+![](https://img.shields.io/badge/CDK%20Skylight-Developer%20Preview-orange.svg?style=for-the-badge)
+
+# CDK Skylight
+
+CDK Skylight is a set of **Level 3 constructs** for the [Microsoft products on AWS](https://aws.amazon.com/windows/) ecosystem (Windows OS, SQL Server, Active Directory, Windows Containers, Amazon FSx for Windows, and so on). **CDK Skylight Constructs are a natural fit for Platform Teams building Platform as a Product.**
+
+A few examples are:
+
+1. Windows Worker with Domain join and Powershell API that allows running complex automation with a single line of code
+2. Managed Active Directory configured with DNS Topology and an API to create new AD Group with a domain-joined machine.
+3. Amazon FSx library that creates Filesystem with API to create Folder on it
+4. Windows EKS Workers that joins to specified AD domain with APIs to create and configure complex integrations such as SMB with Global Mapping and Domain authentication with gMSA plugin.
+
+All those examples are built with CDK Skylight libraries and can be used separately with maximum flexibility to change the default settings.
+
+CDK Skylight is set to address repetitive tasks and best practices involved with managing, deploying, and integrating those apps. In addition to the complexity of integrating the AWS side products, Microsoft technologies such as SQL, AD, Windows OS require OS-level integration and optimization. Skylight help in both the "AWS-side" and the "OS-side," offering a complete end-to-end configuration and integration solution of AWS products.
+
+# Who should use CDK Skylight?
+
+The primary persona to use CDK Skylight is the platform team owners to customize the stacks and provide them to the application owners teams.
+
+As a vision, Project CDK-Skylight targets all Windows EC2 customers in all stages, specifically developers developing features integrated with the Microsoft-products ecosystem (SQL Server, Active Directory, Windows OS, etc.)
+
+# When to use CDK Skylight?
+
+CDK Skylight helps in all application lifecycle stages, starting from the developer machine to running production workloads. With CDK Skylight, the time it takes to move between stages and integrate new services is reduced dramatically.
+
+# How to use
+
+```bash
+npm install cdk-skylight
+```
+
+In your CDK App
+
+```typescript
+import * as skylight from "cdk-skylight";
+
+new skylight.authentication.AwsManagedMicrosoftAdR53(scope: Construct, id: string, props: IAwsManagedMicrosoftAdProps)
+
+```
+
+# CDK Skylight Constructs
+
+## Skylight-Compute
+
+Library of Custom Compute components
+
+### DomainWindowsNode
+
+A Domain Windows Node Construct represents one Windows EC2 instance configured with Active Directory.
+
+The DomainWindowsNode can be customized to different instance sizes and additional permissions set just like any other EC2 Instance.
+You can use this construct to run elevated domain tasks with domain permissions or run your application in a single instance setup.
+
+The machine will be joined to the provided Active Directory domain using a custom CloudFormation bootstrap that will wait until the required reboot to join the domain. Then it will register the machine in SSM and pull tasks from the SSM State manager.
+
+You can send tasks to that machine using the provided methods: runPsCommands() and runPSwithDomainAdmin()
+
+```typescript
+const windowsNodeObject = new skylight.compute.DomainWindowsNode(
+  stack,
+  'WindowsNode',
+  {
+    vpc: vpc,
+    madSsmParameters: {}, //pointer to the Secret that holds the Domain Admin username and password
+  }
+);
+
+// Special Methods:
+windowsNodeObject.runPsCommands(['echo hello-world'], 'hello');
+windowsNodeObject.runPSwithDomainAdmin(
+  ['Write-Host hello-world'],
+  'hello-withPS'
+);
+windowsNodeObject.openRDP('1.1.1.1/32');
+```
+
+## Skylight-Authentication
+
+Library of Custom Authentication components
+
+### **AwsManagedMicrosoftAd** - Managed Active Directory
+
+Managed AD with Secret stored in secret manager
+
+The secret saved to SSM parameter store so others can use it with other Constructs (Such as Windows node or FSx)
+The provided VPC or the new created VPC will be configured to forward DNS requests to the Managed AD with Route53 Resolvers
+
+The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createADGroup)
+The createADGroup() method creates an Active Directory permission group in the domain, using the domain admin user.
+
+Please note: When calling createADGroup() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
+then each command will be scheduled with State Manager, and the instance will be shut down after complete.
+
+```typescript
+const ad = new skylight.authentication.AwsManagedMicrosoftAd(
+  stack,
+  'AwsManagedMicrosoftAdR53',
+  {
+    vpc: vpc,
+    edition: 'Enterprise', // Optional
+    secret: new Secret(stack, 'test-secret'), // Optional
+    domainName: 'test-domain', // Optional
+    secretName: 'custom-secret-name', // Optional
+    createWorker: false, // Optional
+  }
+);
+ad.managedActiveDirectory.createADGroup(
+  'MyADGroup', // AD group name
+  'My AD Group Created by CDK-Skylight!' //AD Description
+);
+```
+
+### **AwsManagedMicrosoftAdR53** - Extenstion of Manged Active Directory with R53 Resolvers
+
+AwsManagedMicrosoftAdR53 represents an integration pattern of Managed AD and Route 53 Resolver in a specific VPC, it will create Managed AD with the provided Secret (Secrets Manager) or generates a new Secret.
+
+Example:
+
+```typescript
+const ad = new skylight.authentication.AwsManagedMicrosoftAdR53(
+  stack,
+  'AwsManagedMicrosoftAdR53',
+  {
+    vpc: vpc,
+  }
+);
+```
+
+## Skylight-Storage
+
+### FSxWindows
+
+A FSxWindows represents an integration pattern of Amazon FSx and Managed AD in a specific VPC.
+The Construct creates Amazon FSx for Windows
+
+The construct also creates t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createFolder)
+The createFolder() method creates an SMB Folder in the FSx filesystem, using the domain admin user.
+
+Please note: When calling createFolder() API, a Lambda will be created to start the worker machine (Using AWS-SDK), then each command will be scheduled with State Manager, and the instance will be shut down after complete.
+
+Example:
+
+```typescript
+this.fsxWindows = new skylight.storage.FSxWindows(this, 'FSx', {
+  vpc: vpc,
+  adParametersStore: adParametersStore,
+});
+this.fsxWindows.createFolder('myFolderStorageOnFSx');
+```
+
+# Very experimental Libraries
+
+### EKS Compute
+
+The stack creates the Windows Autoscaling group with domain join script and the SSM Documents for gMSA and Global Mapping.
+
+### EKS Cluster
+
+```typescript
+const cluster = new WindowsEKSCluster(stack, 'ElasticCluster', {
+  vpc: new aws_ec2.Vpc(stack, 'MyVpc', {}),
+}); // Creates EKS Cluster with Windows support
+```
+
+### EKS Nodes
+
+This stack takes the PersistentStorage stack as input and creates the EKS cluster with permissions to operate EKS clusters.
+
+```typescript
+const myNodes = new WindowsEKSNodes(stack, 'WindowsEKSNodes', {
+  // Creates AutoScaling group for Windows Support
+  vpc: new aws_ec2.Vpc(stack, 'MyVpc', {}),
+});
+
+myNodes.addAdDependency(secretObject);
+myNodes.addStorageDependency(secretObject, storageMount);
+myNodes.addEKSDependency(eks_cluster.eksCluster);
+myNodes.addLocalCredFile(secretObject, 'myEKSNodes', 'myWebApp');
+```

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * as compute from './skylight-compute';
+export * as storage from './skylight-storage';
+export * as authentication from './skylight-authentication';

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authentication = exports.storage = exports.compute = void 0;
+exports.compute = require("./skylight-compute");
+exports.storage = require("./skylight-storage");
+exports.authentication = require("./skylight-authentication");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsZ0RBQThDO0FBQzlDLGdEQUE4QztBQUM5Qyw4REFBNEQiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBhcyBjb21wdXRlIGZyb20gJy4vc2t5bGlnaHQtY29tcHV0ZSc7XG5leHBvcnQgKiBhcyBzdG9yYWdlIGZyb20gJy4vc2t5bGlnaHQtc3RvcmFnZSc7XG5leHBvcnQgKiBhcyBhdXRoZW50aWNhdGlvbiBmcm9tICcuL3NreWxpZ2h0LWF1dGhlbnRpY2F0aW9uJztcbiJdfQ==

package/lib/skylight-authentication/ad-authentication.d.ts

@@ -0,0 +1,132 @@
+/**
+ *  Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+ *  with the License. A copy of the License is located at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+ *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+ *  and limitations under the License.
+ */
+import { aws_ec2 as ec2, aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
+import { CfnMicrosoftAD } from 'aws-cdk-lib/aws-directoryservice';
+import { ISecret } from 'aws-cdk-lib/aws-secretsmanager';
+import { Construct } from 'constructs';
+import * as skylight from '../index';
+/**
+ * The properties for the AwsManagedMicrosoftAd class.
+ */
+export interface IAwsManagedMicrosoftAdProps {
+    /**
+     * The domain name for the Active Directory Domain.
+     *
+     * @default - 'domain.aws'.
+     */
+    domainName?: string;
+    /**
+     * The edition to use for the Active Directory Domain.
+     * Allowed values: Enterprise | Standard
+     * https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition
+     * @default - 'Standard'.
+     */
+    edition?: string;
+    /**
+     * The secrets manager secret to use must be in format:
+     * '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}'
+     * @default - 'Randomly generated and stored in Secret Manager'.
+     */
+    secret?: secretsmanager.ISecret;
+    /**
+     * The secret name to save the Domain Admin object
+     * @default - '<domain.name>-secret'.
+     */
+    secretName?: string;
+    /**
+     * The VPC to use, must have private subnets.
+     */
+    vpc: ec2.IVpc;
+    /**
+     * VPC subnet selection, subnets must be private and exactly 2
+     */
+    vpcSubnets?: ec2.SelectedSubnets;
+    /**
+     * The configuration store to save the directory parameters (After deployed)
+     */
+    configurationStore?: IAwsManagedMicrosoftAdParameters;
+    /**
+     * Create Domain joined machine to be used to run Powershell commands to that directory. (i.e Create Ad Group)
+     * @default - 'true'.
+     */
+    createWorker?: boolean;
+}
+export declare enum AwsManagedMicrosoftConfigurationStoreType {
+    SSM = "AWS Systems Manager Parameter Store"
+}
+/**
+ * The properties of an DomainWindowsNodeProps, requires Active Directory parameter to read the Secret to join the domain
+ * Default setting: Domain joined, m5.2xlarge, latest windows, Managed by SSM.
+ */
+export interface IAwsManagedMicrosoftAdParameters {
+    /**
+     * The name of the Configuration Store Type to use
+     * @default - 'AWS Systems Manager Parameter Store'.
+     */
+    configurationStoreType?: AwsManagedMicrosoftConfigurationStoreType;
+    /**
+     * The name of the SSM Object that contains the secret name in Secrets Manager
+     * @default - 'domain-secret'.
+     */
+    secretPointer?: string;
+    /**
+     * The name of the SSM Object that contains the Directory ID
+     * @default - 'directoryID'.
+     */
+    directoryIDPointer?: string;
+    /**
+     * The SSM namespace to read/write parameters to
+     * @default - 'cdk-skylight'.
+     */
+    namespace?: string;
+}
+/**
+ * A Ad Authentication represents an integration pattern of Managed AD and Route 53 Resolver in a specific VPC
+ *
+ * The Construct creates Managed AD with the provided Secret (Secrets Manager) or generates a new Secret.
+ * The secret saved to SSM parameter store so others can use it with other Constructs (Such as Windows node or FSx)
+ * The provided VPC or the new created VPC will be configured to forward DNS requests to the Managed AD with Route53 Resolvers
+ * The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createADGroup)
+ *
+ * The createADGroup() method creates an Active Directory permission group in the domain, using the domain admin user.
+ * Please note: When calling createADGroup() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
+ * then each command will be scheduled with State Manager, and the instance will be shut down after complete.
+ *
+ */
+export declare class AwsManagedMicrosoftAd extends Construct {
+    readonly microsoftAD: CfnMicrosoftAD;
+    readonly adParameters: IAwsManagedMicrosoftAdParameters;
+    readonly props: IAwsManagedMicrosoftAdProps;
+    readonly domainWindowsNode?: skylight.compute.DomainWindowsNode;
+    readonly secret: ISecret;
+    constructor(scope: Construct, id: string, props: IAwsManagedMicrosoftAdProps);
+    createWorker(domainName: string, domainPassword: ISecret): skylight.compute.DomainWindowsNode;
+    createADGroup(groupName: string, groupDescription: string): void;
+    createServiceAccount(adServiceAccountName: string, servicePrincipalNames: string, principalsAllowedToRetrieveManagedPassword: string): void;
+}
+/**
+ * A Ad Authentication represents an integration pattern of Managed AD and Route 53 Resolver in a specific VPC
+ *
+ * The Construct creates Managed AD with the provided Secret (Secrets Manager) or generates a new Secret.
+ * The secret saved to SSM parameter store so others can use it with other Constructs (Such as Windows node or FSx)
+ * The provided VPC or the new created VPC will be configured to forward DNS requests to the Managed AD with Route53 Resolvers
+ * The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createADGroup)
+ *
+ * The createADGroup() method creates an Active Directory permission group in the domain, using the domain admin user.
+ * Please note: When calling createADGroup() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
+ * then each command will be scheduled with State Manager, and the instance will be shut down after complete.
+ *
+ */
+export declare class AwsManagedMicrosoftAdR53 extends AwsManagedMicrosoftAd {
+    constructor(scope: Construct, id: string, props: IAwsManagedMicrosoftAdProps);
+}