platform

Documentation

Index

• Variables
• type Components
• type Platform
  • func NewPlatform(name string, components Components) (Platform, error)

Variables

var (
	// ErrInvalidPlatformName is returned when a platform with an invalid name is created.
	ErrInvalidPlatformName = errors.New("invalid platform name")
)

Types

type Components

type Components struct {
	Machines    machines.Machines
	Storage     storage.Storage
	Cluster     orchestrator.Cluster
	Store       store.Store
	Secrets     secrets.Secrets
	EmailSender email.Sender
}

Components lists the components used to initialize a Platform.

type Platform

type Platform interface {
	// GetName returns the platform name.
	GetName() string

	// Storage returns a storage.Storage component.
	Storage() storage.Storage

	// Machines returns a machines.Machines component.
	Machines() machines.Machines

	// Orchestrator returns a orchestrator.Cluster component.
	Orchestrator() orchestrator.Cluster

	// Store returns a store.Store component.
	Store() store.Store

	// Secrets returns a secrets.Secrets component.
	Secrets() secrets.Secrets

	// EmailSender returns an email.Sender component.
	EmailSender() email.Sender
}

Platform groups a set of components for managing simulations. Each application will make use of one platform to run their simulations. The cloudsim team provides a default Kubernetes and AWS implementation of this Platform. Other combinations could be implemented after adding their respective subcomponents.

func NewPlatform

func NewPlatform(name string, components Components) (Platform, error)

NewPlatform initializes a new platform using the given components.