From cfb8f8326a81e1a6f48c9e902847540d84f18ca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Wed, 15 Mar 2017 15:25:47 +0100 Subject: [PATCH] Add documentation for rancher_host (#12693) --- .../providers/rancher/r/host.html.markdown | 36 +++++++++++++++++++ website/source/layouts/rancher.erb | 3 ++ 2 files changed, 39 insertions(+) create mode 100644 website/source/docs/providers/rancher/r/host.html.markdown diff --git a/website/source/docs/providers/rancher/r/host.html.markdown b/website/source/docs/providers/rancher/r/host.html.markdown new file mode 100644 index 000000000..382d8ac86 --- /dev/null +++ b/website/source/docs/providers/rancher/r/host.html.markdown @@ -0,0 +1,36 @@ +--- +layout: "rancher" +page_title: "Rancher: rancher_host" +sidebar_current: "docs-rancher-resource-host" +description: |- + Provides a Rancher Host resource. This can be used to manage and delete hosts on Rancher. +--- + +# rancher\_host + +Provides a Rancher Host resource. This can be used to manage and delete hosts on Rancher. + +## Example usage + +```hcl +# Manage an existing Rancher host +resource rancher_host "foo" { + name = "foo" + description = "The foo node" + environment_id = "1a5" + hostname = "foo.example.com" + labels { + role = "database" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required) The name of the host. +* `description` - (Optional) A host description. +* `environment_id` - (Required) The ID of the environment the host is associated to. +* `hostname` - (Required) The host name. Used as the primary key to detect the host ID. +* `labels` - (Optional) A dictionary of labels to apply to the host. Computed internal labels are excluded from that list. diff --git a/website/source/layouts/rancher.erb b/website/source/layouts/rancher.erb index 48a6d25d4..b25a468b4 100644 --- a/website/source/layouts/rancher.erb +++ b/website/source/layouts/rancher.erb @@ -19,6 +19,9 @@ > rancher_environment + > + rancher_host + > rancher_registration_token