Команда: show

Команда tofu show позволяет проверять различные артефакты OpenTofu и выводить их описание в удобочитаемом или машиночитаемом формате.

Например, с помощью tofu show можно проверить сохранённый файл плана, чтобы убедиться, что запланированные операции допустимы, или просмотреть последний снимок состояния.

Использование​

Использование: tofu show [target-selection-option] [other-options]

Чтобы указать проверяемый артефакт, используйте один из следующих параметров выбора целевого объекта:

• -state: Проверяет последний снимок состояния, если он существует.
• -plan=FILENAME: Проверяет план, сохранённый в указанном файле плана.

Если ни один из этих параметров не используется, по умолчанию применяется параметр -state. Параметры выбора целевого объекта взаимоисключающие.

Эта команда также принимает следующие дополнительные параметры:

• -no-color: Отключает использование управляющих последовательностей терминала в выводе для пользователей.
• -json: Выбирает машиночитаемый формат вывода JSON вместо используемого по умолчанию формата для пользователей.
• -var и -var-file: Задаёт значения для любых входных переменных, используемых в адресах источников модулей или параметрах серверной части текущей конфигурации.
• -show-sensitive: Если указан, конфиденциальные значения будут отображаться.

Для полного понимания специфичных для поставщика структур данных в артефактах состояния, плана и конфигурации эта команда использует информацию о схемах из плагинов поставщиков. Если сейчас используются версии поставщиков, отличающиеся от тех, что применялись при создании выбранного артефакта, может потребоваться использовать tofu apply (или аналогичный параметр), чтобы разрешить OpenTofu обновить сохранённые данные в соответствии с последними схемами поставщиков.

Вывод JSON​

При использовании параметра -json структура машиночитаемого вывода зависит от выбранного типа артефакта:

• -state возвращает представление состояния в формате JSON.
• -plan=FILENAME возвращает представление плана в формате JSON, которое также содержит сведения о конфигурации и предыдущем состоянии, на основе которых был создан план.

Устаревший способ использования​

Для обратной совместимости со старыми версиями OpenTofu эта команда также поддерживает другой шаблон использования:

tofu show [other-options] <filename>

В этом случае нельзя использовать явные параметры выбора целевого объекта. Вместо этого OpenTofu проверяет указанный файл и действует следующим образом:

• Если файл можно загрузить как сохранённый файл плана, команда действует так же, как -plan=FILENAME с тем же файлом.

• Если файл можно разобрать как локальный файл снимка состояния, например созданный командой tofu state pull, команда проверяет содержимое этого файла состояния, используя тот же формат вывода, что обычно применяется для проверки последнего снимка состояния.

  Выбранный файл снимка состояния должен быть связан с конфигурацией в текущем рабочем каталоге. В противном случае результаты не определены, поскольку доступные поставщики могут отличаться от тех, которые использовались при создании данных в снимке состояния.

Если вам не нужно проверять произвольный файл снимка состояния с помощью устаревшего способа, рекомендуем использовать новые явные параметры выбора целевого объекта, чтобы OpenTofu мог точнее определить тип проверяемого артефакта.