ibmcloud

Documentation

Index

• Constants
• Variables
• func Run(plugins func() discovery.Plugins, name plugin.Name, config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, ...)
• type Options
• type VolumeAuth

Constants

const (
	// Kind is the canonical name of the plugin for starting up, etc.
	Kind = "ibmcloud"

	// EnvIBMCloudUsername is the name of the LB ENV variable name for the IBM Cloud Username.
	EnvIBMCloudUsername = "INFRAKIT_IBMCLOUD_USERNAME"

	// EnvIBMCloudAPIKey is the name of the LB ENV variable name for the IBM Cloud API Key.
	EnvIBMCloudAPIKey = "INFRAKIT_IBMCLOUD_APIKEY"
)

Variables

var DefaultOptions = Options{
	Username: local.Getenv(EnvIBMCloudUsername, ""),
	APIKey:   local.Getenv(EnvIBMCloudAPIKey, ""),
	VolumeAuth: VolumeAuth{
		VolumeID: 0,
	},
}

DefaultOptions return an Options with default values filled in.

Functions

func Run

func Run(plugins func() discovery.Plugins, name plugin.Name,
	config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, onStop func(), err error)

Run runs the plugin, blocking the current thread. Error is returned immediately if the plugin cannot be started.

Types

type Options

type Options struct {
	Username   string
	APIKey     string
	VolumeAuth VolumeAuth
}

Options capture the options for starting up the plugin.

type VolumeAuth

type VolumeAuth struct {
	// VolumeID is the volume to authorize to the group members
	VolumeID int
}

VolumeAuth is the type that contains the volume information to authorize