package
0.0.0-20221107231338-b44688ae358d
Repository: https://github.com/intelsdi-x/swan.git
Documentation: pkg.go.dev
# Functions
DefaultKubernetesConfig returns a KubernetesConfig object with safe defaults.
DefaultOpenstackConfig creates default OpenStack config.
DefaultRemoteConfig returns default Remote Executor configuration from flags.
NewChainedTaskHandle returns TaskHandle that executes current handle, and will launch Launcher when handle will finish it's execution.
NewClusterTaskHandle returns a ClusterTaskHandle instance.
NewKubernetes returns an executor which lets the user run commands in pods in a kubernetes cluster.
NewLocal returns instance of local executors without any isolators.
NewLocalIsolated returns a Local instance with some isolators set.
NewOpenstack creates OpenStack executor.
NewParallel prepares instance of Decorator that allows to ran tasks in parallel.
NewRemote returns a remote executor instance.
NewRemoteFromIP returns a remote executo instance.
NewRemoteIsolated returns a remote executor instance.
NewRuntimeScheme creates instance of runtime.Scheme and registers default conversions.
NewServiceHandle wraps TaskHandle with serviceHandle.
NewServiceLauncher is constructor for ServiceLauncher.
NewShell is a wrapper constructor for NewLocal or NewRemote executor depending on ip provided.
StopAndEraseOutput run Stop and EraseOutput on TaskHandle and add errors to errorCollection.
# Constants
RUNNING task state means that task is still running.
TERMINATED task state means that task completed or stopped.
# Structs
ChainedTaskHandle is an links Launchers in a way that one will be launched after another.
ClusterTaskHandle is a task handle for composition of master and multiple agents.
CPU defines CPU data.
Disk defines disk data.
HostAggregate defines OpenStack host aggregate data.
Hypervisor defines OpenStack hypervisor data.
KubernetesConfig describes the necessary information to connect to a Kubernetes cluster.
LaunchTimedOutError is the error type returned when launching new pods exceed the timeout value defined in kubernetes.Config.LaunchTimeout.
Local provisioning is responsible for providing the execution environment on local machine via exec.Command.
MockExecutor is an autogenerated mock type for the Executor type.
MockLauncher is an autogenerated mock type for the Launcher type.
MockLoadGenerator is an autogenerated mock type for the LoadGenerator type.
MockTaskControl is an autogenerated mock type for the TaskControl type.
MockTaskHandle is an autogenerated mock type for the TaskHandle type.
MockTaskInfo is an autogenerated mock type for the TaskInfo type.
Openstack defines OpenStack server configuration and client.
OpenstackAuthConfig defines OpenStack authentication configuration data.
OpenstackConfig defines OpenStack instance configuration data.
OpenstackFlavor defines OpenStack flavor data.
OpenstackTaskHandle represents an abstraction to control task lifecycle and status.
Parallel allows to run same command using same executor multiple times.
RAM defines RAM data.
Remote provisioning is responsible for providing the execution environment on remote machine via ssh.
RemoteConfig is configuration for Remote Executor.
ServiceLauncher is a decorator and Launcher implementation that should be used for tasks that do not stop on their own.
# Interfaces
Executor is responsible for creating execution environment for given workload.
Launcher responsibility is to launch previously configured job.
LoadGenerator launches stresser which generates load on specified workload.
TaskControl controls task's lifecycle and garbage collection.
TaskHandle represents an abstraction to control task lifecycle and status.
TaskInfo represents task's address, status and output information.
# Type aliases
TaskState is an enum presenting current task state.