docker

Documentation

Overview

Package docker implements migrate drivers that operate on top of docker.

Index

• type Kind
  • func (r Kind) Create(ctx context.Context, out io.Writer) error
  • func (r Kind) Destroy(ctx context.Context, out io.Writer) error
  • func (r Kind) Execute(out io.Writer, args []string) error
  • func (r Kind) Source(ctx context.Context, out io.Writer) error
  • func (r *Kind) UnmarshalJSON(b []byte) error
• type Postgres
  • func (r Postgres) Create(ctx context.Context, out io.Writer) error
  • func (r Postgres) Destroy(ctx context.Context, out io.Writer) error
  • func (r Postgres) Source(ctx context.Context, out io.Writer) error

Types

type Kind

type Kind struct {
	Name   string            `json:"name" yaml:"name"`
	Images []string          `json:"images,omitempty" yaml:"images,omitempty"`
	Config *v1alpha4.Cluster `json:"config,omitempty" yaml:"config,omitempty"`
}

Kind represents a driver for the Kubernetes IN Docker (sigs.k8s.io/kind) project.

func (Kind) Create

func (r Kind) Create(ctx context.Context, out io.Writer) error

Create executes the resource creation process.

func (Kind) Destroy

func (r Kind) Destroy(ctx context.Context, out io.Writer) error

Destroy executes the resource destruction process.

func (Kind) Execute

func (r Kind) Execute(out io.Writer, args []string) error

Execute is a wrapper function to the kind command runner.

func (Kind) Source

func (r Kind) Source(ctx context.Context, out io.Writer) error

Source returns the data source name for the driver.

func (*Kind) UnmarshalJSON

func (r *Kind) UnmarshalJSON(b []byte) error

UnmarshalJSON defines custom json unmarshalling procedure.

type Postgres

type Postgres struct {
	Name         string `json:"name" yaml:"name"`
	Version      string `json:"version" yaml:"version"`
	Password     string `json:"password,omitempty" yaml:"password,omitempty"`
	User         string `json:"user,omitempty" yaml:"user,omitempty"`
	DBName       string `json:"dbName,omitempty" yaml:"dbName,omitempty"`
	InitDBArgs   string `json:"initDBArgs,omitempty" yaml:"initDBArgs,omitempty"`
	InitDBWalDir string `json:"initDBWalDir,omitempty" yaml:"initDBWalDir,omitempty"`
	PGData       string `json:"pgData,omitempty" yaml:"pgData,omitempty"`
	Network      string `json:"network,omitempty" yaml:"network,omitempty"`
}

Postgres represents a driver for a docker based postgres database.

func (Postgres) Create

func (r Postgres) Create(ctx context.Context, out io.Writer) error

Create executes the resource creation process.

func (Postgres) Destroy

func (r Postgres) Destroy(ctx context.Context, out io.Writer) error

Destroy executes the resource destruction process.

func (Postgres) Source

func (r Postgres) Source(ctx context.Context, out io.Writer) error

Source returns the data source name for the driver.