bind

Documentation

Overview

Package bind provides interfaces and types for use when binding an app to a service.

Index

• type AddInstanceArgs
• type App
• type EnvVar
• type RemoveInstanceArgs
• type ServiceEnvVar
• type SetEnvArgs
• type Unit
• type UnsetEnvArgs

Types

type AddInstanceArgs

type AddInstanceArgs struct {
	Envs          []ServiceEnvVar
	Writer        io.Writer
	ShouldRestart bool
}

type App

type App interface {
	// GetAddresses returns the app addresses.
	GetAddresses() ([]string, error)

	// GetName returns the app name.
	GetName() string

	// GetUUID returns the App v4 UUID
	GetUUID() (string, error)

	// GetUnits returns the app units.
	GetUnits() ([]Unit, error)

	// AddInstance adds an instance to the application.
	AddInstance(args AddInstanceArgs) error

	// RemoveInstance removes an instance from the application.
	RemoveInstance(args RemoveInstanceArgs) error
}

type EnvVar

type EnvVar struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Public bool   `json:"public"`
}

EnvVar represents a environment variable for an app.

type RemoveInstanceArgs

type RemoveInstanceArgs struct {
	ServiceName   string
	InstanceName  string
	Writer        io.Writer
	ShouldRestart bool
}

type ServiceEnvVar

type ServiceEnvVar struct {
	EnvVar       `bson:",inline"`
	ServiceName  string `json:"-"`
	InstanceName string `json:"-"`
}

type SetEnvArgs

type SetEnvArgs struct {
	Envs          []EnvVar
	Writer        io.Writer
	ShouldRestart bool
}

type Unit

type Unit interface {
	GetID() string
	GetIp() string
}

Unit represents an application unit to be used in binds.

type UnsetEnvArgs

type UnsetEnvArgs struct {
	VariableNames []string
	Writer        io.Writer
	ShouldRestart bool
}