project

Documentation

Index

• type Project
  • func FromFile(fs afero.Fs, filepath string) (*Project, error)
  • func (p *Project) BuildServices(fs afero.Fs) (chan ServiceBuildUpdate, error)
  • func (p *Project) CollectServicesRequirements() ([]*collector.ServiceRequirements, error)
  • func (p *Project) GetServices() []Service
  • func (p *Project) RunServices(localCloud *cloud.LocalCloud, stop <-chan bool, ...) error
  • func (p *Project) RunServicesWithCommand(localCloud *cloud.LocalCloud, stop <-chan bool, ...) error
• type ProjectConfiguration
  • func ConfigurationFromFile(fs afero.Fs, filePath string) (*ProjectConfiguration, error)
  • func (p ProjectConfiguration) ToFile(fs afero.Fs, filepath string) error
• type RunContainerOption
  • func WithEnvVars(envVars map[string]string) RunContainerOption
  • func WithNitricEnvironment(environment string) RunContainerOption
  • func WithNitricHost(host string) RunContainerOption
  • func WithNitricPort(port string) RunContainerOption
• type RuntimeConfiguration
• type Service
  • func (s *Service) BuildImage(fs afero.Fs, logs io.Writer) error
  • func (s *Service) GetAbsoluteFilePath() (string, error)
  • func (s *Service) GetFilePath() string
  • func (s *Service) Run(stop <-chan bool, updates chan<- ServiceRunUpdate, env map[string]string) error
  • func (s *Service) RunContainer(stop <-chan bool, updates chan<- ServiceRunUpdate, opts ...RunContainerOption) error
• type ServiceBuildStatus
• type ServiceBuildUpdate
• type ServiceConfiguration
• type ServiceRunStatus
• type ServiceRunUpdate
• type ServiceRunUpdateWriter
  • func (s *ServiceRunUpdateWriter) Write(data []byte) (int, error)

Types

type Project

type Project struct {
	Name      string
	Directory string
	Preview   []preview.Feature
	// contains filtered or unexported fields
}

func FromFile

func FromFile(fs afero.Fs, filepath string) (*Project, error)

FromFile - Loads a nitric project from a nitric.yaml file If no filepath is provided, the default location './nitric.yaml' is used

func (*Project) BuildServices

func (p *Project) BuildServices(fs afero.Fs) (chan ServiceBuildUpdate, error)

BuildServices - Builds all the services in the project

func (*Project) CollectServicesRequirements

func (p *Project) CollectServicesRequirements() ([]*collector.ServiceRequirements, error)

func (*Project) GetServices

func (p *Project) GetServices() []Service

func (*Project) RunServices

func (p *Project) RunServices(localCloud *cloud.LocalCloud, stop <-chan bool, updates chan<- ServiceRunUpdate) error

RunServices - Runs all the services as containers use the stop channel to stop all running services

func (*Project) RunServicesWithCommand

func (p *Project) RunServicesWithCommand(localCloud *cloud.LocalCloud, stop <-chan bool, updates chan<- ServiceRunUpdate) error

RunServices - Runs all the services locally using a startup command use the stop channel to stop all running services

type ProjectConfiguration

type ProjectConfiguration struct {
	Name      string                          `yaml:"name"`
	Directory string                          `yaml:"-"`
	Services  []ServiceConfiguration          `yaml:"services"`
	Runtimes  map[string]RuntimeConfiguration `yaml:"runtimes,omitempty"`
	Preview   []preview.Feature               `yaml:"preview,omitempty"`
}

func ConfigurationFromFile

func ConfigurationFromFile(fs afero.Fs, filePath string) (*ProjectConfiguration, error)

func (ProjectConfiguration) ToFile

func (p ProjectConfiguration) ToFile(fs afero.Fs, filepath string) error

type RunContainerOption

type RunContainerOption func(*runContainerOptions)

func WithEnvVars

func WithEnvVars(envVars map[string]string) RunContainerOption

func WithNitricEnvironment

func WithNitricEnvironment(environment string) RunContainerOption

func WithNitricHost

func WithNitricHost(host string) RunContainerOption

func WithNitricPort

func WithNitricPort(port string) RunContainerOption

type RuntimeConfiguration

type RuntimeConfiguration struct {
	// Template dockerfile to use as the base for the custom runtime
	Dockerfile string
	// Additional args to pass to the custom runtime
	Args map[string]string
}

type Service

type Service struct {
	Name string
	Type string
	// contains filtered or unexported fields
}

func (*Service) BuildImage

func (s *Service) BuildImage(fs afero.Fs, logs io.Writer) error

func (*Service) GetAbsoluteFilePath

func (s *Service) GetAbsoluteFilePath() (string, error)

func (*Service) GetFilePath

func (s *Service) GetFilePath() string

func (*Service) Run

func (s *Service) Run(stop <-chan bool, updates chan<- ServiceRunUpdate, env map[string]string) error

Run - runs the service using the provided command, typically not in a container.

func (*Service) RunContainer

func (s *Service) RunContainer(stop <-chan bool, updates chan<- ServiceRunUpdate, opts ...RunContainerOption) error

RunContainer - Runs a container for the service, blocking until the container exits

type ServiceBuildStatus

type ServiceBuildStatus string

const (
	ServiceBuildStatus_InProgress ServiceBuildStatus = "In Progress"
	ServiceBuildStatus_Complete   ServiceBuildStatus = "Complete"
	ServiceBuildStatus_Error      ServiceBuildStatus = "Error"
)

type ServiceBuildUpdate

type ServiceBuildUpdate struct {
	ServiceName string
	Message     string
	Status      ServiceBuildStatus
	Err         error
}

type ServiceConfiguration

type ServiceConfiguration struct {
	// This is the string version
	Match string `yaml:"match"`

	// This is the custom runtime version (is custom if not nil, we auto-detect a standard language runtime)
	Runtime string `yaml:"runtime"`

	// This allows specifying a particular service type (e.g. "Job"), this is optional and custom service types can be defined for each stack
	Type string `yaml:"type"`

	// This is a command that will be use to run these services when using nitric start
	Start string `yaml:"start"`
}

type ServiceRunStatus

type ServiceRunStatus string

const (
	ServiceRunStatus_Running ServiceRunStatus = "Running"
	ServiceRunStatus_Done    ServiceRunStatus = "Done"
	ServiceRunStatus_Error   ServiceRunStatus = "Error"
)

type ServiceRunUpdate

type ServiceRunUpdate struct {
	ServiceName string
	Filepath    string
	Message     string
	Status      ServiceRunStatus
	Err         error
}

type ServiceRunUpdateWriter

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

func (*ServiceRunUpdateWriter) Write

func (s *ServiceRunUpdateWriter) Write(data []byte) (int, error)