Remote Mount Backends

A Remote Mount Backend is used to provide high availability for a Remote Server Mount Folder Behavior.

Resource Schema

Required

Property	Description
canary_file_path String	Path to the canary file used for health checks.
remote_server_id Int64	The remote server that this backend is associated with.
remote_server_mount_id Int64	The mount ID of the Remote Server Mount that this backend is associated with.

Optional

Property	Description
enabled Bool	True if this backend is enabled.
fall Int64	Number of consecutive failures before considering the backend unhealthy.
health_check_enabled Bool	True if health checks are enabled for this backend.
health_check_type String	Type of health check to perform. Possible values: `active`, `passive`
interval Int64	Interval in seconds between health checks.
min_free_cpu String	Minimum free CPU percentage required for this backend to be considered healthy.
min_free_mem String	Minimum free memory percentage required for this backend to be considered healthy.
priority Int64	Priority of this backend.
remote_path String	Path on the remote server to treat as the root of this mount.
rise Int64	Number of consecutive successes before considering the backend healthy.

Read Only

Property	Description
health_check_results Dynamic	Array of recent health check results.
id Int64	Unique identifier for this backend.
status String	Status of this backend. Possible values: `healthy`, `degraded`, `failed`, `desynced`
undergoing_maintenance Bool	True if this backend is undergoing maintenance.

Example Resource

resource "files_remote_mount_backend" "example_remote_mount_backend" {
  enabled                = true
  fall                   = 1
  health_check_enabled   = true
  health_check_type      = "active"
  interval               = 60
  min_free_cpu           = 1.0
  min_free_mem           = 1.0
  priority               = 1
  remote_path            = "/path/on/remote"
  rise                   = 1
  canary_file_path       = "backend1.txt"
  remote_server_mount_id = 1
  remote_server_id       = 1
}

Resource Import

This Resource supports importing using the following syntax:

Example Import Command

# Remote Mount Backends can be imported by specifying the id.
terraform import files_remote_mount_backend.example_remote_mount_backend 1

Data Source Schema

Required

Property	Description
id Int64	Unique identifier for this backend.

Read Only

Property	Description
canary_file_path String	Path to the canary file used for health checks.
enabled Bool	True if this backend is enabled.
fall Int64	Number of consecutive failures before considering the backend unhealthy.
health_check_enabled Bool	True if health checks are enabled for this backend.
health_check_results Dynamic	Array of recent health check results.
health_check_type String	Type of health check to perform. Possible values: `active`, `passive`
interval Int64	Interval in seconds between health checks.
min_free_cpu String	Minimum free CPU percentage required for this backend to be considered healthy.
min_free_mem String	Minimum free memory percentage required for this backend to be considered healthy.
priority Int64	Priority of this backend.
remote_path String	Path on the remote server to treat as the root of this mount.
remote_server_id Int64	The remote server that this backend is associated with.
remote_server_mount_id Int64	The mount ID of the Remote Server Mount that this backend is associated with.
rise Int64	Number of consecutive successes before considering the backend healthy.
status String	Status of this backend. Possible values: `healthy`, `degraded`, `failed`, `desynced`
undergoing_maintenance Bool	True if this backend is undergoing maintenance.

Example Data Source

data "files_remote_mount_backend" "example_remote_mount_backend" {
  id = 1
}