providers

package
v3.234.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2026 License: Apache-2.0 Imports: 22 Imported by: 5

Documentation

Overview

Package providers contains the logic for managing provider resources (versioning, loading, resource operations).

Index

Constants

View Source 
const UnconfiguredID = "unconfigured"

UnconfiguredID is a distinguished token used to indicate that a provider doesn't yet have an ID because it hasn't been configured yet. This should never be returned back to SDKs by the engine but is used for internal tracking so we maximally reuse provider instances but only configure them once.

View Source 
const UnknownID = plugin.UnknownStringValue

UnknownID is a distinguished token used to indicate that a provider's ID is not known (e.g. because we are performing a preview).

Variables

This section is empty.

Functions

func FilterProviderConfig added in v3.149.0 

func FilterProviderConfig(inputs resource.PropertyMap) resource.PropertyMap

FilterProviderConfig filters out the __internal key from provider state so the resulting map can be passed to provider plugins.

func GetEnvironmentVariableMappings added in v3.220.0 

func GetEnvironmentVariableMappings(
	inputs resource.PropertyMap,
) (map[string]string, error)

GetEnvironmentVariableMappings fetches environment variable remappings. Returns a map of NEW_KEY -> OLD_KEY mappings. If NEW_KEY exists in the environment, the provider will see OLD_KEY=value(NEW_KEY).

func GetProviderChecksums added in v3.82.0 

func GetProviderChecksums(inputs resource.PropertyMap) (map[string][]byte, error)

GetProviderChecksums fetches a provider plugin checksums from the given property map. If the checksums is not set, this function returns nil.

func GetProviderDownloadURL added in v3.21.0 

func GetProviderDownloadURL(inputs resource.PropertyMap) (string, error)

GetProviderDownloadURL fetches a provider plugin download server URL from the given property map. If the server URL is not set, this function returns "".

func GetProviderName added in v3.125.0 

func GetProviderName(name tokens.Package, inputs resource.PropertyMap) (tokens.Package, error)

GetProviderName fetches and parses a provider name from the given property map. If the name property is not present, this function returns the passed in name.

func GetProviderParameterization added in v3.125.0 

func GetProviderParameterization(
	name tokens.Package, inputs resource.PropertyMap,
) (*workspace.Parameterization, error)

GetProviderParameterization fetches and parses a provider parameterization from the given property map. If the parameterization property is not present, this function returns nil.

func GetProviderVersion 

func GetProviderVersion(inputs resource.PropertyMap) (*semver.Version, error)

GetProviderVersion fetches and parses a provider version from the given property map. If the version property is not present, this function returns nil.

func SetEnvironmentVariableMappings added in v3.220.0 

func SetEnvironmentVariableMappings(inputs resource.PropertyMap, mappings map[string]string)

SetEnvironmentVariableMappings sets environment variable remappings in the given property map. The mappings map should be NEW_KEY -> OLD_KEY (if NEW_KEY exists, provider sees OLD_KEY=value(NEW_KEY)).

func SetProviderChecksums added in v3.82.0 

func SetProviderChecksums(inputs resource.PropertyMap, value map[string][]byte)

SetProviderChecksums sets the provider plugin checksums in the given property map.

func SetProviderName added in v3.125.0 

func SetProviderName(inputs resource.PropertyMap, name tokens.Package)

Sets the provider name in the given property map.

func SetProviderParameterization added in v3.125.0 

func SetProviderParameterization(inputs resource.PropertyMap, value *workspace.Parameterization)

Sets the provider parameterization in the given property map, this should be called _after_ SetVersion.

func SetProviderURL added in v3.21.0 

func SetProviderURL(inputs resource.PropertyMap, value string)

SetProviderURL sets the provider plugin download server URL in the given property map.

func SetProviderVersion added in v3.21.0 

func SetProviderVersion(inputs resource.PropertyMap, value *semver.Version)

Sets the provider version in the given property map.

Types

type ProviderRequest 

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

A ProviderRequest is a tuple of an optional semantic version, download server url, parameter, and a package name. Whenever the engine receives a registration for a resource that doesn't explicitly specify a provider, the engine creates a ProviderRequest for that resource's provider, using the version passed to the engine as part of RegisterResource and the package derived from the resource's token.

