opentofu/internal/states/doc.go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

// Package states contains the types that are used to represent OpenTofu
// states.
package states
Update copyright notice (#1232) Signed-off-by: namgyalangmo <75657887+namgyalangmo@users.noreply.github.com> 2024-02-08 03:48:59 -06:00			`// Copyright (c) The OpenTofu Authors`
			`// SPDX-License-Identifier: MPL-2.0`
			`// Copyright (c) 2023 HashiCorp, Inc.`
[COMPLIANCE] Add Copyright and License Headers 2023-05-02 10:33:06 -05:00			`// SPDX-License-Identifier: MPL-2.0`

Rename terraform to tofu in `GoString` method and docstrings (#576) Signed-off-by: Dmitry Kisler <admin@dkisler.com> 2023-09-26 12:09:27 -05:00			`// Package states contains the types that are used to represent OpenTofu`
states: New package with modern models for Terraform state Our previous state models in the "terraform" package had a few limitations that are addressed here: - Instance attributes were stored as map[string]string with dot-separated keys representing traversals through a data structure. Now that we have a full type system, it's preferable to store it as a real data structure. - The existing state structures skipped over the "resource" concept and went straight to resource instance, requiring heuristics to decide whether a particular resource should appear as a single object or as a list of objects when used in configuration expressions. - Related to the previous point, the state models also used incorrect terminology where "ResourceState" was really a resource instance state and "InstanceState" was really the state of a particular remote object associated with an instance. These new models use the correct names for each of these, introducing the idea of a "ResourceInstanceObject" as the local record of a remote object associated with an instance. This is a first pass at fleshing out a new model for state. Undoubtedly there will be further iterations of this as we work on integrating these new models into the "terraform" package. These new model types no longer serve double-duty as a description of the JSON state file format, since they are for in-memory use only. A subsequent commit will introduce a separate package that deals with persisting state to files and reloading those files later. 2018-06-07 19:27:57 -05:00			`// states.`
			`package states`