Add force-unlock command to the docs

This commit is contained in:
James Bardin 2017-02-13 14:15:40 -05:00
parent fb025d4046
commit 1a9869b1af
4 changed files with 41 additions and 4 deletions

View File

@ -0,0 +1,31 @@
---
layout: "docs"
page_title: "Command: force-unlock"
sidebar_current: "docs-commands-force-unlock"
description: |-
The `terraform force-unlock` manually unlocks the Terraform state
---
# Command: force-unlock
Manually unlock the state for the defined configuration.
This will not modify your infrastructure. This command removes the lock on the
state for the current configuration. The behavior of this lock is dependent
on the backend being used. Local state files cannot be unlocked by another
process.
## Usage
Usage: terraform force-unlock [DIR]
Manually unlock the state for the defined configuration.
This will not modify your infrastructure. This command removes the lock on the
state for the current configuration. The behavior of this lock is dependent
on the backend being used. Local state files cannot be unlocked by another
process.
Options:
* `-force` - Don't ask for input for unlock confirmation.

View File

@ -34,15 +34,15 @@ Common commands:
console Interactive console for Terraform interpolations
destroy Destroy Terraform-managed infrastructure
fmt Rewrites config files to canonical format
force-unlock Manually unlock the terraform state
get Download and install modules for the configuration
graph Create a visual graph of Terraform resources
import Import existing infrastructure into Terraform
init Initializes Terraform configuration from a module
init Initialize a new or existing Terraform configuration
output Read an output from a state file
plan Generate and show an execution plan
push Upload this Terraform module to Atlas to run
refresh Update local state file against real resources
remote Configure remote state storage
show Inspect Terraform state or plan
taint Manually mark a resource for recreation
untaint Manually unmark a resource as tainted

View File

@ -52,17 +52,18 @@ other commands, please read the help and docs before usage.
Common commands:
apply Builds or changes infrastructure
console Interactive console for Terraform interpolations
destroy Destroy Terraform-managed infrastructure
fmt Rewrites config files to canonical format
force-unlock Manually unlock the terraform state
get Download and install modules for the configuration
graph Create a visual graph of Terraform resources
import Import existing infrastructure into Terraform
init Initializes Terraform configuration from a module
init Initialize a new or existing Terraform configuration
output Read an output from a state file
plan Generate and show an execution plan
push Upload this Terraform module to Atlas to run
refresh Update local state file against real resources
remote Configure remote state storage
show Inspect Terraform state or plan
taint Manually mark a resource for recreation
untaint Manually unmark a resource as tainted
@ -70,6 +71,7 @@ Common commands:
version Prints the Terraform version
All other commands:
debug Debug output management (experimental)
state Advanced state management
```

View File

@ -83,6 +83,10 @@
<a href="/docs/commands/fmt.html">fmt</a>
</li>
<li<%= sidebar_current("docs-commands-force-unlock") %>>
<a href="/docs/commands/force-unlock.html">force-unlock</a>
</li>
<li<%= sidebar_current("docs-commands-get") %>>
<a href="/docs/commands/get.html">get</a>
</li>