Directories
¶
| Path | Synopsis |
|---|---|
|
Package addrs contains types that represent "addresses", which are references to specific objects within a OpenTofu configuration or state.
|
Package addrs contains types that represent "addresses", which are references to specific objects within a OpenTofu configuration or state. |
|
Package backend provides interfaces that the CLI uses to interact with OpenTofu.
|
Package backend provides interfaces that the CLI uses to interact with OpenTofu. |
|
init
Package init contains the list of backends that can be initialized and basic helper functions for initializing those backends.
|
Package init contains the list of backends that can be initialized and basic helper functions for initializing those backends. |
|
remote-state/gcs
Package gcs implements remote storage of state on Google Cloud Storage (GCS).
|
Package gcs implements remote storage of state on Google Cloud Storage (GCS). |
|
builtin
|
|
|
Package checks contains the models for representing various kinds of declarative condition checks that can be defined in a OpenTofu module and then evaluated and reported by OpenTofu Core during plan and apply operations.
|
Package checks contains the models for representing various kinds of declarative condition checks that can be defined in a OpenTofu module and then evaluated and reported by OpenTofu Core during plan and apply operations. |
|
cliconfig
Package cliconfig has the types representing and the logic to load CLI-level configuration settings.
|
Package cliconfig has the types representing and the logic to load CLI-level configuration settings. |
|
cliconfig/ociauthconfig
Package ociauthconfig contains types used for describing OCI authentication settings, and helpers for discovering such settings from container engine configuration files as described in https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md .
|
Package ociauthconfig contains types used for describing OCI authentication settings, and helpers for discovering such settings from container engine configuration files as described in https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md . |
|
cliconfig/svcauthconfig
Package svcauthconfig contains some helper functions and types to support the cliconfig package's use of github.com/opentofu/svchost/svcauth, which is our mechanism for representing the policy for authenticating to OpenTofu-native services such as implementations OpenTofu's provider registry protocol.
|
Package svcauthconfig contains some helper functions and types to support the cliconfig package's use of github.com/opentofu/svchost/svcauth, which is our mechanism for representing the policy for authenticating to OpenTofu-native services such as implementations OpenTofu's provider registry protocol. |
|
clistate
Package state exposes common helpers for working with state from the CLI.
|
Package state exposes common helpers for working with state from the CLI. |
|
e2etest
Package e2etest contains a set of tests that run against a real OpenTofu binary, compiled on the fly at the start of the test run.
|
Package e2etest contains a set of tests that run against a real OpenTofu binary, compiled on the fly at the start of the test run. |
|
e2etest/fakeocireg
Package fakeocireg provides a minimal, read-only implementation of the OCI Distribution protocol that interacts with a local filesystem directory.
|
Package fakeocireg provides a minimal, read-only implementation of the OCI Distribution protocol that interacts with a local filesystem directory. |
|
format
Package format contains helpers for formatting various OpenTofu structures for human-readable output.
|
Package format contains helpers for formatting various OpenTofu structures for human-readable output. |
|
jsonchecks
Package jsonchecks implements the common JSON representation of check results/statuses that we use across both the JSON plan and JSON state representations.
|
Package jsonchecks implements the common JSON representation of check results/statuses that we use across both the JSON plan and JSON state representations. |
|
jsonconfig
Package jsonconfig implements methods for outputting a configuration snapshot in machine-readable json format
|
Package jsonconfig implements methods for outputting a configuration snapshot in machine-readable json format |
|
jsonentities
Package jsonentities contains the entities for representing a few common resources used around the json* packages.
|
Package jsonentities contains the entities for representing a few common resources used around the json* packages. |
|
jsonformat/computed
Package computed contains types that represent the computed diffs for OpenTofu blocks, attributes, and outputs.
|
Package computed contains types that represent the computed diffs for OpenTofu blocks, attributes, and outputs. |
|
jsonformat/structured
Package structured contains the structured representation of the JSON changes returned by the jsonplan package.
|
Package structured contains the structured representation of the JSON changes returned by the jsonplan package. |
|
jsonplan
Package jsonplan implements methods for outputting a plan in a machine-readable json format
|
Package jsonplan implements methods for outputting a plan in a machine-readable json format |
|
jsonprovider
Package jsonprovider contains types and functions to marshal OpenTofu provider schemas into a json formatted output.
|
Package jsonprovider contains types and functions to marshal OpenTofu provider schemas into a json formatted output. |
|
jsonstate
Package jsonstate implements methods for outputting a state in a machine-readable json format
|
Package jsonstate implements methods for outputting a state in a machine-readable json format |
|
workdir
Package workdir models the various local artifacts and state we keep inside a OpenTofu "working directory".
|
Package workdir models the various local artifacts and state we keep inside a OpenTofu "working directory". |
|
Package configs contains types that represent OpenTofu configurations and the different elements thereof.
|
Package configs contains types that represent OpenTofu configurations and the different elements thereof. |
|
configload
Package configload knows how to install modules into the .terraform/modules directory and to load modules from those installed locations.
|
Package configload knows how to install modules into the .terraform/modules directory and to load modules from those installed locations. |
|
configschema
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime.
|
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime. |
|
Package depsfile contains the logic for reading and writing OpenTofu's dependency lock and development override configuration files.
|
Package depsfile contains the logic for reading and writing OpenTofu's dependency lock and development override configuration files. |
|
keyprovider/pbkdf2
Package pbkdf2 contains a key provider that takes a passphrase and emits a PBKDF2 hash of the configured length.
|
Package pbkdf2 contains a key provider that takes a passphrase and emits a PBKDF2 hash of the configured length. |
|
keyprovider/static
Package static contains a key provider that emits a static key.
|
Package static contains a key provider that emits a static key. |
|
keyprovider/xor
Package xor contains a key provider that combines two other keys.
|
Package xor contains a key provider that combines two other keys. |
|
method/external/testmethod/data
command
|
|
|
engine
|
|
|
internal/exec
Package exec contains the models and main interface used for apply phase execution.
|
Package exec contains the models and main interface used for apply phase execution. |
|
internal/execgraph/execgraphproto
Package execgraphproto contains just the protocol buffers models we use for marshaling and unmarshaling execution graphs.
|
Package execgraphproto contains just the protocol buffers models we use for marshaling and unmarshaling execution graphs. |
|
planning
Package planning implements a planning engine for OpenTofu, which takes a prior state and a configuration instance (which can be evaluated to produce a desired state) and proposes a set of changes to make to bring the remote system closer to convergence with the desired state.
|
Package planning implements a planning engine for OpenTofu, which takes a prior state and a configuration instance (which can be evaluated to produce a desired state) and proposes a set of changes to make to bring the remote system closer to convergence with the desired state. |
|
Package experiments contains the models and logic for opt-in experiments that can be activated for a particular OpenTofu module.
|
Package experiments contains the models and logic for opt-in experiments that can be activated for a particular OpenTofu module. |
|
Package genconfig implements config generation from provided state values.
|
Package genconfig implements config generation from provided state values. |
|
Package getmodules contains the low-level functionality for fetching remote module packages.
|
Package getmodules contains the low-level functionality for fetching remote module packages. |
|
Package getproviders is the lowest-level provider automatic installation functionality.
|
Package getproviders is the lowest-level provider automatic installation functionality. |
|
helper
|
|
|
Package initwd contains various helper functions used by the "tofu init" command to initialize a working directory.
|
Package initwd contains various helper functions used by the "tofu init" command to initialize a working directory. |
|
Package ipaddr is a fork of a subset of the Go standard "net" package which retains parsing behaviors from Go 1.16 or earlier.
|
Package ipaddr is a fork of a subset of the Go standard "net" package which retains parsing behaviors from Go 1.16 or earlier. |
|
Package lang deals with the runtime aspects of OpenTofu's configuration language, with concerns such as expression evaluation.
|
Package lang deals with the runtime aspects of OpenTofu's configuration language, with concerns such as expression evaluation. |
|
blocktoattr
Package blocktoattr includes some helper functions that can perform preprocessing on a HCL body where a configschema.Block schema is available in order to allow list and set attributes defined in the schema to be optionally written by the user as block syntax.
|
Package blocktoattr includes some helper functions that can perform preprocessing on a HCL body where a configschema.Block schema is available in order to allow list and set attributes defined in the schema to be optionally written by the user as block syntax. |
|
eval
Package eval aims to encapsulate the details of evaluating the objects in an overall configuration, including all of the expressions written inside their declarations, in a way that can be reused across various different phases of execution.
|
Package eval aims to encapsulate the details of evaluating the objects in an overall configuration, including all of the expressions written inside their declarations, in a way that can be reused across various different phases of execution. |
|
eval/internal/tofu2024
Package tofu2024 contains the "module compiler" implementation for the first edition of the OpenTofu language, established with OpenTofu v1.6 in 2024 and then gradually evolved in backward-compatible ways.
|
Package tofu2024 contains the "module compiler" implementation for the first edition of the OpenTofu language, established with OpenTofu v1.6 in 2024 and then gradually evolved in backward-compatible ways. |
|
exprs
Package exprs contains supporting code for expression evaluation.
|
Package exprs contains supporting code for expression evaluation. |
|
globalref
Package globalref is home to some analysis algorithms that aim to answer questions about references between objects and object attributes across an entire configuration.
|
Package globalref is home to some analysis algorithms that aim to answer questions about references between objects and object attributes across an entire configuration. |
|
grapheval
Package grapheval contains some low-level helpers for coordinating interdependent work happening across different parts of the system, including detection and reporting of self-dependency problems that would otherwise cause a deadlock.
|
Package grapheval contains some low-level helpers for coordinating interdependent work happening across different parts of the system, including detection and reporting of self-dependency problems that would otherwise cause a deadlock. |
|
lint
Package lint contains a collection of helpers for performing "lint-like" checks to try to detect configuration constructs that are valid but nonetheless very likely to be a mistake.
|
Package lint contains a collection of helpers for performing "lint-like" checks to try to detect configuration constructs that are valid but nonetheless very likely to be a mistake. |
|
types
Package types contains non-standard cty types used only within OpenTofu.
|
Package types contains non-standard cty types used only within OpenTofu. |
|
legacy
|
|
|
hcl2shim
Package hcl2shim contains a small number of "shimming" utilities that the other packages under internal/legacy use to adapt from HCL 2 concepts to legacy concepts.
|
Package hcl2shim contains a small number of "shimming" utilities that the other packages under internal/legacy use to adapt from HCL 2 concepts to legacy concepts. |
|
helper/acctest
Package acctest contains for OpenTofu Acceptance Tests
|
Package acctest contains for OpenTofu Acceptance Tests |
|
helper/schema
Package schema is a legacy package that used to represent the SDK, which is now its own library external to OpenTofu Core https://github.com/hashicorp/terraform-plugin-sdk Some of it is still used by OpenTofu's remote state backends, but this entire package should be removed in the future.
|
Package schema is a legacy package that used to represent the SDK, which is now its own library external to OpenTofu Core https://github.com/hashicorp/terraform-plugin-sdk Some of it is still used by OpenTofu's remote state backends, but this entire package should be removed in the future. |
|
Package stateless implements OpenTofu's stateless mode: a run mode with no authoritative state file, no backend, and no lock.
|
Package stateless implements OpenTofu's stateless mode: a run mode with no authoritative state file, no backend, and no lock. |
|
discovery
Package discovery finds the live resources of a stateless estate by their ownership markers and binds them to the addresses that declare them.
|
Package discovery finds the live resources of a stateless estate by their ownership markers and binds them to the addresses that declare them. |
|
flocitest
Package flocitest holds the gate, the fixture paths and the container bookkeeping that the floci integration tests share.
|
Package flocitest holds the gate, the fixture paths and the container bookkeeping that the floci integration tests share. |
|
foreign
Package foreign classifies the live resources an estate does not own, and is the safety property of stateless mode: a live resource nobody claims is surfaced, and is never a deletion candidate.
|
Package foreign classifies the live resources an estate does not own, and is the safety property of stateless mode: a live resource nobody claims is surfaced, and is never a deletion candidate. |
|
identity
Package identity classifies the identity of every managed resource instance in a configuration, using nothing but the configuration itself.
|
Package identity classifies the identity of every managed resource instance in a configuration, using nothing but the configuration itself. |
|
lifecycle
Package lifecycle holds five integration tests and nothing else: the lifecycle test itself (P4.1), the snapshot test (P4.2), the exactness test (P5.1), the crash-mid-apply test (the concurrency taxonomy's crash row, run rather than argued), and the existence-flavor receipt test (RA.6).
|
Package lifecycle holds five integration tests and nothing else: the lifecycle test itself (P4.1), the snapshot test (P4.2), the exactness test (P5.1), the crash-mid-apply test (the concurrency taxonomy's crash row, run rather than argued), and the existence-flavor receipt test (RA.6). |
|
lint
Package lint is the stateless-mode subset check: the pass that decides whether a configuration can be planned with no authoritative state at all.
|
Package lint is the stateless-mode subset check: the pass that decides whether a configuration can be planned with no authoritative state at all. |
|
listclient
Package listclient is stateless mode's client for the provider list protocol: the ListResource server-streaming RPC and the list resource schemas that parameterize it.
|
Package listclient is stateless mode's client for the provider list protocol: the ListResource server-streaming RPC and the list resource schemas that parameterize it. |
|
markers
Package markers is live/MARKERS.md in code: the ownership tag keys, the escaping rule that lets a resource address live in a tag value, and the reading of those tags off a live object.
|
Package markers is live/MARKERS.md in code: the ownership tag keys, the escaping rule that lets a resource address live in a tag value, and the reading of those tags off a live object. |
|
mv
Package mv performs the rename operation stateless mode has instead of `moved` blocks and state surgery: it rewrites the tofu-address ownership marker on one live resource.
|
Package mv performs the rename operation stateless mode has instead of `moved` blocks and state surgery: it rewrites the tofu-address ownership marker on one live resource. |
|
projection
Package projection materializes an ephemeral prior state by reading the live system.
|
Package projection materializes an ephemeral prior state by reading the live system. |
|
slots
Package slots is the set matcher for count instances: the rule that turns "N declared instances and M live resources" into a binding, without any index participating in identity.
|
Package slots is the set matcher for count instances: the rule that turns "N declared instances and M live resources" into a binding, without any index participating in identity. |
|
stamp
Package stamp makes ownership markers something the tool guarantees rather than something the configuration author remembered to write.
|
Package stamp makes ownership markers something the tool guarantees rather than something the configuration author remembered to write. |
|
Package modsdir is an internal package containing the model types used to represent the manifest of modules in a local modules cache directory.
|
Package modsdir is an internal package containing the model types used to represent the manifest of modules in a local modules cache directory. |
|
Package plans contains the types that are used to represent OpenTofu plans.
|
Package plans contains the types that are used to represent OpenTofu plans. |
|
internal/planproto
Package planproto is home to the Go stubs generated from the tfplan protobuf schema.
|
Package planproto is home to the Go stubs generated from the tfplan protobuf schema. |
|
objchange
Package objchange deals with the business logic of taking a prior state value and a config value and producing a proposed new merged value, along with other related rules in this domain.
|
Package objchange deals with the business logic of taking a prior state value and a config value and producing a proposed new merged value, along with other related rules in this domain. |
|
planfile
Package planfile deals with the file format used to serialize plans to disk and then deserialize them back into memory later.
|
Package planfile deals with the file format used to serialize plans to disk and then deserialize them back into memory later. |
|
mock_proto
Package mock_tfplugin5 is a generated GoMock package.
|
Package mock_tfplugin5 is a generated GoMock package. |
|
mock_proto
Package mock_tfplugin6 is a generated GoMock package.
|
Package mock_tfplugin6 is a generated GoMock package. |
|
simple provider a minimal provider implementation for testing
|
simple provider a minimal provider implementation for testing |
|
main
command
|
|
|
simple provider a minimal provider implementation for testing
|
simple provider a minimal provider implementation for testing |
|
main
command
|
|
|
Package providercache contains the logic for auto-installing providers from packages obtained elsewhere, and for managing the local directories that serve as global or single-configuration caches of those auto-installed providers.
|
Package providercache contains the logic for auto-installing providers from packages obtained elsewhere, and for managing the local directories that serve as global or single-configuration caches of those auto-installed providers. |
|
Package providers contains the interface and primary types required to implement a OpenTofu resource provider.
|
Package providers contains the interface and primary types required to implement a OpenTofu resource provider. |
|
provisioner-local-exec
|
|
|
main
command
|
|
|
Package provisioners contains the interface and primary types to implement a OpenTofu resource provisioner.
|
Package provisioners contains the interface and primary types to implement a OpenTofu resource provisioner. |
|
Package repl provides the structs and functions necessary to run REPL for OpenTofu.
|
Package repl provides the structs and functions necessary to run REPL for OpenTofu. |
|
Package replacefile is a small helper package focused directly at the problem of atomically "renaming" one file over another one.
|
Package replacefile is a small helper package focused directly at the problem of atomically "renaming" one file over another one. |
|
Package resources contains helpers that encapsulate the main interactions OpenTofu has with resource instance objects, wrapping the raw provider client calls with certain preprocessing, postprocessing, and validation logic that ought to happen regardless of why OpenTofu is asking each of these questions.
|
Package resources contains helpers that encapsulate the main interactions OpenTofu has with resource instance objects, wrapping the raw provider client calls with certain preprocessing, postprocessing, and validation logic that ought to happen regardless of why OpenTofu is asking each of these questions. |
|
Package states contains the types that are used to represent OpenTofu states.
|
Package states contains the types that are used to represent OpenTofu states. |
|
statefile
Package statefile deals with the file format used to serialize states for persistent storage and then deserialize them into memory again later.
|
Package statefile deals with the file format used to serialize states for persistent storage and then deserialize them into memory again later. |
|
statemgr
Package statemgr defines the interfaces and some supporting functionality for "state managers", which are components responsible for writing state to some persistent storage and then later retrieving it.
|
Package statemgr defines the interfaces and some supporting functionality for "state managers", which are components responsible for writing state to some persistent storage and then later retrieving it. |
|
Package terminal encapsulates some platform-specific logic for detecting if we're running in a terminal and, if so, properly configuring that terminal to meet the assumptions that the rest of OpenTofu makes.
|
Package terminal encapsulates some platform-specific logic for detecting if we're running in a terminal and, if so, properly configuring that terminal to meet the assumptions that the rest of OpenTofu makes. |
|
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user.
|
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user. |
Click to show internal directories.
Click to hide internal directories.