github.com/ratanraj/packer@v1.3.2/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  -   `api_access_key` (string) - The organization access key to use to identify your
    40      organization. It can also be specified via environment variable
    41      `SCALEWAY_API_ACCESS_KEY`. Your access key is available in the
    42      ["Credentials" section](https://cloud.scaleway.com/#/credentials) of the
    43      control panel.
    44  
    45  -   `api_token` (string) - The token to use to authenticate with your
    46      account. It can also be specified via environment variable
    47      `SCALEWAY_API_TOKEN`. You can see and generate tokens in the
    48      ["Credentials" section](https://cloud.scaleway.com/#/credentials) of the
    49      control panel.
    50  
    51  -   `image` (string) - The UUID of the base image to use. This is the image
    52      that will be used to launch a new server and provision it. See
    53      <https://api-marketplace.scaleway.com/images> get the complete list of the
    54      accepted image UUID.
    55  
    56  -   `region` (string) - The name of the region to launch the server in (`par1`
    57      or `ams1`). Consequently, this is the region where the snapshot will be
    58      available.
    59  
    60  -   `commercial_type` (string) - The name of the server commercial type:
    61        `ARM64-128GB`, `ARM64-16GB`, `ARM64-2GB`, `ARM64-32GB`, `ARM64-4GB`, `ARM64-64GB`,
    62        `ARM64-8GB`, `C1`, `C2L`, `C2M`, `C2S`, `START1-L`, `START1-M`, `START1-S`,
    63        `START1-XS`, `X64-120GB`, `X64-15GB`, `X64-30GB`, `X64-60GB`
    64  
    65  ### Optional:
    66  
    67  -   `server_name` (string) - The name assigned to the server. Default
    68      `packer-UUID`
    69  
    70  -   `image_name` (string) - The name of the resulting image that will appear in
    71      your account. Default `packer-TIMESTAMP`
    72  
    73  -   `snapshot_name` (string) - The name of the resulting snapshot that will
    74      appear in your account. Default `packer-TIMESTAMP`
    75  
    76  -   `boottype` (string) - The type of boot, can be either `local` or `bootscript`,
    77      Default `bootscript`
    78  
    79  -   `bootscript` (string) - The id of an existing bootscript to use when booting
    80      the server.
    81  
    82  ## Basic Example
    83  
    84  Here is a basic example. It is completely valid as soon as you enter your own
    85  access tokens:
    86  
    87  ```json
    88  {
    89    "type": "scaleway",
    90    "api_access_key": "YOUR API ACCESS KEY",
    91    "api_token": "YOUR TOKEN",
    92    "image": "UUID OF THE BASE IMAGE",
    93    "region": "par1",
    94    "commercial_type": "START1-S",
    95    "ssh_username": "root",
    96    "ssh_private_key_file": "~/.ssh/id_rsa"
    97  }
    98  ```
    99  
   100  When you do not specified the `ssh_private_key_file`, a temporarily SSH keypair
   101  is generated to connect the server. This key will only allow the `root` user to
   102  connect the server.