The source evaluator (source_eval.go) is responsible for servicing provider requests. It does this by interpreting these provider requests and sending resource registrations to the engine for the providers themselves. These are called "default providers".

ProviderRequest is useful as a hash key. The engine is free to instantiate any number of provider requests, but it is free to cache requests for a provider request that is equal to one that has already been serviced. If you do use ProviderRequest as a hash key, you should call String() to get a usable key for string-based hash maps. ProviderRequests only hash by their package name, version and download URL. The checksums and parameterization are not used in the hash.

func NewProviderRequest 

func NewProviderRequest(
	name tokens.Package, version *semver.Version,
	pluginDownloadURL string, checksums map[string][]byte,
	parameterization *workspace.Parameterization,
) ProviderRequest

NewProviderRequest constructs a new provider request from an optional version, optional pluginDownloadURL, optional parameter, and package.

func (ProviderRequest) DefaultName added in v3.125.0 

func (p ProviderRequest) DefaultName() string

DefaultName returns a QName that is an appropriate name for a default provider constructed from this provider request. The name is intended to be unique; as such, the name is derived from the version associated with this request.

If a version is not provided, "default" is returned. Otherwise, Name returns a name starting with "default" and followed by a QName-legal representation of the semantic version of the requested provider.

func (ProviderRequest) Name 

func (p ProviderRequest) Name() tokens.Package

Name returns the this provider plugin name.

func (ProviderRequest) Package 

func (p ProviderRequest) Package() tokens.Package

Package returns this provider request's package.

func (ProviderRequest) Parameterization added in v3.120.0 

func (p ProviderRequest) Parameterization() *workspace.Parameterization

Parameterization returns the parameterization of this provider request. May be nil if no parameterization was provided.

func (ProviderRequest) PluginChecksums added in v3.82.0 

func (p ProviderRequest) PluginChecksums() map[string][]byte

PluginChecksums returns this providers checksums. May be nil if no checksums were provided.

func (ProviderRequest) PluginDownloadURL added in v3.21.0 

func (p ProviderRequest) PluginDownloadURL() string

PluginDownloadURL returns this providers server url. May be "" if no pluginDownloadURL was provided.

func (ProviderRequest) String 

func (p ProviderRequest) String() string

String returns a string representation of this request. This string is suitable for use as a hash key.

func (ProviderRequest) Version 

func (p ProviderRequest) Version() *semver.Version

Version returns this provider request's version. May be nil if no version was provided.

type Registry 

type Registry struct {
	plugin.NotForwardCompatibleProvider
	// contains filtered or unexported fields
}

Registry manages the lifecylce of provider resources and their plugins and handles the resolution of provider references to loaded plugins.

When a registry is created, it is handed the set of old provider resources that it will manage. Each provider resource in this set is loaded and configured as per its recorded inputs and registered under the provider reference that corresponds to its URN and ID, both of which must be known. At this point, the created registry is prepared to be used to manage the lifecycle of these providers as well as any new provider resources requested by invoking the registry's CRUD operations.

In order to fit neatly in to the existing infrastructure for managing resources using Pulumi, a provider regidstry itself implements the plugin.Provider interface.

func NewRegistry 

func NewRegistry(host plugin.Host, isPreview bool, builtins plugin.Provider) *Registry

NewRegistry creates a new provider registry using the given host.

func (*Registry) Call added in v3.6.0 

func (r *Registry) Call(context.Context, plugin.CallRequest) (plugin.CallResponse, error)

func (*Registry) Check 

func (r *Registry) Check(ctx context.Context, req plugin.CheckRequest) (plugin.CheckResponse, error)

Check validates the configuration for a particular provider resource.

The particulars of Check are a bit subtle for a few reasons:

  • we need to load the provider for the package indicated by the type name portion provider resource's URN in order to check its config
  • we need to keep the newly-loaded provider around in case we need to diff its config
  • if we are running a preview, we need to configure the provider, as its corresponding CRUD operations will not run (we would normally configure the provider in Create or Update).

func (*Registry) CheckConfig 

func (r *Registry) CheckConfig(context.Context, plugin.CheckConfigRequest) (plugin.CheckConfigResponse, error)

CheckConfig validates the configuration for this resource provider.

func (*Registry) Close 

func (r *Registry) Close() error

func (*Registry) Configure 

