From 6021f7bd45f269a7fe84a17bf5b021221fa2f3b1 Mon Sep 17 00:00:00 2001 From: Stefan Benz <46600784+stebenz@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:30:02 +0200 Subject: [PATCH] docs: add smtp config note and generate docs --- docs/resources/smtp_config.md | 11 +++++++++++ templates/resources/smtp_config.md.tmpl | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/resources/smtp_config.md b/docs/resources/smtp_config.md index 17912896..f8e85d58 100644 --- a/docs/resources/smtp_config.md +++ b/docs/resources/smtp_config.md @@ -14,6 +14,17 @@ Resource representing the SMTP configuration of an instance. Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed. +```bash +# Find out the state path of your SMTP resource +export SMTP_CONFIG=$(terraform state list | grep 'smtp_config') + +# Remove the current state of your SMTP resource +terraform state rm ${SMTP_CONFIG} + +# Reimport your SMTP resource +terraform import ${SMTP_CONFIG} "${SMTP_CONFIG_ID}:${SMTP_CONFIG_PASSWORD}" +``` + --- ## Example Usage diff --git a/templates/resources/smtp_config.md.tmpl b/templates/resources/smtp_config.md.tmpl index 1b0450b1..35b35c6a 100644 --- a/templates/resources/smtp_config.md.tmpl +++ b/templates/resources/smtp_config.md.tmpl @@ -14,6 +14,17 @@ description: |- Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed. +```bash +# Find out the state path of your SMTP resource +export SMTP_CONFIG=$(terraform state list | grep 'smtp_config') + +# Remove the current state of your SMTP resource +terraform state rm ${SMTP_CONFIG} + +# Reimport your SMTP resource +terraform import ${SMTP_CONFIG} "${SMTP_CONFIG_ID}:${SMTP_CONFIG_PASSWORD}" +``` + --- ## Example Usage