packer-cn/website/source/docs/builders/profitbricks.html.md

84 lines
2.5 KiB
Markdown
Raw Normal View History

---
2017-06-14 21:04:16 -04:00
description: 'The ProfitBricks builder is able to create images for ProfitBricks cloud.'
layout: docs
2017-06-14 21:04:16 -04:00
page_title: 'ProfitBricks - Builders'
sidebar_current: 'docs-builders-profitbricks'
---
# ProfitBricks Builder
Type: `profitbricks`
2018-10-26 20:02:51 -04:00
The ProfitBricks Builder is able to create virtual machines for
[ProfitBricks](https://www.profitbricks.com).
## Configuration Reference
There are many configuration options available for the builder. They are
segmented below into two categories: required and optional parameters. Within
each category, the available configuration keys are alphabetized.
In addition to the options listed here, a
[communicator](/docs/templates/communicator.html) can be configured for this
builder.
### Required
2018-10-26 20:02:51 -04:00
- `image` (string) - ProfitBricks volume image. Only Linux public images are
supported. To obtain full list of available images you can use
[ProfitBricks CLI](https://github.com/profitbricks/profitbricks-cli#image).
2018-10-26 20:02:51 -04:00
- `password` (string) - ProfitBricks password. This can be specified via
environment variable \`PROFITBRICKS\_PASSWORD', if provided. The value
defined in the config has precedence over environemnt variable.
2016-08-31 07:55:11 -04:00
2018-10-26 20:02:51 -04:00
- `username` (string) - ProfitBricks username. This can be specified via
environment variable \`PROFITBRICKS\_USERNAME', if provided. The value
defined in the config has precedence over environemnt variable.
### Optional
2016-07-07 04:28:46 -04:00
2018-10-26 20:02:51 -04:00
- `cores` (number) - Amount of CPU cores to use for this build. Defaults to
"4".
2018-10-26 20:02:51 -04:00
- `disk_size` (string) - Amount of disk space for this image in GB. Defaults
to "50"
2018-10-26 20:02:51 -04:00
- `disk_type` (string) - Type of disk to use for this image. Defaults to
"HDD".
2017-06-14 21:04:16 -04:00
- `location` (string) - Defaults to "us/las".
- `ram` (number) - Amount of RAM to use for this image. Defaults to "2048".
2016-11-15 18:17:30 -05:00
2018-10-26 20:02:51 -04:00
- `retries` (string) - Number of retries Packer will make status requests
while waiting for the build to complete. Default value 120 seconds.
2018-10-26 20:02:51 -04:00
- `snapshot_name` (string) - If snapshot name is not provided Packer will
generate it
2017-06-14 21:04:16 -04:00
- `snapshot_password` (string) - Password for the snapshot.
2018-10-26 20:02:51 -04:00
- `url` (string) - Endpoint for the ProfitBricks REST API. Default URL
"<https://api.profitbricks.com/rest/v2>"
2016-07-07 04:28:46 -04:00
## Example
Here is a basic example:
2016-07-07 04:28:46 -04:00
2017-06-14 21:04:16 -04:00
``` json
{
"builders": [
{
"image": "Ubuntu-16.04",
"type": "profitbricks",
"disk_size": "5",
"snapshot_name": "double",
"snapshot_password": "test1234",
2016-11-17 15:15:28 -05:00
"ssh_username" :"root",
"timeout": 100
}
]
}
2017-02-02 04:24:45 -05:00
```