Skip to content

Commit

Permalink
DO-1545: update the readme and add the Acknowledgments section
Browse files Browse the repository at this point in the history
  • Loading branch information
krishanthisera committed Nov 9, 2023
1 parent 4f9cba5 commit 281a152
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion packages/prerender-fargate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ To use the PrerenderFargate construct, you can instantiate it with suitable Prer

- The maximum number of Fargate instances to run.

### `minInstanceCount` (number, optional)

- The minimum number of Fargate instances to run.

### `instanceCPU` (number, optional)

- The amount of CPU to allocate to each Fargate instance.
Expand All @@ -66,12 +70,20 @@ To use the PrerenderFargate construct, you can instantiate it with suitable Prer

### `enableS3Endpoint` (boolean, optional)

- Whether to enable the S3 endpoint for the VPC.
- Whether to enable the [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html) for S3.

### `tokenUrlAssociation` (PrerenderTokenUrlAssociationOptions, optional)

- Configuration for associating tokens with specific domain URLs. During the recaching process, these tokens will be used to validate the request.

### `prerenderFargateScalingOptions` (PrerenderFargateScalingOptions, optional)

- This allows to alter the scaling behavior. The default configuration should be sufficient for most of the cases.

### `prerenderFargateRecachingOptions` (PrerenderFargateRecachingOptions, optional)

- This allows to alter the re-caching behavior. The default configuration should be sufficient.

## Example

Here's an example of how to use the PrerenderFargate construct in a TypeScript CDK application:
Expand Down Expand Up @@ -105,9 +117,23 @@ export class RagPrerenderStackStack extends Stack {
token2: ["https://example1.com", "https:acme.example1.com"],
},
ssmPathPrefix: "/prerender/recache/tokens",
prerenderFargateRecachingOptions: {
maxConcurrentExecutions: 1,
},
prerenderFargateScalingOptions: {
healthCheckGracePeriod: 20,
healthCheckInterval: 30,
unhealthyThresholdCount: 3,
scaleInCooldown: 120,
scaleOutCooldown: 60,
},
});
}
}
```

## Acknowledgements

- [prerender.io](https://prerender.io/) - The Prerender service.

[Prerender]:https://github.com/prerender/prerender

0 comments on commit 281a152

Please sign in to comment.