From 561ffc16b32cfe030547f1083fecc62bd4b32940 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Thu, 24 Jul 2014 11:18:00 -0400 Subject: [PATCH] website: Document Heroku --- .../providers/heroku/r/addon.html.markdown | 9 +++- .../docs/providers/heroku/r/app.html.markdown | 41 +++++++++++++++++++ .../providers/heroku/r/domain.html.markdown | 41 +++++++++++++++++++ 3 files changed, 89 insertions(+), 2 deletions(-) create mode 100644 website/source/docs/providers/heroku/r/app.html.markdown create mode 100644 website/source/docs/providers/heroku/r/domain.html.markdown diff --git a/website/source/docs/providers/heroku/r/addon.html.markdown b/website/source/docs/providers/heroku/r/addon.html.markdown index 7198f2da4..eb7ced786 100644 --- a/website/source/docs/providers/heroku/r/addon.html.markdown +++ b/website/source/docs/providers/heroku/r/addon.html.markdown @@ -12,9 +12,14 @@ services to a Heroku app. ## Example Usage ``` +# Create a new heroku app +resource "heroku_app" "default" { + name = "test-app" +} + # Add a web-hook addon for the app resource "heroku_addon" "webhook" { - app = "${heroku_app.foobar.name}" + app = "${heroku_app.default.name}" plan = "deployhooks:http" config { url = "http://google.com" @@ -27,7 +32,7 @@ resource "heroku_addon" "webhook" { The following arguments are supported: * `app` - (Required) The Heroku app to add to. -* `plan` - (Requried) The addon to add. +* `plan` - (Required) The addon to add. * `config` - (Optional) Optional plan configuration. ## Attributes Reference diff --git a/website/source/docs/providers/heroku/r/app.html.markdown b/website/source/docs/providers/heroku/r/app.html.markdown new file mode 100644 index 000000000..377e75460 --- /dev/null +++ b/website/source/docs/providers/heroku/r/app.html.markdown @@ -0,0 +1,41 @@ +--- +layout: "heroku" +page_title: "Heroku: heroku_app" +sidebar_current: "docs-heroku-resource-app" +--- + +# heroku\_app + +Provides a Heroku App resource. This can be used to +create and manage applications on Heroku. + +## Example Usage + +``` +# Create a new heroku app +resource "heroku_app" "default" { + name = "my-cool-app" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional) The name of the Heroku app +* `region` - (Optional) The region of the Heroku app +* `stack` - (Optional) The stack for the Heroku app +* `config_vars` - (Optional) Configuration variables for the app + +## Attributes Reference + +The following attributes are exported: + +* `id` - The ID of the app +* `name` - The name of the app +* `stack` - The stack of the app +* `region` - The region of the app +* `git_url` - The Git URL for the app +* `web_url` - The Web URL for the app +* `heroku_hostname` - The Heroku URL for the app + diff --git a/website/source/docs/providers/heroku/r/domain.html.markdown b/website/source/docs/providers/heroku/r/domain.html.markdown new file mode 100644 index 000000000..b02b4b591 --- /dev/null +++ b/website/source/docs/providers/heroku/r/domain.html.markdown @@ -0,0 +1,41 @@ +--- +layout: "heroku" +page_title: "Heroku: heroku_domain" +sidebar_current: "docs-heroku-resource-domain" +--- + +# heroku\_domain + +Provides a Heroku App resource. This can be used to +create and manage applications on Heroku. + +## Example Usage + +``` +# Create a new heroku app +resource "heroku_app" "default" { + name = "test-app" +} + +# Associate a custom domain +resource "heroku_domain" "default" { + app = "${heroku_app.default.name}" + hostname = "terraform.example.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `hostname` - (Required) The hostname to serve requests from. +* `app` - (Required) The Heroku app to link to. + +## Attributes Reference + +The following attributes are exported: + +* `id` - The ID of the of the domain record +* `hostname` - The hostname traffic will be served as +* `cname` - The cname traffic should route to. +