func (r *Registry) Configure(context.Context, plugin.ConfigureRequest) (plugin.ConfigureResponse, error)

func (*Registry) Construct 

func (r *Registry) Construct(context.Context, plugin.ConstructRequest) (plugin.ConstructResponse, error)

func (*Registry) Create 

func (r *Registry) Create(ctx context.Context, req plugin.CreateRequest) (plugin.CreateResponse, error)

Create configures the provider with the given URN using the indicated configuration, assigns it an ID, and registers it under the assigned (URN, ID).

The provider must have been loaded by a prior call to Check.

func (*Registry) Delete 

func (r *Registry) Delete(_ context.Context, req plugin.DeleteRequest) (plugin.DeleteResponse, error)

Delete unregisters and unloads the provider with the given URN and ID. If the provider was never loaded this is a no-op.

func (*Registry) Diff 

func (r *Registry) Diff(ctx context.Context, req plugin.DiffRequest) (plugin.DiffResponse, error)

Diff diffs the configuration of the indicated provider. The provider corresponding to the given URN must have previously been loaded by a call to Check.

func (*Registry) DiffConfig 

func (r *Registry) DiffConfig(context.Context, plugin.DiffConfigRequest) (plugin.DiffConfigResponse, error)

DiffConfig checks what impacts a hypothetical change to this provider's configuration will have on the provider.

func (*Registry) GetMapping added in v3.49.0 

func (r *Registry) GetMapping(context.Context, plugin.GetMappingRequest) (plugin.GetMappingResponse, error)

func (*Registry) GetMappings added in v3.85.0 

func (r *Registry) GetMappings(context.Context, plugin.GetMappingsRequest) (plugin.GetMappingsResponse, error)

func (*Registry) GetPluginInfo 

func (r *Registry) GetPluginInfo(context.Context) (plugin.PluginInfo, error)

func (*Registry) GetProvider 

func (r *Registry) GetProvider(ref providers.Reference) (plugin.Provider, bool)

GetProvider returns the provider plugin that is currently registered under the given reference, if any.

func (*Registry) GetSchema 

func (r *Registry) GetSchema(context.Context, plugin.GetSchemaRequest) (plugin.GetSchemaResponse, error)

GetSchema returns the JSON-serialized schema for the provider.

func (*Registry) Handshake added in v3.143.0 

func (r *Registry) Handshake(
	context.Context, plugin.ProviderHandshakeRequest,
) (*plugin.ProviderHandshakeResponse, error)

func (*Registry) Invoke 

func (r *Registry) Invoke(context.Context, plugin.InvokeRequest) (plugin.InvokeResponse, error)

func (*Registry) Parameterize added in v3.117.0 

func (r *Registry) Parameterize(context.Context, plugin.ParameterizeRequest) (plugin.ParameterizeResponse, error)

func (*Registry) Pkg 

func (r *Registry) Pkg() tokens.Package

func (*Registry) Read 

func (r *Registry) Read(context.Context, plugin.ReadRequest) (plugin.ReadResponse, error)

func (*Registry) RegisterAlias added in v3.9.1 

func (r *Registry) RegisterAlias(providerURN, alias resource.URN)

RegisterAliases informs the registry that the new provider object with the given URN is aliased to the given list of URNs.

func (*Registry) Same added in v3.9.1 

func (r *Registry) Same(ctx context.Context, res *resource.State, fromCheck bool) error

Same executes as part of the "Same" step for a provider that has not changed. It configures the provider instance with the given state and fixes up aliases.

If fromCheck is true, we attempt to reuse a provider registered during Check/Diff. This should be true when called from SameStep.Apply after the Check→Diff flow determined the provider hasn't changed. If fromCheck is false (e.g., called from EnsureProvider for dependency diffing), we always load fresh and do not touch the UnconfiguredID entry, which may be in use by a concurrent provider update.

func (*Registry) SignalCancellation 

func (r *Registry) SignalCancellation(context.Context) error

func (*Registry) Update 

func (r *Registry) Update(ctx context.Context, req plugin.UpdateRequest) (plugin.UpdateResponse, error)

Update configures the provider with the given URN and ID using the indicated configuration and registers it at the reference indicated by the (URN, ID) pair.

The provider must have been loaded by a prior call to Check.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.