Skip to content

Latest commit

 

History

History
58 lines (55 loc) · 10.6 KB

provider_scripted.md

File metadata and controls

58 lines (55 loc) · 10.6 KB

provider scripted

Arguments reference

Argument Type Description Default
commands_create string Create command. update_command
REMOVED commands_customizediff_computekeys string Command printing keys to be forced to recompute. Lines must be prefixed with LinePrefix and keys separated by whitespace characters not set
commands_delete string Delete command not set
commands_delete_on_not_exists bool Delete resource when exists fails true
commands_delete_on_read_failure bool Delete resource when read fails false
commands_dependencies string Command determining whether dependencies are met, dependencies met triggered by {{ .TriggerString }} not set
commands_dependencies_error bool Should commands fail on dependencies not met? false
commands_environment_include_json_context bool Should whole TemplateContext be passed as JSON serialized TF_SCRIPTED_CONTEXT environment variable to commands? false
commands_environment_include_parent bool Include whole parent environment in the command? false
commands_environment_inherit_variables list List of environment variables to inherit from parent. $TF_SCRIPTED_ENVIRONMENT_INHERIT_VARIABLES (JSON array)
commands_environment_prefix_new string New environment prefix (skip if empty) not set
commands_environment_prefix_old string Old environment prefix (skip if empty) not set
commands_exists string Exists command, not-exists triggered by {{ .TriggerString }} not set
commands_id string Command building resource id not set
commands_interpreter list Interpreter and it's arguments, can be a template with command variable. $TF_SCRIPTED_COMMANDS_INTERPRETER (JSON array), ["cmd","/C","{{ .command }}"] (windows) or ["bash","-Eeuo","pipefail","-c","{{ .command }}"]
commands_interpreter_is_provider bool Should interpreter be considered provider implementation? Should execude commands based based on TF_SCRIPTED_CONTEXT envvar (context's .Command) and ignore command line arguments. false
commands_interpreter_provider_commands list Commands supported by interpreter-provider. result of running interpreter with commands argument
commands_modify_prefix string Modification commands (create and update) prefix not set
commands_needs_update string Command indicating whether resource should be updated, update triggered by {{ .TriggerString }} not set
commands_prefix string Command prefix shared between all commands not set
commands_prefix_fromenv string Command prefix shared between all commands (added before commands_prefix) $TF_SCRIPTED_COMMANDS_PREFIX_FROMENV or not set
commands_read string Read command not set
commands_read_use_default_line_prefix bool Ignore lines in read command without default line prefix instead of read-specific $TF_SCRIPTED_COMMANDS_READ_USE_DEFAULT_LINE_PREFIX == ""
commands_separator string Format for joining 2 commands together without isolating them. $TF_SCRIPTED_COMMANDS_SEPARATOR or %s\n%s
commands_update string Update command. Deletes then creates if not set. Can be used in place of create_command. not set
commands_working_directory string Working directory to run commands in $TF_SCRIPTED_COMMANDS_WORKING_DIRECTORY or not set
dependencies map Dependencies purely for provider graph walking, otherwise ignored. not set
line_prefix string General line prefix $TF_SCRIPTED_LINE_PREFIX or QmGRizGk1fdPEBVVZSGkCRPJRgAe9p07B
logging_buffer_size int output (on error) buffer sizes 8192
logging_iids bool Should output lines contain piid (provider instance id) and riid (resource instance id? $TF_SCRIPTED_LOGGING_IIDS == ""
logging_jsonformat bool should logs be json instead of plain text? $TF_SCRIPTED_LOGGING_JSONFORMAT != ""
logging_jsonlist bool should json log formatter output lists instead of direct values? $TF_SCRIPTED_LOGGING_JSONLIST == ""
logging_jsonlistpromote bool should json log formatter promote single values to lists and append? $TF_SCRIPTED_LOGGING_JSONLISTPROMOTE != ""
logging_log_level string Logging level: TRACE, DEBUG, INFO, WARN, ERROR. $TF_SCRIPTED_LOG_LEVEL or INFO
logging_log_path string Additional logs output path. $TF_SCRIPTED_LOG_PATH or not set
logging_output_line_width int Width of command's line to use during formatting. $TF_SCRIPTED_LOGGING_OUTPUT_LINE_WIDTH
logging_output_logging_log_level string Command stdout/stderr log level: TRACE, DEBUG, INFO, WARN, ERROR. $TF_SCRIPTED_OUTPUT_LOG_LEVEL or INFO
logging_output_parent_stderr bool should we log directly to parent's stderr instead of our own? $TF_SCRIPTED_LOGGING_OUTPUT_PARENT_STDERR == ""
logging_pids bool Should output lines contain ppid and pid? $TF_SCRIPTED_LOGGING_PIDS == ""
logging_provider_name string Name to display in log entries for this provider not set
logging_running_messages_interval float should resources report still being in a running state? Trigger reports every N seconds. $TF_SCRIPTED_LOGGING_RUNNING_MESSAGES_INTERVAL
open_parent_stderr bool should we open 3rd file descriptor as parent's Stderr? $TF_SCRIPTED_OPEN_PARENT_STDERR == ""
output_compute_keys list List of output keys which are forced to be computed on change. not set
output_format string Templates output types: raw /^(?<key>[^=]+)=(?<value>[^\n]*)$/, base64 /^(?<key>[^=]+)=(?<value_base64>[^\n]*)$/ or one JSON object per line overriding previously existing keys. $TF_SCRIPTED_OUTPUT_FORMAT or raw
output_line_prefix string Ignore lines in read command without this prefix. $TF_SCRIPTED_OUTPUT_LINE_PREFIX or not set
state_compute_keys list List of state keys which are forced to be computed on change. not set
state_format string Create/Update state output format, for more info see output_format. $TF_SCRIPTED_STATE_FORMAT or output_format
state_line_prefix string State line prefix $TF_SCRIPTED_STATE_LINE_PREFIX or WViRV1TbGAGehAYFL8g3ZL8o1cg1bxaq
templates_left_delim string Left delimiter for templates. $TF_SCRIPTED_TEMPLATES_LEFT_DELIM or {{
templates_right_delim string Right delimiter for templates. $TF_SCRIPTED_TEMPLATES_RIGHT_DELIM or }}
trigger_string string TriggerString for exists, dependencies_met and needs_update $TF_SCRIPTED_TRIGGER_STRING or ndn4VFxYG489bUmV6xKjKFE0RYQIJdts