@studion/infra-code-blocks 0.5.1 → 0.5.3

package/README.md

@@ -12,7 +12,7 @@ Studion Platform common infra components.
 ## Prerequisites
 
 - Working [Pulumi](https://www.pulumi.com/docs/clouds/aws/get-started/begin/#pulumi-aws-before-you-begin) project
-- AWS account with neccessary permissions for each studion component
+- AWS account with necessary permissions for each Studion component
 
 ## Installation
 
@@ -48,7 +48,7 @@ const project = new studion.Project('demo-project', {
 export const projectName = project.name;
 ```
 
-- Deploy pulumi stack
+- Deploy Pulumi stack
 
 ```bash
 $ pulumi up
@@ -71,7 +71,7 @@ $ pulumi up
 Project component makes it really easy to spin up project infrastructure,
 hiding infrastructure complexity.
 <br>
-The component creates its own VPC which is used for resources within the project.
+The component creates its own VPC used for resources within the project.
 
 ```ts
 new Project(name: string, args: ProjectArgs, opts?: pulumi.CustomResourceOptions);
@@ -102,7 +102,7 @@ type ProjectArgs = {
 | Argument         |                                                                         Description                                                                          |
 | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------: |
 | services \*      |                                                                        Service list.                                                                         |
-| 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. |
+| enableSSMConnect | Set up 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. |
 | numberOfAvailabilityZones | Default is 2 which is recommended. If building a dev server, we can reduce to 1 availability zone to reduce hosting cost. |
 
 ```ts
@@ -257,7 +257,7 @@ type EcsServiceOptions = {
 
 Often, web server depends on other services such as database, Redis, etc.
 For that purpose, environment factory can be used. The factory function
-recieves services bag as argument.
+receives services bag as argument.
 
 ```ts
 const project = new studion.Project('demo-project', {
@@ -287,7 +287,7 @@ const project = new studion.Project('demo-project', {
 });
 ```
 
-In order to pass sensitive information to the container use `secrets` instead of `environment`. AWS will fetch values from
+In order to pass sensitive information to the container, use `secrets` instead of `environment`. AWS will fetch values from
 Secret Manager based on arn that is provided for the `valueFrom` field.
 
 ```ts
@@ -379,7 +379,7 @@ type DatabaseArgs = {
 };
 ```
 
-If the password is not specified it will be autogenerated.
+If the password is not specified, it will be autogenerated.
 The database password is stored as a secret inside AWS Secret Manager.
 The secret will be available on the `Database` resource as `password.secret`.
 
@@ -407,8 +407,8 @@ new DatabaseReplica(name: string, args: DatabaseReplicaArgs, opts?: pulumi.Custo
 ```ts
 type DatabaseReplicaArgs = {
   replicateSourceDb: pulumi.Input<string>;
-  dbSubnetGroupName: pulumi.Input<string>;
   dbSecurityGroupId: pulumi.Input<string>;
+  dbSubnetGroupName?: pulumi.Input<string>;
   monitoringRole?: aws.iam.Role;
   multiAz?: pulumi.Input<boolean>;
   applyImmediately?: pulumi.Input<boolean>;
@@ -421,7 +421,15 @@ type DatabaseReplicaArgs = {
   }>;
 };
 ```
-Database replica requires primary DB instance to exist.
+Database replica requires primary DB instance to exist. If the replica is in the same
+region as primary instance, we should not set `dbSubnetGroupNameParam`.
+The `replicateSourceDb` param is referenced like this:
+```javascript
+  const primaryDb = new studion.Database(...);
+  const replica = new studion.DatabaseReplica('replica', {
+    replicateSourceDb: primaryDb.instance.identifier
+  });
+```
 
 ### Redis
 
@@ -510,7 +518,7 @@ Features:
 - 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`
+- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
 
 <br>
 
@@ -565,7 +573,7 @@ Features:
 - 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`
+- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
 - CDN in front of the application load balancer for static resource caching
 
 <br>
@@ -616,7 +624,7 @@ Features:
 - persistent storage
 - service auto-discovery
 - creates CloudWatch log group
-- comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
+- comes with predefined CPU and memory options: `small`, `medium`, `large`, `xlarge`
 
 <br>
 
@@ -648,7 +656,7 @@ export type MongoArgs = {
 ```
 
 If the password is not specified it will be autogenerated.
-The mongo password is stored as a secret inside AWS Secret Manager.
+The Mongo password is stored as a secret inside AWS Secret Manager.
 The secret will be available on the `Mongo` resource as `password.secret`.
 
 ### Ecs Service
@@ -658,7 +666,7 @@ AWS ECS Fargate.
 Features:
 
 - memory and CPU autoscaling
-- service auto discovery
+- service auto-discovery
 - persistent storage
 - CloudWatch logs
 - comes with predefined cpu and memory options: `small`, `medium`, `large`, `xlarge`
@@ -739,7 +747,7 @@ Where `CLUSTER_NAME` is the name of the ECS cluster and `TASK_FAMILY_NAME` is th
 
 ## SSM Connect
 
-The [Database](#database) component deploys a database instance inside a isolated subnet,
+The [Database](#database) component deploys a database instance inside an isolated subnet,
 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
@@ -788,7 +796,7 @@ 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 are port forwarding traffic from
+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`.
 

package/dist/components/database-replica.d.ts

@@ -10,7 +10,7 @@ export type DatabaseReplicaArgs = {
      * * If primary DB is instance of studion:Database, it can be accessed as
      * `db.dbSubnetGroup.name`.
      */
-    dbSubnetGroupName: pulumi.Input<string>;
+    dbSubnetGroupName?: pulumi.Input<string>;
     /**
      * DB security group ID. Should be the same as primary instance.
      * If primary DB is instance of studion:Database, it can be accessed as

package/dist/components/database-replica.js

@@ -7,7 +7,6 @@ const constants_1 = require("../constants");
 const defaults = {
     multiAz: false,
     applyImmediately: false,
-    skipFinalSnapshot: false,
     allocatedStorage: 20,
     maxAllocatedStorage: 100,
     instanceClass: 'db.t4g.micro',
@@ -33,7 +32,7 @@ class DatabaseReplica extends pulumi.ComponentResource {
                 performanceInsightsRetentionPeriod: 7,
             }
             : {};
-        const instance = new aws.rds.Instance(`${this.name}-rds`, Object.assign(Object.assign({ identifierPrefix: `${this.name}-`, engine: 'postgres', engineVersion: '15.5', allocatedStorage: argsWithDefaults.allocatedStorage, maxAllocatedStorage: argsWithDefaults.maxAllocatedStorage, instanceClass: argsWithDefaults.instanceClass, dbSubnetGroupName: argsWithDefaults.dbSubnetGroupName, vpcSecurityGroupIds: [argsWithDefaults.dbSecurityGroupId], storageEncrypted: true, multiAz: argsWithDefaults.multiAz, publiclyAccessible: false, applyImmediately: argsWithDefaults.applyImmediately, autoMinorVersionUpgrade: true, maintenanceWindow: 'Mon:07:00-Mon:07:30', replicateSourceDb: argsWithDefaults.replicateSourceDb, parameterGroupName: argsWithDefaults.parameterGroupName }, monitoringOptions), { tags: Object.assign(Object.assign({}, constants_1.commonTags), argsWithDefaults.tags) }), { parent: this });
+        const instance = new aws.rds.Instance(`${this.name}-rds`, Object.assign(Object.assign({ identifierPrefix: `${this.name}-`, engine: 'postgres', engineVersion: '15.5', allocatedStorage: argsWithDefaults.allocatedStorage, maxAllocatedStorage: argsWithDefaults.maxAllocatedStorage, instanceClass: argsWithDefaults.instanceClass, dbSubnetGroupName: argsWithDefaults.dbSubnetGroupName, vpcSecurityGroupIds: [argsWithDefaults.dbSecurityGroupId], storageEncrypted: true, multiAz: argsWithDefaults.multiAz, publiclyAccessible: false, applyImmediately: argsWithDefaults.applyImmediately, autoMinorVersionUpgrade: true, maintenanceWindow: 'Mon:07:00-Mon:07:30', replicateSourceDb: argsWithDefaults.replicateSourceDb, parameterGroupName: argsWithDefaults.parameterGroupName, skipFinalSnapshot: true }, monitoringOptions), { tags: Object.assign(Object.assign({}, constants_1.commonTags), argsWithDefaults.tags) }), { parent: this });
         return instance;
     }
 }

package/package.json

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