opentofu/internal/getproviders/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 getproviders is the lowest-level provider automatic installation
// functionality. It can answer questions about what providers and provider
// versions are available in a registry, and it can retrieve the URL for
// the distribution archive for a specific version of a specific provider
// targeting a particular platform.
//
// This package is not responsible for choosing the best version to install
// from a set of available versions, or for any signature verification of the
// archives it fetches. Callers will use this package in conjunction with other
// logic elsewhere in order to construct a full provider installer.
package getproviders
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`

internal/getproviders: Query a provider registry Our existing provider installer was originally built to work with releases.hashicorp.com and later retrofitted to talk to the official Terraform Registry. It also assumes a flat namespace of providers. We're starting a new one here, copying and adapting code from the old one as necessary, so that we can build out this new API while retaining all of the existing functionality and then cut over to this new implementation in a later step. Here we're creating a foundational component for the new installer, which is a mechanism to query for the available versions and download locations of a particular provider. Subsequent commits in this package will introduce other Source implementations for installing from network and filesystem mirrors. 2019-12-19 19:24:14 -06:00			`// Package getproviders is the lowest-level provider automatic installation`
			`// functionality. It can answer questions about what providers and provider`
			`// versions are available in a registry, and it can retrieve the URL for`
			`// the distribution archive for a specific version of a specific provider`
			`// targeting a particular platform.`
			`//`
			`// This package is not responsible for choosing the best version to install`
			`// from a set of available versions, or for any signature verification of the`
			`// archives it fetches. Callers will use this package in conjunction with other`
			`// logic elsewhere in order to construct a full provider installer.`
			`package getproviders`