mongodb_docker

Documentation

Overview

Package mongodb_docker implements the plugins.StorageProtocol interface, storing data using an instance of mongodb running in a container, with the data stored in a docker volume.

Index

• Constants
• func EnsureMongoIsRunning(c *portercontext.Context, container string, port string, dataVol string, ...) (*mongodb.Store, error)
• func NewPlugin(cxt *portercontext.Context, pluginConfig interface{}) (plugins.StoragePlugin, error)
• type PluginConfig
• type Store
  • func NewStore(cxt *portercontext.Context, cfg PluginConfig) *Store
  • func (s *Store) Close() error
  • func (s *Store) Connect() error

Constants

const PluginKey = plugins.PluginInterface + ".porter.mongodb-docker"

PluginKey is the identifier of the internal mongodb run in docker plugin.

Functions

func EnsureMongoIsRunning

func EnsureMongoIsRunning(c *portercontext.Context, container string, port string, dataVol string, dbName string, timeoutSeconds int) (*mongodb.Store, error)

func NewPlugin

func NewPlugin(cxt *portercontext.Context, pluginConfig interface{}) (plugins.StoragePlugin, error)

NewPlugin creates an instance of the storage.porter.mongodb-docker plugin

Types

type PluginConfig

type PluginConfig struct {
	Port     string `mapstructure:"port,omitempty"`
	Database string `mapstructure:"database,omitempty"`

	// Timeout in seconds
	Timeout int `mapstructure:"timeout,omitempty"`
}

PluginConfig supported by the mongodb-docker plugin as defined in porter.yaml

type Store

type Store struct {
	plugins.StorageProtocol
	// contains filtered or unexported fields
}

Store is a storage plugin for porter suitable for running on machines that have not configured proper storage, i.e. a mongo database. It runs mongodb in a docker container and stores its data in a docker volume.

func NewStore

func NewStore(cxt *portercontext.Context, cfg PluginConfig) *Store

func (*Store) Close

func (s *Store) Close() error

func (*Store) Connect

func (s *Store) Connect() error