Terraform

Avec le fournisseur lionbackup, vous créez des projets et des jetons de sauvegarde en infrastructure as code. Il utilise l'API publique et donc les mêmes droits que votre compte de service dans le portail. Le fournisseur fonctionne avec Terraform à partir de la version 1.9 et avec OpenTofu.

Source d'installation

Le fournisseur n'est pas distribué via le registre public de Terraform, mais via un network mirror de lionbackup. Inscrivez-le une seule fois dans votre configuration CLI ~/.terraformrc (ou dans le fichier désigné par TF_CLI_CONFIG_FILE) :

provider_installation {
  network_mirror {
    url     = "https://git.prod.lionbackup.cloud/terraform/providers/"
    include = ["git.lionbackup.cloud/*/*"]
  }
  direct {
    exclude = ["git.lionbackup.cloud/*/*"]
  }
}

Testé avec Terraform 1.16 et OpenTofu 1.12. OpenTofu lit la même configuration dans ~/.tofurc ou, à défaut, dans ~/.terraformrc.

Le bloc direct garantit que Terraform récupère le fournisseur lionbackup exclusivement depuis le mirror ; tous les autres fournisseurs continuent de se charger comme d'habitude depuis leurs registres.

Intégrer le fournisseur

L'adresse source est git.lionbackup.cloud/lionbackup/lionbackup. Utilisez le fournisseur à partir de la version 0.1.1 :

terraform {
  required_providers {
    lionbackup = {
      source  = "git.lionbackup.cloud/lionbackup/lionbackup"
      version = "~> 0.1.1"
    }
  }
}

provider "lionbackup" {
  # La clé d'API provient de l'environnement :
  #   export LIONBACKUP_API_KEY=...   (Portail → Développeurs)
  # environment = "prod"   # par défaut ; "dev" pour l'environnement de développement
}

Vous créez la clé d'API dans le portail sous Développeurs (voir API) et la transmettez comme variable d'environnement LIONBACKUP_API_KEY. L'attribut api_key existe aussi, mais une clé dans la configuration finit facilement dans le gestionnaire de versions.

Exemple

L'exemple détermine votre organisation, y crée un projet dans la zone de01-1, génère un jeton d'écriture et expose son secret comme output sensible :

data "lionbackup_organizations" "mine" {}

locals {
  organization_id = one([
    for o in data.lionbackup_organizations.mine.organizations : o.id
    if o.name == "Example Ltd"
  ])
}

resource "lionbackup_project" "backup" {
  organization_id   = local.organization_id
  name              = "web-servers"
  availability_zone = "de01-1"
  alert_email       = "ops@example.com"
}

resource "lionbackup_project_token" "writer" {
  project_id = lionbackup_project.backup.id
  type       = "write"
}

output "backup_token" {
  value     = lionbackup_project_token.writer.secret
  sensitive = true
}

L'organisation est choisie par son nom, pas par sa position dans la liste : un compte de service peut voir plusieurs organisations et l'ordre n'est pas garanti. one() échoue s'il y a plusieurs correspondances ; s'il n'y en a aucune, organization_id reste vide et Terraform refuse le plan. Dans aucun cas le projet n'est créé silencieusement dans la mauvaise organisation.

availability_zone attend le nom de la zone, tel que l'indiquent la page Régions et la data source lionbackup_zones ; la résolution vers l'identifiant est prise en charge par le fournisseur.

Appliquer :

export LIONBACKUP_API_KEY=...
terraform init
terraform apply
terraform output -raw backup_token

terraform init télécharge le fournisseur depuis le mirror et le vérifie par rapport aux sommes de contrôle qui y sont déposées. La sortie devrait se terminer ainsi :

- Installing git.lionbackup.cloud/lionbackup/lionbackup v0.1.2...
- Installed git.lionbackup.cloud/lionbackup/lionbackup v0.1.2 (verified checksum)

La somme de contrôle est enregistrée dans .terraform.lock.hcl. Ajoutez ce fichier au gestionnaire de versions : chaque exécution installera alors exactement la même version du fournisseur.

Ce qu'il faut savoir

