github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/profitbricks/index.html.markdown (about)

     1  ---
     2  layout: "profitbricks"
     3  page_title: "Provider: ProfitBricks"
     4  sidebar_current: "docs-profitbricks-index"
     5  description: |-
     6    A provider for ProfitBricks.
     7  ---
     8  
     9  # ProfitBricks Provider
    10  
    11  The ProfitBricks provider gives the ability to deploy and configure resources using ProfitBricks Cloud API.
    12  
    13  Use the navigation to the left to read about the available resources.
    14  
    15  
    16  ## Usage
    17  
    18  The provider needs to be configured with proper credentials before it can be used.
    19  
    20  
    21  ```hcl
    22  $ export PROFITBRICKS_USERNAME="profitbricks_username"
    23  $ export PROFITBRICKS_PASSWORD="profitbricks_password"
    24  $ export PROFITBRICKS_API_URL="profitbricks_rest_url"
    25  ```
    26  
    27  Or you can provide your credentials like this:
    28  
    29  
    30  The credentials provided in `.tf` file will override credentials in the environment variables.
    31  
    32  ## Example Usage
    33  
    34  
    35  ```hcl
    36  provider "profitbricks" {
    37    username = "profitbricks_username"
    38    password = "profitbricks_password"
    39    endpoint = "profitbricks_rest_url"
    40    retries  = 100
    41  }
    42  
    43  resource "profitbricks_datacenter" "main" {
    44    # ...
    45  }
    46  ```
    47  
    48  
    49  ## Configuration Reference
    50  
    51  The following arguments are supported:
    52  
    53  * `username` - (Required) If omitted, the `PROFITBRICKS_USERNAME` environment variable is used.
    54  
    55  * `password` - (Required) If omitted, the `PROFITBRICKS_PASSWORD` environment variable is used.
    56  
    57  * `endpoint` - (Required) If omitted, the `PROFITBRICKS_API_URL` environment variable is used.
    58  
    59  * `retries` - (Optional) Number of retries while waiting for a resource to be provisioned. Default value is 50.
    60  
    61  
    62  #Support
    63  You are welcome to contact us with questions or comments at [ProfitBricks DevOps Central](https://devops.profitbricks.com/).