registry

Documentation

Index

• func IsModuleNotFound(err error) bool
• func IsServiceNotProvided(err error) bool
• func IsServiceUnreachable(err error) bool
• type Client
  • func NewClient(services *disco.Disco, client *http.Client) *Client
  • func (c *Client) Discover(host svchost.Hostname, serviceID string) (*url.URL, error)
  • func (c *Client) ModuleLocation(ctx context.Context, module *regsrc.Module, version string) (string, error)
  • func (c *Client) ModuleVersions(ctx context.Context, module *regsrc.Module) (*response.ModuleVersions, error)
• type ServiceUnreachableError
  • func (e *ServiceUnreachableError) Error() string

Functions

func IsModuleNotFound

func IsModuleNotFound(err error) bool

IsModuleNotFound returns true only if the given error is a "module not found" error. This allows callers to recognize this particular error condition as distinct from operational errors such as poor network connectivity.

func IsServiceNotProvided

func IsServiceNotProvided(err error) bool

IsServiceNotProvided returns true only if the given error is a "service not provided" error. This allows callers to recognize this particular error condition as distinct from operational errors such as poor network connectivity.

func IsServiceUnreachable

func IsServiceUnreachable(err error) bool

IsServiceUnreachable returns true if the registry/discovery service was unreachable

Types

type Client

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

Client provides methods to query OpenTofu Registries.

func NewClient

func NewClient(services *disco.Disco, client *http.Client) *Client

NewClient returns a new initialized registry client.

func (*Client) Discover

func (c *Client) Discover(host svchost.Hostname, serviceID string) (*url.URL, error)

Discover queries the host, and returns the url for the registry.

func (*Client) ModuleLocation

func (c *Client) ModuleLocation(ctx context.Context, module *regsrc.Module, version string) (string, error)

ModuleLocation find the download location for a specific version module. This returns a string, because the final location may contain special go-getter syntax.

func (*Client) ModuleVersions

func (c *Client) ModuleVersions(ctx context.Context, module *regsrc.Module) (*response.ModuleVersions, error)

ModuleVersions queries the registry for a module, and returns the available versions.

type ServiceUnreachableError

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

ServiceUnreachableError Registry service is unreachable

func (*ServiceUnreachableError) Error

func (e *ServiceUnreachableError) Error() string