499 lines
16 KiB
JSON
499 lines
16 KiB
JSON
[
|
|
{ "heading": "Terraform CLI" },
|
|
{ "title": "Overview", "path": "" },
|
|
{ "title": "Basic CLI Features", "href": "/cli/commands" },
|
|
{
|
|
"title": "Initializing Working Directories",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "init" },
|
|
{ "title": "<code>init</code>", "href": "/cli/commands/init" },
|
|
{ "title": "<code>get</code>", "href": "/cli/commands/get" }
|
|
]
|
|
},
|
|
{
|
|
"title": "Provisioning Infrastructure",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "run" },
|
|
{ "title": "<code>plan</code>", "href": "/cli/commands/plan" },
|
|
{ "title": "<code>apply</code>", "href": "/cli/commands/apply" },
|
|
{ "title": "<code>destroy</code>", "href": "/cli/commands/destroy" }
|
|
]
|
|
},
|
|
{
|
|
"title": "Authenticating",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "auth" },
|
|
{ "title": "<code>login</code>", "href": "/cli/commands/login" },
|
|
{ "title": "<code>logout</code>", "href": "/cli/commands/logout" }
|
|
]
|
|
},
|
|
{
|
|
"title": "Writing and Modifying Code",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "code" },
|
|
{ "title": "<code>console</code>", "href": "/cli/commands/console" },
|
|
{ "title": "<code>fmt</code>", "href": "/cli/commands/fmt" },
|
|
{ "title": "<code>validate</code>", "href": "/cli/commands/validate" },
|
|
{
|
|
"title": "<code>0.13upgrade</code>",
|
|
"href": "/cli/commands/0.13upgrade"
|
|
},
|
|
{
|
|
"title": "<code>0.12upgrade</code>",
|
|
"href": "/cli/commands/0.12upgrade"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Inspecting Infrastructure",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "inspect" },
|
|
{ "title": "<code>graph</code>", "href": "/cli/commands/graph" },
|
|
{ "title": "<code>output</code>", "href": "/cli/commands/output" },
|
|
{ "title": "<code>show</code>", "href": "/cli/commands/show" },
|
|
{
|
|
"title": "<code>state list</code>",
|
|
"href": "/cli/commands/state/list"
|
|
},
|
|
{
|
|
"title": "<code>state show</code>",
|
|
"href": "/cli/commands/state/show"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Importing Infrastructure",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "import" },
|
|
{
|
|
"title": "<code>import</code>",
|
|
"href": "/cli/commands/import"
|
|
},
|
|
{ "title": "Usage Tips", "path": "import/usage" },
|
|
{
|
|
"title": "Resource Importability",
|
|
"path": "import/importability"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Manipulating State",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "state" },
|
|
{
|
|
"title": "Resource Addressing",
|
|
"path": "state/resource-addressing"
|
|
},
|
|
{ "title": "<code>state</code>", "href": "/cli/commands/state" },
|
|
{
|
|
"title": "Inspecting State",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "state/inspect" },
|
|
{
|
|
"title": "<code>state list</code>",
|
|
"href": "/cli/commands/state/list"
|
|
},
|
|
{
|
|
"title": "<code>state show</code>",
|
|
"href": "/cli/commands/state/show"
|
|
},
|
|
{
|
|
"title": "<code>refresh</code>",
|
|
"href": "/cli/commands/refresh"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Forcing Re-creation (Tainting)",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "state/taint" },
|
|
{
|
|
"title": "<code>taint</code>",
|
|
"href": "/cli/commands/taint"
|
|
},
|
|
{
|
|
"title": "<code>untaint</code>",
|
|
"href": "/cli/commands/untaint"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Moving Resources",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "state/move" },
|
|
{
|
|
"title": "<code>state mv</code>",
|
|
"href": "/cli/commands/state/mv"
|
|
},
|
|
{
|
|
"title": "<code>state rm</code>",
|
|
"href": "/cli/commands/state/rm"
|
|
},
|
|
{
|
|
"title": "<code>state replace-provider</code>",
|
|
"href": "/cli/commands/state/replace-provider"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Disaster Recovery",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"path": "state/recover"
|
|
},
|
|
{
|
|
"title": "<code>state pull</code>",
|
|
"href": "/cli/commands/state/pull"
|
|
},
|
|
{
|
|
"title": "<code>state push</code>",
|
|
"href": "/cli/commands/state/push"
|
|
},
|
|
{
|
|
"title": "<code>force-unlock</code>",
|
|
"href": "/cli/commands/force-unlock"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Managing Workspaces",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "workspaces" },
|
|
{
|
|
"title": "<code>workspace</code>",
|
|
"routes": [
|
|
{ "title": "Overview", "href": "/cli/commands/workspace" },
|
|
{
|
|
"title": "<code>workspace list</code>",
|
|
"href": "/cli/commands/workspace/list"
|
|
},
|
|
{
|
|
"title": "<code>workspace select</code>",
|
|
"href": "/cli/commands/workspace/select"
|
|
},
|
|
{
|
|
"title": "<code>workspace new</code>",
|
|
"href": "/cli/commands/workspace/new"
|
|
},
|
|
{
|
|
"title": "<code>workspace delete</code>",
|
|
"href": "/cli/commands/workspace/delete"
|
|
},
|
|
{
|
|
"title": "<code>workspace show</code>",
|
|
"href": "/cli/commands/workspace/show"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Managing Plugins",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "plugins" },
|
|
{ "title": "Plugin Signing", "path": "plugins/signing" },
|
|
{
|
|
"title": "<code>providers</code>",
|
|
"href": "/cli/commands/providers"
|
|
},
|
|
{
|
|
"title": "<code>version</code>",
|
|
"href": "/cli/commands/version"
|
|
},
|
|
{
|
|
"title": "<code>providers lock</code>",
|
|
"href": "/cli/commands/providers/lock"
|
|
},
|
|
{
|
|
"title": "<code>providers mirror</code>",
|
|
"href": "/cli/commands/providers/mirror"
|
|
},
|
|
{
|
|
"title": "<code>providers schema</code>",
|
|
"href": "/cli/commands/providers/schema"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "CLI Configuration",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "config" },
|
|
{ "title": "CLI Configuration", "path": "config/config-file" },
|
|
{
|
|
"title": "Environment Variables",
|
|
"path": "config/environment-variables"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Using Terraform Cloud",
|
|
"routes": [
|
|
{ "title": "Overview", "path": "cloud" },
|
|
{ "title": "Terraform Cloud Settings", "path": "cloud/settings" },
|
|
{
|
|
"title": "Initializing and Migrating",
|
|
"path": "cloud/migrating"
|
|
},
|
|
{
|
|
"title": "Command Line Arguments",
|
|
"path": "cloud/command-line-arguments"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Automating Terraform",
|
|
"routes": [
|
|
{
|
|
"title": "Running Terraform in Automation",
|
|
"href": "https://learn.hashicorp.com/tutorials/terraform/automate-terraform?in=terraform/automation&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS"
|
|
},
|
|
{
|
|
"title": "GitHub Actions",
|
|
"href": "https://learn.hashicorp.com/tutorials/terraform/github-actions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Alphabetical List of Commands",
|
|
"routes": [
|
|
{ "title": "Overview", "href": "/cli/commands" },
|
|
{ "title": "<code>apply</code>", "href": "/cli/commands/apply" },
|
|
{ "title": "<code>console</code>", "href": "/cli/commands/console" },
|
|
{ "title": "<code>destroy</code>", "href": "/cli/commands/destroy" },
|
|
{ "title": "<code>env</code>", "href": "/cli/commands/env" },
|
|
{ "title": "<code>fmt</code>", "href": "/cli/commands/fmt" },
|
|
{
|
|
"title": "<code>force-unlock</code>",
|
|
"href": "/cli/commands/force-unlock"
|
|
},
|
|
{ "title": "<code>get</code>", "href": "/cli/commands/get" },
|
|
{ "title": "<code>graph</code>", "href": "/cli/commands/graph" },
|
|
{ "title": "<code>import</code>", "href": "/cli/commands/import" },
|
|
{ "title": "<code>init</code>", "href": "/cli/commands/init" },
|
|
{ "title": "<code>login</code>", "href": "/cli/commands/login" },
|
|
{ "title": "<code>logout</code>", "href": "/cli/commands/logout" },
|
|
{ "title": "<code>output</code>", "href": "/cli/commands/output" },
|
|
{ "title": "<code>plan</code>", "href": "/cli/commands/plan" },
|
|
{ "title": "<code>providers</code>", "href": "/cli/commands/providers" },
|
|
{
|
|
"title": "<code>providers lock</code>",
|
|
"href": "/cli/commands/providers/lock"
|
|
},
|
|
{
|
|
"title": "<code>providers mirror</code>",
|
|
"href": "/cli/commands/providers/mirror"
|
|
},
|
|
{
|
|
"title": "<code>providers schema</code>",
|
|
"href": "/cli/commands/providers/schema"
|
|
},
|
|
{
|
|
"title": "<code>push (deprecated)</code>",
|
|
"href": "/cli/commands/push"
|
|
},
|
|
{ "title": "<code>refresh</code>", "href": "/cli/commands/refresh" },
|
|
{ "title": "<code>show</code>", "href": "/cli/commands/show" },
|
|
{ "title": "<code>state</code>", "href": "/cli/commands/state" },
|
|
{
|
|
"title": "<code>state list</code>",
|
|
"href": "/cli/commands/state/list"
|
|
},
|
|
{ "title": "<code>state mv</code>", "href": "/cli/commands/state/mv" },
|
|
{
|
|
"title": "<code>state pull</code>",
|
|
"href": "/cli/commands/state/pull"
|
|
},
|
|
{
|
|
"title": "<code>state push</code>",
|
|
"href": "/cli/commands/state/push"
|
|
},
|
|
{
|
|
"title": "<code>state replace-provider</code>",
|
|
"href": "/cli/commands/state/replace-provider"
|
|
},
|
|
{ "title": "<code>state rm</code>", "href": "/cli/commands/state/rm" },
|
|
{
|
|
"title": "<code>state show</code>",
|
|
"href": "/cli/commands/state/show"
|
|
},
|
|
{ "title": "<code>taint</code>", "href": "/cli/commands/taint" },
|
|
{
|
|
"title": "<code>test (deprecated)</code>",
|
|
"href": "/cli/commands/test"
|
|
},
|
|
{ "title": "<code>untaint</code>", "href": "/cli/commands/untaint" },
|
|
{ "title": "<code>validate</code>", "href": "/cli/commands/validate" },
|
|
{ "title": "<code>version</code>", "href": "/cli/commands/version" },
|
|
{ "title": "<code>workspace</code>", "href": "/cli/commands/workspace" },
|
|
{
|
|
"title": "<code>workspace list</code>",
|
|
"href": "/cli/commands/workspace/list"
|
|
},
|
|
{
|
|
"title": "<code>workspace select</code>",
|
|
"href": "/cli/commands/workspace/select"
|
|
},
|
|
{
|
|
"title": "<code>workspace new</code>",
|
|
"href": "/cli/commands/workspace/new"
|
|
},
|
|
{
|
|
"title": "<code>workspace delete</code>",
|
|
"href": "/cli/commands/workspace/delete"
|
|
},
|
|
{
|
|
"title": "<code>workspace show</code>",
|
|
"href": "/cli/commands/workspace/show"
|
|
},
|
|
{
|
|
"title": "<code>0.12upgrade</code>",
|
|
"href": "/cli/commands/0.12upgrade"
|
|
},
|
|
{
|
|
"title": "<code>0.13upgrade</code>",
|
|
"href": "/cli/commands/0.13upgrade"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Alphabetical list of commands",
|
|
"hidden": true,
|
|
"routes": [
|
|
{ "title": "Overview", "path": "commands" },
|
|
{ "title": "apply", "path": "commands/apply" },
|
|
{ "title": "console", "path": "commands/console" },
|
|
{ "title": "destroy", "path": "commands/destroy" },
|
|
{ "title": "env", "path": "commands/env" },
|
|
{ "title": "fmt", "path": "commands/fmt" },
|
|
{ "title": "force-unlock", "path": "commands/force-unlock" },
|
|
{ "title": "get", "path": "commands/get" },
|
|
{ "title": "graph", "path": "commands/graph" },
|
|
{ "title": "import", "path": "commands/import" },
|
|
{ "title": "init", "path": "commands/init" },
|
|
{ "title": "login", "path": "commands/login" },
|
|
{ "title": "logout", "path": "commands/logout" },
|
|
{ "title": "output", "path": "commands/output" },
|
|
{ "title": "plan", "path": "commands/plan" },
|
|
{
|
|
"title": "providers",
|
|
"routes": [
|
|
{ "title": "providers", "path": "commands/providers" },
|
|
{ "title": "providers lock", "path": "commands/providers/lock" },
|
|
{ "title": "providers mirror", "path": "commands/providers/mirror" },
|
|
{ "title": "providers schema", "path": "commands/providers/schema" }
|
|
]
|
|
},
|
|
{ "title": "push (deprecated)", "path": "commands/push" },
|
|
{ "title": "refresh", "path": "commands/refresh" },
|
|
{ "title": "show", "path": "commands/show" },
|
|
{
|
|
"title": "state",
|
|
"routes": [
|
|
{ "title": "state", "path": "commands/state" },
|
|
{ "title": "state list", "path": "commands/state/list" },
|
|
{ "title": "state mv", "path": "commands/state/mv" },
|
|
{ "title": "state pull", "path": "commands/state/pull" },
|
|
{ "title": "state push", "path": "commands/state/push" },
|
|
{
|
|
"title": "state replace-provider",
|
|
"path": "commands/state/replace-provider"
|
|
},
|
|
{ "title": "state rm", "path": "commands/state/rm" },
|
|
{ "title": "state show", "path": "commands/state/show" }
|
|
]
|
|
},
|
|
{ "title": "taint", "path": "commands/taint" },
|
|
{ "title": "test (deprecated)", "path": "commands/test", "hidden": true },
|
|
{ "title": "untaint", "path": "commands/untaint" },
|
|
{ "title": "validate", "path": "commands/validate" },
|
|
{ "title": "version", "path": "commands/version" },
|
|
{
|
|
"title": "workspace",
|
|
"routes": [
|
|
{
|
|
"title": "workspace",
|
|
"path": "commands/workspace"
|
|
},
|
|
{ "title": "workspace list", "path": "commands/workspace/list" },
|
|
{ "title": "workspace select", "path": "commands/workspace/select" },
|
|
{ "title": "workspace new", "path": "commands/workspace/new" },
|
|
{ "title": "workspace delete", "path": "commands/workspace/delete" },
|
|
{ "title": "workspace show", "path": "commands/workspace/show" }
|
|
]
|
|
},
|
|
{ "title": "0.12upgrade", "path": "commands/0.12upgrade" },
|
|
{ "title": "0.13upgrade", "path": "commands/0.13upgrade" }
|
|
]
|
|
},
|
|
{
|
|
"title": "Internals",
|
|
"routes": [
|
|
{
|
|
"title": "Overview",
|
|
"href": "/internals"
|
|
},
|
|
{
|
|
"title": "Credentials Helpers",
|
|
"href": "/internals/credentials-helpers"
|
|
},
|
|
{
|
|
"title": "Debugging Terraform",
|
|
"href": "/internals/debugging"
|
|
},
|
|
{
|
|
"title": "Module Registry Protocol",
|
|
"href": "/internals/module-registry-protocol"
|
|
},
|
|
{
|
|
"title": "Provider Network Mirror Protocol",
|
|
"href": "/internals/provider-network-mirror-protocol"
|
|
},
|
|
{
|
|
"title": "Provider Registry Protocol",
|
|
"href": "/internals/provider-registry-protocol"
|
|
},
|
|
{
|
|
"title": "Resource Graph",
|
|
"href": "/internals/graph"
|
|
},
|
|
{
|
|
"title": "Resource Lifecycle",
|
|
"href": "/internals/lifecycle"
|
|
},
|
|
{
|
|
"title": "Login Protocol",
|
|
"href": "/internals/login-protocol"
|
|
},
|
|
{
|
|
"title": "JSON Output Format",
|
|
"href": "/internals/json-format"
|
|
},
|
|
{
|
|
"title": "Remote Service Discovery",
|
|
"href": "/internals/remote-service-discovery"
|
|
},
|
|
{
|
|
"title": "Provider Metadata",
|
|
"href": "/internals/provider-meta"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "Installation",
|
|
"hidden": true,
|
|
"routes": [
|
|
{
|
|
"title": "APT Packages for Debian and Ubuntu",
|
|
"path": "install/apt"
|
|
},
|
|
{
|
|
"title": "Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux",
|
|
"path": "install/yum"
|
|
}
|
|
]
|
|
}
|
|
]
|