parlay

Documentation

Index

• Variables
• func DeleteTargetLogs(target string) error
• func DeploySSH(m *parlaytypes.TreasureMap, logFile string, jsonLogging, background bool) error
• func GetTargetLogs(target string) (*plunderlogging.JSONLog, error)
• func RegisterToAPIServer()
• func StartUI(m *parlaytypes.TreasureMap) (*parlaytypes.TreasureMap, error)
• func ValidateAction(action *parlaytypes.Action) error
• type Restore
  • func RestoreFromCheckpoint() *Restore

Variables

var Keys map[string]string

Keys are used to store information between sessions and deployments

Functions

func DeleteTargetLogs

func DeleteTargetLogs(target string) error

DeleteTargetLogs will retrieve the JSON logs

func DeploySSH

func DeploySSH(m *parlaytypes.TreasureMap, logFile string, jsonLogging, background bool) error

DeploySSH - will iterate through a deployment and perform the relevant actions

func GetTargetLogs

func GetTargetLogs(target string) (*plunderlogging.JSONLog, error)

GetTargetLogs will retrieve the JSON logs

func RegisterToAPIServer

func RegisterToAPIServer()

RegisterToAPIServer - will add the endpoints to the API server

func StartUI

func StartUI(m *parlaytypes.TreasureMap) (*parlaytypes.TreasureMap, error)

StartUI will enable parlay to provide an easier way of selecting which operations will be performed

func ValidateAction

func ValidateAction(action *parlaytypes.Action) error

ValidateAction will parse an action to ensure it is valid

Types

type Restore

type Restore struct {
	Deployment string   `json:"deployment"` // Name of deployment to restore from
	Action     string   `json:"action"`     // Action to restore from
	Host       string   `json:"host"`       // Single host to start from
	Hosts      []string `json:"hosts"`      // Restart operation on a number of hosts
}

Restore provides a checkpoint to resume from

func RestoreFromCheckpoint

func RestoreFromCheckpoint() *Restore

RestoreFromCheckpoint will attempt to find a restoration checkpoint file