0
0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-06-30 02:31:10 +00:00
terraform-provider-proxmox/docs/resources/virtual_environment_acme_account.md
Björn Brauer 9de4037a82
feat(acme): implement resources and data sources for ACME accounts (#1455)
* feat(acme): implement CRUD API for proxmox cluster ACME
* feat(acme): implement acme_accounts data source
* feat(acme): implement acme_account data source
* fix(acme): wait for task status on account creation
* feat(acme): implement account resource creation
* feat(acme): implement account read
* fix(acme): wait for task status on account update
* feat(acme): implement account update
* fix(acme): wait for task status on account deletion
* feat(acme): implement account deletion
* feat(acme): implement account import
* feat(acme): provide correctly typed API response for `account` field
* feat(acme): implement account schema for acme_account data source
* fix(acme): read `location` into state in acme_account resource
* fix(acme): ensure `name` of acme_account resource can't be changed
* docs(acme): generate documentation
* feat(acme): read back ACME account details from API
* Revert "fix(acme): ensure `name` of acme_account resource can't be changed"
* fix(acme): provide default for acme account name
* fix(acme): acme account name can't be changed
* chore(acme): update resource doc to clarify PVE auth requirements
* chore(acme): add `created_at` attr to the resource, sort model fields & schema attributes alphabetically

---------

Signed-off-by: Björn Brauer <zaubernerd@zaubernerd.de>
Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
Co-authored-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
2024-08-07 23:16:31 -04:00

1.5 KiB

layout title parent subcategory description
page proxmox_virtual_environment_acme_account Resources Virtual Environment Manages an ACME account in a Proxmox VE cluster. ~> This resource requires root@pam authentication.

Resource: proxmox_virtual_environment_acme_account

Manages an ACME account in a Proxmox VE cluster.

~> This resource requires root@pam authentication.

Example Usage

resource "proxmox_virtual_environment_acme_account" "example" {
  name      = "example"
  contact   = "example@email.com"
  directory = "https://acme-staging-v02.api.letsencrypt.org/directory"
  tos       = "https://letsencrypt.org/documents/LE-SA-v1.3-September-21-2022.pdf"
}

Schema

Required

  • contact (String) The contact email addresses.

Optional

  • directory (String) The URL of the ACME CA directory endpoint.
  • eab_hmac_key (String) The HMAC key for External Account Binding.
  • eab_kid (String) The Key Identifier for External Account Binding.
  • name (String) The ACME account config file name.
  • tos (String) The URL of CA TermsOfService - setting this indicates agreement.

Read-Only

  • created_at (String) The timestamp of the ACME account creation.
  • location (String) The location of the ACME account.

Import

Import is supported using the following syntax:

#!/usr/bin/env sh
# ACME accounts can be imported using their name, e.g.:
terraform import proxmox_virtual_environment_acme_account.example example