Команда: providers schema
Команда tofu providers schema используется для вывода подробных схем провайдеров, используемых в текущей конфигурации.
Использование
Использование: tofu providers schema [options]
Использование переменных в источниках модулей, конфигурации бэкенда или блоке шифрования требует задания значений переменным корневого модуля при запуске tofu providers schema.
Доступны следующие флаги:
-
-json- Выводит схемы в машиночитаемом формате JSON. -
-var 'NAME=VALUE'- Задает значение для одной входной переменной, объявленной в корневом модуле конфигурации. Используйте этот параметр несколько раз, чтобы задать значения нескольких переменных. Дополнительные сведения см. в разделе Входные переменные в командной строке. -
-var-file=FILENAME- Задает значения для любого количества входных переменных, объявленных в корневом модуле конфигурации, используя определения из файла «tfvars». Используйте этот параметр несколько раз, чтобы включить значения из нескольких файлов.
Помимо параметров -var и -var-file, существуют и другие способы задать значения входных переменных в корневом модуле. Дополнительные сведения см. в разделе Задание значений переменным корневого модуля.
Обратите внимание, что в настоящее время флаг -json является обязательным параметром. В будущих выпусках эта команда будет расширена и получит дополнительные параметры.
Вывод содержит ключ format_version со значением "1.0". Семантика этой версии следующая:
- Для обратно совместимых изменений или дополнений мы будем увеличивать младшую версию, например
"1.1". Чтобы сохранить совместимость с будущими младшими версиями, игнорируйте свойства объектов с неизвестными именами. - Для несовместимых изменений мы будем увеличивать старшую версию, например
"2.0". Отклоняйте любые входные данные, в которых указана неподдерживаемая старшая версия.
Новые старшие версии будут вводиться только в рамках гарантий совместимости OpenTofu 1.0.
Краткое описание формата
В следующих разделах на примерах описан формат вывода JSON с использованием псевдо-JSON-нотации. Важные элементы описаны в комментариях, начинающихся с //. Чтобы избежать излишних повторов, мы разделили полный формат на несколько отдельных подобъектов, описанных в отдельных разделах. Ссылки в угловых скобках (например, <block-representation>) — это заполнители, которые в реальном выводе будут заменены экземпляром указанного подобъекта.
Формат вывода JSON состоит из следующих объектов и подобъектов:
-
Представление схемы провайдеров — объект верхнего уровня, возвращаемый командой
tofu providers schema -json - Представление схемы — подобъект провайдеров, ресурсов и источников данных, описывающий их схему
- Представление блока — подобъект схем, описывающий атрибуты и вложенные блоки
Представление схемы провайдеров
{
"format_version": "1.0",
// "provider_schemas" describes the provider schemas for all
// providers throughout the configuration tree.
"provider_schemas": {
// keys in this map are the provider type, such as "random"
"example_provider_name": {
// "provider" is the schema for the provider configuration
"provider": <schema-representation>,
// "resource_schemas" map the resource type name to the resource's schema
"resource_schemas": {
"example_resource_name": <schema-representation>
},
// "data_source_schemas" map the data source type name to the
// data source's schema
"data_source_schemas": {
"example_datasource_name": <schema-representation>,
}
},
"example_provider_two": { … }
}
}Представление схемы
Представление схемы объединяет схему провайдера или ресурса (в «блоке») с версией этой схемы.
{
// "version" is the schema version, not the provider version
"version": int64,
"block": <block-representation>
}Представление блока
Представление блока содержит «атрибуты» и «block_types» (которые представляют вложенные блоки).
{
// "attributes" describes any attributes that appear directly inside the
// block. Keys in this map are the attribute names.
"attributes": {
"example_attribute_name": {
// "type" is a representation of a type specification
// that the attribute's value must conform to.
"type": "string",
// "description" is an English-language description of
// the purpose and usage of the attribute.
"description": "string",
// "required", if set to true, specifies that an
// omitted or null value is not permitted.
"required": bool,
// "optional", if set to true, specifies that an
// omitted or null value is permitted.
"optional": bool,
// "computed", if set to true, indicates that the
// value comes from the provider rather than the
// configuration.
"computed": bool,
// "sensitive", if set to true, indicates that the
// attribute may contain sensitive information.
"sensitive": bool
},
},
// "block_types" describes any nested blocks that appear directly
// inside the block.
// Keys in this map are the names of the block_type.
"block_types": {
"example_block_name": {
// "nesting_mode" describes the nesting mode for the
// child block, and can be one of the following:
// single
// list
// set
// map
"nesting_mode": "list",
"block": <block-representation>,
// "min_items" and "max_items" set lower and upper
// limits on the number of child blocks allowed for
// the list and set modes. These are
// omitted for other modes.
"min_items": 1,
"max_items": 3
}
}
Copyright (c) The OpenTofu Authors
Copyright (c) 2014 HashiCorp, Inc.
Mozilla Public License, version 2.0
https://opentofu.org/docs/v1.11/cli/commands/providers/schema/