initialize

Documentation

Overview

Package initialize provides the initialize command, which initializes an installation.

Index

• func ClientCommand(builder Builder) *cobra.Command
• func Command(builder Builder) *cobra.Command
• func ServerCommand(builder Builder) *cobra.Command
• type Builder
• type Initializer
  • func NewInitializer(cfg *config.Config, cfgPath string, profiler profile.Profiler) Initializer

Functions

func ClientCommand

func ClientCommand(builder Builder) *cobra.Command

ClientCommand provides the implementation for "bindplane init client"

func Command

func Command(builder Builder) *cobra.Command

Command returns the BindPlane initialize cobra command

func ServerCommand

func ServerCommand(builder Builder) *cobra.Command

ServerCommand provides the implementation for "bindplane init server"

Types

type Builder

type Builder interface {
	// Build returns a new Initializer
	BuildInitializer(ctx context.Context) (Initializer, error)
}

Builder is an interface for building an Initializer

type Initializer

type Initializer interface {
	// InitializeServer initializes a server config
	InitializeServer(ctx context.Context) error

	// InitializeClient initializes a client config
	InitializeClient(ctx context.Context) error
}

Initializer is an interface for initializing a server or client

func NewInitializer

func NewInitializer(cfg *config.Config, cfgPath string, profiler profile.Profiler) Initializer

NewInitializer returns a new Initializer