@studion/infra-code-blocks 0.0.6 → 0.0.8

package/README.md

@@ -30,7 +30,6 @@ import * as studion from '@studion/infra-code-blocks';
 import * as studion from '@studion/infra-code-blocks';
 
 const project = new studion.Project('demo-project', {
-  environment: 'DEVELOPMENT',
   services: [
     {
       type: 'REDIS',
@@ -76,7 +75,6 @@ type ProjectArgs = {
     | StaticSiteService
     | WebServerService
   )[];
-  environment: Environment;
   hostedZoneId?: pulumi.Input<string>;
   enableSSMConnect?: pulumi.Input<boolean>;
 };
@@ -85,7 +83,6 @@ type ProjectArgs = {
 | Argument         |                                                                         Description                                                                          |
 | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------: |
 | services \*      |                                                                        Service list.                                                                         |
-| environment \*   |                                                                      Environment name.                                                                       |
 | hostedZoneId     |                                           Route53 hosted zone ID responsible for managing records for the domain.                                            |
 | enableSSMConnect | Setup ec2 instance and SSM in order to connect to the database in the private subnet. Please refer to the [SSM Connect](#ssm-connect) section for more info. |
 
@@ -101,6 +98,9 @@ type DatabaseService = {
   allocatedStorage?: pulumi.Input<number>;
   maxAllocatedStorage?: pulumi.Input<number>;
   instanceClass?: pulumi.Input<string>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
@@ -118,6 +118,9 @@ export type StaticSiteService = {
   type: 'STATIC_SITE';
   serviceName: string;
   domain: pulumi.Input<string>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
@@ -140,6 +143,9 @@ export type WebServerService = {
     pulumi.Input<RoleInlinePolicy>[]
   >;
   taskRoleInlinePolicies?: pulumi.Input<pulumi.Input<RoleInlinePolicy>[]>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
@@ -370,11 +376,12 @@ The [Database](#database) component deploys a database instance inside a private
 and it's not publicly accessible from outside of VPC.
 <br>
 In order to connect to the database we need to deploy the ec2 instance which will be used
-to open an SSH tunnel to the database instance.
+to forward traffic to the database instance.
 <br>
-Because of security reasons, ec2 instance is also deployed inside private subnet
+Because of security reasons, the ec2 instance is also deployed inside a private subnet
 which means we can't directly connect to it. For that purpose, we use AWS System Manager
-which enables us to connect to the ec2 instance even though it's inside private subnet.
+which enables us to connect to the ec2 instance even though it's inside a private subnet.
+The benefit of using AWS SSM is that we don't need a ssh key pair.
 
 ![AWS RDS connection schema](/assets/images/ssm-rds.png)
 
@@ -386,18 +393,6 @@ which enables us to connect to the ec2 instance even though it's inside private
 $ brew install --cask session-manager-plugin
 ```
 
-2. Generate a new ssh key pair or use the existing one.
-
-```bash
-$ ssh-keygen -f my_rsa
-```
-
-3. Set stack config property by running:
-
-```bash
-$ pulumi config set ssh:publicKey "ssh-rsa Z...9= mymac@Studions-MBP.localdomain"
-```
-
 SSM Connect can be enabled by setting `enableSSMConnect` property to `true`.
 
 ```ts
@@ -412,20 +407,13 @@ export const ec2InstanceId = project.ec2SSMConnect?.ec2.id;
 Open up your terminal and run the following command:
 
 ```bash
-$ aws ssm start-session --target EC2_INSTANCE_ID --document-name AWS-StartPortForwardingSession --parameters '{"portNumber":["22"], "localPortNumber":["9999"]}'
-```
-
-Where `EC2_INSTANCE_ID` is an ID of the EC2 instance that is created for you. ID can be
-obtained by exporting it from the stack.
-
-Next, open another terminal window and run the following command:
-
-```bash
-$ ssh ec2-user@localhost -p 9999 -N -L 5555:DATABASE_ADDRESS:DATABASE_PORT -i SSH_PRIVATE_KEY
+$ aws ssm start-session --target EC2_INSTANCE_ID --document-name AWS-StartPortForwardingSessionToRemoteHost --parameters '{"host": ["DATABASE_ADDRESS"], "portNumber":["DATABASE_PORT"], "localPortNumber":["5555"]}'
 ```
 
-Where `DATABASE_ADDRESS` and `DATABASE_PORT` are the address and port of the database instance,
-and `SSH_PRIVATE_KEY` is the path to the SSH private key.
+Where `EC2_INSTANCE_ID` is an ID of the EC2 instance that is created for you
+(ID can be obtained by exporting it from the stack), and
+`DATABASE_ADDRESS` and `DATABASE_PORT` are the address and port of the
+database instance.
 
 And that is it! 🥳
 Now you can use your favorite database client to connect to the database.
@@ -433,9 +421,9 @@ Now you can use your favorite database client to connect to the database.
 ![RDS connection](/assets/images/rds-connection.png)
 
 It is important that for the host you set `localhost` and for the port you set `5555`
-because we have an SSH tunnel open that forwards traffic from localhost:5555 to the
-DATABASE_ADDRESS:DATABASE_PORT. For the user, password, and database field, set values
-which are set in the `Project`.
+because we are port forwarding traffic from
+localhost:5555 to DATABASE_ADDRESS:DATABASE_PORT.
+For the user, password, and database field, set values which are set in the `Project`.
 
 ```ts
 const project = new studion.Project('demo-project', {
@@ -455,4 +443,4 @@ const project = new studion.Project('demo-project', {
 ## 🚧 TODO
 
 - [ ] Add worker service for executing tasks
-- [ ] Update docs, describe each service, describe required stack configs...
+- [ ] Add MongoDB service

package/dist/components/database.js

@@ -29,6 +29,7 @@ class Database extends pulumi.ComponentResource {
             ],
         }, { parent: this });
         this.kms = new aws.kms.Key(`${name}-rds-key`, {
+            description: `${name} RDS encryption key`,
             customerMasterKeySpec: 'SYMMETRIC_DEFAULT',
             isEnabled: true,
             keyUsage: 'ENCRYPT_DECRYPT',

package/dist/components/ec2-ssm-connect.d.ts

@@ -3,7 +3,6 @@ import * as aws from '@pulumi/aws';
 import * as awsx from '@pulumi/awsx';
 export type Ec2SSMConnectArgs = {
     vpc: awsx.ec2.Vpc;
-    sshPublicKey: pulumi.Input<string>;
     tags?: pulumi.Input<{
         [key: string]: pulumi.Input<string>;
     }>;
@@ -14,6 +13,5 @@ export declare class Ec2SSMConnect extends pulumi.ComponentResource {
     ec2MessagesVpcEndpoint: aws.ec2.VpcEndpoint;
     ssmMessagesVpcEndpoint: aws.ec2.VpcEndpoint;
     ec2: aws.ec2.Instance;
-    sshKeyPair: aws.ec2.KeyPair;
     constructor(name: string, args: Ec2SSMConnectArgs, opts?: pulumi.ComponentResourceOptions);
 }

package/dist/components/ec2-ssm-connect.js

@@ -56,14 +56,10 @@ class Ec2SSMConnect extends pulumi.ComponentResource {
         const ssmProfile = new aws.iam.InstanceProfile(`${name}-ssm-profile`, {
             role: role.name,
         }, { parent: this, dependsOn: [ssmPolicyAttachment] });
-        this.sshKeyPair = new aws.ec2.KeyPair(`${name}-ec2-keypair`, {
-            publicKey: args.sshPublicKey,
-        }, { parent: this });
         this.ec2 = new aws.ec2.Instance(`${name}-ec2`, {
             ami: 'ami-067d1e60475437da2',
             associatePublicIpAddress: false,
             instanceType: 't2.micro',
-            keyName: this.sshKeyPair.keyName,
             iamInstanceProfile: ssmProfile.name,
             subnetId,
             vpcSecurityGroupIds: [this.ec2SecurityGroup.id],

package/dist/components/project.d.ts

@@ -6,7 +6,6 @@ import { Database, DatabaseArgs } from './database';
 import { WebServer, WebServerArgs } from './web-server';
 import { Redis, RedisArgs } from './redis';
 import { StaticSite, StaticSiteArgs } from './static-site';
-import { Environment } from '../constants';
 import { Ec2SSMConnect } from './ec2-ssm-connect';
 export type Service = Database | Redis | StaticSite | WebServer;
 export type Services = Record<string, Service>;
@@ -18,21 +17,19 @@ type ServiceArgs = {
 };
 export type DatabaseService = {
     type: 'DATABASE';
-} & ServiceArgs & Omit<DatabaseArgs, 'vpc' | 'tags'>;
+} & ServiceArgs & Omit<DatabaseArgs, 'vpc'>;
 export type RedisService = {
     type: 'REDIS';
 } & ServiceArgs & Pick<RedisArgs, 'dbName' | 'region'>;
 export type StaticSiteService = {
     type: 'STATIC_SITE';
-} & ServiceArgs & Omit<StaticSiteArgs, 'hostedZoneId' | 'tags'>;
+} & ServiceArgs & Omit<StaticSiteArgs, 'hostedZoneId'>;
 export type WebServerService = {
     type: 'WEB_SERVER';
     environment?: aws.ecs.KeyValuePair[] | ((services: Services) => aws.ecs.KeyValuePair[]);
-} & ServiceArgs & Omit<WebServerArgs, 'cluster' | 'vpc' | 'hostedZoneId' | 'environment' | 'tags'>;
-export type Environment = (typeof Environment)[keyof typeof Environment];
+} & ServiceArgs & Omit<WebServerArgs, 'cluster' | 'vpc' | 'hostedZoneId' | 'environment'>;
 export type ProjectArgs = {
     services: (DatabaseService | RedisService | StaticSiteService | WebServerService)[];
-    environment: Environment;
     hostedZoneId?: pulumi.Input<string>;
     enableSSMConnect?: pulumi.Input<boolean>;
 };
@@ -41,7 +38,6 @@ export declare class MissingHostedZoneId extends Error {
 }
 export declare class Project extends pulumi.ComponentResource {
     name: string;
-    environment: Environment;
     vpc: awsx.ec2.Vpc;
     cluster?: aws.ecs.Cluster;
     hostedZoneId?: pulumi.Input<string>;

package/dist/components/project.js

@@ -33,20 +33,14 @@ class Project extends pulumi.ComponentResource {
     constructor(name, args, opts = {}) {
         super('studion:Project', name, {}, opts);
         this.services = {};
-        const { services, environment, hostedZoneId } = args;
+        const { services, hostedZoneId } = args;
         this.name = name;
         this.hostedZoneId = hostedZoneId;
-        this.environment = environment;
         this.vpc = this.createVpc();
         this.createServices(services);
         if (args.enableSSMConnect) {
-            const sshConfig = new pulumi.Config('ssh');
             this.ec2SSMConnect = new ec2_ssm_connect_1.Ec2SSMConnect(`${name}-ssm-connect`, {
                 vpc: this.vpc,
-                sshPublicKey: sshConfig.require('publicKey'),
-                tags: {
-                    Env: this.environment,
-                },
             });
         }
         this.registerOutputs();
@@ -56,9 +50,6 @@ class Project extends pulumi.ComponentResource {
             numberOfAvailabilityZones: 2,
             enableDnsHostnames: true,
             enableDnsSupport: true,
-            tags: {
-                Env: this.environment,
-            },
         }, { parent: this });
         return vpc;
     }
@@ -90,16 +81,11 @@ class Project extends pulumi.ComponentResource {
     createWebServerPrerequisites() {
         this.cluster = new aws.ecs.Cluster(`${this.name}-cluster`, {
             name: this.name,
-            tags: {
-                Env: this.environment,
-            },
         }, { parent: this });
     }
     createDatabaseService(options) {
         const { serviceName, type } = options, databaseOptions = __rest(options, ["serviceName", "type"]);
-        const service = new database_1.Database(serviceName, Object.assign(Object.assign({}, databaseOptions), { vpc: this.vpc, tags: {
-                Env: this.environment,
-            } }), { parent: this });
+        const service = new database_1.Database(serviceName, Object.assign(Object.assign({}, databaseOptions), { vpc: this.vpc }), { parent: this });
         this.services[serviceName] = service;
     }
     createRedisService(options) {
@@ -116,9 +102,7 @@ class Project extends pulumi.ComponentResource {
         const { serviceName } = options, staticSiteOptions = __rest(options, ["serviceName"]);
         if (!this.hostedZoneId)
             throw new MissingHostedZoneId(options.type);
-        const service = new static_site_1.StaticSite(serviceName, Object.assign(Object.assign({}, staticSiteOptions), { hostedZoneId: this.hostedZoneId, tags: {
-                Env: this.environment,
-            } }), { parent: this });
+        const service = new static_site_1.StaticSite(serviceName, Object.assign(Object.assign({}, staticSiteOptions), { hostedZoneId: this.hostedZoneId }), { parent: this });
         this.services[serviceName] = service;
     }
     createWebServerService(options) {
@@ -130,9 +114,7 @@ class Project extends pulumi.ComponentResource {
         const parsedEnv = typeof environment === 'function'
             ? environment(this.services)
             : environment;
-        const service = new web_server_1.WebServer(serviceName, Object.assign(Object.assign({}, ecsOptions), { cluster: this.cluster, vpc: this.vpc, hostedZoneId: this.hostedZoneId, environment: parsedEnv, tags: {
-                Env: this.environment,
-            } }), { parent: this });
+        const service = new web_server_1.WebServer(serviceName, Object.assign(Object.assign({}, ecsOptions), { cluster: this.cluster, vpc: this.vpc, hostedZoneId: this.hostedZoneId, environment: parsedEnv }), { parent: this });
         this.services[options.serviceName] = service;
     }
 }

package/dist/constants.d.ts

@@ -16,7 +16,3 @@ export declare const PredefinedSize: {
         readonly memory: number;
     };
 };
-export declare const Environment: {
-    readonly DEVELOPMENT: "DEVELOPMENT";
-    readonly PRODUCTION: "PRODUCTION";
-};

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Environment = exports.PredefinedSize = void 0;
+exports.PredefinedSize = void 0;
 const CPU_1_VCPU = 1024;
 const MEMORY_1GB = 1024;
 exports.PredefinedSize = {
@@ -21,7 +21,3 @@ exports.PredefinedSize = {
         memory: MEMORY_1GB * 4, // 4 GB memory
     },
 };
-exports.Environment = {
-    DEVELOPMENT: 'DEVELOPMENT',
-    PRODUCTION: 'PRODUCTION',
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studion/infra-code-blocks",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Studion common infra components",
   "keywords": [
     "infrastructure",