From a7e0078cf3bd7b177673d40ea9646add85976563 Mon Sep 17 00:00:00 2001 From: Petar Trutanic Date: Thu, 26 Oct 2023 16:37:46 +0200 Subject: [PATCH 1/3] Added pulumi prerequisites --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5c30bf0..4ab86b4 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,14 @@ Studion Platform common infra components. ## Table of Contents -1. [Installation](#installation) -2. [Usage](#usage) -3. [API](#api) +1. [Prerequisites](#prerequisites) +2. [Installation](#installation) +3. [Usage](#usage) +4. [API](#api) + +## Prerequisites + +- Working [Pulumi](https://www.pulumi.com/docs/get-started/) project ## Installation @@ -42,6 +47,12 @@ const project = new studion.Project('demo-project', { export const projectName = project.name; ``` +- Deploy pulumi stack + +```bash +$ pulumi up +``` + ## API 1. [Project](#project) From 870c8adfa9a2a17592e344189956eb0db4a92b55 Mon Sep 17 00:00:00 2001 From: Petar Trutanic Date: Fri, 27 Oct 2023 02:09:52 +0200 Subject: [PATCH 2/3] Added missing details --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ab86b4..494e2cf 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Studion Platform common infra components. ## Prerequisites - Working [Pulumi](https://www.pulumi.com/docs/get-started/) project +- AWS account with neccessary permissions for each studion component ## Installation @@ -94,7 +95,7 @@ type ProjectArgs = { | Argument | Description | | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------: | | services \* | Service list. | -| hostedZoneId | Route53 hosted zone ID responsible for managing records for the domain. | +| hostedZoneId | Route53 hosted zone ID responsible for managing records for the domain. Required for 'STATIC_SITE' and 'WEB_SERVER' | | 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. | ```ts From aaa89b96e59502419722e1c862f2cc62fb5ae63f Mon Sep 17 00:00:00 2001 From: Petar Trutanic Date: Fri, 27 Oct 2023 13:30:43 +0200 Subject: [PATCH 3/3] Updated link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 494e2cf..99e817d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Studion Platform common infra components. ## Prerequisites -- Working [Pulumi](https://www.pulumi.com/docs/get-started/) project +- 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 ## Installation