resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doc state/http supports_locking

This commit is contained in:
Ross McFarland 2017-08-13 09:49:49 -07:00
parent 6cdea5af5d
commit 06b4b509d7
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/docs/backends/types/http.html.md
View File

@ -8,12 +8,17 @@ description: |-
# http
**Kind: Standard (with no locking)**
**Kind: Standard (with optional locking)**
Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client.
State will be fetched via GET, updated via POST, and purged with DELETE.
If locking is enabled a lock POST request will be made by appending `/lock` to the configured address with the lock info in the
body as json. The endpiont should return a 409 Conflict with the holding lock info when it's already taken, 200 OK for success.
Any other status will be considered an error. Unlocking works simillarly, appending `/unlock` and adding the `ID` of the lock
being freed as a query parameter. An `ID` query parameter will also be added when sending state updates.
## Example Usage
```hcl
@ -44,3 +49,5 @@ The following configuration options are supported:
* `password` - (Optional) The password for HTTP basic authentication
* `skip_cert_verification` - (Optional) Whether to skip TLS verification.
Defaults to `false`.
* `supports_locking` - (Optional) Whether to enable locking related calls
Defaults to `false`.