Skip to content

Commit 4d65464

Browse files
authored
Simplify Readme (#557)
1 parent e944716 commit 4d65464

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,13 @@ Run this once (in the directory containing `main.tf`) to download the `required_
109109

110110
```
111111
terraform init
112+
export TF_LOG_PROVIDER=INFO
112113
```
113114

114115
### Run Task
115116

116117
```
117-
TF_LOG_PROVIDER=INFO terraform apply
118+
terraform apply
118119
```
119120

120121
This launches a `machine` in the `cloud`, uploads `workdir`, and runs the `script`. Upon completion (or error), the `machine` is terminated.
@@ -126,14 +127,14 @@ With spot/preemptible instances (`spot >= 0`), auto-recovery logic and persisten
126127
Results and logs are periodically synced to persistent cloud storage. To query this status and view logs:
127128

128129
```
129-
TF_LOG_PROVIDER=INFO terraform refresh
130-
TF_LOG_PROVIDER=INFO terraform show
130+
terraform refresh
131+
terraform show
131132
```
132133

133134
### End Task
134135

135136
```
136-
TF_LOG_PROVIDER=INFO terraform destroy
137+
terraform destroy
137138
```
138139

139140
This terminates the `machine` (if still running), downloads `output`, and removes the persistent `disk_size` storage.

docs/guides/authentication.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Environment variables are the only supported authentication method, and should b
88

99
```bash
1010
export GOOGLE_APPLICATION_CREDENTIALS_DATA="$(cat service_account.json)"
11-
TF_LOG_PROVIDER=INFO terraform apply
11+
export TF_LOG_PROVIDER=INFO
12+
terraform apply
1213
```
1314

1415
## Amazon Web Services

docs/guides/getting-started.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ project/
8181

8282
```console
8383
$ terraform init
84+
$ export TF_LOG_PROVIDER=INFO
8485
```
8586

8687
This command will check `main.tf` and download the required TPI plugin.
@@ -90,7 +91,7 @@ This command will check `main.tf` and download the required TPI plugin.
9091
## Run Task
9192

9293
```console
93-
$ TF_LOG_PROVIDER=INFO terraform apply
94+
$ terraform apply
9495
```
9596

9697
This command will:
@@ -110,9 +111,11 @@ With spot/preemptible instances (`spot >= 0`), auto-recovery logic and persisten
110111

111112
## Query Status
112113

114+
-> **Note:** Ensure that `TF_LOG_PROVIDER=INFO` is set to properly view logs.
115+
113116
```console
114-
$ TF_LOG_PROVIDER=INFO terraform refresh
115-
$ TF_LOG_PROVIDER=INFO terraform show
117+
$ terraform refresh
118+
$ terraform show
116119
```
117120

118121
These commands will:
@@ -123,7 +126,7 @@ These commands will:
123126
## End Task
124127

125128
```console
126-
$ TF_LOG_PROVIDER=INFO terraform destroy
129+
$ terraform destroy
127130
```
128131

129132
This command will:

0 commit comments

Comments
 (0)