Skip to content

Latest commit

 

History

History
189 lines (121 loc) · 6.33 KB

deployment.md

File metadata and controls

189 lines (121 loc) · 6.33 KB
page_title subcategory description
grid_deployment Resource - terraform-provider-grid
Deployment resource (zdbs + vms + disks + qsfs).

grid_deployment (Resource)

Deployment resource (zdbs + vms + disks + qsfs).

Schema

Required

  • node (Number) Node id to place the deployment on

Optional

Read-Only

  • id (String) The ID of this resource.

Nested Schema for disks

Required:

  • name (String) the disk name, used to reference it in zmachine mounts
  • size (Number) the disk size in GBs

Optional:

  • description (String)

Nested Schema for qsfs

Required:

  • cache (Number) The size of the fuse mountpoint on the node in MBs (holds qsfs local data before pushing)
  • encryption_key (String) 64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
  • expected_shards (Number) The amount of shards which are generated when the data is encoded. Essentially, this is the amount of shards which is needed to be able to recover the data, and some disposable shards which could be lost. The amount of disposable shards can be calculated as expected_shards - minimal_shards.
  • groups (Block List, Min: 1) The backend groups to write the data to. (see below for nested schema)
  • max_zdb_data_dir_size (Number) Maximum size of the data dir in MiB, if this is set and the sum of the file sizes in the data dir gets higher than this value, the least used, already encoded file will be removed.
  • metadata (Block List, Min: 1, Max: 1) (see below for nested schema)
  • minimal_shards (Number) The minimum amount of shards which are needed to recover the original data.
  • name (String)
  • redundant_groups (Number) The amount of groups which one should be able to loose while still being able to recover the original data.
  • redundant_nodes (Number) The amount of nodes that can be lost in every group while still being able to recover the original data.

Optional:

  • compression_algorithm (String) configuration to use for the compression stage. Currently only snappy is supported
  • description (String)
  • encryption_algorithm (String) configuration to use for the encryption stage. Currently only AES is supported.

Read-Only:

  • metrics_endpoint (String) QSFS exposed metrics

Nested Schema for qsfs.groups

Optional:

Nested Schema for qsfs.groups.backends

Required:

  • address (String) Address of backend zdb (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
  • namespace (String) ZDB namespace
  • password (String) Namespace password

Nested Schema for qsfs.metadata

Required:

  • encryption_key (String) 64 long hex encoded encryption key (e.g. 0000000000000000000000000000000000000000000000000000000000000000)
  • prefix (String) Data stored on the remote metadata is prefixed with

Optional:

  • backends (Block List) (see below for nested schema)
  • encryption_algorithm (String) configuration to use for the encryption stage. Currently only AES is supported.
  • type (String) configuration for the metadata store to use, currently only zdb is supported

Nested Schema for qsfs.metadata.backends

Required:

  • address (String) Address of backend zdb (e.g. [300:a582:c60c:df75:f6da:8a92:d5ed:71ad]:9900 or 60.60.60.60:9900)
  • namespace (String) ZDB namespace
  • password (String) Namespace password

Nested Schema for timeouts

Optional:

  • create (String)

Nested Schema for vms

Required:

Optional:

  • corex (Boolean) Enable corex
  • cpu (Number) Number of VCPUs
  • description (String)
  • entrypoint (String) command to execute as the Zmachine init
  • env_vars (Map of String) Environment variables to pass to the zmachine
  • flist_checksum (String) if present, the flist is rejected if it has a different hash. the flist hash can be found by append
  • ip (String) The private wg IP of the Zmachine
  • memory (Number) Memory size
  • mounts (Block List) Zmachine mounts, can reference QSFSs and Disks (see below for nested schema)
  • planetary (Boolean) Enable Yggdrasil allocation
  • publicip (Boolean) true to enable public ip reservation
  • publicip6 (Boolean) true to enable public ipv6 reservation
  • rootfs_size (Number) Rootfs size in MB
  • zlogs (List of String) Zlogs is a utility workload that allows you to stream zmachine logs to a remote location.

Read-Only:

  • computedip (String) The reserved public ip
  • computedip6 (String) The reserved public ipv6
  • ygg_ip (String) Allocated Yggdrasil IP

Nested Schema for vms.mounts

Required:

  • disk_name (String) Name of QSFS or Disk to mount
  • mount_point (String) Directory to mount the disk on inside the Zmachine

Nested Schema for zdbs

Required:

  • name (String)
  • password (String)
  • size (Number) Size of the zdb in GBs

Optional:

  • description (String)
  • mode (String) Mode of the zdb, user or seq
  • public (Boolean) Makes it read-only if password is set, writable if no password set

Read-Only:

  • ips (List of String) IPs of the zdb
  • namespace (String) Namespace of the zdb
  • port (Number) Port of the zdb