Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
minamijoyo committed Dec 20, 2019
1 parent 9434670 commit c42e033
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# tflock

Lock your Terraform state manually.

# Why

Terraform has a state lock mechanism and it works automatically. Nevertheless, I found it's useful to lock state manually when I don't want team members to touch code during refactorings of Terraform configurations.
Terraform has the `terraform force-unlock` command for when somthing goes wrong, and it doesn't provide the `terraform lock` command. It seems that this decision was by design. Not all backend types can acquire explicit lock. For more details, see https://github.com/hashicorp/terraform/issues/17203

But I want `terraform lock` command!

# Features

- Lock your Terraform state manually.

That's all.

I'm testing in Terraform 0.12 + backend type s3 (lock with dynamodb).
Other backend types may or may not work.

# Install

Required: Go 1.13+.

```
$ go get github.com/minamijoyo/tflock
```

# License
MIT

0 comments on commit c42e033

Please sign in to comment.