client

package

v0.1.14 Latest Latest Go to latest Published: Feb 1, 2024 License: Apache-2.0 Imports: 43 Imported by: 1

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/ppc64le-cloud/pvsadm

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GetEnvironment(env string) (map[string]string, error)
func ListEnvironments() (keys []string)
type Client
- func NewClient(apikey, ep string, debug bool) (*Client, error)
- func NewClientWithEnv(apikey, env string, debug bool) (*Client, error)
type CreateResourceKeyOptions
type CustomReader
type PVMClient
- func NewPVMClient(c *Client, instanceID, instanceName, ep string) (*PVMClient, error)
- func NewPVMClientWithEnv(c *Client, instanceID, instanceName, env string) (*PVMClient, error)
type ResourceControllerV2
- func NewResourceControllerV2(r *rcv2.ResourceControllerV2Options) (*ResourceControllerV2, error)
type S3Client
- func NewS3Client(c *Client, instanceName, region string) (s3client *S3Client, err error)
- func NewS3Clientwithkeys(accesskey, secretkey, region string) (s3client *S3Client, err error)
type User

Constants ¶

View Source

const (
	AuthEndpoint = "https://iam.cloud.ibm.com/identity/token"
)

View Source

const DefaultEnv = "prod"

Variables ¶

View Source

var EnvironmentNotFound = errors.New("environment not found")

View Source

var Environments = map[string]map[string]string{
	"test": {
		"TPEndpoint": "https://iam.test.cloud.ibm.com",
		"RCEndpoint": "https://resource-controller.test.cloud.ibm.com",
		"PIEndpoint": "power-iaas.test.cloud.ibm.com",
	},
	"prod": {
		"TPEndpoint": "https://iam.cloud.ibm.com",
		"RCEndpoint": "https://resource-controller.cloud.ibm.com",
		"PIEndpoint": "power-iaas.cloud.ibm.com",
	},
}

Functions ¶

func GetEnvironment ¶

func GetEnvironment(env string) (map[string]string, error)

func ListEnvironments ¶

func ListEnvironments() (keys []string)

Types ¶

type Client ¶

type Client struct {
	*bxsession.Session
	User               *User
	ResourceClientV2   controllerv2.ResourceServiceInstanceRepository
	ResourceClientV1   controller.ResourceServiceInstanceRepository
	ResourceServiceKey controller.ResourceServiceKeyRepository
	ResCatalogAPI      catalog.ResourceCatalogRepository
	ResGroupAPI        management.ResourceGroupRepository
}

func NewClient ¶

func NewClient(apikey, ep string, debug bool) (*Client, error)

func NewClientWithEnv ¶

func NewClientWithEnv(apikey, env string, debug bool) (*Client, error)

func (*Client) CreateServiceInstance ¶

func (c *Client) CreateServiceInstance(instanceName, serviceName, servicePlan, resourceGrp, region string) (string, error)

func (*Client) DeleteServiceInstance ¶

func (c *Client) DeleteServiceInstance(instanceID string, recursive bool) error

DeleteSericeInstance deletes service instances on the IBM Cloud, takes instanceID as input

func (*Client) GetResourceKeys ¶

func (c *Client) GetResourceKeys(instanceID string) ([]models.ServiceKey, error)

func (*Client) ListServiceInstances ¶

func (c *Client) ListServiceInstances(serviceType string) (map[string]string, error)

Func ListServiceInstances, list all available instances of particular servicetype

type CreateResourceKeyOptions ¶

type CreateResourceKeyOptions struct {
	*rcv2.CreateResourceKeyOptions

	// Overriding the Parameters to accommodate the HMAC parameter
	Parameters map[string]interface{} `json:"parameters,omitempty"`
}

type CustomReader ¶ added in v0.1.8

type CustomReader struct {
	// contains filtered or unexported fields
}

func (*CustomReader) Read ¶ added in v0.1.8

func (r *CustomReader) Read(p []byte) (int, error)

func (*CustomReader) ReadAt ¶ added in v0.1.8

func (r *CustomReader) ReadAt(p []byte, off int64) (int, error)

func (*CustomReader) Seek ¶ added in v0.1.8

func (r *CustomReader) Seek(offset int64, whence int) (int64, error)

type PVMClient ¶

