@studion/infra-code-blocks 0.0.5 → 0.0.7

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>;
+  }>;
 };
 ```
 
@@ -177,7 +183,15 @@ const project = new studion.Project('demo-project', {
 
 ### Database
 
-RDS Postgres instance.
+AWS RDS Postgres instance.
+
+Features:
+
+- enabled encryption with a symmetric encryption key
+- deployed inside a private subnet
+- backup enabled with retention period set to 14 days
+
+<br>
 
 ```ts
 new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions);
@@ -200,12 +214,31 @@ type DatabaseArgs = {
   allocatedStorage?: pulumi.Input<number>;
   maxAllocatedStorage?: pulumi.Input<number>;
   instanceClass?: pulumi.Input<string>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
 ### Redis
 
-Upstash Redis instance.
+[Upstash](https://upstash.com) Redis instance.
+
+**Prerequisites**
+
+1. Stack Config
+
+| Name              |     Description     | Secret |
+| :---------------- | :-----------------: | :----: |
+| upstash:email \*  | Upstash user email. |  true  |
+| upstash:apiKey \* |  Upstash API key.   |  true  |
+
+```bash
+$ pulumi config set --secret upstash:email myemail@example.com
+$ pulumi config set --secret upstash:apiKey my-api-key
+```
+
+<br>
 
 ```ts
 new Redis(name: string, args: RedisArgs, opts: RedisOptions);
@@ -230,7 +263,16 @@ interface RedisOptions extends pulumi.ComponentResourceOptions {
 
 ### Static Site
 
-A static site that will be deployed using S3 + Cloudfront.
+AWS S3 + Cloudfront static site.
+
+Features:
+
+- creates TLS certificate for the specified domain
+- redirects HTTP traffic to HTTPS
+- enables http2 and http3 protocols
+- uses North America and Europe edge locations
+
+<br>
 
 ```ts
 new StaticSite(name: string, args: StaticSiteArgs, opts?: pulumi.ComponentResourceOptions );
@@ -246,12 +288,25 @@ new StaticSite(name: string, args: StaticSiteArgs, opts?: pulumi.ComponentResour
 type StaticSiteArgs = {
   domain: pulumi.Input<string>;
   hostedZoneId: pulumi.Input<string>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
 ### Web Server
 
-A web server that will be deployed to ECS Fargate service with autoscaling enabled.
+AWS ECS Fargate web server.
+
+Features:
+
+- Memory and CPU autoscaling enabled
+- creates TLS certificate for the specified domain
+- redirects HTTP traffic to HTTPS
+- creates CloudWatch log group
+- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
+
+<br>
 
 ```ts
 new WebServer(name: string, args: WebServerArgs, opts?: pulumi.ComponentResourceOptions );
@@ -281,6 +336,9 @@ export type WebServerArgs = {
     pulumi.Input<RoleInlinePolicy>[]
   >;
   taskRoleInlinePolicies?: pulumi.Input<pulumi.Input<RoleInlinePolicy>[]>;
+  tags?: pulumi.Input<{
+    [key: string]: pulumi.Input<string>;
+  }>;
 };
 ```
 
@@ -310,7 +368,7 @@ aws ecs execute-command  \
   --interactive
 ```
 
-Where the `CLUSTER_NAME` is the name of the ECS cluster and `TASK_FAMILY_NAME` is the name of the task family that task belongs to.
+Where `CLUSTER_NAME` is the name of the ECS cluster and `TASK_FAMILY_NAME` is the name of the task family that task belongs to.
 
 ## SSM Connect
 
@@ -403,4 +461,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.d.ts

@@ -38,6 +38,12 @@ export type DatabaseArgs = {
      * The instance type of the RDS instance.
      */
     instanceClass?: pulumi.Input<string>;
+    /**
+     * A map of tags to assign to the resource.
+     */
+    tags?: pulumi.Input<{
+        [key: string]: pulumi.Input<string>;
+    }>;
 };
 export declare class Database extends pulumi.ComponentResource {
     instance: aws.rds.Instance;

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',
@@ -57,6 +58,7 @@ class Database extends pulumi.ComponentResource {
             finalSnapshotIdentifier: `${name}-final-snapshot`,
             backupWindow: '06:00-06:30',
             backupRetentionPeriod: 14,
+            tags: argsWithDefaults.tags,
         }, { parent: this });
         this.registerOutputs();
     }

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

@@ -4,6 +4,9 @@ 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>;
+    }>;
 };
 export declare class Ec2SSMConnect extends pulumi.ComponentResource {
     ec2SecurityGroup: aws.ec2.SecurityGroup;

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

@@ -67,9 +67,7 @@ class Ec2SSMConnect extends pulumi.ComponentResource {
             iamInstanceProfile: ssmProfile.name,
             subnetId,
             vpcSecurityGroupIds: [this.ec2SecurityGroup.id],
-            tags: {
-                Name: `${name}-ec2`,
-            },
+            tags: Object.assign({ Name: `${name}-ec2` }, args.tags),
         }, { parent: this });
         this.ssmVpcEndpoint = new aws.ec2.VpcEndpoint(`${name}-ssm-vpc-endpoint`, {
             vpcId: args.vpc.vpcId,

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>;
@@ -29,10 +28,8 @@ export type WebServerService = {
     type: 'WEB_SERVER';
     environment?: aws.ecs.KeyValuePair[] | ((services: Services) => aws.ecs.KeyValuePair[]);
 } & ServiceArgs & Omit<WebServerArgs, 'cluster' | 'vpc' | 'hostedZoneId' | 'environment'>;
-export type Environment = (typeof Environment)[keyof typeof 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,10 +33,9 @@ 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) {
@@ -82,7 +81,9 @@ class Project extends pulumi.ComponentResource {
         });
     }
     createWebServerPrerequisites() {
-        this.cluster = new aws.ecs.Cluster(`${this.name}-cluster`, { name: this.name }, { parent: this });
+        this.cluster = new aws.ecs.Cluster(`${this.name}-cluster`, {
+            name: this.name,
+        }, { parent: this });
     }
     createDatabaseService(options) {
         const { serviceName, type } = options, databaseOptions = __rest(options, ["serviceName", "type"]);

package/dist/components/static-site.d.ts

@@ -11,6 +11,12 @@ export type StaticSiteArgs = {
      * The ID of the hosted zone.
      */
     hostedZoneId: pulumi.Input<string>;
+    /**
+     * A map of tags to assign to the resource.
+     */
+    tags?: pulumi.Input<{
+        [key: string]: pulumi.Input<string>;
+    }>;
 };
 export declare class StaticSite extends pulumi.ComponentResource {
     certificate: AcmCertificate;

package/dist/components/static-site.js

@@ -17,6 +17,7 @@ class StaticSite extends pulumi.ComponentResource {
                 indexDocument: 'index.html',
                 errorDocument: 'index.html',
             },
+            tags: args.tags,
         }, { parent: this });
         const bucketPublicAccessBlock = new aws.s3.BucketPublicAccessBlock(`${name}-bucket-access-block`, {
             bucket: bucket.id,
@@ -86,6 +87,7 @@ class StaticSite extends pulumi.ComponentResource {
             restrictions: {
                 geoRestriction: { restrictionType: 'none' },
             },
+            tags: args.tags,
         }, { parent: this });
         const cdnAliasRecord = new aws.route53.Record(`${name}-cdn-route53-record`, {
             type: 'A',

package/dist/components/web-server.d.ts

@@ -70,6 +70,12 @@ export type WebServerArgs = {
     healtCheckPath?: pulumi.Input<string>;
     taskExecutionRoleInlinePolicies?: pulumi.Input<pulumi.Input<RoleInlinePolicy>[]>;
     taskRoleInlinePolicies?: pulumi.Input<pulumi.Input<RoleInlinePolicy>[]>;
+    /**
+     * A map of tags to assign to the resource.
+     */
+    tags?: pulumi.Input<{
+        [key: string]: pulumi.Input<string>;
+    }>;
 };
 export declare class WebServer extends pulumi.ComponentResource {
     certificate: AcmCertificate;

package/dist/components/web-server.js

@@ -138,7 +138,7 @@ class WebServer extends pulumi.ComponentResource {
             inlinePolicies: argsWithDefaults.taskExecutionRoleInlinePolicies,
         }, { parent: this });
         const execCmdInlinePolicy = {
-            name: 'ecs-exec',
+            name: `${name}-ecs-exec`,
             policy: JSON.stringify({
                 Version: '2012-10-17',
                 Statement: [
@@ -219,6 +219,7 @@ class WebServer extends pulumi.ComponentResource {
                     },
                 ]);
             }),
+            tags: argsWithDefaults.tags,
         }, { parent: this });
         this.serviceSecurityGroup = new aws.ec2.SecurityGroup(`${name}-security-group`, {
             vpcId: argsWithDefaults.vpc.vpcId,
@@ -258,6 +259,7 @@ class WebServer extends pulumi.ComponentResource {
                 subnets: argsWithDefaults.vpc.publicSubnetIds,
                 securityGroups: [this.serviceSecurityGroup.id],
             },
+            tags: argsWithDefaults.tags,
         }, {
             parent: this,
             dependsOn: [

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.5",
+  "version": "0.0.7",
   "description": "Studion common infra components",
   "keywords": [
     "infrastructure",