control

Documentation

Overview

Package control handles the details of control calls to the O² Control core.

Index

• Constants
• func AddRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) error
• func CleanTasks(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func ControlEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func DestroyEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func GetEnvironments(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func GetInfo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func GetTasks(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func ListRepos(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func ListWorkflowTemplates(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func ModifyEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func QueryRoles(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func RefreshRepos(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func RemoveRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func SetDefaultRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) error
• func SetDefaultRevision(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) error
• func ShowEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• func Teardown(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, ...) (err error)
• type ConfigurationPayload
• type ControlCall
• type RunFunc
  • func WrapCall(call ControlCall) RunFunc

Constants

const (
	CALL_TIMEOUT = 55 * time.Second
	SPINNER_TICK = 100 * time.Millisecond
)

Functions

func AddRepo

func AddRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) error

AddRepo add a new repository to the available git repositories used for configuration and checks it out.

func CleanTasks

func CleanTasks(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func ControlEnvironment

func ControlEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func CreateEnvironment

func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func DestroyEnvironment

func DestroyEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func GetEnvironments

func GetEnvironments(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func GetInfo

func GetInfo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func GetTasks

func GetTasks(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func ListRepos

func ListRepos(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

ListRepos lists all available git repositories that are used for configuration.

func ListWorkflowTemplates

func ListWorkflowTemplates(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

ListWorkflowTemplates lists the available workflow templates and the git repo on which they reside.

func ModifyEnvironment

func ModifyEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func QueryRoles

func QueryRoles(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func RefreshRepos

func RefreshRepos(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

RefreshRepos runs the equivalent of git pull origin/master for all available repositories.

func RemoveRepo

func RemoveRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

RemoveRepo removes a git repository based on the indexes reported by ListRepos. If the default repository is removed, the repository with the lowest index is set as the new default. If all repositories are removed, the backend (consul or file) record of the default repository is updated to the relevant viper entry.

func SetDefaultRepo

func SetDefaultRepo(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) error

SetDefaultRepo selects the default repository based on the indexes reported by ListRepos. It also updates the backend (consul or file) which holds a record for the default repository which is persistent across core executions.

func SetDefaultRevision

func SetDefaultRevision(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) error

SetDefaultRevision selects the default repository revision. This can be done on the global or on the repository level.

func ShowEnvironment

func ShowEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

func Teardown

func Teardown(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error)

Types

type ConfigurationPayload

type ConfigurationPayload struct {
	Name       string            `json:"name"`
	Workflow   string            `json:"workflow"`
	Revision   string            `json:"revision"`
	Repository string            `json:"repository"`
	Vars       map[string]string `json:"variables"`
	Detectors  []string          `json:"detectors"`
}

type ControlCall

type ControlCall func(context.Context, *coconut.RpcClient, *cobra.Command, []string, io.Writer) error

type RunFunc

type RunFunc func(*cobra.Command, []string)

func WrapCall

func WrapCall(call ControlCall) RunFunc