type PVMClient struct {
	InstanceName string
	InstanceID   string
	Region       string
	Zone         string

	PISession *ibmpisession.IBMPISession

	DatacenterClient *datacenter.Client
	DHCPClient       *dhcp.Client
	EventsClient     *events.Client
	ImgClient        *image.Client
	InstanceClient   *instance.Client
	JobClient        *job.Client
	KeyClient        *key.Client
	NetworkClient    *network.Client
	VolumeClient     *volume.Client
}

func NewPVMClient ¶

func NewPVMClient(c *Client, instanceID, instanceName, ep string) (*PVMClient, error)

func NewPVMClientWithEnv ¶

func NewPVMClientWithEnv(c *Client, instanceID, instanceName, env string) (*PVMClient, error)

type ResourceControllerV2 ¶

type ResourceControllerV2 struct {
	ResourceControllerV2 *rcv2.ResourceControllerV2
}

func NewResourceControllerV2 ¶

func NewResourceControllerV2(r *rcv2.ResourceControllerV2Options) (*ResourceControllerV2, error)

func (*ResourceControllerV2) CreateResourceKey ¶

func (resourceController *ResourceControllerV2) CreateResourceKey(createResourceKeyOptions *CreateResourceKeyOptions) (result *rcv2.ResourceKey, response *core.DetailedResponse, err error)

func (*ResourceControllerV2) CreateResourceKeyWithContext ¶

func (resourceController *ResourceControllerV2) CreateResourceKeyWithContext(ctx context.Context, createResourceKeyOptions *CreateResourceKeyOptions) (result *rcv2.ResourceKey, response *core.DetailedResponse, err error)

Overriding the CreateResourceKeyWithContext function from the ResourceControllerV2 code to work with HMAC parameter

func (*ResourceControllerV2) ListResourceKeysBySourceCrn ¶

func (resourceController *ResourceControllerV2) ListResourceKeysBySourceCrn(name, sourceCrn string) (keys []rcv2.ResourceKey, err error)

ListResourceKeysBySourceCrn will return all the resource keys by name belongs to a sourceCrn

type S3Client ¶

type S3Client struct {
	ApiKey       string
	InstanceName string
	InstanceID   string
	Region       string
	StorageClass string
	SvcEndpoint  string
	S3Session    *s3.S3
}

func NewS3Client ¶

func NewS3Client(c *Client, instanceName, region string) (s3client *S3Client, err error)

Func NewS3Client accepts apikey, instanceid of the IBM COS instance and return the s3 client to perform different s3 operations like upload, delete etc.,

func NewS3Clientwithkeys ¶ added in v0.1.8

func NewS3Clientwithkeys(accesskey, secretkey, region string) (s3client *S3Client, err error)

Func NewS3Client accepts apikey, accesskey, secretkey of the bucket and return the s3 client to perform different s3 operations like upload, delete etc.,

func (*S3Client) CheckBucketExists ¶

func (c *S3Client) CheckBucketExists(bucketName string) (bool, error)

Func CheckBucketExists will verify for the existence of the bucket in the particular account

func (*S3Client) CheckBucketLocationConstraint ¶ added in v0.1.3

func (c *S3Client) CheckBucketLocationConstraint(bucketName string, bucketLocationConstraint string) (bool, error)

Func CheckBucketLocationConstraint will verify the existence of the bucket in the particular locationConstraint

func (*S3Client) CheckIfObjectExists ¶

func (c *S3Client) CheckIfObjectExists(bucketName, objectName string) (bool, error)

func (*S3Client) CopyObjectToBucket ¶ added in v0.1.3

func (c *S3Client) CopyObjectToBucket(srcBucketName string, destBucketName string, objectName string) error

To copy the object from src bucket to target bucket

func (*S3Client) CreateBucket ¶

func (c *S3Client) CreateBucket(bucketName string) error

To create a new bucket in the provided instance

func (*S3Client) SelectObjects ¶ added in v0.1.3

func (c *S3Client) SelectObjects(bucketName string, regex string) ([]string, error)

To select objects matching regex from src bucket

func (*S3Client) UploadObject ¶

func (c *S3Client) UploadObject(fileName, objectName, bucketName string) error

To upload a object to S3 bucket

type User ¶

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
datacenter
dhcp
events
image
instance
job
key
network
volume

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