vmware-go-sdk

README

IBM Cloud VMware Go SDK Version 0.1.1

Go client library to interact with the various IBM Cloud VMware Service APIs.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

• Overview
• Prerequisites
• Installation
  • Go modules
  • go get command
• Authentication
  • Authentication with environment variables
  • Authentication with external configuration
  • Programmatic authentication
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud VMware Go SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Package name
VMware	vmwarev1

Prerequisites

• An IBM Cloud account.
• An IAM API key to allow the SDK to access your account. Create one here.
• Go version 1.19 or above.

Installation

The current version of this SDK: 0.1.1

Go modules

If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application.
Here is an example:

import (
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.

In the example above, the vmwarev1 part of the import path is the package name associated with the VMware service. See the service table above to find the appropriate package name for the services used by your application.

go get command

Alternatively, you can use the go get command to download and install the appropriate packages needed by your application:

go get -u github.com/IBM/vmware-go-sdk/vmwarev1

Be sure to use the appropriate package name from the service table above for the services used by your application.

Authentication

There are several ways to set these properties:

1. As environment variables
2. The programmatic approach
3. With an external credentials file

Authentication with environment variables

IAM authentication

For IAM authentication, set the following environmental variables by replacing the <url>, <apikey> and <auth_url> with your proper authenticator properties and endpoint URLs.

VMWARE_AUTH_URL=iam
VMWARE_URL=<url>
VMWARE_APIKEY=<apikey>
VMWARE_AUTH_TYPE=<auth_url>

Authentication with external configuration

To use an external configuration file, the general SDK usage information will guide you.

Programmatic authentication

To learn more about how to use programmatic authentication, see the related documentation in the Go SDK Core document about authentication.

Using the SDK

For general SDK usage information, please see this link.

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.