Terraform provider reference

This page lists every argument and attribute of every resource and data source in the plakarkorp/plakar Terraform provider. For an introduction to what these resources are and how to use them, see Terraform Provider.

Provider

Manage Plakar backup configuration — stores, connectors and schedules — through the Plakar management API.

Example Usage

provider "plakar" {
  api_url = "https://plakar.example.com" # or PLAKAR_API_URL
  api_key = var.plakar_api_key           # or PLAKAR_API_KEY
}

Optional

Resources

plakar_connector (Resource)

A Plakar source or destination connector. For stores, use plakar_store.

Example Usage

resource "plakar_connector" "web" {
  name        = "Web tier"
  type        = "source"
  integration = "sftp"
  resource    = "urn:res-grateful-cascade"
  environment = "production"
  fields = {
    username = "tunnel"
    root     = "/home/tunnel/data"
    port     = "2222"
  }
}

Required

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import plakar_connector.example <uuid>

plakar_grant (Resource)

A grant — a role held by a member of an organization. The subject must already be a member (see plakar_member); the role names come from the server’s catalogue, the standard tier being owner, administrator, operator and auditor.

Example Usage

# What a member may do is a grant: one (subject, role) pair.
resource "plakar_grant" "alice_audits" {
  organization_id = plakar_organization.lyon.id
  subject_id      = plakar_member.alice.id
  role            = "auditor"
}

resource "plakar_grant" "nightly_runs" {
  organization_id = plakar_organization.lyon.id
  subject_id      = plakar_member.nightly.id
  role            = "operator"
}

Required

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# <organization_id>/<grant_id>
terraform import plakar_grant.alice_audits 3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90/9d8e7f6a-5b4c-4d3e-8f2a-1b0c9d8e7f6a

plakar_inventory (Resource)

An inventory — the census of resources Plakar watches over. Provider-backed inventories (aws, ovh, scaleway, gcp, vmware, k8s) discover their resources from the account they are configured against; a self-managed inventory holds resources declared by hand, e.g. with plakar_inventory_resource.

Example Usage

# The fleet declared by hand: a self-managed inventory carries no
# configuration, its resources are declared with plakar_inventory_resource.
resource "plakar_inventory" "fleet" {
  name = "Fleet"
  type = "self-managed"
}

# A provider-backed inventory discovers its resources from the account it is
# configured against.
resource "plakar_inventory" "aws" {
  name = "AWS production"
  type = "aws"

  aws {
    credentials_type  = "access_key"
    access_key        = var.aws_access_key
    secret_access_key = var.aws_secret_access_key
    region            = "eu-west-1"
  }
}

Required

Optional

Read-Only

Nested Schema for aws

Optional:

Nested Schema for gcp

Optional:

Nested Schema for k8s

Optional:

Nested Schema for ovh

Optional:

Nested Schema for scaleway

Optional:

Nested Schema for vmware

Optional:

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import plakar_inventory.fleet 3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90

plakar_inventory_resource (Resource)

A resource declared in a self-managed inventory — a machine, database or share Plakar should know about. Connectors attach to it by URN, e.g. through the plakar_resource data source.

Example Usage

resource "plakar_inventory" "fleet" {
  name = "Fleet"
  type = "self-managed"
}

resource "plakar_inventory_resource" "db1" {
  inventory_id = plakar_inventory.fleet.id
  urn          = "urn:fleet:database/db1"
  name         = "db1"
  class        = "database"
  subclass     = "postgres"
  endpoints    = ["db1.internal"]
  tags         = ["production"]
}

# Connectors attach to the resource by URN.
resource "plakar_connector" "db1_dump" {
  name        = "db1 nightly dump"
  type        = "source"
  integration = "postgres"
  resource    = plakar_inventory_resource.db1.urn

  fields = {
    connection_string = var.db1_connection_string
  }
}

Required

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# <inventory_id>/<urn_id>
terraform import plakar_inventory_resource.db1 3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90/7b2c1d0e-4f5a-4b6c-9d8e-0a1b2c3d4e5f

plakar_member (Resource)

A membership — a person or a service account belonging to an organization. Adding a person goes through the admin invitation path: a brand-new address gets an account with a one-time generated password (in generated_password, shown once and kept in state — treat state accordingly); an address that already has an account simply gains the membership. A membership carries no permission; what a member may do is a plakar_grant. Destroying the resource removes the membership, not the person’s account.

