client

package

v0.0.1 Latest Latest Go to latest Published: Mar 31, 2022 License: Apache-2.0 Imports: 26 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/openshift/machine-api-provider-powervs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func FormatProviderID(region, zone, serviceInstanceID, vmInstanceID string) string
func GetAPIKey(ctrlRuntimeClient client.Client, secretName, namespace string) (apikey string, err error)
type Client
- func NewValidatedClient(ctrlRuntimeClient client.Client, secretName, namespace, cloudInstanceID string, ...) (Client, error)
type PowerVSClientBuilderFuncType
type User

Constants ¶

View Source

const (
	//TIMEOUT is default timeout used by Power VS client for operations like DeleteInstance
	TIMEOUT = time.Hour

	//DefaultCredentialNamespace is the default namespace used to create a client object
	DefaultCredentialNamespace = "openshift-machine-api"
	//DefaultCredentialSecret is the credential secret name used by node update controller to fetch API key
	DefaultCredentialSecret = "powervs-credentials"

	//InstanceStateNameShutoff is indicates the shutoff state of Power VS instance
	InstanceStateNameShutoff = "SHUTOFF"
	//InstanceStateNameActive is indicates the active state of Power VS instance
	InstanceStateNameActive = "ACTIVE"
	//InstanceStateNameBuild is indicates the build state of Power VS instance
	InstanceStateNameBuild = "BUILD"

	//PowerServiceType is the power-iaas service type of IBM Cloud
	PowerServiceType = "power-iaas"
)

Variables ¶

View Source

var (
	//ErrorInstanceNotFound is error type for Instance Not Found
	ErrorInstanceNotFound = errors.New("instance Not Found")
)

Functions ¶

func FormatProviderID ¶

func FormatProviderID(region, zone, serviceInstanceID, vmInstanceID string) string

FormatProviderID formats and returns the provided instanceID

func GetAPIKey ¶

func GetAPIKey(ctrlRuntimeClient client.Client, secretName, namespace string) (apikey string, err error)

GetAPIKey will return the api key read from given secretName in a given namespace

Types ¶

type Client ¶

type Client interface {
	CreateInstance(createParams *models.PVMInstanceCreate) (*models.PVMInstanceList, error)
	GetInstance(id string) (*models.PVMInstance, error)
	GetInstanceByName(name string) (*models.PVMInstance, error)
	GetInstances() (*models.PVMInstances, error)
	DeleteInstance(id string) error
	GetImages() (*models.Images, error)
	GetNetworks() (*models.Networks, error)
	GetCloudServiceInstances() ([]bluemixmodels.ServiceInstanceV2, error)

	GetZone() string
	GetRegion() string
}

Client is a wrapper object for actual PowerVS SDK clients to allow for easier testing.

func NewValidatedClient ¶

func NewValidatedClient(ctrlRuntimeClient client.Client, secretName, namespace, cloudInstanceID string, debug bool) (Client, error)

NewValidatedClient creates and return a new Power VS client

type PowerVSClientBuilderFuncType ¶

type PowerVSClientBuilderFuncType func(client client.Client, secretName, namespace, cloudInstanceID string,
	debug bool) (Client, error)

PowerVSClientBuilderFuncType is function type for building the Power VS client

type User ¶

type User struct {
	ID      string
	Email   string
	Account string
	// contains filtered or unexported fields
}

User is used to hold the user details

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.

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