Skip to content

Commit

Permalink
generate docs-partials
Browse files Browse the repository at this point in the history
  • Loading branch information
nvthongswansea committed Mar 25, 2022
1 parent d1cc217 commit 4f0fd49
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs-partials/builder/gridscale/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/gridscale/config.go; DO NOT EDIT MANUALLY -->

- `api_url` (string) - The server URL to use to access your account. Default: "https://api.gridscale.io". Environment variable `GRIDSCALE_URL` can be set instead.

- `api_request_headers` (string) - APIRequestHeaders is for debug purpose only. Format: "key1:val1,key2:val2"

- `template_name` (string) - The name of the new template.

- `hostname` (string) - Name of the host.

- `server_name` (string) - Name of the server used for producing the template.

- `secondary_storage` (bool) - SecondaryStorage is set to true when the server needs a secondary storage
during producing template process.
**NOTE**: If `secondary_storage=true`, the template will be built from the second storage.

- `base_template_uuid` (string) - A pre-built template UUID. This template is used to produce another template. E.g: Ubuntu template.
**NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.

- `isoimage_uuid` (string) - A pre-built ISO image is used by the given ISO image UUID. If IsoImageUUID is set, IsoImageURL is ignored.
**NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.

- `isoimage_url` (string) - An URL is used to download the image. If IsoImageUUID is set, IsoImageURL is ignored.
**NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.

- `boot_command` ([]string) - This is an array of commands to type when the server instance is first
booted. The goal of these commands should be to type just enough to
initialize the operating system installer. Special keys can be typed as
well, and are covered in the section below on the boot command. If this
is not specified, it is assumed the installer will start itself.

- `boot_wait` (duration string | ex: "1h5m2s") - The time to wait after booting the initial virtual machine before typing
the `boot_command`. The value of this should be a duration. Examples are
`5s` and `1m30s` which will cause Packer to wait five seconds and one
minute 30 seconds, respectively. If this isn't specified, the default is
`10s` or 10 seconds. To set boot_wait to 0s, use a negative number, such
as "-1s"

- `boot_key_interval` (duration string | ex: "1h5m2s") - Time in ms to wait between each key press

- `files` ([]string) - A list of files' relative paths that need to be served on a HTTP server.
Put this address ({{__HTTP__ADDRESS__}} is a placeholder, do not edit) http://{{__HTTP__ADDRESS__}}/path/to/file
to `boot_command` to use http-served files in boot commands.

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

- `api_token` (string) - The client TOKEN to use to access your account. Environment variable `GRIDSCALE_TOKEN` can be set instead.

- `api_key` (string) - The client KEY to use to access your account. Environment variable `GRIDSCALE_UUID` can be set instead.

- `server_cores` (int) - Number of server cores

- `server_memory` (int) - Server memory capacity (in GB)

- `storage_capacity` (int) - Storage capacity (in GB)

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

0 comments on commit 4f0fd49

Please sign in to comment.