From a478bf6f37627de814e549ed03f2c029ab38a429 Mon Sep 17 00:00:00 2001 From: abarbare Date: Wed, 7 Oct 2020 12:02:08 +0200 Subject: [PATCH] fix: update scaleway website documentation (#10058) --- builder/scaleway/config.go | 6 +-- website/pages/docs/builders/scaleway.mdx | 54 +++---------------- .../builder/scaleway/Config-required.mdx | 6 +-- 3 files changed, 11 insertions(+), 55 deletions(-) diff --git a/builder/scaleway/config.go b/builder/scaleway/config.go index 2f744986b..b55cf36f4 100644 --- a/builder/scaleway/config.go +++ b/builder/scaleway/config.go @@ -46,10 +46,8 @@ type Config struct { // get the complete list of the accepted image UUID. Image string `mapstructure:"image" required:"true"` // The name of the server commercial type: - // ARM64-128GB, ARM64-16GB, ARM64-2GB, ARM64-32GB, ARM64-4GB, - // ARM64-64GB, ARM64-8GB, C1, C2L, C2M, C2S, START1-L, - // START1-M, START1-S, START1-XS, X64-120GB, X64-15GB, X64-30GB, - // X64-60GB + // C1, C2L, C2M, C2S, DEV1-S, DEV1-M, DEV1-L, DEV1-XL, + // GP1-XS, GP1-S, GP1-M, GP1-L, GP1-XL, RENDER-S CommercialType string `mapstructure:"commercial_type" required:"true"` // The name of the resulting snapshot that will // appear in your account. Default packer-TIMESTAMP diff --git a/website/pages/docs/builders/scaleway.mdx b/website/pages/docs/builders/scaleway.mdx index a93fbdbaf..82b9f972e 100644 --- a/website/pages/docs/builders/scaleway.mdx +++ b/website/pages/docs/builders/scaleway.mdx @@ -43,52 +43,11 @@ can also be supplied to override the typical auto-generated key: ### Required: -- `organization_id` (string) - The organization id to use to identify your - organization. It can also be specified via environment variable - `SCALEWAY_ORGANIZATION`. Your organization id is available in the - ["Account" section](https://cloud.scaleway.com/#/account) of the - control panel. - Previously named: `api_access_key` with environment variable: `SCALEWAY_API_ACCESS_KEY` - -- `api_token` (string) - The token to use to authenticate with your account. - It can also be specified via environment variable `SCALEWAY_API_TOKEN`. You - can see and generate tokens in the ["Credentials" - section](https://cloud.scaleway.com/#/credentials) of the control panel. - -- `image` (string) - The UUID of the base image to use. This is the image - that will be used to launch a new server and provision it. See - [the images list](https://api-marketplace.scaleway.com/images) - get the complete list of the accepted image UUID. - -- `region` (string) - The name of the region to launch the server in (`par1` - or `ams1`). Consequently, this is the region where the snapshot will be - available. - -- `commercial_type` (string) - The name of the server commercial type: - `ARM64-128GB`, `ARM64-16GB`, `ARM64-2GB`, `ARM64-32GB`, `ARM64-4GB`, - `ARM64-64GB`, `ARM64-8GB`, `C1`, `C2L`, `C2M`, `C2S`, `START1-L`, - `START1-M`, `START1-S`, `START1-XS`, `X64-120GB`, `X64-15GB`, `X64-30GB`, - `X64-60GB` +@include 'builder/scaleway/Config-required.mdx' ### Optional: -- `server_name` (string) - The name assigned to the server. Default - `packer-UUID` - -- `image_name` (string) - The name of the resulting image that will appear in - your account. Default `packer-TIMESTAMP` - -- `snapshot_name` (string) - The name of the resulting snapshot that will - appear in your account. Default `packer-TIMESTAMP` - -- `boottype` (string) - The type of boot, can be either `local` or - `bootscript`. Default `local` - -- `bootscript` (string) - The id of an existing bootscript to use when - booting the server. - -- `remove_volume` (boolean) - Force Packer to delete volume associated with - the resulting snapshot after the build. Default `false`. +@include 'builder/scaleway/Config-not-required.mdx' ## Basic Example @@ -98,11 +57,12 @@ access tokens: ```json { "type": "scaleway", - "organization_id": "YOUR ORGANIZATION ID", - "api_token": "YOUR TOKEN", + "project_id": "YOUR PROJECT ID", + "access_key": "YOUR ACCESS KEY", + "secret_key": "YOUR SECRET KEY", "image": "UUID OF THE BASE IMAGE", - "region": "par1", - "commercial_type": "START1-S", + "zone": "fr-par-1", + "commercial_type": "DEV1-S", "ssh_username": "root", "ssh_private_key_file": "~/.ssh/id_rsa" } diff --git a/website/pages/partials/builder/scaleway/Config-required.mdx b/website/pages/partials/builder/scaleway/Config-required.mdx index f3a641d37..36d0baf86 100644 --- a/website/pages/partials/builder/scaleway/Config-required.mdx +++ b/website/pages/partials/builder/scaleway/Config-required.mdx @@ -18,7 +18,5 @@ get the complete list of the accepted image UUID. - `commercial_type` (string) - The name of the server commercial type: - ARM64-128GB, ARM64-16GB, ARM64-2GB, ARM64-32GB, ARM64-4GB, - ARM64-64GB, ARM64-8GB, C1, C2L, C2M, C2S, START1-L, - START1-M, START1-S, START1-XS, X64-120GB, X64-15GB, X64-30GB, - X64-60GB + C1, C2L, C2M, C2S, DEV1-S, DEV1-M, DEV1-L, DEV1-XL, + GP1-XS, GP1-S, GP1-M, GP1-L, GP1-XL, RENDER-S