Команда: show

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

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

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

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

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

• -state: проверить последний снимок состояния, если он есть.
• -plan=FILENAME: проверить план, сохранённый в указанном файле плана.
• -config: проверить текущую полную конфигурацию (требуется -json).
• -module=DIR: проверить конфигурацию только одного модуля в указанном каталоге, не требуя установки зависимостей (требуется -json).

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

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

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

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

Вывод JSON​

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

• -state возвращает представление состояния в формате JSON.

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

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

• -module=DIR возвращает подмножество представления конфигурации в формате JSON, в котором:

  • Свойство "module" для каждого вызова модуля опущено.
  • Свойство "schema_version" для каждого ресурса опущено.
  • Все свойства, связанные с выражениями, опущены.

  Благодаря этим исключениям этот режим работает без предварительного выполнения tofu init и, следовательно, без предварительной установки зависимостей модуля.

Использование в устаревшем формате​

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

tofu show [other-options] <filename>

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

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

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

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

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