api

package

v0.0.0-...-fc9d343 Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/evergreen-ci/evergreen

Documentation ¶

Overview ¶

Package api provides common functions used by the service and graphql packages.

Index ¶

Constants
func GetHostsAndUserPermissions(ctx context.Context, user *user.DBUser, hostIds []string) ([]host.Host, map[string]gimlet.Permissions, int, error)
func GetReprovisionToNewCallback(ctx context.Context, env evergreen.Environment, username string) func(h *host.Host) (int, error)
func GetRestartJasperCallback(ctx context.Context, env evergreen.Environment, username string) func(h *host.Host) (int, error)
func GetUpdateHostStatusCallback(ctx context.Context, env evergreen.Environment, rq amboy.Queue, status string, ...) func(h *host.Host) (httpStatus int, err error)
func ModifyHostStatus(ctx context.Context, env evergreen.Environment, queue amboy.Queue, ...) (string, int, error)
func ModifyHostsWithPermissions(hosts []host.Host, perm map[string]gimlet.Permissions, ...) (updated int, httpStatus int, err error)

Constants ¶

View Source

const (
	InvalidStatusError             = "'%v' is not a valid status"
	DecommissionStaticHostError    = "Cannot decommission static hosts"
	HostTerminationQueueingError   = "Error starting background job for host termination"
	HostUpdateError                = "Error updating host"
	HostTerminationQueueingSuccess = "Host %v successfully queued for termination"
	HostStatusUpdateSuccess        = "Host status successfully updated from '%v' to '%v'"
	HostStatusWriteConfirm         = "Successfully updated host status"
	HostRestartJasperConfirm       = "Successfully marked host as needing Jasper service restarted"
	HostReprovisionConfirm         = "Successfully marked host as needing to reprovision"
	UnrecognizedAction             = "Unrecognized action: %v"
)

Variables ¶

This section is empty.

Functions ¶

func GetHostsAndUserPermissions ¶

func GetHostsAndUserPermissions(ctx context.Context, user *user.DBUser, hostIds []string) ([]host.Host, map[string]gimlet.Permissions, int, error)

func GetReprovisionToNewCallback ¶

func GetReprovisionToNewCallback(ctx context.Context, env evergreen.Environment, username string) func(h *host.Host) (int, error)

func GetRestartJasperCallback ¶

func GetRestartJasperCallback(ctx context.Context, env evergreen.Environment, username string) func(h *host.Host) (int, error)

func GetUpdateHostStatusCallback ¶

func GetUpdateHostStatusCallback(ctx context.Context, env evergreen.Environment, rq amboy.Queue, status string, notes string, user *user.DBUser) func(h *host.Host) (httpStatus int, err error)

func ModifyHostStatus ¶

func ModifyHostStatus(ctx context.Context, env evergreen.Environment, queue amboy.Queue, h *host.Host, newStatus string, notes string, u *user.DBUser) (string, int, error)

func ModifyHostsWithPermissions ¶

func ModifyHostsWithPermissions(hosts []host.Host, perm map[string]gimlet.Permissions, modifyHost func(h *host.Host) (int, error)) (updated int, httpStatus int, err error)

ModifyHostsWithPermissions performs an update on each of the given hosts for which the permissions allow updates on that host.

Types ¶

This section is empty.

Source Files ¶

View all Source files

host.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL