Document persistent storage

Author: MiroDojkic

README.md

@@ -171,6 +171,14 @@ export type WebServerServiceOptions = {
   }>;
   size?: pulumi.Input<Size>;
   healthCheckPath?: pulumi.Input<string>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   taskExecutionRoleInlinePolicies?: pulumi.Input<
     pulumi.Input<RoleInlinePolicy>[]
   >;
@@ -219,6 +227,14 @@ type MongoServiceOptions = {
   password?: pulumi.Input<string>;
   port?: pulumi.Input<number>;
   size?: pulumi.Input<Size>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   tags?: pulumi.Input<{
     [key: string]: pulumi.Input<string>;
   }>;
@@ -233,7 +249,14 @@ type EcsServiceOptions = {
   port: pulumi.Input<number>;
   enableServiceAutoDiscovery: pulumi.Input<boolean>;
   lbTargetGroupArn?: aws.lb.TargetGroup['arn'];
-  persistentStorageVolumePath?: pulumi.Input<string>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   securityGroup?: aws.ec2.SecurityGroup;
   assignPublicIp?: pulumi.Input<boolean>;
   dockerCommand?: pulumi.Input<string[]>;
@@ -339,6 +362,37 @@ const project = new studion.Project('demo-project', {
 });
 ```
 
+### Persistent Storage Configuration
+
+Services that require persistent storage (e.g. `ECS`, `Mongo`) can be configured with multiple EFS volumes and mount points.
+Currently, only one access point is configured, with root directory set to `/data`.
+The configuration consists of two main parts:
+
+1. `volumes`: Define the EFS volumes to be created
+2. `mountPoints`: Specify where these volumes should be mounted in the container
+
+Example configuration:
+
+```ts
+persistentStorageConfig: {
+  volumes: [
+    { name: 'data-volume' },
+    { name: 'config-volume' }
+  ],
+  mountPoints: [
+    {
+      sourceVolume: 'data-volume',
+      containerPath: '/data',
+    },
+    {
+      sourceVolume: 'config-volume',
+      containerPath: '/config',
+      readOnly: true
+    }
+  ]
+}
+```
+
 ### Database
 
 AWS RDS Postgres instance.
@@ -559,6 +613,14 @@ export type WebServerArgs = {
   environment?: aws.ecs.KeyValuePair[];
   secrets?: aws.ecs.Secret[];
   healthCheckPath?: pulumi.Input<string>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   taskExecutionRoleInlinePolicies?: pulumi.Input<
     pulumi.Input<RoleInlinePolicy>[]
   >;
@@ -655,6 +717,14 @@ export type MongoArgs = {
   password?: pulumi.Input<string>;
   port?: pulumi.Input<number>;
   size?: pulumi.Input<Size>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   tags?: pulumi.Input<{
     [key: string]: pulumi.Input<string>;
   }>;
@@ -665,6 +735,8 @@ If the password is not specified it will be autogenerated.
 The Mongo password is stored as a secret inside AWS Secret Manager.
 The secret will be available on the `Mongo` resource as `password.secret`.
 
+The Mongo component comes with a default persistent storage configuration that mounts an EFS volume `mongo` to `/data/db`. You can override this by providing your own `persistentStorageConfig`.
+
 ### Ecs Service
 
 AWS ECS Fargate.
@@ -708,7 +780,14 @@ export type EcsServiceArgs = {
   environment?: aws.ecs.KeyValuePair[];
   secrets?: aws.ecs.Secret[];
   enableServiceAutoDiscovery: pulumi.Input<boolean>;
-  persistentStorageVolumePath?: pulumi.Input<string>;
+  persistentStorageConfig?: pulumi.Input<{
+    volumes: { name: string }[];
+    mountPoints: {
+      sourceVolume: string;
+      containerPath: string;
+      readOnly?: boolean;
+    }[];
+  }>;
   dockerCommand?: pulumi.Input<string[]>;
   lbTargetGroupArn?: aws.lb.TargetGroup['arn'];
   securityGroup?: aws.ec2.SecurityGroup;

src/components/mongo.ts

@@ -25,7 +25,9 @@ export type MongoArgs = Pick<
    */
   port?: pulumi.Input<number>;
   /**
-   * TODO document parameter
+   * Configuration for persistent storage using EFS volumes.
+   * By default, creates a volume named 'mongo' mounted at '/data/db'.
+   * You can override this by providing your own volume and mount point configuration.
    */
   persistentStorageConfig?: EcsServiceArgs['persistentStorageConfig']
 };