options.md

hetzner cloud options

• hcloud.enable
  type: boolean
  default: false
  example: true
  defined: module/provider.nix
  description: Whether to enable hcloud provider See https://www.terraform.io/docs/providers/hcloud/index.html for documentation. .
  
• hcloud.export.nix
  type: null or string
  default: null
  example: null
  defined: module/export.nix
  description: Export hcloud information as nix file. Useful when if you want to import run a NixOS script after the terraform.
  
• hcloud.nixserver
  type: attribute set of submodules
  default: {}
  example: null
  defined: module/nixserver.nix
  description: create a nixos server, via nixos-infect.
  
• hcloud.nixserver.<name>.backups
  type: boolean
  default: false
  example: null
  defined: module/nixserver.nix
  description: enable backups or not
  
• hcloud.nixserver.<name>.channel
  type: string
  default: "nixos-21.05"
  example: null
  defined: module/nixserver.nix
  description: nixos channel to install
  
• hcloud.nixserver.<name>.configurationFile
  type: null or path
  default: null
  example: null
  defined: module/nixserver.nix
  description: The configuration.nix, only used by the initial provisioning by nixos-infect.
  
• hcloud.nixserver.<name>.enable
  type: boolean
  default: false
  example: true
  defined: module/nixserver.nix
  description: Whether to enable nixserver.
  
• hcloud.nixserver.<name>.extraConfig
  type: attribute set
  default: {}
  example: null
  defined: module/nixserver.nix
  description: parameter of the hcloud_server which are not covered yet.
  
• hcloud.nixserver.<name>.location
  type: null or string
  default: null
  example: null
  defined: module/nixserver.nix
  description: location where the machine should run.
  
• hcloud.nixserver.<name>.name
  type: string
  default: "nixserver-‹name›"
  example: null
  defined: module/nixserver.nix
  description: name of the server
  
• hcloud.nixserver.<name>.provisioners
  type: list of attribute sets
  default: []
  example: null
  defined: module/nixserver.nix
  description: provision steps. see `hcloud.server.provisioners`.
  
• hcloud.nixserver.<name>.serverType
  type: string
  default: "cx11"
  example: null
  defined: module/nixserver.nix
  description: Hardware equipment.This options influences costs!
  
• hcloud.provider.endpoint
  type: null or string
  default: null
  example: null
  defined: module/provider.nix
  description: Hetzner Cloud API endpoint, can be used to override the default API Endpoint https://api.hetzner.cloud/v1
  
• hcloud.provider.token
  type: string
  default: "${ var.hcloud_api_token }"
  example: null
  defined: module/provider.nix
  description: You need an API token to use the API. Sign in into the Hetzner Cloud Console choose a project, go to Access → Tokens, and create a new token. Make sure to copy the token because it won’t be shown to you again. A token is bound to a project, to interact with the API of another project you have to create a new token inside the project

  If you use a variable you can set it via the environment variable TF_VAR_hcloud_api_token.
  

• hcloud.server
  type: attribute set of submodules
  default: {}
  example: null
  defined: module/server.nix
  description: servers deployed to the hcloud.
  
• hcloud.server.<name>.backups
  type: boolean
  default: false
  example: null
  defined: module/server.nix
  description: enable backups or not
  
• hcloud.server.<name>.enable
  type: boolean
  default: false
  example: true
  defined: module/server.nix
  description: Whether to enable really deploy server .
  
• hcloud.server.<name>.extraConfig
  type: attribute set
  default: {}
  example: null
  defined: module/server.nix
  description: parameter of the hcloud_server which are not covered yet.
  
• hcloud.server.<name>.image
  type: string
  default: "ubuntu-22.04"
  example: null
  defined: module/server.nix
  description: image to spawn on the server
  
• hcloud.server.<name>.location
  type: null or string
  default: null
  example: null
  defined: module/server.nix
  description: location where the machine should run.
  
• hcloud.server.<name>.name
  type: string
  default: "‹name›"
  example: null
  defined: module/server.nix
  description: name of the server
  
• hcloud.server.<name>.provisioners
  type: list of attribute sets
  default: []
  example: [{"file":{"destination":"/root/.zshrc","source":"~/.zshrc"}},{"remote-exec":{"inline":["shutdown -r +1"]}}]
  defined: module/server.nix
  description: provision steps.

  file and remote-exec steps automatically get the connection part setup, if you configure the provisioner.privateKeyFile parameter.
  

• hcloud.server.<name>.serverType
  type: string
  default: "cx11"
  example: null
  defined: module/server.nix
  description: Hardware equipment. This options influences costs!