terraform/website/source/layouts/docs.erb

508 lines
16 KiB
Plaintext
Raw Normal View History

2014-07-16 23:51:48 +02:00
<% wrap_layout :inner do %>
2015-07-02 04:48:25 +02:00
<% 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/index.html">Documentation Home</a>
</li>
<li<%= sidebar_current(/^docs-config/) %>>
<a href="/docs/configuration/index.html">Configuration</a>
<ul class="nav">
<li<%= sidebar_current("docs-config-load") %>>
<a href="/docs/configuration/load.html">Load Order and Semantics</a>
</li>
<li<%= sidebar_current("docs-config-syntax") %>>
<a href="/docs/configuration/syntax.html">Configuration Syntax</a>
</li>
<li<%= sidebar_current("docs-config-interpolation") %>>
<a href="/docs/configuration/interpolation.html">Interpolation Syntax</a>
</li>
<li<%= sidebar_current("docs-config-override") %>>
<a href="/docs/configuration/override.html">Overrides</a>
</li>
<li<%= sidebar_current("docs-config-resources") %>>
<a href="/docs/configuration/resources.html">Resources</a>
</li>
<li<%= sidebar_current("docs-config-data-sources") %>>
<a href="/docs/configuration/data-sources.html">Data Sources</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-config-providers") %>>
<a href="/docs/configuration/providers.html">Providers</a>
</li>
<li<%= sidebar_current("docs-config-variables") %>>
<a href="/docs/configuration/variables.html">Variables</a>
</li>
<li<%= sidebar_current("docs-config-outputs") %>>
<a href="/docs/configuration/outputs.html">Outputs</a>
</li>
<li<%= sidebar_current("docs-config-modules") %>>
<a href="/docs/configuration/modules.html">Modules</a>
</li>
2016-11-13 07:50:28 +01:00
<li<%= sidebar_current("docs-config-terraform") %>>
<a href="/docs/configuration/terraform.html">Terraform</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-config-atlas") %>>
<a href="/docs/configuration/atlas.html">Atlas</a>
</li>
<li<%= sidebar_current("docs-config-environment-variables") %>>
<a href="/docs/configuration/environment-variables.html">Environment Variables</a>
</li>
</ul>
</li>
<li<%= sidebar_current(/^docs-commands/) %>>
<a href="/docs/commands/index.html">Commands (CLI)</a>
<ul class="nav">
<li<%= sidebar_current("docs-commands-apply") %>>
<a href="/docs/commands/apply.html">apply</a>
</li>
2016-11-14 07:57:28 +01:00
<li<%= sidebar_current("docs-commands-console") %>>
<a href="/docs/commands/console.html">console</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-destroy") %>>
<a href="/docs/commands/destroy.html">destroy</a>
</li>
<li<%= sidebar_current("docs-commands-fmt") %>>
<a href="/docs/commands/fmt.html">fmt</a>
</li>
2017-02-13 20:15:40 +01:00
<li<%= sidebar_current("docs-commands-force-unlock") %>>
<a href="/docs/commands/force-unlock.html">force-unlock</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-get") %>>
<a href="/docs/commands/get.html">get</a>
</li>
<li<%= sidebar_current("docs-commands-graph") %>>
<a href="/docs/commands/graph.html">graph</a>
</li>
2016-05-18 20:56:51 +02:00
<li<%= sidebar_current("docs-commands-import") %>>
<a href="/docs/commands/import.html">import</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-init") %>>
<a href="/docs/commands/init.html">init</a>
</li>
<li<%= sidebar_current("docs-commands-output") %>>
<a href="/docs/commands/output.html">output</a>
</li>
<li<%= sidebar_current("docs-commands-plan") %>>
<a href="/docs/commands/plan.html">plan</a>
2015-07-02 04:50:26 +02:00
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-push") %>>
<a href="/docs/commands/push.html">push</a>
</li>
<li<%= sidebar_current("docs-commands-refresh") %>>
<a href="/docs/commands/refresh.html">refresh</a>
2015-07-02 04:50:26 +02:00
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-remote") %>>
<a href="/docs/commands/remote.html">remote</a>
</li>
<li<%= sidebar_current("docs-commands-show") %>>
<a href="/docs/commands/show.html">show</a>
</li>
<li<%= sidebar_current("docs-commands-state") %>>
<a href="/docs/commands/state/index.html">state</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-commands-taint") %>>
<a href="/docs/commands/taint.html">taint</a>
</li>
2015-11-05 15:47:08 +01:00
<li<%= sidebar_current("docs-commands-validate") %>>
<a href="/docs/commands/validate.html">validate</a>
</li>
<li<%= sidebar_current("docs-commands-untaint") %>>
<a href="/docs/commands/untaint.html">untaint</a>
</li>
2015-07-02 04:48:25 +02:00
</ul>
</li>
2016-05-18 20:47:41 +02:00
<li<%= sidebar_current(/^docs-import/) %>>
<a href="/docs/import/index.html">Import</a>
<ul class="nav">
<li<%= sidebar_current("docs-import-usage") %>>
<a href="/docs/import/usage.html">Usage</a>
</li>
<li<%= sidebar_current("docs-import-importability") %>>
<a href="/docs/import/importability.html">Resource Importability</a>
</li>
</ul>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current(/^docs-state/) %>>
<a href="/docs/state/index.html">State</a>
<ul class="nav">
<li<%= sidebar_current("docs-state-purpose") %>>
<a href="/docs/state/purpose.html">Purpose</a>
</li>
2016-05-18 20:47:41 +02:00
<li<%= sidebar_current("docs-state-import") %>>
<a href="/docs/state/import.html">Import Existing Resources</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-state-remote") %>>
<a href="/docs/state/remote/index.html">Remote State</a>
2015-07-02 04:48:25 +02:00
</li>
</ul>
</li>
<li<%= sidebar_current(/^docs-providers/) %>>
<a href="/docs/providers/index.html">Providers</a>
2015-07-02 04:50:26 +02:00
<ul class="nav">
<li<%= sidebar_current("docs-providers-alicloud") %>>
<a href="/docs/providers/alicloud/index.html">Alicloud</a>
</li>
<li<%= sidebar_current("docs-providers-archive") %>>
<a href="/docs/providers/archive/index.html">Archive</a>
</li>
<li<%= sidebar_current("docs-providers-arukas") %>>
<a href="/docs/providers/arukas/index.html">Arukas</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-atlas") %>>
<a href="/docs/providers/atlas/index.html">Atlas</a>
2015-07-02 04:50:26 +02:00
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-aws") %>>
<a href="/docs/providers/aws/index.html">AWS</a>
</li>
<li<%= sidebar_current("docs-providers-bitbucket") %>>
<a href="/docs/providers/bitbucket/index.html">Bitbucket</a>
2015-07-02 04:48:25 +02:00
</li>
<li<%= sidebar_current("docs-providers-clc") %>>
<a href="/docs/providers/clc/index.html">CenturyLinkCloud</a>
</li>
<li<%= sidebar_current("docs-providers-chef") %>>
<a href="/docs/providers/chef/index.html">Chef</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-cloudflare") %>>
<a href="/docs/providers/cloudflare/index.html">CloudFlare</a>
2015-07-02 04:50:26 +02:00
</li>
2015-07-02 04:48:25 +02:00
2015-07-02 04:50:26 +02:00
<li<%= sidebar_current("docs-providers-cloudstack") %>>
2015-07-02 04:48:25 +02:00
<a href="/docs/providers/cloudstack/index.html">CloudStack</a>
2015-07-02 04:50:26 +02:00
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-cobbler") %>>
<a href="/docs/providers/cobbler/index.html">Cobbler</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-consul") %>>
<a href="/docs/providers/consul/index.html">Consul</a>
</li>
2016-02-08 10:00:00 +01:00
<li<%= sidebar_current("docs-providers-datadog") %>>
<a href="/docs/providers/datadog/index.html">Datadog</a>
2016-02-08 10:00:00 +01:00
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-do") %>>
<a href="/docs/providers/do/index.html">DigitalOcean</a>
</li>
<li<%= sidebar_current("docs-providers-dme") %>>
<a href="/docs/providers/dme/index.html">DNSMadeEasy</a>
</li>
<li<%= sidebar_current("docs-providers-dnsimple") %>>
<a href="/docs/providers/dnsimple/index.html">DNSimple</a>
</li>
<li<%= sidebar_current("docs-providers-docker") %>>
<a href="/docs/providers/docker/index.html">Docker</a>
</li>
<li<%= sidebar_current("docs-providers-dyn") %>>
<a href="/docs/providers/dyn/index.html">Dyn</a>
</li>
<li<%= sidebar_current("docs-providers-external") %>>
<a href="/docs/providers/external/index.html">External</a>
</li>
<li<%= sidebar_current("docs-providers-fastly") %>>
<a href="/docs/providers/fastly/index.html">Fastly</a>
</li>
<li<%= sidebar_current("docs-providers-github") %>>
<a href="/docs/providers/github/index.html">GitHub</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-google") %>>
<a href="/docs/providers/google/index.html">Google Cloud</a>
</li>
<li<%= sidebar_current("docs-providers-grafana") %>>
<a href="/docs/providers/grafana/index.html">Grafana</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-heroku") %>>
<a href="/docs/providers/heroku/index.html">Heroku</a>
</li>
<li<%= sidebar_current("docs-providers-icinga2") %>>
<a href="/docs/providers/icinga2/index.html">Icinga2</a>
</li>
<li<%= sidebar_current("docs-providers-ignition") %>>
<a href="/docs/providers/ignition/index.html">Ignition</a>
</li>
<li<%= sidebar_current("docs-providers-influxdb") %>>
<a href="/docs/providers/influxdb/index.html">InfluxDB</a>
</li>
2015-10-01 00:08:51 +02:00
<li<%= sidebar_current("docs-providers-librato") %>>
<a href="/docs/providers/librato/index.html">Librato</a>
</li>
<li<%= sidebar_current("docs-providers-logentries") %>>
<a href="/docs/providers/logentries/index.html">Logentries</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-mailgun") %>>
<a href="/docs/providers/mailgun/index.html">Mailgun</a>
</li>
<li<%= sidebar_current("docs-providers-newrelic") %>>
<a href="/docs/providers/newrelic/index.html">New Relic</a>
</li>
Ns1 provider (#10782) * vendor: update gopkg.in/ns1/ns1-go.v2 * provider/ns1: Port the ns1 provider to Terraform core * docs/ns1: Document the ns1 provider * ns1: rename remaining nsone -> ns1 (#10805) * Ns1 provider (#11300) * provider/ns1: Flesh out support for meta structs. Following the structure outlined by @pashap. Using reflection to reduce copy/paste. Putting metas inside single-item lists. This is clunky, but I couldn't figure out how else to have a nested struct. Maybe the Terraform people know a better way? Inside the meta struct, all fields are always written to the state; I can't figure out how to omit fields that aren't used. This is not just verbose, it actually causes issues because you can't have both "up" and "up_feed" set). Also some minor other changes: - Add "terraform" import support to records and zones. - Create helper class StringEnum. * provider/ns1: Make fmt * provider/ns1: Remove stubbed out RecordRead (used for testing metadata change). * provider/ns1: Need to get interface that m contains from Ptr Value with Elem() * provider/ns1: Use empty string to indicate no feed given. * provider/ns1: Remove old record.regions fields. * provider/ns1: Removes redundant testAccCheckRecordState * provider/ns1: Moves account permissions logic to permissions.go * provider/ns1: Adds tests for team resource. * provider/ns1: Move remaining permissions logic to permissions.go * ns1/provider: Adds datasource.config * provider/ns1: Small clean up of datafeed resource tests * provider/ns1: removes testAccCheckZoneState in favor of explicit name check * provider/ns1: More renaming of nsone -> ns1 * provider/ns1: Comment out metadata for the moment. * Ns1 provider (#11347) * Fix the removal of empty containers from a flatmap Removal of empty nested containers from a flatmap would sometimes fail a sanity check when removed in the wrong order. This would only fail sometimes due to map iteration. There was also an off-by-one error in the prefix check which could match the incorrect keys. * provider/ns1: Adds ns1 go client through govendor. * provider/ns1: Removes unused debug line * docs/ns1: Adds docs around apikey/datasource/datafeed/team/user/record. * provider/ns1: Gets go vet green
2017-01-23 22:41:07 +01:00
<li<%= sidebar_current("docs-providers-nomad") %>>
<a href="/docs/providers/nomad/index.html">Nomad</a>
</li>
<li<%= sidebar_current("docs-providers-ns1") %>>
<a href="/docs/providers/ns1/index.html">NS1</a>
</li>
<li<%= sidebar_current("docs-providers-azurerm") %>>
<a href="/docs/providers/azurerm/index.html">Microsoft Azure</a>
</li>
<li<%= sidebar_current("docs-providers-azurerm") %>>
<a href="/docs/providers/azure/index.html">Microsoft Azure (Legacy ASM)</a>
</li>
<li<%= sidebar_current("docs-providers-mysql") %>>
<a href="/docs/providers/mysql/index.html">MySQL</a>
</li>
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-openstack") %>>
<a href="/docs/providers/openstack/index.html">OpenStack</a>
</li>
<li<%= sidebar_current("docs-providers-opsgenie") %>>
<a href="/docs/providers/opsgenie/index.html">OpsGenie</a>
</li>
2015-10-09 23:42:36 +02:00
<li<%= sidebar_current("docs-providers-packet") %>>
<a href="/docs/providers/packet/index.html">Packet</a>
</li>
2016-10-16 03:52:45 +02:00
<li<%= sidebar_current("docs-providers-pagerduty") %>>
<a href="/docs/providers/pagerduty/index.html">PagerDuty</a>
</li>
<li<%= sidebar_current("docs-providers-postgresql") %>>
<a href="/docs/providers/postgresql/index.html">PostgreSQL</a>
</li>
<li<%= sidebar_current("docs-providers-powerdns") %>>
<a href="/docs/providers/powerdns/index.html">PowerDNS</a>
</li>
<li<%= sidebar_current("docs-providers-profitbricks") %>>
<a href="/docs/providers/profitbricks/index.html">ProfitBricks</a>
</li>
2016-07-20 22:18:44 +02:00
<li<%= sidebar_current("docs-providers-rabbitmq") %>>
<a href="/docs/providers/rabbitmq/index.html">RabbitMQ</a>
</li>
<li<%= sidebar_current("docs-providers-rancher") %>>
<a href="/docs/providers/rancher/index.html">Rancher</a>
</li>
<li<%= sidebar_current("docs-providers-random") %>>
<a href="/docs/providers/random/index.html">Random</a>
</li>
<li<%= sidebar_current("docs-providers-rundeck") %>>
<a href="/docs/providers/rundeck/index.html">Rundeck</a>
</li>
<li<%= sidebar_current("docs-providers-scaleway") %>>
<a href="/docs/providers/scaleway/index.html">Scaleway</a>
</li>
<li<%= sidebar_current("docs-providers-softlayer") %>>
<a href="/docs/providers/softlayer/index.html">SoftLayer</a>
</li>
<li<%= sidebar_current("docs-providers-statuscake") %>>
<a href="/docs/providers/statuscake/index.html">StatusCake</a>
</li>
Add scaleway provider (#7331) * Add scaleway provider this PR allows the entire scaleway stack to be managed with terraform example usage looks like this: ``` provider "scaleway" { api_key = "snap" organization = "snip" } resource "scaleway_ip" "base" { server = "${scaleway_server.base.id}" } resource "scaleway_server" "base" { name = "test" # ubuntu 14.04 image = "aecaed73-51a5-4439-a127-6d8229847145" type = "C2S" } resource "scaleway_volume" "test" { name = "test" size_in_gb = 20 type = "l_ssd" } resource "scaleway_volume_attachment" "test" { server = "${scaleway_server.base.id}" volume = "${scaleway_volume.test.id}" } resource "scaleway_security_group" "base" { name = "public" description = "public gateway" } resource "scaleway_security_group_rule" "http-ingress" { security_group = "${scaleway_security_group.base.id}" action = "accept" direction = "inbound" ip_range = "0.0.0.0/0" protocol = "TCP" port = 80 } resource "scaleway_security_group_rule" "http-egress" { security_group = "${scaleway_security_group.base.id}" action = "accept" direction = "outbound" ip_range = "0.0.0.0/0" protocol = "TCP" port = 80 } ``` Note that volume attachments require the server to be stopped, which can lead to downtimes of you attach new volumes to already used servers * Update IP read to handle 404 gracefully * Read back resource on update * Ensure IP detachment works as expected Sadly this is not part of the official scaleway api just yet * Adjust detachIP helper based on feedback from @QuentinPerez in https://github.com/scaleway/scaleway-cli/pull/378 * Cleanup documentation * Rename api_key to access_key following @stack72 suggestion and rename the provider api_key for more clarity * Make tests less chatty by using custom logger
2016-07-13 22:03:41 +02:00
2015-07-02 04:48:25 +02:00
<li<%= sidebar_current("docs-providers-template") %>>
<a href="/docs/providers/template/index.html">Template</a>
</li>
<li<%= sidebar_current("docs-providers-terraform") %>>
<a href="/docs/providers/terraform/index.html">Terraform</a>
</li>
<li<%= sidebar_current("docs-providers-tls") %>>
<a href="/docs/providers/tls/index.html">TLS</a>
</li>
<li<%= sidebar_current("docs-providers-triton") %>>
<a href="/docs/providers/triton/index.html">Triton</a>
</li>
2015-07-04 10:26:13 +02:00
<li<%= sidebar_current("docs-providers-ultradns") %>>
<a href="/docs/providers/ultradns/index.html">UltraDNS</a>
</li>
<li<%= sidebar_current("docs-providers-vault") %>>
<a href="/docs/providers/vault/index.html">Vault</a>
</li>
<li<%= sidebar_current("docs-providers-vcd") %>>
2015-11-11 08:43:36 +01:00
<a href="/docs/providers/vcd/index.html">VMware vCloud Director</a>
</li>
<li<%= sidebar_current("docs-providers-vsphere") %>>
<a href="/docs/providers/vsphere/index.html">VMware vSphere</a>
</li>
2015-07-02 04:48:25 +02:00
</ul>
</li>
<li<%= sidebar_current(/^docs-provisioners/) %>>
<a href="/docs/provisioners/index.html">Provisioners</a>
<ul class="nav">
<li<%= sidebar_current("docs-provisioners-chef") %>>
<a href="/docs/provisioners/chef.html">chef</a>
</li>
<li<%= sidebar_current("docs-provisioners-connection") %>>
<a href="/docs/provisioners/connection.html">connection</a>
</li>
<li<%= sidebar_current("docs-provisioners-file") %>>
<a href="/docs/provisioners/file.html">file</a>
</li>
<li<%= sidebar_current("docs-provisioners-local") %>>
<a href="/docs/provisioners/local-exec.html">local-exec</a>
</li>
<li<%= sidebar_current("docs-provisioners-remote") %>>
<a href="/docs/provisioners/remote-exec.html">remote-exec</a>
</li>
2015-10-27 21:28:37 +01:00
<li<%= sidebar_current("docs-provisioners-null-resource") %>>
<a href="/docs/provisioners/null_resource.html">null_resource</a>
</li>
2015-07-02 04:48:25 +02:00
</ul>
</li>
<li<%= sidebar_current(/^docs-modules/) %>>
<a href="/docs/modules/index.html">Modules</a>
<ul class="nav">
<li<%= sidebar_current("docs-modules-usage") %>>
<a href="/docs/modules/usage.html">Usage</a>
</li>
<li<%= sidebar_current("docs-modules-sources") %>>
<a href="/docs/modules/sources.html">Sources</a>
</li>
<li<%= sidebar_current("docs-modules-create") %>>
<a href="/docs/modules/create.html">Creating Modules</a>
</li>
</ul>
</li>
<li<%= sidebar_current(/^docs-plugins/) %>>
<a href="/docs/plugins/index.html">Plugins</a>
<ul class="nav">
<li<%= sidebar_current("docs-plugins-basics") %>>
<a href="/docs/plugins/basics.html">Basics</a>
</li>
<li<%= sidebar_current("docs-plugins-provider") %>>
<a href="/docs/plugins/provider.html">Provider</a>
</li>
<li<%= sidebar_current("docs-internals-plugins") %>>
<a href="/docs/internals/internal-plugins.html">Internals</a>
</li>
2015-07-02 04:48:25 +02:00
</ul>
</li>
<li<%= sidebar_current(/^docs-internals/) %>>
<a href="/docs/internals/index.html">Internals</a>
<ul class="nav">
<li<%= sidebar_current("docs-internals-debug") %>>
<a href="/docs/internals/debugging.html">Debugging Terraform</a>
</li>
<li<%= sidebar_current("docs-internals-graph") %>>
<a href="/docs/internals/graph.html">Resource Graph</a>
</li>
<li<%= sidebar_current("docs-internals-lifecycle") %>>
<a href="/docs/internals/lifecycle.html">Resource Lifecycle</a>
</li>
<li<%= sidebar_current("docs-internals-resource-addressing") %>>
<a href="/docs/internals/resource-addressing.html">Resource Addressing</a>
</li>
<li<%= sidebar_current("docs-internals-plugins") %>>
<a href="/docs/internals/internal-plugins.html">Internal Plugins</a>
</li>
2015-07-02 04:48:25 +02:00
</ul>
</li>
</ul>
</div>
<% end %>
<%= yield %>
<% end %>