setup

Documentation

Index

• Variables
• type Client
  • func (c Client) OnboardingRequest(params *Params) (req api.OnboardingRequest, err error)
  • func (c Client) Setup(ctx context.Context, params *Params) error
• type Params

Variables

var (
	ErrAlreadySetUp       = errors.New("instance has already been set up")
	ErrConfigNameRequired = errors.New("config name is required if you already have existing configs")
	ErrSetupCanceled      = errors.New("setup was canceled")
)

Types

type Client

type Client struct {
	clients.CLI
	api.SetupApi
}

func (Client) OnboardingRequest

func (c Client) OnboardingRequest(params *Params) (req api.OnboardingRequest, err error)

OnboardingRequest constructs a request body for the onboarding API. Unless the 'force' parameter is set, the user will be prompted to enter any missing information and to confirm the final request parameters.

func (Client) Setup

func (c Client) Setup(ctx context.Context, params *Params) error

type Params

type Params struct {
	Username   string
	Password   string
	AuthToken  string
	Org        string
	Bucket     string
	Retention  string
	Force      bool
	ConfigName string
	Host       string
}