cmd

Documentation

Overview

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. vespa api-key command Author: mpolden

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. vespa auth show command Author: arnej

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. vespa cert command Author: mpolden

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Index

• type CLI
  • func New(stdout, stderr io.Writer, environment []string) (*CLI, error)
  • func (c *CLI) Run(args ...string) error
• type Config
• type DocumentBlob
  • func (d *DocumentBlob) MarshalJSON() ([]byte, error)
  • func (d *DocumentBlob) UnmarshalJSON(data []byte) error
• type ErrCLI
• type HandlersInfo
• type KeyPair
• type OperationResult
  • func Failure(message string) OperationResult
  • func FailureWithDetail(message string, detail string) OperationResult
  • func FailureWithPayload(message string, payload string) OperationResult
  • func Success(message string) OperationResult
  • func SuccessWithPayload(message string, payload string) OperationResult
• type VespaVisitOutput
• type Waiter
  • func (w *Waiter) DeployService(target vespa.Target) (*vespa.Service, error)
  • func (w *Waiter) Deployment(target vespa.Target, wantedID int64) (int64, error)
  • func (w *Waiter) FastWaitOn(target vespa.Target) bool
  • func (w *Waiter) Service(target vespa.Target, cluster string) (*vespa.Service, error)
  • func (w *Waiter) Services(target vespa.Target) ([]*vespa.Service, error)

Types

type CLI

type CLI struct {
	// Environment holds the process environment.
	Environment map[string]string
	Stdin       io.ReadWriter
	Stdout      io.Writer
	Stderr      io.Writer
	// contains filtered or unexported fields
}

CLI holds the Vespa CLI command tree, configuration and dependencies.

func New

func New(stdout, stderr io.Writer, environment []string) (*CLI, error)

New creates the Vespa CLI, writing output to stdout and stderr, and reading environment variables from environment.

func (*CLI) Run

func (c *CLI) Run(args ...string) error

Run executes the CLI with given args. If args is nil, it defaults to os.Args[1:].

type Config

type Config struct {
	// contains filtered or unexported fields
}

type DocumentBlob

type DocumentBlob struct {
	// contains filtered or unexported fields
}

func (*DocumentBlob) MarshalJSON

func (d *DocumentBlob) MarshalJSON() ([]byte, error)

func (*DocumentBlob) UnmarshalJSON

func (d *DocumentBlob) UnmarshalJSON(data []byte) error

type ErrCLI

type ErrCLI struct {
	Status int
	// contains filtered or unexported fields
}

ErrCLI is an error returned to the user. It wraps an exit status, a regular error and optional hints for resolving the error.

type HandlersInfo

type HandlersInfo struct {
	Handlers []struct {
		HandlerId      string   `json:"id"`
		HandlerClass   string   `json:"class"`
		HandlerBundle  string   `json:"bundle"`
		ServerBindings []string `json:"serverBindings"`
	} `json:"handlers"`
}

type KeyPair

type KeyPair struct {
	KeyPair          tls.Certificate
	RootCertificates []byte
	CertificateFile  string
	PrivateKeyFile   string
}

type OperationResult

type OperationResult struct {
	Success bool
	Message string // Mandatory message
	Detail  string // Optional detail message
	Payload string // Optional payload - may be present whether or not the operation was success
}

func Failure

func Failure(message string) OperationResult

func FailureWithDetail

func FailureWithDetail(message string, detail string) OperationResult

func FailureWithPayload

func FailureWithPayload(message string, payload string) OperationResult

func Success

func Success(message string) OperationResult

func SuccessWithPayload

func SuccessWithPayload(message string, payload string) OperationResult

type VespaVisitOutput

type VespaVisitOutput struct {
	PathId        string         `json:"pathId"`
	Documents     []DocumentBlob `json:"documents"`
	DocumentCount int            `json:"documentCount"`
	Continuation  string         `json:"continuation"`
	ErrorMsg      string         `json:"message"`
}

type Waiter

type Waiter struct {
	// Timeout specifies how long we should wait for an operation to complete.
	Timeout time.Duration // TODO(mpolden): Consider making this a budget
	// contains filtered or unexported fields
}

Waiter waits for Vespa services to become ready, within a timeout.

func (*Waiter) DeployService

func (w *Waiter) DeployService(target vespa.Target) (*vespa.Service, error)

DeployService returns the service providing the deploy API on given target,

func (*Waiter) Deployment

func (w *Waiter) Deployment(target vespa.Target, wantedID int64) (int64, error)

Deployment waits for a deployment to become ready, returning the ID of the converged deployment.

func (*Waiter) FastWaitOn

func (w *Waiter) FastWaitOn(target vespa.Target) bool

FastWaitOn returns whether we should use a short default timeout for given target.

func (*Waiter) Service

func (w *Waiter) Service(target vespa.Target, cluster string) (*vespa.Service, error)

Service returns the service identified by cluster ID, available on target.

func (*Waiter) Services

func (w *Waiter) Services(target vespa.Target) ([]*vespa.Service, error)

Services returns all container services available on target.