From e0b9961d939133867167149d2eea59a77a01e4f8 Mon Sep 17 00:00:00 2001 From: Benjamin Vickers Date: Wed, 3 Jun 2015 11:40:53 +0100 Subject: [PATCH] Update docs for Cloudstack with SSH keypair and timeout --- .../providers/cloudstack/index.html.markdown | 5 +++ .../cloudstack/r/instance.html.markdown | 2 ++ .../cloudstack/r/ssh_keypair.html.markdown | 36 +++++++++++++++++++ website/source/layouts/cloudstack.erb | 4 +++ 4 files changed, 47 insertions(+) create mode 100644 website/source/docs/providers/cloudstack/r/ssh_keypair.html.markdown diff --git a/website/source/docs/providers/cloudstack/index.html.markdown b/website/source/docs/providers/cloudstack/index.html.markdown index 3fe42b98a..0738370b6 100644 --- a/website/source/docs/providers/cloudstack/index.html.markdown +++ b/website/source/docs/providers/cloudstack/index.html.markdown @@ -43,3 +43,8 @@ The following arguments are supported: * `secret_key` - (Required) This is the CloudStack secret key. It must be provided, but it can also be sourced from the `CLOUDSTACK_SECRET_KEY` environment variable. + +* `timeout` - (Optional) A value in seconds. This is the time allowed for Cloudstack + to complete each asynchronous job triggered. If unset, this can be sourced from the + `CLOUDSTACK_TIMEOUT` environment variable. Otherwise, this will default to 300 + seconds. diff --git a/website/source/docs/providers/cloudstack/r/instance.html.markdown b/website/source/docs/providers/cloudstack/r/instance.html.markdown index e09cd6c6e..403c64d4b 100644 --- a/website/source/docs/providers/cloudstack/r/instance.html.markdown +++ b/website/source/docs/providers/cloudstack/r/instance.html.markdown @@ -48,6 +48,8 @@ The following arguments are supported: * `user_data` - (Optional) The user data to provide when launching the instance. +* `keypair` - (Optional) The name of the SSH keypair that will be used to access this instance. + * `expunge` - (Optional) This determines if the instance is expunged when it is destroyed (defaults false) diff --git a/website/source/docs/providers/cloudstack/r/ssh_keypair.html.markdown b/website/source/docs/providers/cloudstack/r/ssh_keypair.html.markdown new file mode 100644 index 000000000..4ad95c702 --- /dev/null +++ b/website/source/docs/providers/cloudstack/r/ssh_keypair.html.markdown @@ -0,0 +1,36 @@ +--- +layout: "cloudstack" +page_title: "CloudStack: cloudstack_ssh_keypair" +sidebar_current: "docs-cloudstack-resource-ssh-keypair" +description: |- + Creates or registers an SSH keypair. +--- + +# cloudstack\_ssh\_keypair + +Creates or registers an SSH keypair. + +## Example Usage + +``` +resource "cloudstack_ssh_keypair" "myKey" { + name = "myKey" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required) The name to give the SSH keypair. This is a unique value within a Cloudstack account. + +* `public_key` - (Optional) The full public key text of this keypair. If this is omitted, Cloudstack + will generate a new keypair. + +## Attributes Reference + +The following attributes are exported: + +* `id` - The keypair ID. This is set to the keypair `name` argument. +* `fingerprint` - The fingerprint of the public key specified or calculated. +* `private_key` - This is returned only if Cloudstack generated the keypair. diff --git a/website/source/layouts/cloudstack.erb b/website/source/layouts/cloudstack.erb index d9830586c..c2051b1b7 100644 --- a/website/source/layouts/cloudstack.erb +++ b/website/source/layouts/cloudstack.erb @@ -53,6 +53,10 @@ cloudstack_port_forward + > + cloudstack_ssh_keypair + + > cloudstack_template