registry

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client provides methods to query OpenTofu module registries.

This client implements the "modules.v1" protocol. It does not implement any other OpenTofu registry protocols, and in particular the client for provider registry clients lives elsewhere.

(The overly-general name of this package is a historical accident, and perhaps one day this package should move to "getmodules/registry" instead of just "registry" to make the scope a little clearer.)

func NewClient(ctx context.Context, services *disco.Disco, client *retryablehttp.Client) *Client

func (c *Client) InstallModulePackage(ctx context.Context, location PackageLocationDirect, targetDir string) (string, error)

func (c *Client) ModulePackageLocation(ctx context.Context, packageAddr regaddr.ModulePackage, version string, subdir string) (PackageLocation, error)

func (c *Client) ModulePackageVersions(ctx context.Context, packageAddr regaddr.ModulePackage) (*response.ModuleVersions, error)

type PackageLocation ¶

type PackageLocation interface {
	// UILabel returns a label that can be used to concisely refer to this
	// location in the OpenTofu UI, such as when reporting progress or
	// describing problems in error messages.
	//
	// The result is not necessarily a unique identifier for the location. It's
	// just expected to be something a human reader could use to confirm whether
	// OpenTofu is installing from somewhere reasonable and expected.
	UILabel() string

	// Subdir returns a path to a directory within the package that contains
	// the module that is being selected. Returns an empty string if the root
	// of the package contains the selected module.
	Subdir() string
	// contains filtered or unexported methods
}

PackageLocation abstractly represents a location that a module package should be installed from.

There are exactly two concrete implementations of this interface: PackageLocationDirect for packages that are hosted as part of the registry they were reported from, and PackageLocationIndirect (for registry packages that are really just aliases for source addresses that someone could've specified directly in their configuration).

This is a closed interface. If any new implementations of it are added in future then an exhaustive type-switch over these in the module installer will need to be updated to support the new variants.

type PackageLocationDirect ¶

type PackageLocationDirect struct {
	// contains filtered or unexported fields
}

PackageLocationDirect represents a module package location that's considered to be a part of the registry that reported it, and so the same registry client that reported this location should also be used to install it.

This type is intentionally opaque, since values of this type should be passed directly to [Client.InstallPackage] on the same Client instance that returned this value. It encapsulates everything that client would need to perform the installation.

func (p PackageLocationDirect) Subdir() string

func (p PackageLocationDirect) UILabel() string

type PackageLocationIndirect ¶

type PackageLocationIndirect struct {
	// SourceAddr is the remote source address to install from, which should
	// be treated in an equivalent way to how this address would've been treated
	// if specified directly in a module call's "source" argument.
	SourceAddr addrs.ModuleSourceRemote
}

PackageLocationIndirect represents a module package that is accessible through a "remote" module source address just like what could be written directly in a "source" argument in a module call, and so must be installed through the normal remote package fetcher instead of through the registry client.

For locations of this type, the registry client that produced it is no longer involved after the location has been decided.

func (p PackageLocationIndirect) Subdir() string

func (p PackageLocationIndirect) UILabel() string

type ServiceUnreachableError ¶

type ServiceUnreachableError struct {
	// contains filtered or unexported fields
}

ServiceUnreachableError Registry service is unreachable

func (e *ServiceUnreachableError) Error() string