devstack

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2026 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DevstackEnvFile added in v1.7.0 

func DevstackEnvFile() string

func NewNoopExecutorsFactory 

func NewNoopExecutorsFactory() node.ExecutorsFactory

func NewNoopExecutorsFactoryWithConfig 

func NewNoopExecutorsFactoryWithConfig(config noop_executor.ExecutorConfig) node.ExecutorsFactory

func NewNoopNodeDependencyInjector 

func NewNoopNodeDependencyInjector() node.NodeDependencyInjector

Noop implementations of node factories used to mock certain components, which is useful for testing.

func NewNoopPublishersFactory 

func NewNoopPublishersFactory() node.PublishersFactory

func NewNoopPublishersFactoryWithConfig added in v0.3.25 

func NewNoopPublishersFactoryWithConfig(config noop_publisher.PublisherConfig) node.PublishersFactory

func NewNoopStorageProvidersFactory 

func NewNoopStorageProvidersFactory() node.StorageProvidersFactory

func NewNoopStorageProvidersFactoryWithConfig 

func NewNoopStorageProvidersFactoryWithConfig(config noop_storage.StorageConfig) node.StorageProvidersFactory

Types

type CloserWithContext 

type CloserWithContext interface {
	// Close closes the resource.
	Close(context.Context) error
}

type ConfigOption added in v1.0.4 

type ConfigOption = func(cfg *DevStackConfig)

func WithAllowListedLocalPaths added in v1.0.4 

func WithAllowListedLocalPaths(paths []string) ConfigOption

func WithAtLeastOneNode added in v1.5.0 

func WithAtLeastOneNode() ConfigOption

func WithAuthSecret added in v1.3.0 

func WithAuthSecret(secret string) ConfigOption

func WithBacalhauConfigOverride added in v1.5.0 

func WithBacalhauConfigOverride(cfg types.Bacalhau) ConfigOption

func WithBasePath added in v1.5.0 

func WithBasePath(path string) ConfigOption

func WithCPUProfilingFile added in v1.0.4 

func WithCPUProfilingFile(path string) ConfigOption

func WithDefaultPublisher added in v1.5.0 

func WithDefaultPublisher(publisher types.DefaultPublisherConfig) ConfigOption

func WithDependencyInjector added in v1.0.4 

func WithDependencyInjector(injector node.NodeDependencyInjector) ConfigOption

func WithDisabledFeatures added in v1.0.4 

func WithDisabledFeatures(disable node.FeatureConfig) ConfigOption

func WithMemoryProfilingFile added in v1.0.4 

func WithMemoryProfilingFile(path string) ConfigOption

func WithNodeOverrides added in v1.0.4 

func WithNodeOverrides(overrides ...node.NodeConfig) ConfigOption

func WithNumberOfBadComputeActors added in v1.0.4 

func WithNumberOfBadComputeActors(count int) ConfigOption

func WithNumberOfComputeOnlyNodes added in v1.0.4 

func WithNumberOfComputeOnlyNodes(count int) ConfigOption

func WithNumberOfHybridNodes added in v1.0.4 

func WithNumberOfHybridNodes(count int) ConfigOption

func WithNumberOfRequesterOnlyNodes added in v1.0.4 

func WithNumberOfRequesterOnlyNodes(count int) ConfigOption

func WithSelfSignedCertificate added in v1.2.1 

func WithSelfSignedCertificate(cert string, key string) ConfigOption

func WithSystemConfig added in v1.5.0 

func WithSystemConfig(cfg node.SystemConfig) ConfigOption

func WithUseStandardPorts added in v1.7.0 

func WithUseStandardPorts(standardPorts bool) ConfigOption

WithUseStandardPorts sets the standard ports for the services

type DevStack 

type DevStack struct {
	Nodes []*node.Node
	// contains filtered or unexported fields
}

func Setup added in v1.0.4 

func Setup(
	ctx context.Context,
	cm *system.CleanupManager,
	opts ...ConfigOption,
) (*DevStack, error)

func (*DevStack) GetNode 

func (stack *DevStack) GetNode(_ context.Context, nodeID string) (
	*node.Node, error)

func (*DevStack) GetNodeIds 

func (stack *DevStack) GetNodeIds() []string

func (*DevStack) GetStackInfo added in v1.7.0 

func (stack *DevStack) GetStackInfo(ctx context.Context) string

func (*DevStack) JoinComputeNode added in v1.8.0 

func (stack *DevStack) JoinComputeNode(ctx context.Context, cm *system.CleanupManager) (*node.Node, error)

func (*DevStack) JoinHybridNode added in v1.8.0 

func (stack *DevStack) JoinHybridNode(ctx context.Context, cm *system.CleanupManager) (*node.Node, error)

func (*DevStack) JoinNode added in v1.8.0 

func (stack *DevStack) JoinNode(ctx context.Context, cm *system.CleanupManager, options JoinNodeOptions) (*node.Node, error)

func (*DevStack) JoinOrchestratorNode added in v1.8.0 

func (stack *DevStack) JoinOrchestratorNode(ctx context.Context, cm *system.CleanupManager) (*node.Node, error)

type DevStackConfig added in v1.0.4 

type DevStackConfig struct {
	BacalhauConfig         types.Bacalhau
	SystemConfig           node.SystemConfig
	NodeDependencyInjector node.NodeDependencyInjector
	NodeOverrides          []node.NodeConfig
	UseStandardPorts       bool // if true, use the standard ports (e.g. 1234) for the services, otherwise random ports

	// DevStackOptions
	NumberOfHybridNodes        int // Number of nodes to start in the cluster
	NumberOfRequesterOnlyNodes int // Number of nodes to start in the cluster
	NumberOfComputeOnlyNodes   int // Number of nodes to start in the cluster
	NumberOfBadComputeActors   int // Number of compute nodes to be bad actors
	CPUProfilingFile           string
	MemoryProfilingFile        string
	BasePath                   string
}

func (*DevStackConfig) MarshalZerologObject added in v1.0.4 

func (o *DevStackConfig) MarshalZerologObject(e *zerolog.Event)

func (*DevStackConfig) Validate added in v1.0.4 

func (o *DevStackConfig) Validate() error

type DevstackTLSSettings added in v1.2.1 

type DevstackTLSSettings struct {
	Certificate string
	Key         string
}

type JoinNodeOptions added in v1.8.0 

type JoinNodeOptions struct {
	IsRequester     bool
	IsCompute       bool
	BadComputeActor bool // Make this node a bad compute actor for testing
	ConfigOverride  *node.NodeConfig
}

type MetadataStore added in v1.5.0 

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

MetadataStore is a simple in-memory implementation of repo's system_metadata store that is useful for testing and development.

func NewMetadataStore added in v1.5.0 

func NewMetadataStore() *MetadataStore

func (*MetadataStore) InstanceID added in v1.5.0 

func (m *MetadataStore) InstanceID() string

func (*MetadataStore) ReadLastUpdateCheck added in v1.5.0 

func (m *MetadataStore) ReadLastUpdateCheck() (time.Time, error)

func (*MetadataStore) WriteLastUpdateCheck added in v1.5.0 

func (m *MetadataStore) WriteLastUpdateCheck(time time.Time) error

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.