terraform destroy ferme un projet, il ne le supprime pas. C'est la sémantique de la plateforme : les jetons d'écriture sont révoqués immédiatement, les sauvegardes stockées restent lisibles jusqu'à la fin de la durée de rétention. Un projet fermé disparaît de l'état Terraform. Les jetons gérés par la même configuration sont aussi révoqués, jetons de lecture compris. Pour garder un jeton de lecture après le démontage, retirez-le d'abord de l'état (terraform state rm <adresse>) ou créez-le dans le portail.
Toute modification d'un jeton le remplace. Tous les attributs d'un lionbackup_project_token ne se choisissent qu'à la création ; qui en modifie un obtient un nouveau jeton (l'ancien révoqué, un nouveau généré) — et donc un nouveau secret.
Le secret est dans l'état. L'API ne délivre un jeton de sauvegarde qu'une seule fois ; le fournisseur le conserve comme attribut sensible secret dans l'état Terraform. Protégez le fichier d'état comme un mot de passe — par exemple dans un backend distant chiffré.
Zone, organisation et immuabilité sont des décisions prises à la création. Une modification de organization_id, availability_zone, immutable_storage, retention_days ou auto_delete_after_retention remplace le projet (plan : must be replaced). Modifiables en cours d'exploitation : name, alert_email et billing_reference.
Limite de débit. L'API autorise 60 requêtes par minute par compte de service et par adresse IP. Le fournisseur répète 429 et 503 jusqu'à trois fois en respectant le délai Retry-After annoncé ; un grand apply devient ainsi plus lent, mais n'est pas interrompu.
Droits. Le fournisseur peut faire exactement ce que peut faire la personne à qui appartient le compte de service. Créer et fermer des projets exige le rôle owner ou admin dans l'organisation.

Référence

Fournisseur

Attribut	Signification
`api_key`	clé d'API ; de préférence via `LIONBACKUP_API_KEY` dans l'environnement
`environment`	`prod` (par défaut) ou `dev` ; sélectionne le point de terminaison API et jeton
`api_url`	URL de base propre pour l'API, remplace `environment`
`token_url`	point de terminaison propre pour le jeton, remplace `environment`

Ressource `lionbackup_project`

Attribut	Obligatoire	Signification
`organization_id`	oui	identifiant de l'organisation (data source `lionbackup_organizations`)
`name`	oui	nom du projet, 100 caractères au maximum
`availability_zone`	oui	nom de la zone, par exemple `de01-1`
`alert_email`	non	adresse pour les notifications
`billing_reference`	non	texte libre pour votre facturation
`immutable_storage`	non	stockage immuable, par défaut `false`
`retention_days`	non	durée de rétention pour le stockage immuable ; sans indication, la valeur par défaut de la plateforme
`auto_delete_after_retention`	non	par défaut `true`
`id`, `status`	—	attribués par la plateforme

Ressource `lionbackup_project_token`

Attribut	Obligatoire	Signification
`project_id`	oui	identifiant du projet
`type`	non	`write` (par défaut) pour les sauvegardes, `read` pour les restaurations
`operating_system`	non	`Linux` (par défaut) ou `Windows`
`usage_count_limit`	non	au maximum ce nombre d'utilisations
`rate_limit_per_minute`	non	requêtes par minute pour ce jeton
`rate_limit_per_hour`	non	requêtes par heure pour ce jeton
`id`	—	attribué par la plateforme
`secret`	—	le jeton de sauvegarde, sensible, uniquement dans l'état

Data sources

lionbackup_organizations renvoie organizations avec id, name, status et role (votre rôle dans l'organisation). lionbackup_zones renvoie zones avec id, name, status, provider, location_city et storage_type ; seules les zones avec status = active peuvent être réservées.

S'y ajoutent lionbackup_projects (tous les projets d'une organisation, indiquer organization_id, projets fermés compris), lionbackup_project (un projet par son id) et lionbackup_whoami (le compte de service qui agit, son propriétaire et le rôle de celui-ci par organisation).

OpenTofu

OpenTofu utilise la même configuration. Placez le bloc provider_installation dans ~/.tofurc (si le fichier manque, OpenTofu lit aussi ~/.terraformrc) et remplacez terraform par tofu dans les commandes. tofu init signale lui aussi verified checksum.

Environnement de développement

Pour des tests contre l'environnement de développement, définissez environment = "dev" dans le fournisseur et utilisez une clé créée dans cet environnement. Le fournisseur lui-même peut en outre être récupéré depuis le mirror de l'environnement de développement ; pour cela, remplacez l'URL dans ~/.terraformrc :

url = "https://git.dev.lionbackup.cloud/terraform/providers/"

L'adresse source git.lionbackup.cloud/lionbackup/lionbackup reste la même dans les deux cas.

Source d'installation​

Intégrer le fournisseur​

Exemple​

Ce qu'il faut savoir​

Référence​

Fournisseur​

Ressource lionbackup_project​

Ressource lionbackup_project_token​

Data sources​

OpenTofu​

Environnement de développement​