Example Usage

# A person: the invitation is auto-accepted; a brand-new address gets an
# account whose one-time password lands in generated_password (state!).
resource "plakar_member" "alice" {
  organization_id = plakar_organization.lyon.id
  email           = "alice@example.com"
  name            = "Alice"
}

# A service account for automation: no email, no interactive login. Mint its
# API key in the Plakar UI.
resource "plakar_member" "nightly" {
  organization_id = plakar_organization.lyon.id
  name            = "nightly-automation"
  service         = true
}

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# <organization_id>/<user_id>
terraform import plakar_member.alice 3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90/7b2c1d0e-4f5a-4b6c-9d8e-0a1b2c3d4e5f

plakar_organization (Resource)

An organization — a tenant, or a perimeter nested under one. Membership is managed with plakar_member, permissions with plakar_grant. v1 has no organization update, so every change replaces — and destroying the resource deletes the tenant and everything scoped to it.

Example Usage

# A tenant under the provider's organization.
resource "plakar_organization" "lyon" {
  name = "Lyon"
}

# A perimeter nested under it.
resource "plakar_organization" "lyon_production" {
  name      = "Lyon production"
  parent_id = plakar_organization.lyon.id
}

Required

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import plakar_organization.lyon 3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90

plakar_schedule (Resource)

A scheduled task — a backup, prune, sync or check with its recurrence rules. A scheduled prune carries the retention rule.

Example Usage

resource "plakar_schedule" "nightly" {
  name      = "Nightly database backup"
  type      = "backup"
  origin_id = data.plakar_connector.db.id
  target_id = plakar_store.offsite.id
  labels    = ["nightly"]

  rule {
    periodicity = 86400
  }
}

resource "plakar_schedule" "retention" {
  name      = "Retention policy"
  type      = "prune"
  origin_id = plakar_store.offsite.id
  group_by  = "dataset"
  retention = {
    day     = 7
    per_day = 1
  }

  rule {
    periodicity = 86400
  }
}

Required

Optional

Read-Only

Nested Schema for rule

Required:

Optional:

Read-Only:

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import plakar_schedule.example <uuid>

plakar_store (Resource)

A Plakar store — where backup data lands. Destroying the resource removes the store from Plakar; data in the underlying storage is not touched.

Example Usage

resource "plakar_store" "offsite" {
  name        = "Offsite S3"
  integration = "s3"
  resource    = "Ample Sky"
  environment = "production"
  fields = {
    passphrase        = var.repo_passphrase
    access_key        = var.s3_access_key
    secret_access_key = var.s3_secret_key
    root              = "/backups"
  }
}

Required

Optional

Read-Only

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import plakar_store.example <uuid>

Data sources

plakar_connector (Data Source)

A source or destination connector, looked up by type and name.

Example Usage

data "plakar_connector" "db" {
  name = "Production DB"
  type = "source"
}

Required

Read-Only

plakar_integration (Data Source)

An installed integration, looked up by name.

Example Usage

data "plakar_integration" "s3" {
  name = "s3"
}

Required

Read-Only

plakar_inventory (Data Source)

An inventory, looked up by name.

Example Usage

data "plakar_inventory" "fleet" {
  name = "Fleet"
}

Required

Read-Only

plakar_member (Data Source)

A member of an organization, looked up by email (a person) or name (a service account, which has no address).

Example Usage

# A person, by email.
data "plakar_member" "alice" {
  organization_id = data.plakar_organization.lyon.id
  email           = "alice@example.com"
}

# A service account, by name.
data "plakar_member" "nightly" {
  organization_id = data.plakar_organization.lyon.id
  name            = "nightly-automation"
}

Optional

Read-Only

plakar_organization (Data Source)

An organization, looked up by name across the provider organization’s subtree.

Example Usage

data "plakar_organization" "lyon" {
  name = "Lyon"
}

Required

Read-Only

plakar_resource (Data Source)

An inventory resource, looked up by URN or name.

Example Usage

data "plakar_resource" "db_host" {
  ref = "urn:aws:123456789:ec2:eu-west-1:instance:i-0abc" # or its name
}

Required

Read-Only

plakar_store (Data Source)

A store, looked up by name.

Example Usage

data "plakar_store" "existing" {
  name = "Offsite S3"
}

Required

Read-Only