opentofu/internal/providercache/doc.go

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

// 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.
//
// It builds on the lower-level provider source functionality provided by
// the internal/getproviders package, adding the additional behaviors around
// obtaining the discovered providers and placing them in the cache
// directories for subsequent use.
package providercache
[COMPLIANCE] Add Copyright and License Headers 2023-05-02 10:33:06 -05:00			`// Copyright (c) HashiCorp, Inc.`
			`// SPDX-License-Identifier: MPL-2.0`

providercache: A package to encapsulate management of provider cache dirs Historically our logic to handle discovering and installing providers has been spread across several different packages. This package is intended to become the home of all logic related to what is now called "provider cache directories", which means directories on local disk where Terraform caches providers in a form that is ready to run. That includes both logic related to interrogating items already in a cache (included in this commit) and logic related to inserting new items into the cache from upstream provider sources (to follow in later commits). These new codepaths are focused on providers and do not include other plugin types (provisioners and credentials helpers), because providers are the only plugin type that is represented by a heirarchical, decentralized namespace and the only plugin type that has an auto-installation protocol defined. The existing codepaths will remain to support the handling of the other plugin types that require manual installation and that use only a flat, locally-defined namespace. 2020-03-11 17:26:18 -05:00			`// 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.`
			`//`
			`// It builds on the lower-level provider source functionality provided by`
			`// the internal/getproviders package, adding the additional behaviors around`
			`// obtaining the discovered providers and placing them in the cache`
			`// directories for subsequent use.`
			`package providercache`