infra

package

v1.35.3 Latest Latest Go to latest Published: Apr 12, 2024 License: MPL-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/encoredev/encore

Links

Open Source Insights

Documentation ¶

Index ¶

type Resource
type ResourceManager
- func NewResourceManager(app *apps.Instance, sqlMgr *sqldb.ClusterManager, ns *namespace.Namespace, ...) *ResourceManager
type Type

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Resource ¶

type Resource interface {
	// Stop shuts down the resource.
	Stop()
}

type ResourceManager ¶

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

ResourceManager manages a set of infrastructure resources to support the running Encore application.

func NewResourceManager ¶

func NewResourceManager(app *apps.Instance, sqlMgr *sqldb.ClusterManager, ns *namespace.Namespace, environ environ.Environ, dbProxyPort int, forTests bool) *ResourceManager

func (*ResourceManager) GetPubSub ¶

func (rm *ResourceManager) GetPubSub() *pubsub.NSQDaemon

GetPubSub returns the PubSub daemon if it is running otherwise it returns nil

func (*ResourceManager) GetRedis ¶

func (rm *ResourceManager) GetRedis() *redis.Server

GetRedis returns the Redis server if it is running otherwise it returns nil

func (*ResourceManager) GetSQLCluster ¶

func (rm *ResourceManager) GetSQLCluster() *sqldb.Cluster

GetSQLCluster returns the SQL cluster

func (*ResourceManager) PubSubProviderConfig ¶ added in v1.33.0

func (rm *ResourceManager) PubSubProviderConfig() (config.PubsubProvider, error)

PubSubProviderConfig returns the PubSub provider configuration.

func (*ResourceManager) PubSubSubscriptionConfig ¶ added in v1.21.2

func (rm *ResourceManager) PubSubSubscriptionConfig(_ *meta.PubSubTopic, sub *meta.PubSubTopic_Subscription) (config.PubsubSubscription, error)

PubSubSubscriptionConfig returns the PubSub subscription configuration for the given subscription.

func (*ResourceManager) PubSubTopicConfig ¶ added in v1.21.2

func (rm *ResourceManager) PubSubTopicConfig(topic *meta.PubSubTopic) (config.PubsubProvider, config.PubsubTopic, error)

PubSubTopicConfig returns the PubSub provider and topic configuration for the given topic.

func (*ResourceManager) RedisConfig ¶ added in v1.21.2

func (rm *ResourceManager) RedisConfig(redis *meta.CacheCluster) (config.RedisServer, config.RedisDatabase, error)

RedisConfig returns the Redis server and database configuration for the given database.

func (*ResourceManager) SQLDatabaseConfig ¶ added in v1.33.0

func (rm *ResourceManager) SQLDatabaseConfig(db *meta.SQLDatabase) (config.SQLDatabase, error)

SQLDatabaseConfig returns the SQL server and database configuration for the given database.

func (*ResourceManager) SQLServerConfig ¶ added in v1.33.0

func (rm *ResourceManager) SQLServerConfig() (config.SQLServer, error)

SQLServerConfig returns the SQL server configuration.

func (*ResourceManager) StartPubSub ¶

func (rm *ResourceManager) StartPubSub(ctx context.Context) error

StartPubSub starts a PubSub daemon.

func (*ResourceManager) StartRedis ¶

func (rm *ResourceManager) StartRedis(ctx context.Context) error

StartRedis starts a Redis server.

func (*ResourceManager) StartRequiredServices ¶

func (rm *ResourceManager) StartRequiredServices(a *optracker.AsyncBuildJobs, md *meta.Data)

StartRequiredServices will start the required services for the current application if they are not already running based on the given parse result

func (*ResourceManager) StartSQLCluster ¶

func (rm *ResourceManager) StartSQLCluster(a *optracker.AsyncBuildJobs, md *meta.Data) func(ctx context.Context) error

func (*ResourceManager) StopAll ¶

func (rm *ResourceManager) StopAll()

func (*ResourceManager) UpdateConfig ¶

func (rm *ResourceManager) UpdateConfig(cfg *config.Runtime, md *meta.Data, dbProxyPort int) error

UpdateConfig updates the given config with infrastructure information. Note that all the requisite services must have started up already, which in practice means that (*optracker.AsyncBuildJobs).Wait must have returned first.

type Type ¶

type Type string

const (
	PubSub Type = "pubsub"
	Cache  Type = "cache"
	SQLDB  Type = "sqldb"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL