terraform

Commit Graph

Author	SHA1	Message	Date
kmoe	6fff41b6de	Delete maintainer-etiquette.md (#32741 )	3 years ago
Brian Flad	0b8c65fa4e	docs: Explicitly mention Computed-only attribute behavior for Proposed New State Reference: `21bb677db7/internal/plans/objchange/objchange.go (L289-L292)` Previously, the resource lifecycle documentation for Proposed New State only mentioned special behavior for Optional and Computed attributes. This minor documentation update mentions that Terraform also imposes special behavior on Computed-only attributes (preserving any Prior State value).	3 years ago
Martin Atkins	e293992d45	docs: "How Terraform Uses Unicode" should mention HCL too I missed this on my first attempt to write this document. Consequently we're currently depending on a version of HCL which uses Unicode 9, and that's significantly lagging behind everything else which is currently on Unicode 13. My goal of adding these docs then is to remind us to update HCL to Unicode 15 once we're updating everything else to Unicode 15 with the Go 1.20 release, assuming that the Go team completes that Unicode upgrade as currently planned.	3 years ago
Brian Flad	8c93420270	docs/plugin-protocol: Add notes about missing configuration in ReadResource and UpgradeResourceState request messages (#31998 ) This opts to inline document these intentional design decisions in the protocol definition as a catch-all for it not being documented elsewhere. Protocol Buffers files updated via: ```shell make protobuf ```	3 years ago
Craig Wright	9854783d34	Merge pull request #31648 from nnzv/patch-3 typo: use destructions singular form	4 years ago
Enzo Venturi	235a8b7fcc	typo: use destructions singular form	4 years ago
Enzo Venturi	467f1d32a0	doc: use american english _Behaviour_ noun is standard in British English.	4 years ago
Laura Pacilio	aeefde7428	Merge pull request #31364 from timgates42/bugfix_typos docs: Fix a few typos	4 years ago
James Bardin	26c569e384	s/Capabilities/ServerCapabilities/	4 years ago
James Bardin	b9f1a5ac57	add Schema Capabilities to protocol	4 years ago
Tim Gates	dce91cafb4	docs: Fix a few typos There are small typos in: - docs/planning-behaviors.md - docs/resource-instance-change-lifecycle.md - website/README.md Fixes: - Should read `exhaustive` rather than `exhastive`. - Should read `representation` rather than `repesentation`. - Should read `preferably` rather than `preferrably`. - Should read `absence` rather than `absense`.	4 years ago
Martin Atkins	543e5f4971	docs: "Resource Instance Change Lifecycle" revised The previous version of this document was produced in haste in order to support the development of the new provider framework, and so it focused only on the most important details and left some of the operations totally unmentioned. This new version aims to capture the full set of managed-resource-related provider operations, documenting when Terraform Core will call them and what the provider ought to do in order to meet Terraform Core's expectations for a valid response. This new version does still assume a certain amount of knowledge on the part of the reader about broadly what Terraform does from a user perspective and what role providers play in that process. Perhaps a future revision will include some additional background context as well, but this is a snapshot of what I had time to do today between other work and so for now I focused on presenting the remaining operations in a similar amount of detail to what was here before.	4 years ago
Martin Atkins	e00f0804ef	development docs: Planning Behaviors For a while now we've had information equivalent to this in various internal documents that we've referred to when designing features such as config-driven refactoring, the "replace" planning option, and so forth. However, so far we've not put that information in any sort of durable public place that we can easily find and refer to when having design discussions on GitHub and similar. This is therefore an attempt to capture a summary of the three main design patterns we've identified for planning-related behaviors, with a few motivating examples of each one, in the hope that this will be a good reference and some helpful inspiration for future design work. It's intentionally not totally comprehensive of all planning behaviors both because that would duplicate the end-user-oriented documentation and because it would be burdensome to keep updating this document each time we add anything new which might fit into these categories. However, we might add a later feature to this document if it illustrates a new take or different perspective on one of these patterns.	4 years ago
Brian Flad	a477d10bd1	Introduce Terraform Plugin Protocol 6.2 with legacy_type_system fields from Protocol 5 (#30375 ) Reference: https://github.com/hashicorp/terraform/issues/30373 This change forward ports the `legacy_type_system` boolean fields in the `ApplyResourceChange.Response` and `PlanResourceChange.Response` messages that existed in protocol version 5, so that existing terraform-plugin-sdk/v2 providers can be muxed with protocol version 6 providers (e.g. terraform-plugin-framework) while also taking advantage of the newer protocol features. This functionality should not be used by any providers or SDKs except those built with terraform-plugin-sdk. Updated via: ```shell cp docs/plugin-protocol/tfplugin6.1.proto docs/plugin-protocol/tfplugin6.2.proto # Copy legacy_type_system fields from tfplugin5.2.proto into ApplyResourceChange.Response and PlanResourceChange rm internal/tfplugin6/tfplugin6.proto ln -s ../../docs/plugin-protocol/tfplugin6.2.proto internal/tfplugin6/tfplugin6.proto go run tools/protobuf-compile/protobuf-compile.go `pwd` # Updates to internal/plugin6/grpc_provider.go ```	4 years ago
Masayuki Morita	bdf683802d	docs: Fix typo in docs/plugin-protocol/releasing-new-version.md	4 years ago
Chris Arcand	f521ba6cd7	Remove 'enhanced' backend type distinction As explained in the changes: The 'enhanced' backend terminology, which only truly pertains to the 'remote' backend with a single API (Terraform Cloud/Enterprise's), has been found to be a confusing vestige which need only be explained in the context of the 'remote' backend. These changes reorient the explanation(s) of backends to pertain more directly to their primary purpose, which is storage of state snapshots (and not implementing operations). That Terraform operations are still _implemented_ by the literal `Backend` and `Enhanced` interfaces is inconsequential a user of Terraform, an internal detail.	4 years ago
James Bardin	fe671206cc	Add detail about the protocol deprecation Make sure it's clear that the deprecated fields serve no purpose, and should be ignored.	4 years ago
James Bardin	24a2bd6301	tfproto version 6.1 Minor version increase to deprecate min_items and max_items in nested types. Nested types have MinItems and MaxItems fields that were inherited from the block implementation, but were never validated by Terraform, and are not supported by the HCL decoder validations. Mark these fields as deprecated, indicating that the SDK should handle the required validation.	4 years ago
Paddy	64a95fc29f	Add docs on how to release a new major protocol version. (#29552 ) Releasing a new major protocol version requires coordination between a few different projects and codebases, and it's easy to forget a step. This commit introduces a doc to keep track of these steps, making it less likely one will be omitted or forgotten.	5 years ago
Martin Atkins	0f015a7ff2	docs: Some notes on adopting new Unicode versions Previously this is a task that I've just taken on using my own knowledge of how these parts fit together, but that's not at all a sustainable situation, and so here I've just documented the steps I've followed in for previous Unicode version upgrades, and thus which I'd expect to follow for future Unicode version upgrades too. I hope this is also a somewhat-interesting overview of how Terraform makes use of Unicode, even for folks who are just working on the other relevant features of Terraform and not specifically trying to change Terraform's Unicode support. Since I'm the primary maintainer of two of the dependencies involved in this it seems likely that following this process will still involve me in _some_ capacity, but hopefully only necessarily in the form of reviewing PRs and cutting new releases of those libraries.	5 years ago
Martin Atkins	d35bc05312	Update various non-code references to renamed Go packages Previous commits have moved all of our Go packages under "internal", so this is a retroactive update of non-Go references to those same packages.	5 years ago
James Bardin	44199ae4ba	update destroying doc to show show more CBD detail Update the create-before-destroy cases in the destroying.md document.	5 years ago
James Bardin	dcb12195a3	update destroying.md Update the full-replacement example graph to show the transitive dependency that is required for the destroy-then-update case. Add another example describing the case where we reduce the graph to only an update and replace and the dependency on the destroy node remains.	5 years ago
Kristin Laemmert	c99d02f326	update arch docs; remove old EvalNode references (#27900 ) * update arch docs; remove old EvalNode and EvalTree references	5 years ago
Kristin Laemmert	106bcd3bf0	update to match new default branch name (#27909 )	5 years ago
Kristin Laemmert	ff05362d51	providers.Interface: rename ValidateDataSourceConfig to ValidateDataResourceConfig (#27874 ) * providers.Interface: rename ValidateDataSourceConfig to ValidateDataResourceConfig This PR came about after renaming ValidateResourceTypeConfig to ValidateResourceConfig: I now understand that we'd called it the former instead of the latter to indicate that the function wasn't necessarily operating on a resource that actually exists. A possibly-more-accurate renaming of both functions might then be ValidateManagedResourceConfig and ValidateDataResourceConfig. The next commit will update the protocol (v6 only) as well; these are in separate commits for reviewers and will get squashed together before merging. * extend renaming to protov6	5 years ago
Antoine Cotten	21d881d4d1	Update "Terraform Core Architecture Summary" doc (#27897 ) * Update Godoc links from godoc.org to pkg.go.dev * Update reference to renamed GraphNodeResource interface Ref hashicorp/terraform#24389 * Update dead links; minor formatting adjustments * Add FIXME item following deprecation of EvalNode	5 years ago
Kristin Laemmert	f3a057eb35	plugin-protocol v6 This is the first commit for plugin protocol v6. This is currently unused (dead) code; future commits will add the necessary conversion packages, extend configschema, and modify the providers.Interface. The new plugin protocol includes the following changes: - A new field has been added to Attribute: NestedType. This will be the key new feature in plugin protocol v6 - Several massages were renamed for consistency with the verb-noun pattern seen in _most_ messages. - The prepared_config has been removed from PrepareProviderConfig (renamed ValidateProviderConfig), as it has never been used. - The provisioner service has been removed entirely. This has no impact on built-in provisioners. 3rd party provisioners are not supported by the SDK and are not included in this protocol at all.	5 years ago
Nick Fagerlund	a60120477c	Update links to CLI docs in code comments, messages, and readme	5 years ago
James Bardin	ccf19fbf5e	regenerate plugin proto with correct tooling The proto file is structurally unchanged, though it now requires a go import path option.	5 years ago
Martin Atkins	6b4ed241d3	docs: Provider protocol wire format for values Although we have in this same directory the protocol buffers schemas for the static parts of the provider wire protocol, many of the protocol messages include DynamicValue messages that are presented in a nested dynamic serialization format. That format was previously not documented, and was thus defined only by the implementation. Terraform happens to use a third-party library to implement parts of this encoding, which means that the rules were even harder to track down from reading the code. Regardless of how Terraform happens to implement its serialization and deserialization of DynamicValue, it's the wire format that is contractual and so this document is an implementation-agnostic description of the mapping rules for serializing any Terraform Language value by reference to a provider-defined schema. All future changes to the rules described in here must be backward compatible until protocol major version 6, which is not currently planned.	6 years ago
MorganGeek	3b6c1ef156	Fix spelling mistakes/typos in documentation	6 years ago
James Bardin	b6c409613e	make all unnecessary edges dotted There were a couple missing	6 years ago
James Bardin	1c1782bb1b	add lists of operations	6 years ago
James Bardin	dcf62ed378	Fix typo and add more information about CBD The reason for the interleaved updated in CBD is important. fix	6 years ago
James Bardin	fb9c8261c5	replace the incorrect graph image The dot in the comment was correct, so it was just the wrong image saved.	6 years ago
James Bardin	16b7541277	Apply suggestions from code review Co-authored-by: Alisdair McDiarmid <alisdair@users.noreply.github.com>	6 years ago
James Bardin	642dadcd96	add doc about destroying resources and ordering	6 years ago
Kyler Middleton	89bef596fc	docs: Fix typo in maintainer-etiquette (#24609 )	6 years ago
Paddy	e6592dc710	Add support for provider metadata to modules. (#22583 ) Implement a new provider_meta block in the terraform block of modules, allowing provider-keyed metadata to be communicated from HCL to provider binaries. Bundled in this change for minimal protocol version bumping is the addition of markdown support for attribute descriptions and the ability to indicate when an attribute is deprecated, so this information can be shown in the schema dump. Co-authored-by: Paul Tyng <paul@paultyng.net>	6 years ago
Martin Atkins	39e609d5fd	vendor: switch to HCL 2.0 in the HCL repository Previously we were using the experimental HCL 2 repository, but now we'll shift over to the v2 import path within the main HCL repository as part of actually releasing HCL 2.0 as stable. This is a mechanical search/replace to the new import paths. It also switches to the v2.0.0 release of HCL, which includes some new code that Terraform didn't previously have but should not change any behavior that matters for Terraform's purposes. For the moment the experimental HCL2 repository is still an indirect dependency via terraform-config-inspect, so it remains in our go.sum and vendor directories for the moment. Because terraform-config-inspect uses a much smaller subset of the HCL2 functionality, this does still manage to prune the vendor directory a little. A subsequent release of terraform-config-inspect should allow us to completely remove that old repository in a future commit.	6 years ago
Martin Atkins	e1af10b554	docs: README for the plugin-protocol directory This is an initial partial description of the plugin protocol focused mainly on explaining the purpose of the .proto files. In subsequent updates we will also document the negotiation protocol, etc. For this first pass the goal was just to publish some information that was already available in an internal design document so that it's visible to SDK implementers. It is focused on the .proto versioning strategy because that was the main topic of the internal design documentation this was based on.	7 years ago
James Bardin	fa1f9be539	add tfplugin proto docs files Add versioned tfplugin proto files to the docs directory, for easier reference. The latest version starts as a symlink to the current file used for generated the tfplugin package in ./internal/tfplugin5. When changing the protocol version, the old file must be copied to ./docs/plugin-protocol/, and a new symlink created for the latest version.	7 years ago
Martin Atkins	1f241f8f83	docs: Some updates to the architecture summary This doc was originally written in the middle of Terraform v0.12 development while some refactoring was already in progress. Here we update those parts to refer to where the relevant functionality finally landed, and also update some things that we did not anticipate changing at the time but ended up having to be changed during the v0.12 development anyway.	7 years ago
Martin Atkins	18c88f5a41	docs: Import some existing docs to bootstrap the codebase docs section For a while now we've been gathering some codebase-level docs that felt out-of-place on the main Terraform website (since they are about the implementation, not usage) but we had no existing suitable place to put them. In order to make this information more available (and, hopefully, more likely to stay up-to-date as we change things), here we'll establish the "docs" directory as a place to keep documentation aimed at those who are working on code changes to the Terraform Core codebase. User-oriented docs should never appear in this directory. The Terraform website is always the better place for those. The set of docs here is rudimentary to start and we'll see if it makes sense to expand and reorganize it over time based on the experience with having these initial docs available.	7 years ago
Julien Pivotto	a4f4c70c60	mons-months: fix typo in maintainer-etiquette	9 years ago
Radek Simko	df26c5460c	docs: Add Maintainer's etiquette	9 years ago

47 Commits (c06db2aaddad1ef58cdc0eb46166aecfd705b7e9)