github.com/StackPointCloud/packer@v0.10.2-0.20180716202532-b28098e0f79b/website/source/docs/builders/scaleway.html.md (about)

     1  ---
     2  layout: docs
     3  sidebar_current: docs-builders-scaleway
     4  page_title: Scaleway - Builders
     5  description: |-
     6    The Scaleway Packer builder is able to create new images for use with
     7    Scaleway BareMetal and Virtual cloud server. The builder takes a source
     8    image, runs any provisioning necessary on the image after launching it, then
     9    snapshots it into a reusable image. This reusable image can then be used as
    10    the foundation of new servers that are launched within Scaleway.
    11  ---
    12  
    13  
    14  # Scaleway Builder
    15  
    16  Type: `scaleway`
    17  
    18  The `scaleway` Packer builder is able to create new images for use with
    19  [Scaleway](https://www.scaleway.com). The builder takes a source image,
    20  runs any provisioning necessary on the image after launching it, then snapshots
    21  it into a reusable image. This reusable image can then be used as the foundation
    22  of new servers that are launched within Scaleway.
    23  
    24  The builder does *not* manage snapshots. Once it creates an image, it is up to you
    25  to use it or delete it.
    26  
    27  ## Configuration Reference
    28  
    29  There are many configuration options available for the builder. They are
    30  segmented below into two categories: required and optional parameters. Within
    31  each category, the available configuration keys are alphabetized.
    32  
    33  In addition to the options listed here, a
    34  [communicator](/docs/templates/communicator.html) can be configured for this
    35  builder.
    36  
    37  ### Required:
    38      
    39  
    40  -   `api_access_key` (string) - The organization access key to use to identify your
    41      organization. It can also be specified via environment variable
    42      `SCALEWAY_API_ACCESS_KEY`. Your access key is available in the
    43      ["Credentials" section](https://cloud.scaleway.com/#/credentials) of the
    44      control panel.
    45  
    46  -   `api_token` (string) - The token to use to authenticate with your
    47      account. It can also be specified via environment variable
    48      `SCALEWAY_API_TOKEN`. You can see and generate tokens in the
    49      ["Credentials" section](https://cloud.scaleway.com/#/credentials) of the
    50      control panel.
    51  
    52  -   `image` (string) - The UUID of the base image to use. This is the image
    53      that will be used to launch a new server and provision it. See
    54      <https://api-marketplace.scaleway.com/images> get the complete list of the
    55      accepted image UUID.
    56  
    57  -   `region` (string) - The name of the region to launch the server in (`par1`
    58      or `ams1`). Consequently, this is the region where the snapshot will be
    59      available.
    60  
    61  -   `commercial_type` (string) - The name of the server commercial type:
    62        `ARM64-128GB`,`ARM64-16GB`,`ARM64-2GB`,`ARM64-32GB`,`ARM64-4GB`, `ARM64-64GB`,
    63        `ARM64-8GB`,`C1`,`C2L`,`C2M`,`C2S`,`START1-L`,`START1-M`,`START1-S`,`START1-XS`,
    64        `X64-120GB`,`X64-15GB`,`X64-30GB`,`X64-60GB`
    65  
    66  ### Optional:
    67  
    68  -   `server_name` (string) - The name assigned to the server. Default
    69      `packer-UUID`
    70  
    71  -   `image_name` (string) - The name of the resulting image that will appear in
    72      your account. Default `packer-TIMESTAMP`
    73  
    74  -   `snapshot_name` (string) - The name of the resulting snapshot that will
    75      appear in your account. Default `packer-TIMESTAMP`
    76  
    77  -   `bootscript` (string) - The id of an existing bootscript to use when booting
    78      the server.
    79  
    80  ## Basic Example
    81  
    82  Here is a basic example. It is completely valid as soon as you enter your own
    83  access tokens:
    84  
    85  ```json
    86  {
    87    "type": "scaleway",
    88    "api_access_key": "YOUR API ACCESS KEY",
    89    "api_token": "YOUR TOKEN",
    90    "image": "UUID OF THE BASE IMAGE",
    91    "region": "par1",
    92    "commercial_type": "START1-S",
    93    "ssh_username": "root",
    94    "ssh_private_key_file": "~/.ssh/id_rsa"
    95  }
    96  ```
    97  
    98  When you do not specified the `ssh_private_key_file`, a temporarily SSH keypair
    99  is generated to connect the server. This key will only allow the `root` user to
   100  connect the server.