Docs for InfluxDB provider and database resource

This commit is contained in:
Martin Atkins 2015-10-10 21:24:54 -07:00 committed by Paul Hinze
parent 1c07e0de21
commit 7061448d74
5 changed files with 101 additions and 0 deletions

View File

@ -23,6 +23,7 @@ body.layout-dyn,
body.layout-github,
body.layout-google,
body.layout-heroku,
body.layout-influxdb,
body.layout-mailgun,
body.layout-mysql,
body.layout-openstack,

View File

@ -0,0 +1,40 @@
---
layout: "influxdb"
page_title: "Provider: InfluxDB"
sidebar_current: "docs-influxdb-index"
description: |-
The InfluxDB provider configures databases, etc on an InfluxDB server.
---
# InfluxDB Provider
The InfluxDB provider allows Terraform to create Databases in
[InfluxDB](https://influxdb.com/). InfluxDB is a database server optimized
for time-series data.
The provider configuration block accepts the following arguments:
* ``url`` - (Optional) The root URL of a InfluxDB server. May alternatively be
set via the ``INFLUXDB_URL`` environment variable. Defaults to
`http://localhost:8086/`.
* ``username`` - (Optional) The name of the user to use when making requests.
May alternatively be set via the ``INFLUXDB_USERNAME`` environment variable.
* ``password`` - (Optional) The password to use when making requests.
May alternatively be set via the ``INFLUXDB_PASSWORD`` environment variable.
Use the navigation to the left to read about the available resources.
## Example Usage
```
provider "influxdb" {
url = "http://influxdb.example.com/"
username = "terraform"
}
resource "influxdb_database" "metrics" {
name = "awesome_app"
}
```

View File

@ -0,0 +1,30 @@
---
layout: "influxdb"
page_title: "InfluxDB: influxdb_database"
sidebar_current: "docs-influxdb-resource-database"
description: |-
The influxdb_database resource allows an InfluxDB database to be created.
---
# influxdb\_database
The database resource allows a database to be created on an InfluxDB server.
## Example Usage
```
resource "influxdb_database" "metrics" {
name = "awesome_app"
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name for the database. This must be unique on the
InfluxDB server.
## Attributes Reference
This resource exports no further attributes.

View File

@ -197,6 +197,10 @@
<a href="/docs/providers/heroku/index.html">Heroku</a>
</li>
<li<%= sidebar_current("docs-providers-influxdb") %>>
<a href="/docs/providers/influxdb/index.html">InfluxDB</a>
</li>
<li<%= sidebar_current("docs-providers-mailgun") %>>
<a href="/docs/providers/mailgun/index.html">Mailgun</a>
</li>

View File

@ -0,0 +1,26 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<div class="docs-sidebar hidden-print affix-top" role="complementary">
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-home") %>>
<a href="/docs/providers/index.html">&laquo; Documentation Home</a>
</li>
<li<%= sidebar_current("docs-influxdb-index") %>>
<a href="/docs/providers/influxdb/index.html">InfluxDB Provider</a>
</li>
<li<%= sidebar_current(/^docs-influxdb-resource/) %>>
<a href="#">Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-influxdb-resource-database") %>>
<a href="/docs/providers/influxdb/r/database.html">influxdb_database</a>
</li>
</ul>
</li>
</ul>
</div>
<% end %>
<%= yield %>
<% end %>