Skip to content

Commit a06ea0a

Browse files
committed
cleaning up readme
1 parent bd3e60e commit a06ea0a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,22 @@
4242
- `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-databricks-aws-workspace/tags" alt="GitHub tag">
4343
<img src="https://img.shields.io/github/v/tag/tomarv2/terraform-databricks-aws-workspace" /></a> in your releases)
4444

45-
**NOTE:**
45+
---
46+
## Usage
4647

47-
- Read more on [tfremote](https://github.com/tomarv2/tfremote)
48+
### Option 1:
4849

49-
## Usage
50+
```
51+
terrafrom init
52+
terraform plan -var='teamid=tryme' -var='prjid=project1'
53+
terraform apply -var='teamid=tryme' -var='prjid=project1'
54+
terraform destroy -var='teamid=tryme' -var='prjid=project1'
55+
```
56+
**Note:** With this option please take care of remote state storage
57+
58+
### Option 2:
5059

51-
Recommended method:
60+
#### Recommended method (store remote state in S3 using prjid and teamid to create directory structure):
5261

5362
- Create python 3.6+ virtual environment
5463
```
@@ -67,7 +76,7 @@ export TF_AWS_PROFILE=default
6776
export TF_AWS_BUCKET_REGION=us-west-2
6877
```
6978

70-
- Updated `examples` directory to required values.
79+
- Updated `examples` directory with required values.
7180

7281
- Run and verify the output before deploying:
7382
```
@@ -84,18 +93,9 @@ tf -cloud aws apply -var='teamid=foo' -var='prjid=bar'
8493
tf -cloud aws destroy -var='teamid=foo' -var='prjid=bar'
8594
```
8695

87-
> ❗️ **Important** - Two variables are required for using `tf` package:
88-
>
89-
> - teamid
90-
> - prjid
91-
>
92-
> These variables are required to set backend path in the remote storage.
93-
> Variables can be defined using:
94-
>
95-
> - As `inline variables` e.g.: `-var='teamid=demo-team' -var='prjid=demo-project'`
96-
> - Inside `.tfvars` file e.g.: `-var-file=<tfvars file location> `
97-
>
98-
> For more information refer to [Terraform documentation](https://www.terraform.io/docs/language/values/variables.html)
96+
**NOTE:**
97+
98+
- Read more on [tfremote](https://github.com/tomarv2/tfremote)
9999

100100
```
101101
module "databricks_workspace" {
@@ -117,7 +117,7 @@ Please refer to examples directory [link](examples) for references.
117117

118118
## Coming up:
119119

120-
- Use [Customer Managed VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html)
120+
- **Use** [**Customer Managed VPC**](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html)
121121

122122
## Troubleshooting:
123123

0 commit comments

Comments
 (0)