Skip to content

Commit ae7e570

Browse files
Update README.md (#22)
* Update README.md * Update README.md
1 parent 6b8a914 commit ae7e570

File tree

1 file changed

+46
-13
lines changed

1 file changed

+46
-13
lines changed

README.md

+46-13
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,63 @@
11
# Description
2-
Cloud agnostic, enterprise grade, bulletproof, battle tested IaC skeleton for SaaS solutions.
2+
Cloud agnostic IaC based SaaS skeleton.
33
![Infrastructure Instance](ii.png)
44

55
## Features
6-
Framework:
7-
* supports AWS, Azure, GCP, Digitalocean provider
8-
* provides Multi-tenancy feature via layers architecture
9-
* implements nested configurations for Infrastructure Instance and Environments
6+
Framework
7+
* supports AWS, DO (Azure, GCP - in progress)
8+
* provides Multi-tenancy feature via layers architecture (provider, network, managed, appl, tenant)
9+
* implements easy-to-construct multiple environment approach (single env var)
1010
* is based on IaC (Terraform)
11-
* includes support of multiple backend providers - Local, Cloud, Remote, PG, S3
11+
* supports of multiple backend providers - Local, Cloud (PG, S3 - in progress)
1212

1313
## Quick start
1414
* Install [tln](https://www.npmjs.com/package/tln-cli)
15-
* Goto **projects** and clone repository
15+
* Goto **projects** folder from tln-cli installation above and clone repository
1616
```
17-
git clone [email protected]:project-talan/tln-clouds.git
17+
git clone --depth 1 --branch v23.7.0 [email protected]:project-talan/tln-clouds.git
1818
```
19-
* Use **.env.template** files as an examples and fill it with actual values (create .env file at repository root level and inside every provider: do, aws, azure, gcp folders)
20-
* NOTE. Commands below assume that Terraform Cloud is used as a storage for states
21-
* Commands below will guide you to configure k8s infrastructure usign DO. By replacing <do> with <aws> you can have AWS based infrastructure
19+
* Use **.env.template** file as an examples and fill it with actual values
20+
* root .env
21+
```
22+
TF_VAR_org_id=project-talan
23+
TF_VAR_project_id=tln-clouds
24+
TF_VAR_env_id=dev
25+
#TF_VAR_tenant_id=
26+
27+
TF_TOKEN_app_terraform_io=<your_token>
28+
```
29+
* do/.env
30+
```
31+
DIGITALOCEAN_TOKEN=<your_token>
32+
33+
TF_VAR_do_region=nyc3
34+
TF_VAR_do_k8s_version=1.27.4-do.0
35+
TF_VAR_do_k8s_nodes_min=1
36+
TF_VAR_do_k8s_nodes_max=2
37+
TF_VAR_do_k8s_nodes_size=s-2vcpu-2gb
38+
```
39+
* aws/.env
40+
```
41+
AWS_ACCESS_KEY_ID=<your_token>
42+
AWS_SECRET_ACCESS_KEY=<your_token>
43+
AWS_SESSION_TOKEN=
2244
45+
AWS_DEFAULT_REGION=eu-central-1
46+
47+
TF_VAR_aws_k8s_version=1.27
48+
TF_VAR_aws_k8s_nodes_min=1
49+
TF_VAR_aws_k8s_nodes_desired=2
50+
TF_VAR_aws_k8s_nodes_max=3
51+
TF_VAR_aws_k8s_nodes_size=t3a.medium
52+
TF_VAR_aws_k8s_nodes_disk=50
53+
```
54+
* NOTE. Commands below assume that Terraform Cloud is used as a storage for states
55+
* Next commands will guide you to configure k8s infrastructure usign DO. By replacing **do** with **aws** you can have AWS based infrastructure
2356
* Install dependencies
2457
```
2558
tln install do --depends
2659
```
27-
* Construct DO Dev infrastructure i
60+
* Construct DO Dev infrastructure instance
2861
```
2962
tln construct do -- --backend cloud --init --plan --apply
3063
```
@@ -49,5 +82,5 @@ Framework:
4982
```
5083
* Deconstruct DO Dev infrastructure instance
5184
```
52-
tln deconstruct do -- --backend cloud --init --plan --apply
85+
tln deconstruct do -- --backend cloud --plan --apply
5386
```

0 commit comments

Comments
 (0)