Skip to content

Commit

Permalink
regen docs partials
Browse files Browse the repository at this point in the history
  • Loading branch information
azr committed Apr 20, 2021
1 parent f322ed9 commit d59e065
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs-partials/builder/scaleway/Config-not-required.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!-- Code generated from the comments of the Config struct in builder/scaleway/config.go; DO NOT EDIT MANUALLY -->

- `api_url` (string) - The Scaleway API URL to use
Will be fetched first from the [scaleway configuration file](https://github.com/scaleway/scaleway-sdk-go/blob/master/scw/README.md).
It can also be specified via the environment variable SCW_API_URL

- `snapshot_name` (string) - The name of the resulting snapshot that will
appear in your account. Default packer-TIMESTAMP

- `image_name` (string) - The name of the resulting image that will appear in
your account. Default packer-TIMESTAMP

- `server_name` (string) - The name assigned to the server. Default
packer-UUID

- `bootscript` (string) - The id of an existing bootscript to use when
booting the server.

- `boottype` (string) - The type of boot, can be either local or
bootscript, Default bootscript

- `remove_volume` (bool) - Remove Volume

- `shutdown_timeout` (string) - Shutdown timeout. Default to 5m

- `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 of the control panel.
Deprecated, use SecretKey instead

- `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 of the
control panel.
Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY
Deprecated, use ProjectID instead

- `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.
Deprecated, use Zone instead

<!-- End of code generated from the comments of the Config struct in builder/scaleway/config.go; -->
29 changes: 29 additions & 0 deletions docs-partials/builder/scaleway/Config-required.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Code generated from the comments of the Config struct in builder/scaleway/config.go; DO NOT EDIT MANUALLY -->

- `access_key` (string) - The AccessKey corresponding to the secret key.
Will be fetched first from the [scaleway configuration file](https://github.com/scaleway/scaleway-sdk-go/blob/master/scw/README.md).
It can also be specified via the environment variable SCW_ACCESS_KEY.

- `secret_key` (string) - The SecretKey to authenticate against the Scaleway API.
Will be fetched first from the [scaleway configuration file](https://github.com/scaleway/scaleway-sdk-go/blob/master/scw/README.md).
It can also be specified via the environment variable SCW_SECRET_KEY.

- `project_id` (string) - The Project ID in which the instances, volumes and snapshots will be created.
Will be fetched first from the [scaleway configuration file](https://github.com/scaleway/scaleway-sdk-go/blob/master/scw/README.md).
It can also be specified via the environment variable SCW_DEFAULT_PROJECT_ID.

- `zone` (string) - The Zone in which the instances, volumes and snapshots will be created.
Will be fetched first from the [scaleway configuration file](https://github.com/scaleway/scaleway-sdk-go/blob/master/scw/README.md).
It can also be specified via the environment variable SCW_DEFAULT_ZONE

- `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
get the complete list of the accepted image UUID.
The marketplace image label (eg `ubuntu_focal`) also works.

- `commercial_type` (string) - The name of the server commercial type:
C1, C2L, C2M, C2S, DEV1-S, DEV1-M, DEV1-L, DEV1-XL,
GP1-XS, GP1-S, GP1-M, GP1-L, GP1-XL, RENDER-S

<!-- End of code generated from the comments of the Config struct in builder/scaleway/config.go; -->

0 comments on commit d59e065

Please sign in to comment.