operations

Documentation

Index

• func Admin() cli.Command
• func Agent() cli.Command
• func CommitQueue() cli.Command
• func CreateVersion() cli.Command
• func Evaluate() cli.Command
• func Export() cli.Command
• func Fetch() cli.Command
• func Host() cli.Command
• func Keys() cli.Command
• func LastGreen() cli.Command
• func List() cli.Command
• func Notification() cli.Command
• func Patch() cli.Command
• func PatchCancel() cli.Command
• func PatchFile() cli.Command
• func PatchFinalize() cli.Command
• func PatchList() cli.Command
• func PatchRemoveModule() cli.Command
• func PatchSetModule() cli.Command
• func Service() cli.Command
• func Subscriptions() cli.Command
• func Update() cli.Command
• func Validate() cli.Command
• func Version() cli.Command
• type APIError
  • func NewAPIError(resp *http.Response) APIError
  • func (ae APIError) Error() string
• type ClientAdminConf
  • func (c ClientAdminConf) Validate() error
• type ClientProjectConf
• type ClientSettings
  • func NewClientSettings(fn string) (*ClientSettings, error)
  • func (s *ClientSettings) FindDefaultAlias(project string) string
  • func (s *ClientSettings) FindDefaultProject() string
  • func (s *ClientSettings) FindDefaultTasks(project string) []string
  • func (s *ClientSettings) FindDefaultVariants(project string) []string
  • func (s *ClientSettings) GetRestCommunicator(ctx context.Context) client.Communicator
  • func (s *ClientSettings) SetDefaultAlias(project string, alias string)
  • func (s *ClientSettings) SetDefaultProject(name string)
  • func (s *ClientSettings) SetDefaultTasks(project string, tasks ...string)
  • func (s *ClientSettings) SetDefaultVariants(project string, variants ...string)
  • func (s *ClientSettings) Write(fn string) error

Functions

func Admin

func Admin() cli.Command

func Agent

func Agent() cli.Command

func CommitQueue

func CommitQueue() cli.Command

func CreateVersion

func CreateVersion() cli.Command

func Evaluate

func Evaluate() cli.Command

func Export

func Export() cli.Command

func Fetch

func Fetch() cli.Command

func Host

func Host() cli.Command

func Keys

func Keys() cli.Command

func LastGreen

func LastGreen() cli.Command

func List

func List() cli.Command

func Notification

func Notification() cli.Command

func Patch

func Patch() cli.Command

func PatchCancel

func PatchCancel() cli.Command

func PatchFile

func PatchFile() cli.Command

func PatchFinalize

func PatchFinalize() cli.Command

func PatchList

func PatchList() cli.Command

func PatchRemoveModule

func PatchRemoveModule() cli.Command

func PatchSetModule

func PatchSetModule() cli.Command

func Service

func Service() cli.Command

func Subscriptions

func Subscriptions() cli.Command

func Update

func Update() cli.Command

func Validate

func Validate() cli.Command

func Version

func Version() cli.Command

Types

type APIError

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

APIError is an implementation of error for reporting unexpected results from API calls.

func NewAPIError

func NewAPIError(resp *http.Response) APIError

NewAPIError creates an APIError by reading the body of the response and its status code.

func (APIError) Error

func (ae APIError) Error() string

type ClientAdminConf

type ClientAdminConf struct {
	Port       int      `json:"port" yaml:"port,omitempty"`
	AppServers []string `json:"app_servers" yaml:"app_servers,omitempty"`
}

ClientAdminConf tracks information about the evergreen deployment internally to support doing operations against specific app servers individually, including administering background jobs, and potentially self-orchestrating deploys.

func (ClientAdminConf) Validate

func (c ClientAdminConf) Validate() error

Validate provides very basic filtering of the admin configuration document.

type ClientProjectConf

type ClientProjectConf struct {
	Name     string   `json:"name" yaml:"name,omitempty"`
	Default  bool     `json:"default" yaml:"default,omitempty"`
	Alias    string   `json:"alias" yaml:"alias,omitempty"`
	Variants []string `json:"variants" yaml:"variants,omitempty"`
	Tasks    []string `json:"tasks" yaml:"tasks,omitempty"`
}

type ClientSettings

type ClientSettings struct {
	APIServerHost      string              `json:"api_server_host" yaml:"api_server_host,omitempty"`
	UIServerHost       string              `json:"ui_server_host" yaml:"ui_server_host,omitempty"`
	APIKey             string              `json:"api_key" yaml:"api_key,omitempty"`
	User               string              `json:"user" yaml:"user,omitempty"`
	UncommittedChanges bool                `json:"patch_uncommitted_changes" yaml:"patch_uncommitted_changes,omitempty"`
	Projects           []ClientProjectConf `json:"projects" yaml:"projects,omitempty"`
	Admin              ClientAdminConf     `json:"admin" yaml:"admin,omitempty"`
	LoadedFrom         string              `json:"-" yaml:"-"`
}

Client represents the data stored in the user's config file, by default located at ~/.evergreen.yml If you change the JSON tags, you must also change an anonymous struct in hostinit/setup.go

func NewClientSettings

func NewClientSettings(fn string) (*ClientSettings, error)

func (*ClientSettings) FindDefaultAlias

func (s *ClientSettings) FindDefaultAlias(project string) string

func (*ClientSettings) FindDefaultProject

func (s *ClientSettings) FindDefaultProject() string

func (*ClientSettings) FindDefaultTasks

func (s *ClientSettings) FindDefaultTasks(project string) []string

func (*ClientSettings) FindDefaultVariants

func (s *ClientSettings) FindDefaultVariants(project string) []string

func (*ClientSettings) GetRestCommunicator

func (s *ClientSettings) GetRestCommunicator(ctx context.Context) client.Communicator

GetRestCommunicator returns a client for communicating with the API server. Callers are responsible for calling (Communicator).Close() when finished with the client.

func (*ClientSettings) SetDefaultAlias

func (s *ClientSettings) SetDefaultAlias(project string, alias string)

func (*ClientSettings) SetDefaultProject

func (s *ClientSettings) SetDefaultProject(name string)

func (*ClientSettings) SetDefaultTasks

func (s *ClientSettings) SetDefaultTasks(project string, tasks ...string)

func (*ClientSettings) SetDefaultVariants

func (s *ClientSettings) SetDefaultVariants(project string, variants ...string)

func (*ClientSettings) Write

func (s *ClientSettings) Write(fn string) error